Studio:Reporting Sample - Revision history

Ivailop: /* Prerequisites */

2010-05-07T05:01:55Z

Prerequisites

← Older revision		Revision as of 05:01, 7 May 2010
Line 3:		Line 3:

	==Prerequisites==		==Prerequisites==
	Before starting, some prerequisites must be satisfied. For details and instructions, see [[Desktop Installation]].		Before starting, some prerequisites must be satisfied. For details and instructions, see [[Studio:Desktop Installation]].

	Specifically:		Specifically:
	* STRIDE must be installed on the Windows PC to be used in the training, and any required licenses must be present.		* STRIDE must be installed on the Windows PC to be used in the training, and any required licenses must be present.
	* Active State Perl must be installed, and [[Desktop Installation#Perl\|additional perl packages]] must be downloaded and installed. '''Note:''' when the sample workspace is executed, a script runs that verifies that the required Perl packages have been installed correctly.		* Active State Perl must be installed, and [[Studio:Desktop Installation#Perl\|additional perl packages]] must be downloaded and installed. '''Note:''' when the sample workspace is executed, a script runs that verifies that the required Perl packages have been installed correctly.

	==Overview==		==Overview==

Timd: moved Reporting Sample to Studio:Reporting Sample

2009-09-04T17:49:44Z

moved Reporting Sample to Studio:Reporting Sample

← Older revision	Revision as of 17:49, 4 September 2009
(No difference)

Timd at 00:03, 2 September 2009

2009-09-02T00:03:37Z

← Older revision		Revision as of 00:03, 2 September 2009
Line 112:		Line 112:
	</li>		</li>
	</ul>		</ul>
	[[Category: Samples]]		[[Category:Studio:Samples]]

Stevel at 00:50, 10 December 2008

2008-12-10T00:50:20Z

← Older revision		Revision as of 00:50, 10 December 2008
Line 3:		Line 3:

	==Prerequisites==		==Prerequisites==
	Before starting, some prerequisites must be satisfied. For details and instructions, see [[~~Host_Installation\|Host~~ Installation]].		Before starting, some prerequisites must be satisfied. For details and instructions, see [[Desktop Installation]].

	Specifically:		Specifically:
	* STRIDE must be installed on the Windows PC to be used in the training, and any required licenses must be present.		* STRIDE must be installed on the Windows PC to be used in the training, and any required licenses must be present.
	* Active State Perl must be installed, and [[~~Host_Installation~~#Perl\|additional perl packages]] must be downloaded and installed. '''Note:''' when the sample workspace is executed, a script runs that verifies that the required Perl packages have been installed correctly.		* Active State Perl must be installed, and [[Desktop Installation#Perl\|additional perl packages]] must be downloaded and installed. '''Note:''' when the sample workspace is executed, a script runs that verifies that the required Perl packages have been installed correctly.

	==Overview==		==Overview==

Robg: /* Introduction */

2008-10-15T00:15:52Z

Introduction

← Older revision		Revision as of 00:15, 15 October 2008
Line 1:		Line 1:

	==Introduction==		==Introduction==
	The following content relates to the sample files and workspaces installed in ''%STRIDE_DIR%\Samples\~~Scripting~~\Reporting''. This sample consists of test scripts and a STRIDE workspace for sample code execution.		The following content relates to the sample files and workspaces installed in ''%STRIDE_DIR%\Samples\TestScripts\Reporting''. This sample consists of test scripts and a STRIDE workspace for sample code execution.

	==Prerequisites==		==Prerequisites==

Robg at 22:11, 14 October 2008

2008-10-14T22:11:27Z

← Older revision		Revision as of 22:11, 14 October 2008
Line 1:		Line 1:
	~~'''Note:''' ''for content related to versions of STRIDE 3.0.0101a and earlier, please refer to [[Reporter Sample v3.0.0101a]]''~~


	==Introduction==		==Introduction==

Mikee at 22:42, 15 September 2008

2008-09-15T22:42:57Z

← Older revision		Revision as of 22:42, 15 September 2008
Line 1:		Line 1:
	'''Note:''' ''for content related to versions of STRIDE 3.0.01 and earlier, please refer to [[Reporter Sample v3.0.0101a]]''		'''Note:''' ''for content related to versions of STRIDE 3.0.0101a and earlier, please refer to [[Reporter Sample v3.0.0101a]]''

Mikee at 22:42, 15 September 2008

2008-09-15T22:42:17Z

← Older revision		Revision as of 22:42, 15 September 2008
Line 1:		Line 1:
	'''Note:''' ''for content related to versions of STRIDE 3.0.01 and earlier, please refer to [[Reporter Sample v3.0.01]]''		'''Note:''' ''for content related to versions of STRIDE 3.0.01 and earlier, please refer to [[Reporter Sample v3.0.0101a]]''

Mikee: /* Dual Mode */

2008-09-11T18:33:46Z

Dual Mode

← Older revision		Revision as of 18:33, 11 September 2008
Line 112:		Line 112:
	cscript Scripts\jscript\DualMode\standalone.js		cscript Scripts\jscript\DualMode\standalone.js
	</pre>		</pre>
	Each script ~~should~~ produce a corresponding report file in the current directory.		Each script will produce a corresponding report file in the current directory.
	</li>		</li>
	</ul>		</ul>
	[[Category: Samples]]		[[Category: Samples]]

Mikee at 18:32, 11 September 2008

2008-09-11T18:32:12Z

← Older revision		Revision as of 18:32, 11 September 2008
Line 12:		Line 12:
	* Active State Perl must be installed, and [[Host_Installation#Perl\|additional perl packages]] must be downloaded and installed. '''Note:''' when the sample workspace is executed, a script runs that verifies that the required Perl packages have been installed correctly.		* Active State Perl must be installed, and [[Host_Installation#Perl\|additional perl packages]] must be downloaded and installed. '''Note:''' when the sample workspace is executed, a script runs that verifies that the required Perl packages have been installed correctly.

	==Getting Started==		==Overview==
			===Getting Started===
	The sample is executed by opening the workspace and executing the scripts by pressing the [[Image:RunAll.png]] button. When execution is complete, the results are summarized to the Studio output window and a link to the results file is provided. You can now peruse the output report and the scripts that generated the results.		The sample is executed by opening the workspace and executing the scripts by pressing the [[Image:RunAll.png]] button. When execution is complete, the results are summarized to the Studio output window and a link to the results file is provided. You can now peruse the output report and the scripts that generated the results.

	==~~Overview~~==		===Reporter Basics===
	The STRIDE [[Reporter]] object provides a means to organize and collect test results data, then publish results in a format of your choosing. The STRIDE Studio application integrates a reporter object with its collection of test scripts, and this sample's Studio workspace defines the hierarchy of the test scripts that will be the resulting hierarchy of the test suites and test cases in the generated report. The following describes the contents of the test report in more detail.		The STRIDE [[Reporter]] object provides a means to organize and collect test results data, then publish results in a format of your choosing. The STRIDE Studio application integrates a reporter object with its collection of test scripts, and this sample's Studio workspace defines the hierarchy of the test scripts that will be the resulting hierarchy of the test suites and test cases in the generated report. The following describes the contents of the test report in more detail.

	==Report Organization==		====Report Organization====
	As stated earlier, the '''Reporter''' stores test results hierarchically. At the top level, it holds a collection of one or more child '''[[Reporter#reporter.Suites\|Suites]]'''. These Suites--in turn--hold a collection of zero or more child '''[[Reporter#reporter.Suites.Item.Tests\|Tests]]''', a second collection of zero or more Suites, and a third collection of zero or more '''[[Reporter#reporter.Suites.Item.Annotations\|Annotations]]'''.		As stated earlier, the '''Reporter''' stores test results hierarchically. At the top level, it holds a collection of one or more child '''[[Reporter#reporter.Suites\|Suites]]'''. These Suites--in turn--hold a collection of zero or more child '''[[Reporter#reporter.Suites.Item.Tests\|Tests]]''', a second collection of zero or more Suites, and a third collection of zero or more '''[[Reporter#reporter.Suites.Item.Annotations\|Annotations]]'''.

Line 27:		Line 28:
	[[Image:ReporterHierarchy.jpg\|frame\|right\|Reporter Object Hierarchy]]		[[Image:ReporterHierarchy.jpg\|frame\|right\|Reporter Object Hierarchy]]

	=== The Suite Object ===		==== The Suite Object ====
	The [[Reporter#reporter.Suites.Item\|Suite]] object is used to group related Tests (and Annotations--if present) so that their results can be summarized on an output report.		The [[Reporter#reporter.Suites.Item\|Suite]] object is used to group related Tests (and Annotations--if present) so that their results can be summarized on an output report.

Line 35:		Line 36:
	* Description		* Description

	=== The Test Object ===		==== The Test Object ====
	The [[Reporter#reporter.Suites.Item.Tests.Item\|Test]] object represents a specific test that is run. The result of a test is reflected in its Status property (''"PASS"/"FAIL"'').		The [[Reporter#reporter.Suites.Item.Tests.Item\|Test]] object represents a specific test that is run. The result of a test is reflected in its Status property (''"PASS"/"FAIL"'').

Line 44:		Line 45:
	* Status		* Status

	=== The Comment Object ===		==== The Comment Object ====
	The [[Reporter#reporter.Suites.Item.Tests.Item.Comments.Item\|Comment]] object allows you to attach a text comment to a Test or Annotation. Comments are useful for logging test script flow and other test information.		The [[Reporter#reporter.Suites.Item.Tests.Item.Comments.Item\|Comment]] object allows you to attach a text comment to a Test or Annotation. Comments are useful for logging test script flow and other test information.

Line 52:		Line 53:
	* Label		* Label

	=== The Annotation Object ===		==== The Annotation Object ====
	The [[Reporter#reporter.Suites.Item.Annotations.Item\|Annotation]] object is used when you want to associate a file or a URI with a Suite. (e.g. a screen shot or other data file).		The [[Reporter#reporter.Suites.Item.Annotations.Item\|Annotation]] object is used when you want to associate a file or a URI with a Suite. (e.g. a screen shot or other data file).

Line 69:		Line 70:

	==== find ====		==== find ====
	Gets instances of existing Suite objects in a collection using the [[Reporter#suites-item\|Item]] and [[Reporter#suites-find\|Find]] methods.		Gets instances of existing Suite objects in a collection using the [[Reporter#suites-item\|Item]] and [[Reporter#suites-find\|Find]] methods. Also shows how the Parent property can be used to navigate upwards in the Suite hierarchy.

	==== output ====		==== output ====
Line 83:		Line 84:

	==== status ====		==== status ====
			Creates several [[Reporter#reporter.Suites.Item.Tests.Item\|Tests]] and shows various means of settings status.

	==== remove ====		==== remove ====
			Removes Test objects from a collection by name and index. Also demonstrates use of [[Reporter#tests-removeall\|RemoveAll]].

	==== find ====		==== find ====
			Gets instances of existing Test objects in a collection using the [[Reporter#tests-item\|Item]] method. Also shows how the Parent property can be used to navigate upwards in the Test/Suite hierarchy.

	==== comments ====		==== comments ====
			Creates [[Reporter#reporter.Suites.Item.Tests.Item.Comments.Item\|Comments]] for a Test.

	==== metrics ====		==== metrics ====
			Demonstrates the use of implicit and explicit duration data. Also shows how to add optional Test Metric data.

	=== Dual Mode ===		=== Dual Mode ===
			We provide one script in each language that is written so as to be runnable both within and outside of stride studio (standalone). These scripts are executed as part of the normal workspace execution. In order to run the scripts outside studio, follow these steps:

			<ul>
			<li>Exit STRIDE Studio</li>
			<li>Open a DOS command prompt and change to the ''%STRIDE_DIR%\Samples\Scripting\Reporting'' directory</li>
			<li>To execute the perl standalone script:
			<pre>
			perl Scripts\perl\DualMode\standalone.pl
			</pre>
			To execute the JScript version:
			<pre>
			cscript Scripts\jscript\DualMode\standalone.js
			</pre>
			Each script should produce a corresponding report file in the current directory.
			</li>
			</ul>
	[[Category: Samples]]		[[Category: Samples]]