Studio:Linking Test Plan with results - Revision history

Timd: Text replace - 'Category:Script Writing' to 'Category:Studio:Script Writing'

2009-08-20T22:31:18Z

Text replace - 'Category:Script Writing' to 'Category:Studio:Script Writing'

← Older revision		Revision as of 22:31, 20 August 2009
Line 90:		Line 90:
	: show a complete implementation linking each test class with its description in the support wiki.		: show a complete implementation linking each test class with its description in the support wiki.

	[[Category:Script Writing]]		[[Category:Studio:Script Writing]]

Timd: Linking Test Plan with results moved to Studio:Linking Test Plan with results

2009-08-18T21:43:39Z

Linking Test Plan with results moved to Studio:Linking Test Plan with results

← Older revision	Revision as of 21:43, 18 August 2009
(No difference)

Ivailop: /* Examples */

2009-06-05T16:59:43Z

Examples

← Older revision		Revision as of 16:59, 5 June 2009
Line 89:		Line 89:
	;[[Test Class Samples]]		;[[Test Class Samples]]
	: show a complete implementation linking each test class with its description in the support wiki.		: show a complete implementation linking each test class with its description in the support wiki.

	[[Category:Script Writing]]		[[Category:Script Writing]]
	~~[[Category:Practice]]~~

Ivailop: /* Examples */

2009-03-20T19:40:10Z

Examples

← Older revision		Revision as of 19:40, 20 March 2009
Line 87:		Line 87:
	</source>		</source>

	;[[Test Class ~~Sample~~]]		;[[Test Class Samples]]
	: ~~shows~~ a complete implementation linking each test class with its description in the support wiki.		: show a complete implementation linking each test class with its description in the support wiki.
	[[Category:Script Writing]]		[[Category:Script Writing]]
	[[Category:Practice]]		[[Category:Practice]]

Ivailop: /* Script-Based Tests */

2009-02-12T18:20:31Z

Script-Based Tests

← Older revision		Revision as of 18:20, 12 February 2009
Line 28:		Line 28:

	[[Image:LinkingTestSpec.jpg\|thumb\|Setting a '''Test Spec''' Link Using STRIDE Studio Properties]]		[[Image:LinkingTestSpec.jpg\|thumb\|Setting a '''Test Spec''' Link Using STRIDE Studio Properties]]
	These tests comprise one or more scripts that define an run tests and are designated in a STRIDE Studio Workspace (<code>.ssw</code>) file. These tests may be run from within STRIDE Studio or from a command line.		These tests comprise one or more scripts that define an run tests and are designated in a [[STRIDE Studio]] Workspace (<code>.ssw</code>) file. These tests may be run from within STRIDE Studio or from a command line.

	===Setting Links From STRIDE Studio===		===Setting Links From STRIDE Studio===

Timd at 22:56, 8 December 2008

2008-12-08T22:56:45Z

← Older revision		Revision as of 22:56, 8 December 2008
Line 2:		Line 2:

	==Overview==		==Overview==
	[[Image:ReportOutputWithPortalLinks.jpg\|thumb\|~~widthpx\|~~ ]]		[[Image:ReportOutputWithPortalLinks.jpg\|thumb\|Test Report Showing Standard Portal Links]]
	When reviewing test output reports it's very helpful to have links from each test suite to its relevant test plan or test spec in the project portal wiki.		When reviewing test output reports it's very helpful to have links from each test suite to its relevant test plan or test spec in the project portal wiki.

	Standard practice dictates that these links be added to all customer test reports in the suites' ''Description'' field.		Standard practice dictates that these links be added to all customer test reports in the suites' ''Description'' field. Further, the report's top-level suite contains a link to the overall test plan, and each of its subsuites link to the suite's corresponding test spec (or other relevant section). (See screenshot at right.)

	~~Top~~-~~level suite links to the overall~~ test ~~plan~~, ~~and subsuites~~ link to ~~relevant sections~~.		The method used to add these links varies between script-based and test unit-based test reports. In all cases, though, the description field link is indicated in the same way; special formatting indicates to the reporter that the string should be interpreted as a hyperlink.

	~~The method used depends on~~ the ~~type of testing done.~~		===Link Formatting===
			To have the reporter interpret your description string as a hyperlink, follow this pattern:

	~~Set~~ the ~~relevant suite's Description field value to~~ the URL of the ~~linked document.~~		<pre>
			[URL label]
			</pre>

			* The hyperlink information must be enclosed in square brackets
			* The URL may be any valid http or https url
			* The label is optional and will be used as the link text if present
			* The label is separated from the URL by one or more space characters
			* The label may contain spaces
			* Note that this formatting identical to that used by the wiki for external links


	==Script-Based Tests==		==Script-Based Tests==
	~~Here, we assume that script-based tests will be run as part of a workspace whether within STRIDE Studio or from the command line~~.		[[Image:LinkingTestPlan.jpg\|thumb\|Setting the '''Test Plan''' Link Using STRIDE Studio Properties]]

	~~For script-based tests,~~ the ~~preferred method of adding links is by setting each suite~~'~~s Description property from the Properties window within~~ STRIDE Studio~~. This has the benefit ***.~~

	~~Set the testplan link at the top-level test suite (Script Files) and then set a link for each subfolder that contains tests that produce reporter output.~~

	~~The suite description field recognizes special formatting that indicates a hyperlink.~~
	~~Link formatting is just like wiki:~~

	~~<code>~~
	~~<nowiki>[URL label~~]~~</nowiki>~~
	~~</code>~~

	~~Enclose URL in square brackets to indicate a link, provide optional label separated by a space within the brackets.~~

	~~Put the link~~ in ~~each suite's Description field~~ within ~~the properties window~~.		[[Image:LinkingTestSpec.jpg\|thumb\|Setting a '''Test Spec''' Link Using STRIDE Studio Properties]]
			These tests comprise one or more scripts that define an run tests and are designated in a STRIDE Studio Workspace (<code>.ssw</code>) file. These tests may be run from within STRIDE Studio or from a command line.

	~~[[Image:LinkingTestPlan~~.~~jpg\|thumb\|frame]]~~		===Setting Links From STRIDE Studio===
			The preferred method of adding links to script-based test suites is by setting each suite's ''Description'' property using the Properties window within STRIDE Studio. (Examples are shown at right).

	~~[[Image:LinkingTestSpec~~.~~jpg\|thumb\|frame]]~~		Set the overall test plan link at the top-level test suite (this suite corresponds to the <code>Script Files</code> workspace node). Then for each subfolder that contains tests that produce reporter output, add a link to a test spec or other relevant document.

			====Example====
			;[[Reporting Sample]]
			:Shows a complete implementation of this style of linking.

	==Setting Links From a Script==		===Setting Links From a Script===
			If is also possible to set suite ''Description''s from your test scripts.

			====Examples====
	* Linking Test Plan to Workspace '''Description'''		* Linking Test Plan to Workspace '''Description'''

Line 53:		Line 57:

	==Test Unit-Based Tests==		==Test Unit-Based Tests==
	~~For~~ Test Unit-based tests, you must set the test suite ~~description~~ explicitly in your test unit code.		Test Unit-based tests create "virtual" suites where each test class creates a suite at runtime. Therefore, you must set the test suite ''Description''s explicitly in your test unit code.

	The most convenient place to add this code is in the test class' constructor. Assuming that <code>szLINK_TO_TEST_SPEC</code> evaluates to the intended description string, the code to add is as follows:		The most convenient place to add this code is in the test class' constructor. Assuming that <code>szLINK_TO_TEST_SPEC</code> evaluates to the intended description string, the code to add is as follows:

			====Examples====
	'''For classes that derive from srTest'''		'''For classes that derive from srTest'''
	<source lang="c">		<source lang="c">
Line 82:		Line 87:
	</source>		</source>

	~~===Example===~~		;[[Test Class Sample]]
	~~The source code included in the~~ [[Test Class Sample]] ~~implements~~ linking of each test class with its description in the support wiki.		: shows a complete implementation linking each test class with its description in the support wiki.
	[[Category:Script Writing]]		[[Category:Script Writing]]
	[[Category:Practice]]		[[Category:Practice]]

Timd at 21:42, 8 December 2008

2008-12-08T21:42:30Z

← Older revision		Revision as of 21:42, 8 December 2008
Line 2:		Line 2:

	==Overview==		==Overview==
	It's very helpful to ~~provide a link with~~ each suite to ~~the~~ relevant test plan ~~section~~.		[[Image:ReportOutputWithPortalLinks.jpg\|thumb\|widthpx\| ]]
			When reviewing test output reports it's very helpful to have links from each test suite to its relevant test plan or test spec in the project portal wiki.

			Standard practice dictates that these links be added to all customer test reports in the suites' ''Description'' field.

	Top-level suite links to the overall test plan, and subsuites link to relevant sections.		Top-level suite links to the overall test plan, and subsuites link to relevant sections.
Line 9:		Line 12:

	Set the relevant suite's Description field value to the URL of the linked document.		Set the relevant suite's Description field value to the URL of the linked document.


	==Script-Based Tests==		==Script-Based Tests==

Timd at 19:40, 8 December 2008

2008-12-08T19:40:12Z

@@ Line 4: / Line 4: @@
 It's very helpful to provide a link with each suite to the relevant test plan section.
-==Using STRIDE Studio==
+The method used depends on the type of testing done.
 Link formatting is just like wiki:
@@ Line 18: / Line 28: @@
 Put the link in each suite's Description field within the properties window.
-==Using a Script==
+[[Image:LinkingTestPlan.jpg|thumb|frame]]
 * Linking Test Plan to Workspace '''Description'''
-  ScriptFiles             = studio.Workspace.Folders.Item("Script Files");
+<source lang="perl">
-  ScriptFiles.Description = <code><nowiki>"[http://www.example.com Test Plan]";</nowiki></code>
+my $ScriptFiles = $main::studio->Workspace->Folders->Item('Script Files');
 * Linking Test Spec to a '''Suite'''
-  Suite = testSuite.Suites.Add();
+<source lang="perl">
-  Suite.Description = <code><nowiki>"[http://www.example.com Test Spec]";</nowiki></code>
+$main::testSuite->{Description} = '[http://my-portal.s2technologies.com#relevant_section Test Spec]';
 [[Category:Script Writing]]
 [[Category:Practice]]

Timd at 01:11, 6 December 2008

2008-12-06T01:11:15Z

← Older revision		Revision as of 01:11, 6 December 2008
Line 15:		Line 15:

	Enclose URL in square brackets to indicate a link, provide optional label separated by a space within the brackets.		Enclose URL in square brackets to indicate a link, provide optional label separated by a space within the brackets.

			Put the link in each suite's Description field within the properties window.

			==Using a Script==

	* Linking Test Plan to Workspace '''Description'''		* Linking Test Plan to Workspace '''Description'''

Timd at 01:10, 6 December 2008

2008-12-06T01:10:15Z

← Older revision		Revision as of 01:10, 6 December 2008
Line 1:		Line 1:
			This article describes the standard method for adding a link to the test plan on a STRIDE report

			==Overview==
			It's very helpful to provide a link with each suite to the relevant test plan section.


			==Using STRIDE Studio==
			This is the preferred method.

			Link formatting is just like wiki:

			<code>
			<nowiki>[URL label]</nowiki>
			</code>

			Enclose URL in square brackets to indicate a link, provide optional label separated by a space within the brackets.

	* Linking Test Plan to Workspace '''Description'''		* Linking Test Plan to Workspace '''Description'''