hdf-compass icon indicating copy to clipboard operation
hdf-compass copied to clipboard

Create Test Plan Document

Open jreadey opened this issue 9 years ago • 11 comments

Create Test Plan document that would outline manual testing process for release validation.

jreadey avatar Oct 07 '15 17:10 jreadey

John, Need some hints for this or you just want me to start from scratch what I am thinking the right plan.

kyang2014 avatar Oct 08 '15 16:10 kyang2014

For our purposes I'd recommend a simple document structured like:

Platforms tested: List of systems to be tested: Windows/Mac OS X/Linux. What OS flavors of each of these will be tested?

Test Environment setup: Compass should require no software perquisites, so this should be easy. Provide instructions for accessing data files used in testing.

Installation: For each platform what is the expected experience for a user installing the software?

Basic functionality: Menu selections: About Box, Help, Hide HDF Compass.
Desktop Integration: Toolbar Icon displays (On mac). Can drag files to Toolbar. Plugin Testing - for each plugin: *Set of files (resources) to be tested *Action(s) to be performed with each file (e.g. open file, navigate to dataset, plot)

Let's start simple and build on this as we come across issues that were missed in testing.

jreadey avatar Oct 08 '15 17:10 jreadey

Write a document under the HDFcompass project of the HDF group confluence page. Haven't finished the last two parts.

kyang2014 avatar Oct 09 '15 20:10 kyang2014

@kyang2014 Can I access such a document? If yes, where is it?

giumas avatar Oct 20 '15 14:10 giumas

@giumas - currently the test plan is in our internal wiki system.

@kyang2014 - Do you want to check it in as a an rst file into the compass project? That would make it easier for other's to suggest improvements to the test plan or run through it themselves.

jreadey avatar Oct 20 '15 15:10 jreadey

The document is not aiming for the release but it includes some information useful for developers to test. So I think it is good for others to view/edit or to make suggestions. My questions is where to check in? I hesitate to check it in under /docs. Is there a good place only for the developers to view and not for the general users? Is it okay to use the Wiki page under hdf-compass? From: John Readey [mailto:[email protected]] Sent: Tuesday, October 20, 2015 10:22 AM To: HDFGroup/hdf-compass Cc: Kent Yang Subject: Re: [hdf-compass] Create Test Plan Document (#71)

@giumashttps://github.com/giumas - currently the test plan is in our internal wiki system.

@kyang2014https://github.com/kyang2014 - Do you want to check it in as a an rst file into the compass project? That would make it easier for other's to suggest improvements to the test plan or run through it themselves.

— Reply to this email directly or view it on GitHubhttps://github.com/HDFGroup/hdf-compass/issues/71#issuecomment-149600718.

kyang2014 avatar Oct 20 '15 17:10 kyang2014

@kyang2014 - create a new 'test' directory and hang it off there. This directory would be a good spot for a future test runner script as well.

jreadey avatar Oct 20 '15 18:10 jreadey

Create the test directory and two rst files. Check in to the develop branch. The RST files need to be edited. What editor is good to use?

kyang2014 avatar Oct 20 '15 19:10 kyang2014

I use PyCharm and http://rst.ninjs.org/.

giumas avatar Oct 20 '15 19:10 giumas

@kyang2014: You asked for this... :-)

I use Sublime Text 3 and its package https://github.com/mgaitan/sublime-rst-completion. There's even a video how it works: https://www.youtube.com/watch?v=otM_tjIi_vY.

ghost avatar Oct 20 '15 20:10 ghost

I use Visual Studio Code: https://code.visualstudio.com/. I think it's basically the as Atom: https://atom.io/.

jreadey avatar Oct 20 '15 20:10 jreadey