Running and Publishing the TestIntro Sample: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Building the TargetApp to Include Test Intro Sample ==
== Building Instrumented Source Under Test ==
In this step, will will add a set of sample tests that provide an overview of STRIDE testing techniques. The [[Test Intro Sample]] tests are described in the linked article.
In this step, will will add a set of sample tests that provide an overview of STRIDE testing techniques. The [[Test Intro Sample]] tests are described in the linked article.


This step requires an installation of the STRIDE Samples package. If not installed, please see [[Package_Installation#Samples|Package Installation]] for more information.
To begin, be sure that TestApp is not running, then copy the <tt>.c</tt> and <tt>.h</tt> files found in <tt>Samples/test_in_c_cpp/TestIntro</tt> to <tt>SDK/Windows/sample_src</tt> (or <tt>SDK/Posix/sample_src</tt> for Linux).  


=== How the SDK Makefile Includes Tests ===
Once the files have been copied to <tt>sample_src</tt>, simply build TestApp as described in [[Building_an_Off-Target_Test_App | here]].
The SDK Makefile is set up so that all <tt>.c</tt> <tt>.cpp</tt> and <tt>.h</tt> files found in the directory <tt>SDK/Linux/sample_src</tt> (or, alternatively <tt>SDK\Windows\sample_src</tt>) are included in the compile and link of the '''testapp''' target.
 
Further--as a pre-compilation step--any <tt>.h</tt> files found in <tt>sample_src</tt> are submitted to the [[s2scompile|S2 compiler]] and subsequent [[Build Tools]]. This will result in
* the detection of [[SCL Pragmas#Test_Units| SCL Pragmas]] which declare Test Units in these <tt>.h</tt> files
* the inclusion of metadata into the sidb file to describe these Test Units
* the generation of test harnessing code to run the indicated Test Units and collect results
 
=VIDEO HERE=
 
=== Build Steps ===
To begin, be sure that TestApp is not running, then copy the <tt>.c</tt> and <tt>.h</tt> files found in <tt>Samples/TestIntro</tt> to <tt>SDK/Linux/sample_src</tt> (or Windows equivalent). As described above, the presence of these files in the <tt>sample_src</tt> will result in the submission of the <tt>.h</tt> files to the STRIDE Build Tools (thus generating test harnessing code from the scl pragmas found within them) and inclusion of both the sources and the generated harnessing code in the build.
 
Once the files have been copied to <tt>sample_src</tt>, simply build testapp using the SDK makefile.
====Linux====
<ol>
<li>Build the test app
<source lang="bash">
cd ~/stride/SDK/Linux/src
make testapp
</source>
</li>
<li>The file <tt>~/stride/SDK/Linux/out/bin/TestApp</tt> will be produced
</li>
<li>Note also that the STRIDE database file <tt>~/stride/SDK/Linux/out/TestApp.sidb</tt> is also produced
</li>
</ol>
 
====Windows====
<ol>
<li>If using Microsoft Visual Studio, open a Visual Studio command prompt<ref>To open a Visual Studio Command prompt: Click the Start button, point to All Programs, Microsoft Visual Studio 200X, Visual Studio Tools, and then click Visual Studio 200X Command Prompt.</ref> to ensure that the compiler and linker are on your PATH.
</li>
<li>Build the test app using the supplied GNU make. (You will get Makefile errors if you use the default make.)
<source lang="dos">
cd stride\SDK\Windows\src
..\bin\make testapp
</source>
</li>
<li>The file <tt>stride\SDK\Windows\out\bin\TestApp.exe</tt> will be produced
</li>
<li>Note that the STRIDE database file <tt>stride\SDK\Windows\out\TestApp.sidb</tt> is also produced
</li>
</ol>


== Running Test Intro Samples and Publishing Results to Test Space ==
== Running Test Intro Samples and Publishing Results to Test Space ==
 
Note: To successfully publish results you are required to create a test space called '''TestIntro'''. Refer to [[Test Space Setup]] for more information.
=VIDEO HERE=


Here we will run all tests in the <tt>TestApp.sidb</tt> database.<ref>Note that the S2 diagnostic tests are treated separately, and are not run unless the <tt>--diagnostics</tt> option is specified to <tt>stride</tt>.</ref>
Here we will run all tests in the <tt>TestApp.sidb</tt> database.<ref>Note that the S2 diagnostic tests are treated separately, and are not run unless the <tt>--diagnostics</tt> option is specified to <tt>stride</tt>.</ref>


# Run TestApp in a console window as in earlier steps.
# Run the build above TestApp in a console window.
# Invoke <tt>stride</tt> as shown below and verify Summary results.
# Invoke <tt>stride</tt> in a separate console window (different from the running TestApp) -- as shown below and verify Summary results.


Here are the command line parameters that we will submit to <tt>stride</tt>
Here are the command line parameters that we will submit to <tt>stride</tt>


<pre>
<pre>
--database TestApp.sidb  
--database ./out/TestApp.sidb  
--device TCP:localhost:8000
--device TCP:localhost:8000
--upload
--upload
--testspace https://USER:PASS@mycompany.stridetestspace.com
--testspace USER:PASS@mycompany.stridetestspace.com
--project Sandbox
--project Training
--space TestIntro
--space TestIntro
</pre>
</pre>
Line 71: Line 28:
* You will have to replace ''USER:PASS'' with your S2-assigned TestSpace user name and password
* You will have to replace ''USER:PASS'' with your S2-assigned TestSpace user name and password
* You will have to replace ''mycompany'' with your S2-assigned subdomain name
* You will have to replace ''mycompany'' with your S2-assigned subdomain name
* The project "Sandbox" and TestSpace "TestIntro" have been pre-created within your company STRIDE TestSpace
* The project "Training" and TestSpace "TestIntro" have been pre-created within your company STRIDE TestSpace
* If you setup [[STRIDE_Runner#Environment_Variables | environment variables]] for the '''project''' and / or '''space''' they are not required in the option file. Note: Command line options override environment variables. 


The command line is very long, so we'll want to create a text file named ''RunTestIntro.txt'' in the <tt>out</tt> directory as a command file to submit to <tt>stride</tt>.
The command line is very long, so we'll want to create a text file named ''RunTestIntro.txt'' in the <tt>SDK\Windows</tt> (or <tt>SDK/Posix</tt> for Linux) directory as an option file to submit to <tt>stride</tt>.


If you haven't done so already, start <tt>TestApp</tt> running in a separate console window.
If you haven't done so already, start <tt>TestApp</tt> running in a separate console window.


 
Now run stride as follows (starting from the <tt>SDK\Windows</tt> or <tt>SDK/Posix</tt> directory):
Now run stride as follows:


<source lang="bash">
<source lang="bash">
stride -O RunTestIntro.txt
stride -O RunTestIntro.txt --run="*"
</source>
</source>


Line 88: Line 45:
Loading database...
Loading database...
Connecting to device...
Connecting to device...
  runtime version: 4.1.01
Executing...
Executing test units...
   test unit "s2_testintro_flist"
   s2_testintro_cclass
     > 2 passed, 1 failed, 0 in progress, 0 not in use.
     > 1 passed, 1 failed, 0 in progress, 0 not in use (109 msec).
   test unit "s2_testintro_cclass"
   s2_testintro_flist
     > 1 passed, 1 failed, 0 in progress, 0 not in use.
     > 2 passed, 1 failed, 0 in progress, 0 not in use (156 msec).
   test unit "s2_testintro_testdoubles"
   s2_testintro_testdoubles
     > 3 passed, 0 failed, 0 in progress, 0 not in use.
     > 3 passed, 0 failed, 0 in progress, 0 not in use (16 msec).
   test unit "s2_testintro_testpoints"
   s2_testintro_testpoints
     > 3 passed, 0 failed, 0 in progress, 0 not in use.
     > 3 passed, 0 failed, 0 in progress, 0 not in use (109 msec).
  test unit "s2_testintro_parameters"
   ---------------------------------------------------------------------
    > 2 passed, 0 failed, 0 in progress, 0 not in use.
   Summary: 9 passed, 2 failed, 0 in progress, 0 not in use (390 msec).
   ---------------------------------------------------------------------  
   Summary: 11 passed, 2 failed, 0 in progress, 0 not in use.


Disconnecting from device...
Disconnecting from device...
Saving result file...
Saving result file...
Uploading to test space...
</pre>
</pre>


Line 109: Line 66:
First navigate to the S2-provided TestSpace with your browser. The URL has the form: <nowiki>https://companyname.stridetestspace.com</nowiki>. On the page that is presented, enter your login credentials.
First navigate to the S2-provided TestSpace with your browser. The URL has the form: <nowiki>https://companyname.stridetestspace.com</nowiki>. On the page that is presented, enter your login credentials.


At the top of the next page, click on the All Projects link to view the status of existing projects. Here you should see the Sandbox project listed, with its contained TestSpace ''TestIntro'' shown.
At the top of the next page, click on the All Projects link to view the status of existing projects. Here you should see the Training project listed, with its contained TestSpace ''TestIntro'' shown.


Clicking the ''TestIntro'' link will present you with the ''TestIntro'' TestSpace page. From the top-line results at the bottom of the page you can drill down into the Sequence_1 results to see the test details.
Clicking the ''TestIntro'' link will present you with the ''TestIntro'' TestSpace page. From the top-line results at the bottom of the page you can drill down into the Sequence_1 results to see the test details.


=== Analyzing the Results ===
=== Analyzing the Results ===
At this point, we recommend that you take some time to review the techniques used in the TestIntro sample tests and correlate the results shown in Test Space with the various STRIDE constructs in the sample source.
At this point, we recommend that you take some time to review the techniques used in the TestIntro sample tests and correlate the results shown in Test Space with the various STRIDE constructs in the sample source. The article [[Test Intro Sample]] describes the tests in detail.


The following articles will be helpful in your analysis:
The following articles will be helpful in your analysis:


*[[Test Intro Sample]]
*[[Test Units]]
*[[Test Organization]]
*[[Test Macros]]
*[[Test Unit Pragmas]]
*[[Test Log]]
*[[Pass/Fail Macros]]
*[[Test Point]]
*[[Test Log Macros]]
*[[Test Double]]
*[[Using Test Points]]
*[[Using Test Doubles]]




<hr/>
<hr/>
<references/>
<references/>
[[Category:Sandbox & Training]]
 
[[Category:Installation]]

Latest revision as of 20:52, 20 February 2013

Building Instrumented Source Under Test

In this step, will will add a set of sample tests that provide an overview of STRIDE testing techniques. The Test Intro Sample tests are described in the linked article.

To begin, be sure that TestApp is not running, then copy the .c and .h files found in Samples/test_in_c_cpp/TestIntro to SDK/Windows/sample_src (or SDK/Posix/sample_src for Linux).

Once the files have been copied to sample_src, simply build TestApp as described in here.

Running Test Intro Samples and Publishing Results to Test Space

Note: To successfully publish results you are required to create a test space called TestIntro. Refer to Test Space Setup for more information.

Here we will run all tests in the TestApp.sidb database.[1]

  1. Run the build above TestApp in a console window.
  2. Invoke stride in a separate console window (different from the running TestApp) -- as shown below and verify Summary results.

Here are the command line parameters that we will submit to stride

--database ./out/TestApp.sidb 
--device TCP:localhost:8000
--upload
--testspace USER:PASS@mycompany.stridetestspace.com
--project Training
--space TestIntro

A couple of things to note:

  • You will have to replace USER:PASS with your S2-assigned TestSpace user name and password
  • You will have to replace mycompany with your S2-assigned subdomain name
  • The project "Training" and TestSpace "TestIntro" have been pre-created within your company STRIDE TestSpace
  • If you setup environment variables for the project and / or space they are not required in the option file. Note: Command line options override environment variables.

The command line is very long, so we'll want to create a text file named RunTestIntro.txt in the SDK\Windows (or SDK/Posix for Linux) directory as an option file to submit to stride.

If you haven't done so already, start TestApp running in a separate console window.

Now run stride as follows (starting from the SDK\Windows or SDK/Posix directory):

stride -O RunTestIntro.txt --run="*"

The output should look like this:

Loading database...
Connecting to device...
Executing...
  test unit "s2_testintro_flist"
    > 2 passed, 1 failed, 0 in progress, 0 not in use.
  test unit "s2_testintro_cclass"
    > 1 passed, 1 failed, 0 in progress, 0 not in use.
  test unit "s2_testintro_testdoubles"
    > 3 passed, 0 failed, 0 in progress, 0 not in use.
  test unit "s2_testintro_testpoints"
    > 3 passed, 0 failed, 0 in progress, 0 not in use.
  test unit "s2_testintro_parameters"
    > 2 passed, 0 failed, 0 in progress, 0 not in use.
  --------------------------------------------------------------------- 
  Summary: 11 passed, 2 failed, 0 in progress, 0 not in use.

Disconnecting from device...
Saving result file...

Viewing Results in Test Space

First navigate to the S2-provided TestSpace with your browser. The URL has the form: https://companyname.stridetestspace.com. On the page that is presented, enter your login credentials.

At the top of the next page, click on the All Projects link to view the status of existing projects. Here you should see the Training project listed, with its contained TestSpace TestIntro shown.

Clicking the TestIntro link will present you with the TestIntro TestSpace page. From the top-line results at the bottom of the page you can drill down into the Sequence_1 results to see the test details.

Analyzing the Results

At this point, we recommend that you take some time to review the techniques used in the TestIntro sample tests and correlate the results shown in Test Space with the various STRIDE constructs in the sample source. The article Test Intro Sample describes the tests in detail.

The following articles will be helpful in your analysis:



  1. Note that the S2 diagnostic tests are treated separately, and are not run unless the --diagnostics option is specified to stride.