https://www.stridewiki.com/api.php?action=feedcontributions&feedformat=atom&user=IvailopSTRIDE Wiki - User contributions [en]2026-04-27T10:19:13ZUser contributionsMediaWiki 1.39.10https://www.stridewiki.com/index.php?title=Release_Notes&diff=14731Release Notes2024-08-31T02:16:53Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.04x =<br />
The code name for this release is ''Tamarack''. Released on Mar 8, 2023. <br />
<br />
== Change Details ==<br />
<br />
=== System Requirements ===<br />
The prebuild binaries require either:<br />
* Linux (x86_64), glibc 2.17 or later<br />
* Windows (x86_64) 10 or later<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* In [[STRIDE Runtime]], fixed memory overrun while restoring IN pointers<br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl 64-bit versions 5.28 and 5.30. <br />
* Support for Perl 64-bit versions 5.24 and older is not provided by default but is available on demand. <br />
* Support for Perl 32-bit has been dropped.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.04x''' is compatible with the Runtime Version '''5.0.04'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.04a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "char16_t/char32_t" built-in types.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "default/delete" class methods.<br />
* Added support for Perl 64-bit versions 5.32 and 5.34. <br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrectly handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "nodiscard" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
=== 5.0.03b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to handle GCC and VC 'preinclude' alternatives.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile variation of GCC `enum __attrbute__((..))`.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14730Framework Setup2023-03-08T23:03:54Z<p>Ivailop: /* Perl Installation (Optional) */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
===<tt>bin</tt>===<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
===<tt>lib</tt>===<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
===<tt>samples</tt>===<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
===<tt>SDK</tt>===<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86_64 with threads support) installed. <br />
<br />
As of this writing, we support only versions 5.18.x, 5.20.x, 5.22.x, 5.24.x, 5.26.x, 5.28.x and 5.30.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''64-bit''' Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl] (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
For Strawberry Perl, simplest method for installing packages is via the <tt>cpanm.bat</tt> utility script. To install the latest stable version of PACKAGE_NAME (the package to install) simply execute:<br />
<br />
cpanm.bat PACKAGE_NAME<br />
<br />
For ActiveState Perl, you can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14729Release Notes2023-03-08T23:01:09Z<p>Ivailop: /* System Requirements */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.04x =<br />
The code name for this release is ''Tamarack''. Released on Mar 8, 2023. <br />
<br />
== Change Details ==<br />
<br />
=== System Requirements ===<br />
The prebuild binaries require either:<br />
* Linux (x86_64), glibc 2.17 or later<br />
* Windows (x86_64) 10 or later<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* In [[STRIDE Runtime]], fixed memory overrun while restoring IN pointers<br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl 64-bit versions 5.28 and 5.30. <br />
* Support for Perl 64-bit versions 5.24 and older is not provided by default but is available on demand. <br />
* Support for Perl 32-bit has been dropped.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.04x''' is compatible with the Runtime Version '''5.0.04'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrectly handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "nodiscard" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
=== 5.0.03b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to handle GCC and VC 'preinclude' alternatives.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile variation of GCC `enum __attrbute__((..))`.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14728Release Notes2023-03-08T21:29:03Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.04x =<br />
The code name for this release is ''Tamarack''. Released on Mar 8, 2023. <br />
<br />
== Change Details ==<br />
<br />
=== System Requirements ===<br />
The prebuild binaries require either:<br />
* Linux 64-bit, glibc 2.17 or later<br />
* Windows 10 64-bit or later<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* In [[STRIDE Runtime]], fixed memory overrun while restoring IN pointers<br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl 64-bit versions 5.28 and 5.30. <br />
* Support for Perl 64-bit versions 5.24 and older is not provided by default but is available on demand. <br />
* Support for Perl 32-bit has been dropped.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.04x''' is compatible with the Runtime Version '''5.0.04'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrectly handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "nodiscard" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
=== 5.0.03b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to handle GCC and VC 'preinclude' alternatives.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile variation of GCC `enum __attrbute__((..))`.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Stride_Overview&diff=14727Stride Overview2021-05-21T23:40:03Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
'''Stride™''' is an [http://en.wikipedia.org/wiki/XUnit xUnit-style] test framework for C/C++ software comprised of an external test ''Runner'', ''Runtime'' source code library, and a set of ''Build Tools''. It was designed with a specific focus on enabling tests to be executed on a device using a fully functional build.<ref>Fully functional build means that the software works the same as before instrumentation, but now has built-in tests that can be invoked on-demand by the test ''Runner''.</ref> <br />
<br />
Stride's unique host-target architecture allows easier and better On-Target/Device White-box testing. Software builds automatically become more testable; facilitating deeper code coverage opportunities.<ref>For more details refer to our [[Frequently Asked Questions About STRIDE | FAQ]].</ref><br />
<br />
Stride is also fully integrated with [http://www.testspace.com Testspace] for test content management. <br />
<br />
<br />
[[image:Stride Overview.jpg | 600px | center | Stride block diagram]]<br />
<br />
<br />
==== Runner ====<br />
Stride includes a lightweight [[Stride_Runner | '''Runner''']] application that is a host-based command-line utility for interactive and automated test execution. It also integrates seamlessly with [http://www.testspace.com Testspace] for ''test content management''.<br />
<br><br />
<br />
====Runtime====<br />
Stride also contains a [[STRIDE Runtime | '''Runtime''']] software source package. The Runtime enables ''testability'' by integrating with the software under test along with supporting connectivity with the host system, all with minimal impact on performance or code size. The software is agnostic to the RTOS, CPU, and host/device I/O transport. It supports simple ''single-process'' devices as well as ''multi-process'' and ''multi-threaded'' environments. It can be used with software running in either user or kernel mode, including drivers. Typically the Runtime is configured as a background thread and only executes when running tests.<br />
<br />
==== Build Tools ====<br />
[[image:STRIDE 4.2 Framework-b.jpg |right|250px | border]]<br />
<br />
The Stride [[STRIDE_Build_Tools | '''Build Tools''']] are a set of command-line utilities that integrate with your target software build process. They preprocess standard C/C++ header files that contain Stride test declarations to auto-generate C/C++ source code comprising a custom [[Intercept_Module | '''Intercept Module''']]. The intercept module code is then included in your target software build along with the Stride Runtime to provide ''fixturing'' and ''harnessing'' test logic as part of your build image.<br />
<br />
== Cross Platform ==<br />
Stride works on virtually any target platform. Stride's cross-platform framework facilitates a ''unified testing approach'' for all team members, enabling organizations to standardize on a test workflow that is independent of the target platform being used or what branch of software is being changed.<br />
<br />
==== Runtime Written in Standard C ====<br />
The Stride Runtime is written in standard ANSI C on top of a simple customizable [[Platform_Abstraction_Layer | '''platform abstraction layer''']] that enables it to work across platforms. It can be configured for a single process multi-threading environment or multiple process environments (i.e. Android, Linux, Windows, Embedded RTOS, etc.). It is delivered as source code to be included in the application's build system. The transport between the host and target is configurable and supports Serial and TCP/IP by default. Custom transports are also available.<br />
<br />
The runtime has been tailored specifically for embedded applications; overhead is minimal. It consumes very little memory for table and control block storage. Resource usage is configurable and can be adjusted to conform to any limitations of the target platform.<br />
<br />
==== Integrates With Your Existing Build System ====<br />
Stride auto-generates ''intercept module'' harnessing and remoting functionality as C or C++ source code during the make process, removing any dependencies on specific compilers and / or processors.<br />
<br />
==== Supports Off-Target Testing ====<br />
Testing can also be simulated using a standard desktop computer (Windows, Linux, or FreeBSD) with no changes to test code. The Stride ''SDKs'' allow for a seamless transition between the real target and an Off-Target host environment.<br />
<br />
== Rich set of Assertions ==<br />
Test cases are typically constructed leveraging a large set of available assertion macros. When failures occur, these macros automatically set test status and provide details to the test report such as file name, line number, and condition causing the failure. Stride provides a large set of these macros to validate a wide variety of scenarios. <br />
<br />
<source lang="cpp"><br />
#include <mytest.h><br />
<br />
void MyTest::CheckFoo() {<br />
.. <br />
srEXPECT_EQ(foo(2 + 2), 4); <br />
}<br />
void MyTest::CheckBoo() {<br />
..<br />
srASSERT_GT(boo(3 * 3), 7); <br />
}<br />
</source><br />
<br />
== Extensive Parameter Support ==<br />
<br />
Parameterized testing is key to reducing test code duplication. Constructor arguments, name-value collection, and host file remoting are all supported. Stride provides an easy way for passing and accessing these types of parameters, allowing customization of test behavior at runtime.<br />
<br />
Create an INI-type of file (i.e. ''myinput.ini'')<br />
<br />
<source lang="ini"><br />
Loopsize = 10<br />
InputFile = ${MYPATH}/datacontent.bin<br />
Toogle = On<br />
</source><br />
<br />
Pass the name-value collection using the Stride Runner<br />
<br />
<source lang="bash"><br />
$ stride .. --run="MyTest(/path/to/myinput.ini)"<br />
</source><br />
<br />
Now simply access your input within test logic using built-in services<br />
<br />
<source lang="cpp"><br />
{<br />
// .. doing stuff ..<br />
GetParam("InputFile", buffer, size);<br />
//.. using parameters for test logic<br />
}<br />
</source><br />
<br />
== Test Doubles & Test Points == <br />
Stride offers advanced testing techniques that enable deeper and more effective testing with less effort.<br />
<br />
==== Test Doubles ====<br />
For more advanced testing scenarios, dependencies can be '''doubled'''. This feature provides a means for intercepting C/C++ global functions on the target and substituting a stub, fake, or mock. The substitution is all controllable via the runtime, allowing the software to continue executing normally when not running a test.<br />
<br />
For example something like the following could be useful:<br />
<br />
<source lang="cpp"><br />
void MySuite::test1()<br />
{<br />
// inserting my own version of malloc()<br />
srDOUBLE_SET(malloc, my_malloc_stub);<br />
<br />
// calling a routine that uses malloc(). checking handled null correctly<br />
ret_code = FuncThatUsesMalloc(42);<br />
srEXPECT_EQ(ret_code, -1)<br />
<br />
// restoring the real malloc()<br />
srDOUBLE_RESET(malloc)<br />
}<br />
</source><br />
<br />
==== Test Points ====<br />
Stride leverages ''source instrumentation'' to provide an additional validation technique called '''Expectation Testing''' that can be applied to the executing software application. The execution sequencing of the code, along with state data, can be automatically validated based on ''what is expected''. This validation technique does not focus on calling functions/methods but rather verifies ''code execution sequencing''. This can span threads, process boundaries, and even multiple targets, as the application(s) is running. Leveraging simple macros -- called '''Test Points''' -- developers strategically instrument the source under test.<br />
<br />
<source lang="c"><br />
<br />
/* a test point with formatted string payload */<br />
srTEST_POINT_STR("IMPORTANT", "important date= %d", myVar);<br />
<br />
</source><br />
<br />
The test validation is done without impacting the application's performance (the on-target test code is executed in a background thread and scripts are executed on the host machine). When failures do occur, context is provided with the file name and associated line number of the failed expectations. This type of validation can be applied to a wide-range of testing scenarios:<br />
* State Machines<br />
* Data flow through system components<br />
* Sequencing between threads<br />
* Drivers that don't return values<br />
* and much more ...<br />
<br />
The following is a snippet of what the test code might look like<br />
<source lang="c"><br />
<br />
srTestPointExpect_t expected[]={<br />
{"IMPORTANT"}, myCheckData,<br />
{"ANOTHER_TP"},<br />
{0}};<br />
<br />
// setup the expections<br />
srTestPointSetup(expected, ..);<br />
<br />
// start the operations<br />
<br />
srTestPointWait(handle, 1000);<br />
<br />
</source><br />
<br />
== Test Implementation ==<br />
Stride based tests are integrated with the existing build system enabling your software to be both fully ''functional'' and ''testable'' at the same time. The ''test logic'' is separated from the application source code and is '''not''' executed unless invoked via the Stride Runner. Any ''source instrumentation'' is only active when executing tests. The impact of built-in testability to the software application is nominal.<br />
<br />
The test validation can be implemented in both ''C/C++'' on the target and ''Perl'' on the host. <br />
<br />
'''C/C++ Test Example'''<br />
<source lang="cpp"><br />
#include <srtest.h><br />
<br />
class MyTest {<br />
public: <br />
void CheckFoo();<br />
void CheckBoo();<br />
};<br />
#pragma scl_test_class(MyTest)<br />
</source><br />
<br />
<br />
<source lang="cpp"><br />
#include <mytest.h><br />
<br />
void MyTest::CheckFoo() {<br />
.. <br />
srEXPECT_EQ(foo(2 + 2), 4); <br />
}<br />
void MyTest::CheckBoo() {<br />
..<br />
srASSERT_GT(boo(3 * 3), 7); <br />
}<br />
</source><br />
<br />
<br />
'''Perl Script Example'''<br />
<source lang="perl"><br />
use strict;<br />
use warnings;<br />
<br />
package MyTests;<br />
use base qw(STRIDE::Test);<br />
use STRIDE::Test;<br />
<br />
sub CheckFoo : Test<br />
{<br />
EXPECT_EQ(Remote->foo(2 + 2), 4);<br />
}<br />
<br />
sub CheckBoo : Test<br />
{<br />
ASSERT_GT(Remote->boo(3 * 3), 7);<br />
}<br />
<br />
1;<br />
</source><br />
<br />
== Works with Testspace ==<br />
<br />
Stride has been designed to fully leverage Testspace features such as test design, execution control, and test analysis. With Testspace, test content and status remain better organized and current results and progress are much easier to assess. Refer to [http://www.testspace.com Testspace] website for more details.<br />
<br />
<br />
<hr/><br />
<references/></div>Ivailophttps://www.stridewiki.com/index.php?title=Stride_Overview&diff=14726Stride Overview2021-05-21T23:35:15Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
'''Stride™''' is an [http://en.wikipedia.org/wiki/XUnit xUnit-style] test framework for C/C++ software comprised of an external test ''Runner'', ''Runtime'' source code library, and a set of ''Build Tools''. It was designed with a specific focus on enabling tests to be executed on a device using a fully functional build.<ref>Fully functional build means that the software works the same as before instrumentation, but now has built-in tests that can be invoked on-demand by the test ''Runner''.</ref> <br />
<br />
Stride's unique host-target architecture allows easier and better On-Target/Device White-box testing. Software builds automatically become more testable; facilitating deeper code coverage opportunities.<ref>For more details refer to our [[Frequently Asked Questions About STRIDE | FAQ]].</ref><br />
<br />
Stride is also fully integrated with [http://www.testspace.com Testspace] for test content management. <br />
<br />
<br />
[[image:Stride Overview.jpg | 600px | center | Stride block diagram]]<br />
<br />
<br />
==== Runner ====<br />
Stride includes a lightweight [[Stride_Runner | '''Runner''']] application that is a host-based command-line utility for interactive and automated test execution. It also integrates seamlessly with [http://www.testspace.com Testspace] for ''test content management''.<br />
<br><br />
<br />
====Runtime====<br />
Stride also contains a [[STRIDE Runtime | '''Runtime''']] software source package. The Runtime enables ''testability'' by integrating with the software under test along with supporting connectivity with the host system, all with minimal impact on performance or code size. The software is agnostic to the RTOS, CPU, and host/device I/O transport. It supports simple ''single-process'' devices as well as ''multi-process'' and ''multi-threaded'' environments. It can be used with software running in either user or kernel mode, including drivers. Typically the Runtime is configured as a background thread and only executes when running tests.<br />
<br />
==== Build Tools ====<br />
[[image:STRIDE 4.2 Framework-b.jpg |right|250px | border]]<br />
<br />
The Stride [[STRIDE_Build_Tools | '''Build Tools''']] are a set of command-line utilities that integrate with your target software build process. They preprocess standard C/C++ header files that contain Stride test declarations to auto-generate C/C++ source code comprising a custom [[Intercept_Module | '''Intercept Module''']]. The intercept module code is then included in your target software build along with the Stride Runtime to provide ''fixturing'' and ''harnessing'' test logic as part of your build image.<br />
<br />
== Cross Platform ==<br />
Stride works on virtually any target platform. Stride's cross-platform framework facilitates a ''unified testing approach'' for all team members, enabling organizations to standardize on a test workflow that is independent of the target platform being used or what branch of software is being changed.<br />
<br />
==== Runtime Written in Standard C ====<br />
The Stride Runtime is written in standard ANSI C on top of a simple customizable [[Platform_Abstraction_Layer | '''platform abstraction layer''']] that enables it to work across platforms. It can be configured for a single process multi-threading environment or multiple process environments (i.e. Android, Linux, Windows, Embedded RTOS, etc.). It is delivered as source code to be included in the application's build system. The transport between the host and target is configurable and supports Serial and TCP/IP by default. Custom transports are also available.<br />
<br />
The runtime has been tailored specifically for embedded applications; overhead is minimal. It consumes very little memory for table and control block storage. Resource usage is configurable and can be adjusted to conform to any limitations of the target platform.<br />
<br />
==== Integrates With Your Existing Build System ====<br />
Stride auto-generates ''intercept module'' harnessing and remoting functionality as C or C++ source code during the make process, removing any dependencies on specific compilers and / or processors.<br />
<br />
==== Supports Off-Target Testing ====<br />
Testing can also be simulated using a standard desktop computer (Windows, Linux, or FreeBSD) with no changes to test code. The Stride ''SDKs'' allow for a seamless transition between the real target and an Off-Target host environment.<br />
<br />
== Rich set of Assertions ==<br />
Test cases are typically constructed leveraging a large set of available assertion macros. When failures occur, these macros automatically set test status and provide details to the test report such as file name, line number, and condition causing the failure. Stride provides a large set of these macros to validate a wide variety of scenarios. <br />
<br />
<source lang=cpp><br />
#include <mytest.h><br />
<br />
void MyTest::CheckFoo() {<br />
.. <br />
srEXPECT_EQ(foo(2 + 2), 4); <br />
}<br />
void MyTest::CheckBoo() {<br />
..<br />
srASSERT_GT(boo(3 * 3), 7); <br />
}<br />
</source><br />
<br />
== Extensive Parameter Support ==<br />
<br />
Parameterized testing is key to reducing test code duplication. Constructor arguments, name-value collection, and host file remoting are all supported. Stride provides an easy way for passing and accessing these types of parameters, allowing customization of test behavior at runtime.<br />
<br />
Create an INI-type of file (i.e. ''myinput.ini'')<br />
<br />
<source lang=ini><br />
Loopsize = 10<br />
InputFile = ${MYPATH}/datacontent.bin<br />
Toogle = On<br />
</source><br />
<br />
Pass the name-value collection using the Stride Runner<br />
<br />
<source lang=bash><br />
$ stride .. --run="MyTest(/path/to/myinput.ini)"<br />
</source><br />
<br />
Now simply access your input within test logic using built-in services<br />
<br />
<source lang=cpp><br />
{<br />
// .. doing stuff ..<br />
GetParam("InputFile", buffer, size);<br />
//.. using parameters for test logic<br />
}<br />
</source><br />
<br />
== Test Doubles & Test Points == <br />
Stride offers advanced testing techniques that enable deeper and more effective testing with less effort.<br />
<br />
==== Test Doubles ====<br />
For more advanced testing scenarios, dependencies can be '''doubled'''. This feature provides a means for intercepting C/C++ global functions on the target and substituting a stub, fake, or mock. The substitution is all controllable via the runtime, allowing the software to continue executing normally when not running a test.<br />
<br />
For example something like the following could be useful:<br />
<br />
<source lang=cpp><br />
void MySuite::test1()<br />
{<br />
// inserting my own version of malloc()<br />
srDOUBLE_SET(malloc, my_malloc_stub);<br />
<br />
// calling a routine that uses malloc(). checking handled null correctly<br />
ret_code = FuncThatUsesMalloc(42);<br />
srEXPECT_EQ(ret_code, -1)<br />
<br />
// restoring the real malloc()<br />
srDOUBLE_RESET(malloc)<br />
}<br />
</source><br />
<br />
==== Test Points ====<br />
Stride leverages ''source instrumentation'' to provide an additional validation technique called '''Expectation Testing''' that can be applied to the executing software application. The execution sequencing of the code, along with state data, can be automatically validated based on ''what is expected''. This validation technique does not focus on calling functions/methods but rather verifies ''code execution sequencing''. This can span threads, process boundaries, and even multiple targets, as the application(s) is running. Leveraging simple macros -- called '''Test Points''' -- developers strategically instrument the source under test.<br />
<br />
<source lang='c'><br />
<br />
/* a test point with formatted string payload */<br />
srTEST_POINT_STR("IMPORTANT", "important date= %d", myVar);<br />
<br />
</source><br />
<br />
The test validation is done without impacting the application's performance (the on-target test code is executed in a background thread and scripts are executed on the host machine). When failures do occur, context is provided with the file name and associated line number of the failed expectations. This type of validation can be applied to a wide-range of testing scenarios:<br />
* State Machines<br />
* Data flow through system components<br />
* Sequencing between threads<br />
* Drivers that don't return values<br />
* and much more ...<br />
<br />
The following is a snippet of what the test code might look like<br />
<source lang='c'><br />
<br />
srTestPointExpect_t expected[]={<br />
{"IMPORTANT"}, myCheckData,<br />
{"ANOTHER_TP"},<br />
{0}};<br />
<br />
// setup the expections<br />
srTestPointSetup(expected, ..);<br />
<br />
// start the operations<br />
<br />
srTestPointWait(handle, 1000);<br />
<br />
</source><br />
<br />
== Test Implementation ==<br />
Stride based tests are integrated with the existing build system enabling your software to be both fully ''functional'' and ''testable'' at the same time. The ''test logic'' is separated from the application source code and is '''not''' executed unless invoked via the Stride Runner. Any ''source instrumentation'' is only active when executing tests. The impact of built-in testability to the software application is nominal.<br />
<br />
The test validation can be implemented in both ''C/C++'' on the target and ''Perl'' on the host. <br />
<br />
'''C/C++ Test Example'''<br />
<source lang=cpp><br />
#include <srtest.h><br />
<br />
class MyTest {<br />
public: <br />
void CheckFoo();<br />
void CheckBoo();<br />
};<br />
#pragma scl_test_class(MyTest)<br />
</source><br />
<br />
<br />
<source lang=cpp><br />
#include <mytest.h><br />
<br />
void MyTest::CheckFoo() {<br />
.. <br />
srEXPECT_EQ(foo(2 + 2), 4); <br />
}<br />
void MyTest::CheckBoo() {<br />
..<br />
srASSERT_GT(boo(3 * 3), 7); <br />
}<br />
</source><br />
<br />
<br />
'''Perl Script Example'''<br />
<source lang="perl"><br />
use strict;<br />
use warnings;<br />
<br />
package MyTests;<br />
use base qw(STRIDE::Test);<br />
use STRIDE::Test;<br />
<br />
sub CheckFoo : Test<br />
{<br />
EXPECT_EQ(Remote->foo(2 + 2), 4);<br />
}<br />
<br />
sub CheckBoo : Test<br />
{<br />
ASSERT_GT(Remote->boo(3 * 3), 7);<br />
}<br />
<br />
1;<br />
</source><br />
<br />
== Works with Testspace ==<br />
<br />
Stride has been designed to fully leverage Testspace features such as test design, execution control, and test analysis. With Testspace, test content and status remain better organized and current results and progress are much easier to assess. Refer to [http://www.testspace.com Testspace] website for more details.<br />
<br />
<br />
<hr/><br />
<references/></div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14725Release Notes2020-12-16T05:01:09Z<p>Ivailop: /* 5.0.03b */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "nodiscard" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
=== 5.0.03b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to handle GCC and VC 'preinclude' alternatives.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile variation of GCC `enum __attrbute__((..))`.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14724Release Notes2020-12-16T05:00:50Z<p>Ivailop: /* Minor and Patch releases */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "nodiscard" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
=== 5.0.03b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to handle handle GCC and VC 'preinclude' alternatives.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile variation of GCC `enum __attrbute__((..))`.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Platform_Abstraction_Layer&diff=14723Platform Abstraction Layer2020-12-10T18:56:50Z<p>Ivailop: /* PAL Transport (I/O) Services */</p>
<hr />
<div>__NOTOC__<br />
The PAL, or Platform Abstraction Layer, enables the [[Runtime Reference|STRIDE Runtime]] to be platform-independent by providing a consistent interface for the STRIDE Runtime regardless of the operating system or data transport used. This interface layer is necessary given the broad variety of operating systems and data transports that exist within embedded systems today.<br />
<br />
A small set of functions, written according to the PAL specification, provide the interfaces between your operating system and platform transport mechanism to the STRIDE Runtime. Through the PAL, the STRIDE Runtime becomes independent of any specific platform. The PAL is designed to use standard concepts and services present in almost all operating systems and transport mechanisms. To complete a PAL, you’ll need to be familiar with concepts such as event signaling, scheduling, timers, critical section protection, memory allocation and data transfers. <br />
<br />
The '''pal.h''' header file provided with the STRIDE Runtime contains all the function prototypes necessary for writing the PAL. <br />
<br />
STRIDE provides fully functional implementations of the PAL for several major platforms (Windows, Linux, FreeBSD, etc.).<br />
<br />
For a detailed description of the PAL and its interfaces, see the '''[[Platform Abstraction Layer|Platform Abstraction Layer]]''' description and the [[Media:s2sPAL.pdf|STRIDE Platform Abstraction Layer (PAL) Specification]].<br />
<br />
= PAL Concepts =<br />
This section describes the basic concepts of the PAL and the system services it must provide.<br />
<br />
== Function Registration ==<br />
Typically, the STRIDE Runtime calls PAL functions; however, there are some functions in the STRIDE Runtime that need to be called by the PAL. To eliminate PAL dependencies on the STRIDE Runtime, these functions are accessed through a function registration process initiated by the STRIDE Runtime at startup. You write the registration routine called by the Runtime. This registration routine passes in the address of the STRIDE Runtime function to be registered as the input parameter, and stores the address of the STRIDE Runtime function in your own function variable, which is actually a pointer to a function. You can then call the registered function using your function pointer variable.<br />
<br />
The registered STRIDE Runtime functions allow you to complete such tasks as delivering a received I block to the Runtime, checking the number of I-blocks the Runtime has ready to send out, or signalling the Runtime that your transport is ready for the next I-block. It is not necessary for the PAL to know the details of these Runtime functions.<br />
<br />
== Task Synchronization / Event Notification ==<br />
Unique information is required by an operating system to notify a thread of a pending event. This information can be a native OS thread id, a simple index into a table, an address to a thread control block, the address of a semaphore or one of a number of other implementations. Although each implementation may be different, a unique notifier is necessary for each thread. The STRIDE Runtime calls this unique information a Notification Identifier (NID). A thread uses a NID when waiting for a STRIDE event, and the STRIDE Runtime uses the same NID to notify the thread of a pending STRIDE event.<br />
<br />
Support for sharing of the synchronization object among multiple applications should be ensured in case of multi-process target is enabled.<br />
<br />
== Protection using Mutex ==<br />
The STRIDE Runtime needs to protect critical and shared data structures from multiple, simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. The PAL requires implementing protection using Mutexes that can be created and, in case of multi-process target is enabled, used with a unique name by any STRIDE Runtime module or PAL itself. The STRIDE Runtime guarantees that calls to palMutexLock() will not be nested.<br />
<br />
== Timer Administration ==<br />
The STRIDE Runtime requires that at least one timer be available. When a timer is created, a callback is registered so that the STRIDE Runtime can be notified of timer expirations. A user parameter, provided when the timer is created, is passed to the callback when it gets called. If several timers share a callback routine, this user parameter can be used to identify which timer expired. The STRIDE Runtime can also stop, start and delete timers.<br />
<br />
Because the STRIDE Runtime also has the need to timestamp trace log data, a routine that returns the system time, palGetTime(), is also part of the PAL. This routine is not associated with timers. <br />
<br />
== Memory Allocation ==<br />
The STRIDE Runtime dynamically allocates memory for messages and trace log storage. The Runtime uses palMemAlloc() and palMemFree() to allocate memory dynamically and then return it to the system.<br />
<br />
The Runtime uses palMemSegmentOpen() and palMemSegmentClose() to create, open and close memory segments. In case of single process target, these routines can simply allocate dynamic memory as in normal memory allocation routines.<br />
<br />
To support multi-process target, the STRIDE Runtime requires dynamic and configurable memory allocated through palMemAlloc() and static internal memory allocated directly through palMemSegmentOpen() to be shared memory.<br />
<br />
In case of multi-process target, palMemAlloc() and palMemFree() routines can simply use the STRIDE Runtime’s Memory Management module ''srMem'', which is in turn dependent on palMemSegmentOpen() and palMemSegmentClose() routines.<br />
<br />
== Transport Services ==<br />
The PAL transport routines are needed to transfer I-blocks (STRIDE data packets) into and out of the STRIDE Runtime on your target platform. These routines handle the buffering and transferring of data to and from your transport mechanism. The PAL also contains registration routines that allow for STRIDE Runtime routines to be called by the PAL.<br />
<br />
The palOut() routine enables the STRIDE Runtime to transfer I-blocks to your transport. The STRIDE Runtime calls the palOut() routine whenever it needs to send out an I-block.<br />
<br />
Your transport calls the routine registered with the palOutRdyReg() routine when the transport is ready for the next I-block to be transmitted. The STRIDE Runtime will not call the palOut() routine until you call the registered function. In this way, you can control the flow of transmitted I-blocks.<br />
When a complete I-block has been received by your transport, the routine registered with the palInReg() routine should be called to put the received I-block into the STRIDE Runtime.<br />
<br />
In some cases it is useful to know when the transmit path is not being requested. Your transport mechanism can check the number of I-blocks the STRIDE Runtime has ready for transmission by calling the routine registered with the palOutPndReg() routine. <br />
<br />
= PAL Organization =<br />
<br />
This section explains the two categories of PAL services that support the STRIDE Runtime, as<br />
well as the files used to implement these services on your target. The '''pal.h''' header file provided with the STRIDE installation contains all the function prototypes.<br />
<br />
== PAL Services ==<br />
The PAL services include the following:<br />
* Operating System (OS) Services<br />
* Input/Output (IO) Services<br />
<br />
== PAL Operating System Services ==<br />
The PAL Operating System (OS) Services are the routines that enable the STRIDE Runtime to work with the operating system on your target platform. In order to write your PAL OS services you must have detailed knowledge of how your operating system handles thread synchronization, timers, mutexes, dynamic memory, shared memory, and notification. The PAL OS services make the features of your operating system available to the STRIDE Runtime.<br />
<br />
{|class="wikitable" border="2" style="margin:1em auto 1em" <br />
! Function Name !! Description<br />
|-<br />
|colspan="2" | '''Synchronization'''<br />
|-<br />
| palCreateNID || Create a Notification Identifier (NID) <br />
|-<br />
| palDeleteNID || Delete a Notification Identifier (NID) <br />
|-<br />
| palCreateRFCProxyNID || Create the RFC Proxy Notification Identifier (NID) <br />
|-<br />
| palDeleteRFCProxyNID || Delete the RFC Proxy Notification Identifier (NID) <br />
|-<br />
| palWait || Wait for an event <br />
|-<br />
| palNotify || Signal a thread that an event is pending <br />
|-<br />
| palGetThreadId || Return current thread Id <br />
|-<br />
| palGetProcessId || Return current process Id <br />
|-<br />
| palSleep || Suspend the execution of the current thread<br />
|-<br />
|colspan="2" | '''Timers'''<br />
|-<br />
| palCreateTimer || Create a timer <br />
|-<br />
| palDeleteTimer || Delete a timer <br />
|-<br />
| palStartTimer || Start a timer <br />
|-<br />
| palStopTimer || Stop a timer <br />
|-<br />
| palGetTime || Return system time (e.g., tick count) <br />
|-<br />
|colspan="2" | '''Mutex'''<br />
|-<br />
| palMutexInit || Initialize a mutex object<br />
|-<br />
| palMutexDestroy || Destroy a mutex object<br />
|-<br />
| palMutexLock || Lock a mutex object<br />
|-<br />
| palMutexUnlock || Unlock a mutex object<br />
|-<br />
|colspan="2" | '''Memory Management'''<br />
|-<br />
| palMemAlloc || Allocate a block of dynamic memory<br />
|-<br />
| palMemFree || Free a block of dynamic memory<br />
|-<br />
| palMemSegmentOpen || Create/open memory segments<br />
|-<br />
| palMemSegmentClose || Close memory segments<br />
|}<br />
<br />
== PAL Input/Output Services ==<br />
The PAL Input/Output (IO) Services are the routines that enable the STRIDE Runtime to<br />
work with different data transport mechanisms. These routines enable your transport to<br />
send and receive data between the host and the target.<br />
<br />
The IO services have also been defined to allow the target platform to control how<br />
memory is managed and the rate of data exchange. <br />
<br />
{|class="wikitable" border="2" style="margin:1em auto 1em" <br />
! Function Name !! Description<br />
|-<br />
|colspan="2" | '''Transmit'''<br />
|-<br />
| palOutPndReg || Registers a callback to query the current output queue of the Runtime<br />
|-<br />
| palOutRdyReg || Registers a callback to identify the transport as ready to receive data <br />
|-<br />
| palOut || Send data to the host platform<br />
|-<br />
|colspan="2" | '''Receive'''<br />
|-<br />
| palInReg || Registers a callback to process the data extracted from the transport and identified for the STRIDE Runtime<br />
|}<br />
<br />
= Integrating the PAL =<br />
<br />
== PAL Operating System (OS) Services ==<br />
The '''[[Platform Abstraction Layer|PAL]]''' OS Services provide the glue between the STRIDE Runtime and the Target Operating System. The services it must provide are:<br />
* Task protection and synchronization (e.g. mutexes)<br />
* Periodic Timers<br />
* Get Time Stamp<br />
* Memory Management<br />
By convention, these services are implemented in a file called ''palOS.c''.<br />
<br />
== PAL Transport (I/O) Services ==<br />
The PAL Transport Services implement the target peer of the I/O services between the Host and Target. By convention, these services are implemented in a file called ''palIO.c''. <br />
<br />
The pre-packaged PALs in the [[Posix SDK]] and [[Windows SDK]] provide both a Serial and a TCP/IP transport.<br />
<br />
;What about USB?: S2 does not yet provide a native USB transport. If you wish to use one of our prepackaged transports, then the USB can either be used to emulate a serial (COM) port, or can be used with TCP/IP by installing and using USBNet. USBNet is open software for Linux and Windows that permits TCP/IP connections over USB. Google "USBNet" to locate a driver for your systems.<br />
<br />
;What if I need a custom transport?: A custom transport can be implemented. Your PAL implementation will need to implement the target side of the custom communication.<br />
<br />
== PAL Resource Requirements ==<br />
Most PALs require a reader task to monitor the Transport input data stream.<br />
<br />
PAL memory usage is limited to a few dozen bytes for table and control block storage. The size of I/O buffers used by the reader task are Transport dependent but are usually in the 8KB range.<br />
<br />
There is no "formal" mechanism required for initializing the PAL. That is, an initialization function is not required by the STRIDE Runtime or IM. In addition good practices require releasing resources on application exit. However, over time the convention of providing ''palInit()'' and ''palUninit()'' functions has developed. All of the Pre-Packaged PAL use this convention and their ''palInit()'' function must be called before any other STRIDE Runtime function and ''palUninit()'' on application shutdown.</div>Ivailophttps://www.stridewiki.com/index.php?title=Posix_SDK&diff=14722Posix SDK2020-12-10T18:52:22Z<p>Ivailop: </p>
<hr />
<div>= Introduction =<br />
<br />
The Posix SDK is a platform-specific package that contains the STRIDE Runtime source and [[Platform_Abstraction_Layer|PAL]] implementation, along with integration tools to build a stride library and a strideDaemon and a TestApp applications. It is intended for this article to be used as a reference.<br />
<br />
=Target Makefile=<br />
<br />
The SDK makefile provides targets for building the [[Runtime Reference|STRIDE Runtime]] library and two executable applications - a strideDaemon (for a [[#Multiprocess_Application_Integration|multiprocess]] application environment), and an TestApp (see [[Building_an_Off-Target_Test_App|this]] for more information).<br />
<br />
The default make target builds the STRIDE Runtime library. When a multiprocess runtime library is specified (see RTSINGLEPROC below), and a strideDaemon executable build as well. To build the test application, specify the '''testapp''' make target. <br />
<br />
The '''testapp''' target compiles SCL source markup present in the Runtime source and therefore requires that the [[Build Tools]] be installed on your system and in your executable search path. <br />
<br />
===Configuration===<br />
<br />
The behavior of the makefile can be affected by setting certain make variable parameters. For example, the following make invocation will change the value of the TOOLCHAIN and DEBUG variables when making:<br />
<source lang="bash"><br />
cd ~/stride/SDK/Posix/src<br />
make TOOLCHAIN=arm DEBUG=1<br />
</source><br />
<br />
The following variable are intended to be specified or overridden as needed:<br />
<br />
====TOOLCHAIN====<br />
<br />
The default compiler toolchain when TOOLCHAIN is set to '''x86''' is gcc/g++/ar, which are assumed to be in your path. For any other TOOLCHAIN value, the toolchain tools are $(TOOLCHAIN)-linux-gcc/g++/ar where $(TOOLCHAIN) is replaced by the specified TOOLCHAIN setting. If your toolchain does not fit this pattern, you will need to modify the makefile or explicitly override values for CC, CPP, and AR.<br />
<br />
====LIBRARYTYPE====<br />
<br />
The default behavior of the makefile is to build the STRIDE Runtime as a static library. If you prefer a shared library, set this value to '.so'.<br />
<br />
====DEBUG====<br />
<br />
The default configuration compiles with optimization and NDEBUG defined. If you prefer debuggable binaries, set this value to 1.<br />
<br />
====RTSINGLEPROC====<br />
<br />
The default configuration, set to '''1''', compiles the runtime library with no multiprocess support. If you want [[#Multiprocess_Application_Integration|multiprocess]] functionality, you can enable this by explicitly setting this value to '''0'''.<br />
<br />
====STANDALONE_TESTAPP====<br />
<br />
The default configuration, set to '''1''', builds the TestApp as a [[#Standalone_Application_Integration|standalone]] application. When set to '''0''' the TestApp is built as a [[#Multiprocess_Application_Integration|multiprocess]] application. <br><br />
The STANDALONE_TESTAPP variable is affected by the value of RTSINGLEPROC. If RTSINGLEPROC is '''1''' and STANDALONE_TESTAPP is '''0''', this is an invalid combination and STANDALONE_TESTAPP will automatically be set to '''1'''.<br />
<br />
====S2SCOPTS====<br />
<br />
The STRIDE build process that produces the database and [[Intercept Module]] for the test application relies on target settings. These settings are passed as options to the stride compiler and are most conveniently stored in an options file. We provide a default options file with target settings that are appropriate for x86 Linux targets with GNU compilers -- this file is ''SDK/Posix/settings/stride.s2scompile'' in the SDK distribution. <br />
<br />
We recommend that you make a copy of this file and adjust the settings as appropriate for your target. You can then set this variable - '''S2SCOPTS''' to the path to your settings file. This will cause the make process to use the specified target settings options instead of the default one provided in the SDK. This same settings file should ultimately be used for the STRIDE build integration with your application source code.<br />
<br />
===S2 Build Flags===<br />
The target Makefile sets the following Build Tool flags:<br />
<pre><br />
S2_BIND_FLAGS = --starting_suid=7000<br />
S2_IM_FLAGS = --disable_access_class<br />
</pre><br />
<br />
The [[S2sbind#Options|s2sbind]] and [[S2sinstrument#Options|s2sinstrument]] flags are combined so that the test application only registers for test message IDs that are created in a higher range so that it doesn't conflict with other application processes.<br />
<br />
===Makefile Targets===<br />
The makefile included with the SDK supports the following targets:<br />
;all<br />
: builds the runtime library and daemon<br />
;library<br />
: builds the runtime library<br />
;daemon<br />
: builds ''library'' and--if RTSINGLEPRC is not zero--the STRIDE daemon<br />
;im<br />
: builds the STRIDE database and generates IM files<br />
;testapp<br />
:builds ''library'', ''im'' and instrumented test application<br />
;clean<br />
:removes all generated files<br />
<br />
=Target API (stride.h)=<br />
<br />
The Posix SDK provides a simplified application interface for initializing the STRIDE subsystem and starting STRIDE messaging and IM threads. The API includes the following routines:<br />
<br />
===srBOOL strideInit(const strideIO_t * io)===<br />
<br />
This function initializes the STRIDE subsystem. The IO configuration is passed in as an argument. If this argument is NULL, then the process will attempt to attach to an already running runtime application (daemon) using shared memory for IPC. This function should only be called once per application and should be match with a call to <tt>strideUninit()</tt>.<br />
<br />
===srBOOL strideUninit(void)===<br />
<br />
Terminates any threads that have been started with this API and uninitializes the STRIDE subsystem.<br />
<br />
===srBOOL strideCreateThread(strideThreadFunc_t entry, const srCHAR * name, void* param)===<br />
<br />
Creates a thread to be managed by the STRIDE subsystem. Threads created using this routine will be sent a palSTOP_EVENT notification (available from palWait) and should respond promptly to this event. The name parameter is used primarily for logging purposes.<br />
<br />
===strideCreateIMThread(name)===<br />
<br />
This is a macro that wraps the invocation of <tt>strideCreateThread()</tt> for intercept module entry point functions. Only the IM name must be provided.<br />
<br />
===void strideStopThread(srDWORD id)===<br />
<br />
Signals a thread to stop (sends palSTOP_EVENT) and joins it.<br />
<br />
===void strideExWaitForExit(void)===<br />
<br />
This function can be called by the main application thread to block until a termination signal ([http://en.wikipedia.org/wiki/SIGTERM SIGTERM]) is received. Internally it uses the pause function to wait for signals to be delivered and then checks if termination has occurred.<br />
<br />
''This function is optional - if you block some other way (e.g. create the application's message loop) do not call this function.''<br />
<br />
===void strideExBlockExitSignals(srBOOL enable)===<br />
<br />
This function can be called by the main application thread to block termination signals ([http://en.wikipedia.org/wiki/SIGTERM SIGTERM]).<br />
<br />
''This function is optional - if you manage your termination signals behaviour do not call this function.''<br />
<br />
=Target Integration=<br />
<br />
Here are a few examples of how to integrate the stride API into your application.<br />
<br />
'''NOTE:''' The following code assumes that the intercept module was generated with a name of ''myintercept''. Change all references to that name in your code to the chosen intercept module name.<br />
<br />
===Standalone Application Integration===<br />
<br />
The following code demonstrates how to integrate your application with the STRIDE Runtime. Your application might require other logic at startup - you can integrate the following calls according to your needs. Note that this code initializes the STRIDE subsystem and assumes a single standalone process that creates the STRIDE system threads as well as application threads. <br />
<br />
<source lang="c"><br />
#include <stdlib.h><br />
#include <unistd.h><br />
#include <stride.h><br />
#include "myinterceptIMEntry.h"<br />
<br />
int main(int argc, char **argv)<br />
{<br />
/* initialize the STRIDE subsytem using default I/O */<br />
#ifdef __cplusplus<br />
strideIO_t io = {strideIO_t::strideDEFAULT};<br />
#else<br />
strideIO_t io = {strideDEFAULT};<br />
#endif<br />
if (strideInit(&io) != srTRUE)<br />
return -1;<br />
<br />
/* start all IM threads */<br />
if (strideCreateIMThread(myintercept) != srTRUE)<br />
return -1;<br />
<br />
/* application code here */<br />
strideExWaitForExit(); /* or block some other way (e.g. application's message loop) */<br />
<br />
/* stop all IM threads and uninitialize STRIDE subsystem */<br />
strideUninit();<br />
return 0; <br />
}<br />
</source><br />
<br />
This sample code assumes you have generated your Intercept Module with a prefix name of '''myintercept'''. <br />
<br />
<u>''NOTE:''</u> If you need to provide additional message processing threads, you can call <tt>strideCreateThread()</tt> for each additional thread that you wish to add (this must be called prior to your application code).<br />
<br />
===Multiprocess Application Integration===<br />
<br />
This code demonstrates how to integrate your application with the STRIDE Runtime in multiprocess mode. In this mode, the pre-packaged strideDaemon runs simultaneously with the application and provides the STRIDE IO and runtime thread initialization. The host communicates with the application process through the strideDaemon (or another STRIDE IO process). In this sample, the only difference with the preceding sample is the call to strideInit which, in this case, specifies no IO parameters which indicates to the API that the communication and runtime threads should not be started. <br />
<br />
<source lang="c"><br />
#include <stdlib.h><br />
#include <unistd.h><br />
#include <stride.h><br />
#include "myinterceptIMEntry.h"<br />
<br />
int main(int argc, char **argv)<br />
{<br />
if (strideInit(NULL) != srTRUE)<br />
return -1;<br />
<br />
if (strideCreateIMThread(myintercept) != srTRUE)<br />
return -1;<br />
<br />
strideExWaitForExit();<br />
<br />
strideUninit();<br />
return 0; <br />
}<br />
</source><br />
<br />
===Kernel Module Integration===<br />
<br />
The following code demonstrates how to integrate your kernel space module with the STRIDE Runtime. Your module might require other logic at startup - you can integrate the following calls according to your needs. <br />
<br />
'''NOTE:''' You need to also have an active user space STRIDE enabled application (see [[#Standalone_Application_Integration | above]]) that runs the core STRIDE Runtime and IO services. That application also must be built with <tt>-DPAL_KERNEL_UDP_PORT=nnnn</tt>, where the "nnnn" matches the value defined below.<br />
<br />
====Linux====<br />
<br />
<source lang="c"><br />
#include <linux/module.h><br />
<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
#define PAL_KERNEL_UDP_PORT 8888 /* value should match whatever is defined in the "user" STRIDE Runtime */<br />
#include <stride.c> /* that's right, directly include the source file */ <br />
#endif /* STRIDE_ENABLED */<br />
<br />
int init_module(void)<br />
{<br />
...<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
strideInit(NULL);<br />
#endif /* STRIDE_ENABLED */<br />
...<br />
return 0;<br />
}<br />
<br />
void cleanup_module(void)<br />
{<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
strideUninit();<br />
#endif /* STRIDE_ENABLED */<br />
...<br />
}<br />
</source><br />
<br />
You don't need to compile any other source nor to link to any other library. Just make sure you pass the following extra flags to your compiler:<br />
<pre><br />
EXTRA_CFLAGS += -DSTRIDE_ENABLED=1 -I"$(STRIDE_DIR)/SDK/Posix/src" -I"$(STRIDE_DIR)/SDK/Runtime"<br />
</pre><br />
<br />
====FreeBSD====<br />
<br />
<source lang="c"><br />
#include <sys/module.h><br />
#include <sys/kernel.h><br />
<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
#define PAL_KERNEL_UDP_PORT 8888 /* value should match whatever is defined in the "user" STRIDE Runtime */<br />
#include <stride.c> /* that's right, directly include the source file */ <br />
#endif /* STRIDE_ENABLED */<br />
<br />
/* The function called at load/unload. */<br />
static int event_handler(struct module *module, int event, void *arg) {<br />
int e = 0; /* Error, 0 for normal return status */<br />
switch (event) {<br />
case MOD_LOAD:<br />
...<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
strideInit(NULL);<br />
#endif /* STRIDE_ENABLED */<br />
...<br />
break;<br />
case MOD_UNLOAD:<br />
...<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
strideUninit();<br />
#endif /* STRIDE_ENABLED */<br />
...<br />
break;<br />
default:<br />
e = EOPNOTSUPP; /* Error, Operation Not Supported */<br />
break;<br />
}<br />
<br />
return(e);<br />
}<br />
</source><br />
<br />
You don't need to compile any other source nor to link to any other library. Just make sure you pass the following extra flags to your compiler:<br />
<pre><br />
CFLAGS += -DSTRIDE_ENABLED=1 -I"$(STRIDE_DIR)/SDK/Posix/src" -I"$(STRIDE_DIR)/SDK/Runtime"<br />
</pre><br />
<br />
=Posix PAL=<br />
<br />
===PAL Configuration (palcfg.h)===<br />
The following parameters can be configured in ''palcfg.h'' to effect the behavior of the compiled pal source files.<br />
<br />
; PAL_DEFAULT_DEVICE_NAME : default IO device to use.<br />
; PAL_MAX_THREADS : max STRIDE integrated threads that can be managed by the STRIDE API.<br />
; PAL_MAX_TIMERS : max STRIDE timers that can be active in the system.</div>Ivailophttps://www.stridewiki.com/index.php?title=Windows_SDK&diff=14721Windows SDK2020-12-10T18:49:45Z<p>Ivailop: </p>
<hr />
<div>= Introduction =<br />
<br />
The Windows SDK is a platform-specific package that contains the STRIDE Runtime source and [[Platform_Abstraction_Layer|PAL]] implementation, along with integration tools to build a stride library and a strideDaemon and a TestApp applications. It is intended for this article to be used as a reference. <br />
<br />
=Target Makefile=<br />
<br />
The SDK Makefile (based on [http://www.gnu.org/software/make/ GNU make] semantics) provides targets for building the [[Runtime Reference|STRIDE Runtime]] library and two executable applications - a strideDaemon (for a [[#Multiprocess_Application_Integration|multiprocess]] application environment), and an TestApp. <br />
<br />
The default make target builds the STRIDE Runtime library. When a multiprocess runtime library is specified (see RTSINGLEPROC below), and a strideDaemon executable build as well. To build the test application, specify the '''testapp''' make target. <br />
<br />
The '''testapp''' target compiles SCL source markup present in the Runtime source and therefore requires that the [[Build Tools]] be installed on your system and in your executable search path.<br />
<br />
===Configuration===<br />
<br />
The behavior of the makefile can be affected by setting certain make variable parameters. For example, the following make invocation will change the value of the TOOLCHAIN and DEBUG variables when making:<br />
<br />
<source lang="dos"><br />
cd stride\SDK\Windows\src<br />
..\bin\make TOOLCHAIN=arm DEBUG=1<br />
</source><br />
<br />
The following variable are intended to be specified or overridden as needed:<br />
<br />
====TOOLCHAIN====<br />
<br />
The default compiler toolchain when TOOLCHAIN is set to '''x86''' which assumes a x86 version of cl/link/lib to be in your path. For any other TOOLCHAIN value, the toolchain compiler is cl$(TOOLCHAIN) where $(TOOLCHAIN) is replaced by the specified TOOLCHAIN setting. If your toolchain does not fit this pattern, you will need to modify the makefile or explicitly override values for CC, CPP, LINK, and AR.<br />
<br />
====LIBRARYTYPE====<br />
<br />
The default behavior of the makefile is to build the STRIDE Runtime as a static library. If you prefer a dynamic library, set this value to '.dll'.<br />
<br />
====DEBUG====<br />
<br />
The default configuration compiles with optimization and NDEBUG defined. If you prefer debuggable binaries, set this value to 1.<br />
<br />
====RTSINGLEPROC====<br />
<br />
The default configuration, set to '''1''', compiles the runtime library with no multiprocess support. If you want [[#Multiprocess_Application_Integration|multiprocess]] functionality, you can enable this by explicitly setting this value to '''0'''.<br />
<br />
====STANDALONE_TESTAPP====<br />
<br />
The default configuration, set to '''1''', builds the TestApp as a [[#Standalone_Application_Integration|standalone]] application. When set to '''0''' the TestApp is built as a [[#Multiprocess_Application_Integration|multiprocess]] application. <br><br />
The STANDALONE_TESTAPP variable is affected by the value of RTSINGLEPROC. If RTSINGLEPROC is '''1''' and STANDALONE_TESTAPP is '''0''', this is an invalid combination and STANDALONE_TESTAPP will automatically be set to '''1'''.<br />
<br />
====S2SCOPTS====<br />
<br />
The STRIDE build process that produces the database and [[Intercept Module]] for the diagnostics tests relies on target settings. These settings are passed as options to the stride compiler and are most conveniently stored in an options file. We provide a default options file with target settings that are appropriate for x86 Windows targets with Microsoft compilers -- this file is ''SDK\Windows\settings\stride.s2scompile'' in the SDK distribution. <br />
<br />
We recommend that you make a copy of this file and adjust the settings as appropriate for your target. You can then set this variable - '''S2SCOPTS''' to the path to your settings file. This will cause the make process to use the specified target settings options instead of the default one provided in the SDK. This same settings file should ultimately be used for the STRIDE build integration with your application source code.<br />
<br />
===S2 Build Flags===<br />
The target Makefile sets the following Build Tool flags:<br />
<pre><br />
S2_BIND_FLAGS = --starting_suid=7000<br />
S2_IM_FLAGS = --disable_access_class<br />
</pre><br />
<br />
The [[S2sbind#Options|s2sbind]] and [[S2sinstrument#Options|s2sinstrument]] flags are combined so that the test application only registers for test message IDs that are created in a higher range so that it doesn't conflict with other application processes.<br />
<br />
===Makefile Targets===<br />
The makefile included with the SDK supports the following targets:<br />
;all<br />
: builds the runtime library and daemon<br />
;library<br />
: builds the runtime library<br />
;daemon<br />
: builds ''library'' and--if RTSINGLEPRC is not zero--the STRIDE daemon<br />
;im<br />
: builds the STRIDE database and generates IM files<br />
;testapp<br />
:builds ''library'', ''im'' and instrumented test application<br />
;clean<br />
:removes all generated files<br />
<br />
=Target API (stride.h)=<br />
<br />
The Windows SDK provides a simplified application interface for initializing the STRIDE subsystem and starting STRIDE messaging and IM threads. The API includes the following routines:<br />
<br />
===srBOOL strideInit(const strideIO_t * io)===<br />
<br />
This function initializes the STRIDE subsystem. The IO configuration is passed in as an argument. If this argument is NULL, then the process will attempt to attach to an already running runtime application (daemon) using shared memory for IPC. This function should only be called once per application and should be match with a call to <tt>strideUninit()</tt>.<br />
<br />
===srBOOL strideUninit(void)===<br />
<br />
Terminates any threads that have been started with this API and uninitializes the STRIDE subsystem.<br />
<br />
===srBOOL strideCreateThread(strideThreadFunc_t entry, const srCHAR * name, void* param)===<br />
<br />
Creates a thread to be managed by the STRIDE subsystem. Threads created using this routine will be sent a palSTOP_EVENT notification (available from palWait) and should respond promptly to this event. The name parameter is used primarily for logging purposes.<br />
<br />
===strideCreateIMThread(name)===<br />
<br />
This is a macro that wraps the invocation of <tt>strideCreateThread()</tt> for intercept module entry point functions. Only the IM name must be provided.<br />
<br />
===void strideStopThread(srDWORD id)===<br />
<br />
Signals a thread to stop (sends palSTOP_EVENT) and joins it.<br />
<br />
===void strideExWaitForExit(void)===<br />
<br />
This function can be called by the main application thread to block until the application is shutdown. <br />
<br />
''This function is optional - if you block some other way (e.g. create the application's message loop) do not call this function.''<br />
<br />
===void strideExSetupMainWindow(const char* name, void* instance, int showCmd)===<br />
<br />
This function is called by applications to create the main window of the process. The first argument specifies a name of the window. The second argument specifies the handle to the current instance of the application. And the third specifies how the window is to be shown.<br />
<br />
''This function is optional - if you create the application's main window do not call this function.''<br />
<br />
=Target Integration=<br />
<br />
Here are a few examples of how to integrate the stride API into your application.<br />
<br />
'''Note:''' the following code assumes that the intercept module was generated with a name of ''myintercept''. Change all references to that name in your code to the chosen intercept module name.<br />
<br />
===Standalone Application Integration===<br />
<br />
The following code demonstrates how to integrate your application with the STRIDE Runtime. Your application might require other logic at startup - you can integrate the following calls according to your needs. Note that this code initializes the STRIDE subsystem and assumes a single standalone process that creates the STRIDE system threads as well as application threads. <br />
<br />
<source lang="c"><br />
#include <tchar.h><br />
#include <stride.h><br />
#include "myinterceptIMEntry.h"<br />
<br />
int _tmain(int argc, _TCHAR* argv[])<br />
{<br />
/* initialize the STRIDE subsytem using default I/O */<br />
#ifdef __cplusplus<br />
strideIO_t io = {strideIO_t::strideDEFAULT};<br />
#else<br />
strideIO_t io = {strideDEFAULT};<br />
#endif<br />
if (strideInit(&io) != srTRUE)<br />
return -1;<br />
<br />
/* start all IM threads */<br />
if (strideCreateIMThread(myintercept) != srTRUE)<br />
return -1;<br />
<br />
/* application code here */<br />
strideExWaitForExit(); /* or block some other way (e.g. application's message loop) */<br />
<br />
/* stop all IM threads and uninitialize STRIDE subsystem */<br />
strideUninit();<br />
return 0; <br />
}<br />
</source><br />
<br />
This sample code assumes you have generated your Intercept Module with a prefix name of '''myintercept'''. <br />
<br />
<u>''NOTE:''</u> If you need to provide additional message processing threads, you can call <tt>strideCreateThread()</tt> for each additional thread that you wish to add (this must be called prior to your application code).<br />
<br />
===Multiprocess Application Integration===<br />
<br />
This code demonstrates how to integrate your application with the STRIDE Runtime in multiprocess mode. In this mode, the pre-packaged strideDaemon runs simultaneously with the application and provides the STRIDE IO and runtime thread initialization. The host communicates with the application process through the strideDaemon (or another STRIDE IO process). In this sample, the only difference with the preceding sample is the call to strideInit which, in this case, specifies no IO parameters which indicates to the API that the communication and runtime threads should not be started. <br />
<br />
<source lang="c"><br />
#include <tchar.h><br />
#include <stride.h><br />
#include "myinterceptIMEntry.h"<br />
<br />
int _tmain(int argc, _TCHAR* argv[])<br />
{<br />
if (strideInit(NULL) != srTRUE)<br />
return -1;<br />
<br />
if (strideCreateIMThread(myintercept) != srTRUE)<br />
return -1;<br />
<br />
strideExWaitForExit();<br />
<br />
strideUninit();<br />
return 0; <br />
}<br />
</source><br />
<br />
===Kernel Module Integration===<br />
<br />
The following code demonstrates how to integrate your kernel space module with the STRIDE Runtime. Your module might require other logic at startup - you can integrate the following calls according to your needs. <br />
<br />
'''NOTE:''' You need to also have an active user space STRIDE enabled application (see [[#Standalone_Application_Integration | above]]) that runs the core STRIDE Runtime and IO services. That application must also link to the STRIDE Runtime built with <tt>-DPAL_KERNEL_SHM_SIZE=nnnn</tt>, where the "nnnn" matches the value defined below.<br />
<br />
<source lang="c"><br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
#define PAL_KERNEL_SHM_SIZE 2048 /* value should match whatever is defined in the "user" STRIDE Runtime */<br />
#define PAL_KERNEL_DRV_NAME "DRV" /* set to whatever your driver name is */<br />
#define __KERNEL__<br />
#include <stride.c> /* that's right, directly include the source file */ <br />
#undef __KERNEL__<br />
#endif /* STRIDE_ENABLED */<br />
<br />
#include <Wdm.h><br />
<br />
NTSTATUS DriverEntry(<br />
__in struct _DRIVER_OBJECT *DriverObject,<br />
__in PUNICODE_STRING RegistryPath<br />
)<br />
{<br />
...<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
strideInit(NULL);<br />
#endif /* STRIDE_ENABLED */<br />
...<br />
return status;<br />
}<br />
<br />
VOID DriverUnload(<br />
__in struct _DRIVER_OBJECT *DriverObject<br />
)<br />
{<br />
#if defined(STRIDE_ENABLED) && STRIDE_ENABLED<br />
strideUninit();<br />
#endif /* STRIDE_ENABLED */<br />
...<br />
}<br />
</source><br />
<br />
You don't need to compile any other source nor to link to any other library. Just make sure you pass the following extra flags to your compiler:<br />
<pre><br />
C_DEFINES = $(C_DEFINES) -DSTRIDE_ENABLED=1 -DSTRIDE_STATIC<br />
INCLUDES = $(INCLUDES); $(STRIDE_DIR)\SDK\Windows\src; $(STRIDE_DIR)\SDK\Runtime<br />
</pre><br />
<br />
=Windows PAL=<br />
<br />
===PAL Configuration (palcfg.h)===<br />
The following parameters can be configured in ''palcfg.h'' to effect the behavior of the compiled pal source files.<br />
<br />
; PAL_DEFAULT_DEVICE_NAME : default IO device to use.<br />
; PAL_MAX_THREADS : max STRIDE integrated threads that can be managed by the STRIDE API.<br />
; PAL_MAX_TIMERS : max STRIDE timers that can be active in the system.</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14720Framework Setup2020-12-10T18:46:30Z<p>Ivailop: </p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
===<tt>bin</tt>===<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
===<tt>lib</tt>===<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
===<tt>samples</tt>===<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
===<tt>SDK</tt>===<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.16.x, 5.18.x, 5.20.x, 5.22.x, 5.24.x and 5.26.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''32-bit''' (with USE_64_BIT_INT) Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl] (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
For Strawberry Perl, simplest method for installing packages is via the <tt>cpanm.bat</tt> utility script. To install the latest stable version of PACKAGE_NAME (the package to install) simply execute:<br />
<br />
cpanm.bat PACKAGE_NAME<br />
<br />
For ActiveState Perl, you can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=S2scompile&diff=14719S2scompile2020-08-06T18:19:07Z<p>Ivailop: /* The SCL Compiler Utility */</p>
<hr />
<div>__FORCETOC__<br />
== The SCL Compiler Utility ==<br />
<br />
The '''s2scompile''' executable will compile a set of scl files (C/C++ source files with [[SCL Pragmas]]) and produce a <tt>.meta</tt> file for each (assuming that compilation is successful).<ref>.meta files are binary-format intermediate files suitable for input to the [[s2sbind]] utility.</ref><br />
<br />
All warnings and errors that occur during the compilation are written to the standard output device. The compilation for a particular file is considered successful if no errors occur. Otherwise it is unsuccessful. Unsuccessful compilations do not yield <tt>.meta</tt> files.<br />
<br />
Options are validated and any incorrect options diagnosed will result in compilation process failure.<br />
<br />
=== Syntax ===<br />
s2scompile [<i>options</i>] <i>scl_file1</i> [<i>scl_fileN</i>]<br />
<br />
=== Options ===<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;background-color:#ffffcc;" <br />
!width="200pt"|'''Option'''<br />
!width="500pt"|'''Description'''<br />
|- <br />
| '''--version'''<br />
| Print version information.<br />
|- <br />
| '''--preprocess'''<br />
| Do preprocessing only. Write preprocessed text file to the output.<br />
|- <br />
| '''--dependencies'''<br />
| Do preprocessing only. Instead of the normal preprocessing output, generate in the preprocessing output file a list of dependency lines suitable for input to the UNIX make program. <br />
|-<br />
| '''--no_line_commands'''<br />
| Same as '''–-preprocess''' except that line number information is removed from the preprocessed output files.<br />
|-<br />
| '''--c++'''<br />
| Enable compilation of c++. <br />
|-<br />
| '''--c'''<br />
| Enable compilation of C (specifically C89). This is the default.<br />
|-<br />
| '''--include_directory='''<i><dir></i><br><br />
'''--sys_include='''<i><dir></i><br><br />
'''-I'''<i><dir></i><br />
| Add dir to the end of the list of directories searched for <tt>#include</tt>.<br />
|-<br />
| '''--no_stdinc'''<br />
| Do not search the standard system directories for header files. See [[#Search Path|Search Path]] for details.<br />
|-<br />
| '''--define_macro='''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br><br />
'''-D'''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br />
| Define macro <i><name></i> as <i>value</i>. If "=<i>value</i>" is omitted, define <i><name></i> as 1.<br />
|-<br />
| '''--undefine_macro='''<i><name></i><br><br />
'''-U'''<i><name></i><br />
| Remove predefined macro <i><name></i>.<br />
|-<br />
| '''--preinclude='''<i><file></i><br />
| Include file at the beginning of compilation.<br />
<br />
'''''NOTE:''' To simplify the integration in existing build environments other standard compiler options (e.g. GCC [https://gcc.gnu.org/onlinedocs/gcc/Preprocessor-Options.html -include<file>], MSVC [https://docs.microsoft.com/en-us/cpp/build/reference/fi-name-forced-include-file /FI@<file>]) with similar meaning are also recognized and processed the same way.''<br />
|-<br />
| '''--compatibility='''<i><string></i><br />
| Vendor compatibility mode. String can be "microsoft", "generic" or "gnu". Default is "generic". When "Microsoft" is set, the compiler supports a number of extensions to the C or C++ language that are compatible with the Microsoft family of compilers. "gnu" - instructs the compiler to support language extensions compatible with the Gnu family of compilers.<br />
|-<br />
| '''--no_warning'''<br />
| Suppress all warnings in the compilation phase.<br />
|-<br />
| '''--macros'''<br />
| Resolve macro (preprocessor define) constant value. Pass this flag only if you intend to do script based testing.<br />
|-<br />
| '''--documentation'''<br />
| Extract [https://en.wikipedia.org/wiki/Doxygen doxygen style] source documentation. <br />
|-<br />
| '''--output='''<i><path></i><br><br />
'''-o'''<path><br />
| Output file or directory. The default is the current directory.<br />
|-<br />
| '''--targ_big_endian'''<br />
| Target uses a big endian by representation. The default is little endian.<br />
|-<br />
| '''--targ_plain_char_is_unsigned'''<br />
| Target uses unsigned chars to represent “plain” char. The default is signed.<br />
|-<br />
| '''--targ_adaptive_enum'''<br />
| Target has adaptive enums. The default is no adaptive enums.<br />
|-<br />
| '''--targ_pack_alignment='''<i><align></i><br />
| Target struct pack alignment. The default is 16. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_char='''<i><size></i><br />
| Target platform size of char. Default is 1. Possible values are 1, 2, 4, 8, or 16.<br />
|-<br />
| '''--targ_alignof_char='''<i><align></i><br />
| Target platform alignment of char. Default is 1. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_short='''<i><size></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_alignof_short='''<i><align></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_sizeof_int='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_int='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_long='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long_long='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_long_long='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_float='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_float='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_double='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_long_double='''<i><size></i><br />
| Default is 8<br />
|-<br />
| '''--targ_alignof_long_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_bool_int_kind='''<i><typename></i><br />
| Default is "char".<br />
|-<br />
| '''--targ_wchar_t_int_kind='''<i><typename></i><br />
| Default is "unsigned short".<br />
|-<br />
| '''--targ_size_t_int_kind='''<i><typename></i><br />
| Default is "unsigned int".<br />
|-<br />
| '''--targ_ptrdiff_t_int_kind='''<i><typename></i><br />
| Default is "int".<br />
|-<br />
| '''--options_file='''<i><file></i><br />
| A file that contains command line options. The format is the same as the command line with the only addition that it could be split on multiple lines. A line starting with "#" or ";" symbol is ignored.<br />
This option is necessary if the length of the command line string exceeds system limits. Otherwise it is provided only as a convenience.<br />
<br />
'''''NOTE:''' To simplify the integration in existing build environments other standard compiler options (e.g. ARM [https://www.keil.com/support/man/docs/armcc/armcc_chr1359124949735.htm --via=<file>], GCC [https://gcc.gnu.org/onlinedocs/gcc/Overall-Options.html @<file>], MSVC [https://docs.microsoft.com/en-us/cpp/build/reference/at-specify-a-compiler-response-file @<file>]) with similar meaning are also recognized and processed the same way.''<br />
|}<br />
<br />
'''Note''': The [[Framework_Setup#SDK|standard Platform SDKs]] shipped with the Framework contain a set of options files with predefined target settings for several popular CPUs. Please consider using one of them instead of explicitly passing <tt>--targ_*</tt> options on the command line.<br />
<br />
=== Search Path ===<br />
<b>s2scompile</b> by default looks in several different places for headers. It looks for headers requested with <tt>#include <file></tt> in:<br />
<pre><br />
$(STRIDE_DIR)/SDK/Runtime<br />
</pre><br />
<br />
Where $(STRIDE_DIR) is the location where the STRIDE packages are installed following [[Framework_Setup#Directories_and_Files|recommended directory layout]].<br />
<br />
When <i>microsoft</i> mode is specified and $(INCLUDE) enviroment variable is defined (as a ";" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>.<br />
<br />
When <i>gnu</i> mode is specified and $(CPATH) and/or $(C_INCLUDE_PATH) (or $(CPLUS_INCLUDE_PATH) for C++) enviroment variables are defined (as a ":" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>. In addition if $(TARGET_CPP) specifies the target GNU <tt>cpp</tt> (GCC preprocessor or a command line equivalent) it is queried and any given path by it is looked in.<br />
<br />
You can add to this list, before any of the default places, by using the <tt>-I<dir></tt> option.<br />
<br />
You can prevent s2scompile from searching any of the default directories with the <tt>--no_stdinc</tt> option. <tt>-I</tt> options are not ignored as described above when <tt>--no_stdinc</tt> is in effect. <br />
<br />
<b>s2scompile</b> looks for headers requested with <tt>#include "file"</tt> first in the directory containing the current file, then in the same places it would have looked for a header requested with angle brackets.<br />
<br />
=== Examples ===<br />
Refer to the [[Build_Tools#Compiling_multiple_files|Compiling]] section of the Build Tools Examples.<br />
<br />
=== Notes ===<br />
<references/><br />
[[Category:Build_Tools]]</div>Ivailophttps://www.stridewiki.com/index.php?title=Test_Double&diff=14718Test Double2020-07-08T22:33:33Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
The ''Test Double'' feature provides a means for intercepting C/C++ language '''global functions''' on the target, and directing the call to a substitute function with identical parameters and return value. The use case is a unit test where the function under test uses a function during its execution, and this dependency is simulated by a substitute or double function during testing. The unit test is able to control the substitution of the dependency during run time, and thereby verify the behavior of the function under test.<br />
The following sample illustrates the relationship of the function under test and a dependency:<br />
<br />
<source lang="c"><br />
// depend.h<br />
int depend(int x);<br />
</source><br />
<br />
<br />
<source lang="c"><br />
// depend.c<br />
#include "depend.h"<br />
<br />
int depend(int x)<br />
{<br />
return x + x;<br />
}<br />
</source><br />
<br />
<br />
<source lang="c"><br />
// fut.h<br />
int fut(int x, int y);<br />
</source><br />
<br />
<br />
<source lang="c"><br />
// fut.c<br />
#include "fut.h"<br />
#include "depend.h"<br />
<br />
int fut(int x, int y)<br />
{<br />
return depend(x) * y;<br />
}<br />
</source><br />
<br />
<br />
In the above sample, ''fut()'' is the function under test and ''depend()'' is a dependency candidate for doubling.<br />
<br />
The steps required to achieve doubling of a dependency function are as follows:<br />
#[[#Configuring the Double Using Function Pragma | Configuring the Double Using Function Pragma]] <br />
#[[#Creating_Double_Intercepts_in_the_IM|Create Double Intercepts in the IM]]<br />
#[[#Switching_the_Double_Function_During_Runtime|Switch Double Function During Runtime]]<br />
<br />
<br />
==Configuring the Double Using Function Pragma==<br />
<br />
The syntax of the [[Scl_function|function pragma]] supports a set of '''''optional''''' attributes that allow the specification of function interception parameters. When captured for the purpose of interception ('''intercept-able''') the optional arguments are '''required'''.<br />
<br />
#pragma scl_function(function-name [,context, name-mangling, group-id])<br />
<br />
<br />
Refer to the actual [[Scl_function | function pragma]] definition for an explanation of <br />
* '''context''' - set to ''DEFINITION'' or ''REFERENCE''<br />
* '''name-mangling''' - set to ''EXPLICIT'' or ''IMPLICIT''. Note if set to explicit requires usage of the ''srTEST_INTERCEPT'' macro<br />
* '''group-id''' - user defined to enable or disable interception<br />
<br />
<br />
In the above sample, ''depend()'' needs to be captured via the pragma and enabled for interception in the following manner.<br />
<br />
<source lang="c"><br />
// depend_scl.h<br />
#include "depend.h"<br />
<br />
#pragma scl_function(depend, "DEFINITION", "IMPLICIT", "TEST_GROUP")<br />
</source><br />
<br />
<br />
==Creating Double Intercepts in the IM==<br />
If a function has been configured as a double candidate using the function pragma as outlined in the above step, the [[Build_Tools|Stride Build Tools]] will automatically create the [[Intercept Module]], aka IM, that contains the intercept for the double function. This all happens automatically during the build process. <br />
<br />
But to enable the interception the source file containing the <tt>depend()</tt> implementation '''must be altered''' to [[Name_Mangling|mangle the function's name]] by defining the Group ID and including the generated Intercept Module header file (xxxIM.h):<br />
<br />
<source lang="c"><br />
// depend.c<br />
#include "depend.h"<br />
/* define the Group ID before including the IM header */<br />
#define TEST_GROUP<br />
#include "strideIM.h"<br />
<br />
int depend(int x)<br />
{<br />
return x + x;<br />
}<br />
</source><br />
<br />
==Switching the Double Function During Runtime==<br />
In the context of the test unit code the following STRIDE runtime macros, defined in the STRIDE runtime header file '''srtest.h''', could be used for substituting a stub function for a double candidate.<br />
<br />
<source lang="c"><br />
srDOUBLE_SET(fn, fnDbl)<br />
srDOUBLE_RESET(fn)<br />
<br />
srDOUBLE_GET(fn, pfnDbl) // used for more advanced scenarios <br />
</source><br />
<br />
Where:<br />
*'''fn''' is the function qualified by <tt>scl_function</tt> or <tt>scl_func</tt> as a dependency candidate, as above.<br />
*'''pfnDbl''' is a pointer to a object of type <tt>srFunctionDouble_t</tt>, declared to hold the current value of the active double function.<br />
*'''fnDbl''' is a function that is to be the current active double. ''The function passed in should '''always''' match the signature of the dependency candidate specified by '''fn'''.''<br />
'''''Note:''''' the initial value of the current active double is always the dependency candidate function.<br />
<br />
=== Example 1 ===<br />
The following example shows how to double a routine for the lifetime of a C++ Test Unit:<br />
<br />
<source lang="cpp"><br />
#include <srtest.h><br />
#include "fut.h"<br />
#include "depend.h"<br />
<br />
extern "C" int depend_dbl(int a) { return a * a; }<br />
<br />
class Test: public stride::srTest<br />
{ <br />
public:<br />
<br />
Test()<br />
{<br />
srDOUBLE_SET(depend, depend_dbl);<br />
}<br />
<br />
~Test()<br />
{<br />
srDOUBLE_RESET(depend);<br />
}<br />
<br />
void test1(void) { srASSERT_EQ(fut(1, 2), 2); }<br />
void test2(void) { srASSERT_EQ(fut(5, 6), 150); }<br />
};<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_class(Test)<br />
#pragma scl_function(depend, "DEFINITION", "IMPLICIT", "TEST_GROUP")<br />
#endif <br />
</source><br />
<br />
=== Example 2 ===<br />
The following example shows how to make a call to the original routine in the context of a double by safely handling any nested doubling:<br />
<br />
<source lang="c"><br />
#include <srtest.h><br />
#include "depend.h"<br />
<br />
extern "C" int depend_dbl(int a) <br />
{<br />
int ret;<br />
<br />
srFunctionDouble_t fn;<br />
srDOUBLE_GET(depend, &fn);<br />
srDOUBLE_RESET(depend);<br />
ret = depend(a);<br />
srDOUBLE_SET(depend, fn);<br />
<br />
return ret; <br />
}<br />
</source></div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14717Framework Setup2020-07-08T20:10:46Z<p>Ivailop: /* Linux */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.16.x, 5.18.x, 5.20.x, 5.22.x, 5.24.x and 5.26.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''32-bit''' (with USE_64_BIT_INT) Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl] (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
For Strawberry Perl, simplest method for installing packages is via the <tt>cpanm.bat</tt> utility script. To install the latest stable version of PACKAGE_NAME (the package to install) simply execute:<br />
<br />
cpanm.bat PACKAGE_NAME<br />
<br />
For ActiveState Perl, you can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14716Framework Setup2020-07-08T20:10:18Z<p>Ivailop: /* Linux */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.16.x, 5.18.x, 5.20.x, 5.22.x, 5.24.x and 5.26.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''32-bit''' (with USE_64_BIT_INT) Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl] (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
For Strawberry Perl, simplest method for installing packages is via the <tt>cpanm.bat</tt> utility script. To install the latest stable version of PACKAGE_NAME (the package to install) simply execute:<br />
<br />
cpanm.bat PACKAGE_NAME<br />
<br />
For ActiveState Perl, you can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14715Framework Setup2020-07-08T19:21:57Z<p>Ivailop: /* Perl Installation (Optional) */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.16.x, 5.18.x, 5.20.x, 5.22.x, 5.24.x and 5.26.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''32-bit''' (with USE_64_BIT_INT) Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl] (or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]).<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
For Strawberry Perl, simplest method for installing packages is via the <tt>cpanm.bat</tt> utility script. To install the latest stable version of PACKAGE_NAME (the package to install) simply execute:<br />
<br />
cpanm.bat PACKAGE_NAME<br />
<br />
For ActiveState Perl, you can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. <br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14714Release Notes2020-06-23T02:44:27Z<p>Ivailop: /* Minor and Patch releases */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "nodiscard" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14713Release Notes2020-06-23T02:44:12Z<p>Ivailop: /* Minor and Patch releases */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "[[nodiscard]]" attribute in Microsoft mode.<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14712Release Notes2020-06-23T02:42:25Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "attributes".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14711Release Notes2020-06-23T02:41:14Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile Clang extensions.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.03a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "inline namespace".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile C+11 "attributes".<br />
* [[s2scompile|STRIDE Compiler]] is unable to compile forward-declared "enum" in Microsoft mode.<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14710Framework Setup2019-06-19T21:45:39Z<p>Ivailop: /* Perl Installation (Optional) */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.16.x, 5.18.x, 5.20.x, 5.22.x, 5.24.x and 5.26.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''32-bit''' (with USE_64_BIT_INT) Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl].<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
You can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. <br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14709Framework Setup2019-06-19T21:35:58Z<p>Ivailop: /* Perl Installation (Optional) */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.16.x, 5.18.x, 5.20.x, 5.22.x, 5.24.x and 5.26.x of Perl. <br />
<br />
== Windows == <br />
It is required to use one of the '''32-bit''' (with USE_64_BIT_INT) Perl distributions from [http://strawberryperl.com/releases.html Strawberry Perl] or [http://www.activestate.com/activeperl/downloads ActiveState].<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
You can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. <br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14708Release Notes2019-03-19T21:43:12Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.03x =<br />
The code name for this release is ''Jetties''. Released on Mar 8, 2019. <br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] is enabled to compile Clang extentions.<br />
* [[s2scompile|STRIDE Compiler]] is enabled to process "char16_t" and "char32_t" C++11 types.<br />
* [[Perl_Script_APIs|Test Script Constants]] are not accessible.<br />
* In [[Test_Script|Test Scripts]], ASSERT in fixtures is incorrect handled.<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been limited to only publishing results. Only local Schema file execution is supported but deprecated. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl versions 5.24 and 5.26. <br />
* Support for Perl versions 5.20 and older is not provided by default but is available on demand. <br />
* In payload, OUT strings are now expected to be passed by "ref". Passing as "array of chars" is not supported anymore. <br />
<br />
=== Tests in C/C++ ===<br />
* [[Test_Macros|Test Skip Macro]] has been implemented. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.03x''' is compatible with the Runtime Version '''5.0.03'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Change Details ==<br />
<br />
=== Testspace integration ===<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifier.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Test_Documentation_in_C/C%2B%2B&diff=14707Test Documentation in C/C++2018-12-28T19:03:46Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
Stride provides an integrated solution for automatically extracting documentation for your test units using the well-known [https://en.wikipedia.org/wiki/Doxygen doxygen format]. <br />
<br />
'''Test documentation'''<br />
<source lang=cpp><br />
#include <srtest.h><br />
/*! This Suite does lots .. */ <br />
class MyTest {<br />
public: <br />
/*! Check on Foo .. */<br />
void CheckFoo();<br />
/*! Check on Boo .. */<br />
void CheckBoo();<br />
};<br />
#pragma scl_test_class(MyTest)<br />
</source><br />
<br />
<br />
In order to enable test unit documentation, here is summary of the necessary steps:<br />
* document your test unit source with [http://www.doxygen.nl/manual/docblocks.html doxygen] formatted blocks. Since only header files are typically passed to the [[S2scompile|Stride Compiler]], we recommend you place your documentation in the header file. <br />
* configure your build/make process to call the [[S2scompile|Stride Compiler]] with the additional '''--documentation''' flag. If you are using one of our preconfigured makefiles in a sandbox environment, this option has already been enabled.<br />
* run your build process to produce a Stride database and Stride enabled target application.<br />
* start your application and execute the [[Stride Runner]] to connect and run the tests.<br />
* The generated report will contain description information for the test suites and test cases generated from the doxygen blocks.<br />
<br />
'''Doxygen''' has a rich set of tags and formatting options aimed at comprehensive source documentation. The Stride test framework uses doxygen on a per-file basis to extract standalone documentation for individual test units and their methods. As such, we only support limited set of doxygen features in the code documentation. The Stride test framework supports the following doc formatting:<br />
* custom HTML formatting<br />
* lists (ordered, unordered, definition)<br />
* code blocks<br />
* bold and emphasis text<br />
More advanced doxygen formatting tags (such as tables and parameter lists) are not supported at this time, but will likely be in future releases.<br />
<br />
For more information on Doxygen formatting, see [http://www.doxygen.nl/manual/docblocks.html]<br />
<br />
== Test Classes ==<br />
Source documentation is generally straight-foward, with doc blocks preceding the corresponding class and method declaration.<br />
<br />
<br />
<source lang=cpp><br />
#pragma once<br />
#include <srtest.h><br />
<br />
/*! Brief description for MyTestUnit (optional)<br />
More detailed documentation goes here.<br />
<a href="http:\\myinfo.mysite.com\MyTestUnit.html">More Info</a><br />
*/<br />
<br />
<br />
class MyTestClass<br />
{<br />
public:<br />
/*! <br />
Description for Test_1 here. <br />
*/<br />
bool Test_1();<br />
<br />
/*! <br />
Description for Test_2 here. <br />
*/<br />
bool Test_2();<br />
};<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_class(MyTestClass)<br />
#endif<br />
</source><br />
<br />
<br />
== Test C-Classes ==<br />
Source documentation must relate to the structure that is used as the "C-Class" for the test unit. Since a C-Class uses function pointers to call its individual tests, test method documentation '''must''' be associated with the corresponding structure function pointer member. As such, method documentation for C-Classes must be in the header file.<br />
<br />
<br />
<source lang=c><br />
#pragma once<br />
#include <srtest.h><br />
<br />
/*! Brief description for my_c_class(optional)<br />
More detailed documentation goes here.<br />
*/<br />
typedef struct my_c_class<br />
{<br />
/*! <br />
Description for Test_1 here. <br />
*/<br />
int (*Test_1)(struct my_c_class* pcc);<br />
<br />
/*! <br />
Description for Test_2 here. <br />
*/ <br />
int (*Test_2)(struct my_c_class* pcc);<br />
} my_c_class;<br />
<br />
#ifdef __cplusplus<br />
extern "C" {<br />
#endif<br />
void my_c_class_init(struct my_c_class* pcc);<br />
#ifdef __cplusplus<br />
}<br />
#endif<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_cclass(my_c_class, my_c_class_init)<br />
#endif<br />
<br />
</source><br />
<br />
<br />
== Test FLists ==<br />
Since F-Lists have no specific storage entity (class or struct) to which they are associated. As such, the only way to provide unit-level documentation for FLists is to document the source file in which its methods are declared. The unit documentation is associated with its file using the '''\flist''' tag. Because of this restriction, we recommend that you generally confine each Test FList to it's own source file pair (.h and .c). The test methods associated with an FList are documented as expected, with the documentation block preceding the function declaration.<br />
<br />
<br />
(source file name is ''my_flist.h'' in the example below)<br />
<source lang=c><br />
#pragma once<br />
#include <srtest.h><br />
<br />
#ifdef __cplusplus<br />
extern "C" {<br />
#endif<br />
<br />
/*! <br />
\flist my_flist.h<br />
\brief Summary description for my_flist(optional)<br />
More detailed documentation goes here.<br />
*/<br />
<br />
/*! <br />
Description for Test_1 here. <br />
*/<br />
int Test_1();<br />
<br />
/*! <br />
Description for Test_2 here. <br />
*/<br />
int Test_2();<br />
<br />
#ifdef __cplusplus<br />
}<br />
#endif<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_flist("my_flist", Test_1, Test_2)<br />
#endif<br />
<br />
</source></div>Ivailophttps://www.stridewiki.com/index.php?title=Training_Tests_in_C/C%2B%2B&diff=14706Training Tests in C/C++2018-12-28T19:01:59Z<p>Ivailop: /* test_in_c_cpp/TestClass */</p>
<hr />
<div>== Background ==<br />
<br />
The STRIDE Framework provides support for implementation of tests in the native C/C++ of the device under test. Once written, these tests are compiled using the device toolchain and are harnessed, via the [[Intercept Module|STRIDE Intercept Module]], into one or more applications under test on the device. These tests have the unique advantage of executing in real-time on the device itself, allowing the tests to operate under actual device conditions during test.<br />
<br />
Please review the following reference articles before proceeding: <br />
<br />
* [[Test Units Overview|Overview]]<br />
* [[Test Units]]<br />
* [[Test Macros]]<br />
* [[Test Point Testing in C/C++|Test Point Testing]]<br />
* [[Test API | Test APIs]]<br />
<br />
== Why would I want to write tests in native code ? ==<br />
<br />
Here are some of the scenarios for which on-target test harnessing is particularly advantageous:<br />
<br />
* direct API testing. If you want to validate native APIs by driving the APIs directly, native code is the simplest way to do so. STRIDE provides convenient [[Test Macros|assertion macros]] to validate your variable states. API testing can also be combined with native test point tests (using [[Test Point]] instrumentation) to provide deeper validation of expected behavior of the units under test.<br />
* unit testing of C objects or C++ classes. The STRIDE native tests execute in the same context as the rest of your code, so it's possible to fully unit test any objects that can be created in your actual application code.<br />
* validation logic that requires sensitive timing thresholds. Sometimes it's only possible to validate tight timing scenarios on-target.<br />
* high-volume data processing scenarios. In some cases, the volume of data being processed and validated for a particular test scenario is to large to be easily handled by an off-target harness. In that case, native test units provide a convenient way to write tests that validate that data without shipping the data to the host during testing.<br />
<br />
What's more, you might simply ''prefer'' to write your test logic in C or C++ (as opposed to perl on the host). If that's the case, we don't discourage you from using a toolset that your more comfortable with - particularly if it enables you to start writing tests without a new language learning curve.<br />
<br />
== Are there any disadvantages ? ==<br />
<br />
Sure. Most of the disadvantages of native on-target tests concern the device build process. If your device build is particularly slow (on the order of hours or days), then adding and running new tests can become a tedious waiting game. Testing is always well served by shorter build cycles, and on-target tests are particularly sensitive to this. <br />
<br />
In some cases, the additional code space requirements of native tests is a concern, but this is also mitigated by ever-increasing device storage capacities. On platforms that support multiple processes (e.g. Linux or Windows), it's possible to bundle tests into one or more separate test process, which further mitigates the code space concern by isolating the test code in one or more separate applications.<br />
<br />
== Samples ==<br />
<br />
For this training, we will be using some of the samples provided in the [[C/C++_Samples]]. For any sample that we don't cover here explicitly, feel free to explore the sample yourself. All of the samples can be easily built and executed using the STRIDE [[Off-Target Environment]]. <br />
<br />
The first three samples that we cover are introductions to the different test unit packaging mechanisms that we support in STRIDE. A good overview of the pros and cons for each type is presented [[Test_Units#Test_Units|here]]. The fourth sample demonstrates test point testing in native code on target (i.e. both the generation and ''validation'' of the test points are done on target). The last sample covers [[File_Transfer_Services|file transfer services]]. The STRIDE file transfer APIs enable reading/writing of files on the host from the device under test and can be useful for implementing data driven test scenarios (for instance, media file playback).<br />
<br />
'''Note:''' each of the three packaging examples include samples that cover ''basic'' usage and more advanced reporting techniques (''runtimeservices''). We recommend for this training that you focus on the ''basic'' samples as they cover the important packaging concepts. The ''runtimeservices'' examples are relevant only if the built-in reporting techniques are not sufficient for your reporting needs.<br />
<br />
=== test_in_c_cpp/TestClass ===<br />
<br />
This sample shows the techniques available for packaging and writing test units using classes. If you have a C++ capable compiler, we recommend that you use test classes to package your unit tests, even if your APIs under test are C only. Review the source code in the directory and follow the sample description [[Test Class Samples|here]].<br />
<br />
''observations:''<br />
<br />
* all of these example classes have been put into one or more namespaces. This is just for organization purposes, mainly to avoid name collisions when built along with lots of other test classes. Your test classes are '''not''' required to be in namespaces, but it can be helpful in avoiding collisions as the number of tests in your system grows.<br />
* we've documented our test classes and methods using [https://en.wikipedia.org/wiki/Doxygen doxygen] style comments. This documentation is automatically extracted by our tools and added to the results report - more information about this feature is [[Test_API#Test_Documentation|here]]<br />
* you can optionally write test classes that inherit from a base class that we've defined ([[Runtime_Test_Services#class_srTest|stride::srTest]]). We recommend you start by writing your classes this way so that your classes will inherit some methods and members that make some custom reporting tasks simpler.<br />
* exceptions are generally handled by the STRIDE unit test harness, but can be disabled if your compiler does not support them (see ''s2_testclass_basic_exceptions_tests.h/cpp'').<br />
* parameterized tests are supported by test classes as well. In these tests, simple constructor arguments can be passed during execution and are available at runtime to the test unit. The STRIDE infrastructure handles the passing of the arguments to the device and the construction of the test class with these arguments. Parameterization of test classes can be a powerful way to expand your test coverage with data driven test scenarios (varying the input to a single test class).<br />
<br />
=== test_in_c_cpp/TestFList ===<br />
<br />
This sample demonstrates a simpler packaging technique that is appropriate for systems that support C compilation only (no C++). [[Test_Units#Test_Units|FLists]] are simple a collection of functions that are called in sequence. There is no shared state or data, unless you arrange to use global data for this purpose. Review the source code in the directory and follow the sample description [[Test Function List Samples|here]]. <br />
<br />
''observations:''<br />
<br />
* flist tests support setup/teardown fixturing, but '''not''' parameterization or exception handling.<br />
* we've again provided documentation using doxygen formatting for these samples. However, because there is no storage-class entity with which the docs are associated in an FList, there are some restrictions to the documentation, which you can read about [[Test_API#Test_FLists|here]].<br />
* notice how the [[Scl_test_flist|scl_test_flist pragma]] requires you to both create a name for the test unit (first argument) '''and''' explicitly list each test method that is part of the unit. This is one disadvantage of flist over a test class (the latter does not require explicit listing of each test since all conforming public methods are assumed to be test methods).<br />
<br />
=== test_in_c_cpp/TestCClass ===<br />
<br />
This sample demonstrates a more sophisticated (and complicated) packaging technique for systems that support C compilation only. [[Test_Units#Test_Units|Test C Classes]] are defined by a structure of function pointers (which may also include data) and an initialization function. Review the source code in the directory and follow the sample description [[Test CClass Samples|here]]. <br />
<br />
''observations:''<br />
<br />
* the [[Scl_test_cclass|scl_test_cclass pragma]] requires a structure of function pointers as well as an initialization function that is called prior to running the tests. The initialization function must take the c class structure pointer as it's first argument and it will assign values to all the function pointer elements as well as perform any other initialization tasks. The pragma also accepts an optional deinitialization function that will be called after test execution (if provided).<br />
* we've provided documentation using doxygen formatting for these samples. Because the test functions themselves are bound at runtime, the test documentation must be associated with the function pointer elements in the structure - read more [[Test_API#Test_C-Classes|here]].<br />
* parameterized tests are also supported by test c classes. Arguments to the initialization function that follow the structure pointer argument are considered constructor arguments and can be passed when running the test.<br />
* because the test methods are assigned to the structure members at runtime, it's possible (and recommended) to use statically scoped functions, so as not to pollute the global function space with test functions. That said, you are free to use any functions with matching signatures and linkage, regardless of scope.<br />
<br />
=== test_in_c_cpp/TestPoint ===<br />
<br />
This sample demonstrates how to do tests that validate [[Test_Point_Testing_in_C/C++|STRIDE Test Points]] - with native test code. Although test point validation tests can be written in host-based scripting languages as well, sometimes it's preferable to write (and execute) the test logic in native target code - for instance, when validating large or otherwise complex data payloads. Review the source code in the directory and follow the sample description [[Test Point Samples|here]]. <br />
<br />
''observations:''<br />
<br />
* test point tests can be packaged into a harness using any of the [[Test_Units#Test_Units|three types of test units]] that we support. In this case, we used an FList so that the sample could be used on systems that were not C++ capable.<br />
* one of two methods is used to process the test: [[Test_Point_Testing_in_C/C++#srTestPointWait|srTestPointWait]] or [[Test_Point_Testing_in_C/C++#srTestPointCheck|srTestPointCheck]]. The former is used to process test points as they happen (with a specified timeout) and the latter is used to process test points that have already occurred at the time it is called (post completion check).<br />
* due to the limitations of C syntax, it can be ugly to create the srTestPointExpect_t data, especially where user data validation is concerned (see the ''CheckData'' example, for instance).<br />
<br />
=== test_in_c_cpp/FileServices ===<br />
<br />
The FileServices sample demonstrates basic usage of the [[File_Transfer_Services|STRIDE File Transfer APIs]], which provide a way to transfer files to/from the host to the running device. All the data for the file transmission is done using STRIDE messaging between the STRIDE Runner on the host and the STRIDE Runtime on the device, so no additional communication ports are required to use these services. Review the source code in the directory and follow the sample description [[File Services Samples|here]].<br />
<br />
''observations:''<br />
<br />
* most of the functions return an integer status code which should be checked - any nonzero status indicates a failure. We wrote a macro for this sample (''fsASSERT'') that checks return codes and adds any errors to the report. You might choose to do something similar, depending on your needs.<br />
* the file transfer API has both byte and line oriented read/write functions. You can use whichever functions are most appropriate for your needs.<br />
* this sample uses the local filesystem ([http://en.wikipedia.org/wiki/Stdio stdio]) to write some data to a tempfile - however the STRIDE APIs are themselves buffer/byte oriented and don't require a local filesystem in general. If your device under test ''does'' have a filesystem, the STRIDE APIs can certainly be used to transfer resources to/from the device filesystem.<br />
<br />
=== Build the test app ===<br />
<br />
So that we can run these samples, let's now build an off target test app that contains the source under tests -- you can follow the generic steps [[Off-Target_Test_App#Copy_Sample_Source|described here]]. When copying the source, make sure you take all the source files from all four of the samples mentioned above.<br />
<br />
=== Run the tests ===<br />
<br />
Now launch the test app (if you have not already) and execute the runner with the following commands: <br />
<br />
''Test Class tests'':<br />
<pre><br />
stride --device="TCP:localhost:8000" --database="../out/TestApp.sidb" --run="s2_testclass::Basic::Exceptions; s2_testclass::Basic::Fixtures; s2_testclass::Basic::Parameterized; s2_testclass::Basic::Simple" --output=TestClass.xml <br />
</pre><br />
<br />
''Test FList tests'':<br />
<pre><br />
stride --device="TCP:localhost:8000" --database="../out/TestApp.sidb" --run="s2_testflist_basic_fixtures; s2_testflist_basic_simple" --output=FList.xml<br />
</pre><br />
<br />
''Test C Class tests'':<br />
<pre><br />
stride --device="TCP:localhost:8000" --database="../out/TestApp.sidb" --run="s2_testcclass_basic_fixtures; s2_testcclass_basic_parameterized(\"mystring\", 8); s2_testcclass_basic_simple" --output=CClass.xml<br />
</pre><br />
<br />
''Test Point tests'':<br />
<pre><br />
stride --device="TCP:localhost:8000" --database="../out/TestApp.sidb" --run="s2_testpoint_basic" --log_level=all --output=TestPoint.xml<br />
</pre><br />
<br />
''File Services tests'':<br />
<pre><br />
stride --device="TCP:localhost:8000" --database="../out/TestApp.sidb" --run="s2_fileservices_basic" --output=FileServices.xml<br />
</pre><br />
<br />
<br />
These commands will produce distinct result files for each run (per the ''--output'' command above). Please use these result files to peruse the results by opening each in your browser.<br />
<br />
=== Examine the results ===<br />
<br />
Open the result files created above and browse the results. <br />
<br />
''observations:''<br />
<br />
* the test documentation has been extracted (at compile time) and is attached to the results when the tests are executed. Most of the test suites/test cases should have documentation in the description field.<br />
* the test point tests cases show the test points that were encountered, information about failures (if any) and log messages (the latter only because we included the <tt>--log_level=all</tt> option when executing the runner).<br />
* The two parameterized tests -- s2_testcclass_parameterized'' and ''s2_testclass::Basic::Parameterized'' -- both pass. We passed explicit arguments to the former (on the stride command line above) while we allowed the default arguments (0/null for all) to be passed to the latter by not explicitly specifying how it was to be called.<br />
<br />
Explore all the results and make sure that the results meet your expectations based on the test source that you've previously browsed.<br />
<br />
=== Other Samples ===<br />
<br />
We've omitted a few samples from this training that cover more advanced and (perhaps) less widely used features. We encourage you to investigate these samples on your own if you are interested - in particular:<br />
<br />
* each of the test packaging samples (''TestClass'', ''TestCClass'', and ''TestFList'') includes examples of using the runtime test APIs to do more advanced reporting (dynamic suite creation, for example). These techniques are applicable for same data driven test scenarios.<br />
* the [[Test_Double_Samples|TestDouble sample]] shows how to use STRIDE Test Doubles to replace function dependencies at runtime, typically for the purpose of isolating functions under test. This can be a powerful technique, but also requires some up-front work on your part to enable it, as this sample demonstrates.<br />
<br />
[[Category: Training_OLD]]</div>Ivailophttps://www.stridewiki.com/index.php?title=Test_Class_Sample&diff=14705Test Class Sample2018-12-28T19:00:28Z<p>Ivailop: /* Observations */</p>
<hr />
<div>==Introduction==<br />
<br />
These examples cover the use of [[Scl test class|Test Classes]] to create logical groupings of test cases. For unit testing, one test class is typically created for each class under test, although more complicated scenarios often justify other arrangements. Test Classes require a c++ compiler.<br />
<br />
''NOTE:'' each of the example test classes is grouped in namespace corresponding to its category (e.g. ''Basic'' or ''Runtime Services''). This is something shown for organizational purposes only -- it is '''not''' a general requirement that test classes be placed into namespaces. <br />
<br />
==Tests Description==<br />
<br />
===Basic===<br />
<br />
These examples cover the simplest, easiest way to code a STRIDE test class. These examples use simple [http://en.wikipedia.org/wiki/Plain_Old_Data_Structures POD] return types to indicate status.<br />
<br />
====Basic::Simple====<br />
<br />
This example demonstrates passing and failing tests using the four primary integer types (int, bool, short, and char) that infer status from.<br />
<br />
====Basic::Fixtures====<br />
<br />
This example demonstrates how to use [[Test_Unit_Pragmas#Fixturing_Pragmas|setup and teardown]] fixtures. The setup and teardown methods are called immediately before and after the execution of each test method, respectively.<br />
<br />
====Basic::Exceptions====<br />
<br />
This example demonstrates exceptions thrown from a test method are caught by the intercept module and noted in the results. Any exception that is caught by the harness is assumed to indicate failure. If you want to write tests for expected exceptions, consider using our [[Test Macros#Exception_Macros|exception macros]]<br />
<br />
====Basic::Parameterized====<br />
<br />
This example demonstrates how to pass arguments to the constructor of your test unit. This is something that is useful when you want to run the same test scenario with different sets of input data, for instance, as described by [http://xunitpatterns.com/Parameterized%20Test.html this pattern].<br />
<br />
===Runtime Services===<br />
<br />
These examples cover basic usage of the [[Runtime_Test_Services#C_Test_Functions|Runtime Test Services API]] (as declared in srtest.h).<br />
<br />
====RuntimeServices::Simple====<br />
<br />
This example demonstrates how to use [[Runtime_Test_Services#srTestCaseSetStatus|srTestCaseSetStatus]] to set status and [[Runtime_Test_Services#srTestCaseAddAnnotation|srTestCaseAddAnnotation]] to add a comment.<br />
<br />
====RuntimeServices::Dynamic====<br />
<br />
This example demonstrates how to use [[Runtime_Test_Services#srTestSuiteAddCase|srTestSuiteAddCase]], [[Runtime_Test_Services#srTestSuiteAddAnnotation|srTestSuiteAddAnnotation]], and [[Runtime_Test_Services#srTestAnnotationAddComment|srTestAnnotationAddComment]] for dynamic case, and annotation creation in the context of a single test method.<br />
<br />
====RuntimeServices::Override====<br />
<br />
This example demonstrates how to use [[Runtime_Test_Services#srTestCaseSetStatus|srTestCaseSetStatus]] to override the status that would otherwise be inferred from the return value.<br />
<br />
====RuntimeServices::VarComment====<br />
<br />
This example demonstrates the use of [http://en.wikipedia.org/wiki/Printf printf] style format strings with [[Runtime_Test_Services#srTestCaseAddAnnotation|srTestCaseAddAnnotation]].<br />
<br />
===srTest===<br />
<br />
These examples show to how to use the [[Runtime_Test_Services#C.2B.2B_Test_Classes|stride::srTest]] base class for your test classes. When you publicly inherit from srTest, you get access to default testCase and testSuite members and their associated methods.<br />
<br />
====srTest::Simple====<br />
<br />
This example demonstrates the use of [[Runtime_Test_Services#SetStatus|testCase.setStatus]] to set the status for test cases.<br />
<br />
====srTest::Dynamic====<br />
<br />
This example demonstrates how to use [[Runtime_Test_Services#method_AddCase|AddCase]], [[Runtime_Test_Services#method_AddAnnotation_2|testCase.AddAnnotation]], and [[Runtime_Test_Services#method_AddComment|testAnnotation.AddComment]] for dynamic test case, and annotation creation within the context of one test method.<br />
<br />
== Run Tests ==<br />
<br />
Now launch the test app (if you have not already) and execute the runner with the following commands: <br />
<br />
''Test Class tests'':<br />
<pre><br />
stride --device="TCP:localhost:8000" --database="../out/TestApp.sidb" --run="s2_testclass::Basic::Exceptions; s2_testclass::Basic::Fixtures; s2_testclass::Basic::Parameterized; s2_testclass::Basic::Simple" --output=TestClass.xml <br />
</pre><br />
<br />
Note the command will produce distinct result files for the run (per the ''--output'' command above). Please use the result file to peruse the results by opening each in your browser.<br />
<br />
== Observations ==<br />
This sample shows the techniques available for packaging and writing test units using classes. If you have a C++ capable compiler, we recommend that you use test classes to package your unit tests, even if your APIs under test are C only. Review the source code in the directory and follow the sample description. <br />
<br />
The following are some test observations:<br />
* all of these example classes have been put into one or more namespaces. This is just for organization purposes, mainly to avoid name collisions when built along with lots of other test classes. Your test classes are '''not''' required to be in namespaces, but it can be helpful in avoiding collisions as the number of tests in your system grows.<br />
* we've documented our test classes and methods using [https://en.wikipedia.org/wiki/Doxygen doxygen] style comments. This documentation is automatically extracted by our tools and added to the results report - more information about this feature is [[Test_Documentation_in_C/C%2B%2B|here]]<br />
* you can optionally write test classes that inherit from a base class that we've defined ([[Runtime_Test_Services#class_srTest|stride::srTest]]). We recommend you start by writing your classes this way so that your classes will inherit some methods and members that make some custom reporting tasks simpler.<br />
* exceptions are generally handled by the STRIDE unit test harness, but can be disabled if your compiler does not support them (see ''s2_testclass_basic_exceptions_tests.h/cpp'').<br />
* parameterized tests are supported by test classes as well. In these tests, simple constructor arguments can be passed during execution and are available at runtime to the test unit. The STRIDE infrastructure handles the passing of the arguments to the device and the construction of the test class with these arguments. Parameterization of test classes can be a powerful way to expand your test coverage with data driven test scenarios (varying the input to a single test class).<br />
<br />
<br />
[[Category: Samples]]</div>Ivailophttps://www.stridewiki.com/index.php?title=S2scompile&diff=14704S2scompile2018-12-28T18:59:58Z<p>Ivailop: /* Options */</p>
<hr />
<div>__FORCETOC__<br />
== The SCL Compiler Utility ==<br />
<br />
The '''s2scompile''' executable will compile a set of scl files (C/C++ source files with [[SCL Pragmas]]) and produce a <tt>.meta</tt> file for each (assuming that compilation is successful).<ref>.meta files are binary-format intermediate files suitable for input to the [[s2sbind]] utility.</ref><br />
<br />
All warnings and errors that occur during the compilation are written to the standard output device. The compilation for a particular file is considered successful if no errors occur. Otherwise it is unsuccessful. Unsuccessful compilations do not yield <tt>.meta</tt> files.<br />
<br />
Options are validated and any incorrect options diagnosed will result in compilation process failure.<br />
<br />
=== Syntax ===<br />
s2scompile [<i>options</i>] <i>scl_file1</i> [<i>scl_fileN</i>]<br />
<br />
=== Options ===<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;background-color:#ffffcc;" <br />
!width="200pt"|'''Option'''<br />
!width="500pt"|'''Description'''<br />
|- <br />
| '''--version'''<br />
| Print version information.<br />
|- <br />
| '''--preprocess'''<br />
| Do preprocessing only. Write preprocessed text file to the output.<br />
|- <br />
| '''--dependencies'''<br />
| Do preprocessing only. Instead of the normal preprocessing output, generate in the preprocessing output file a list of dependency lines suitable for input to the UNIX make program. <br />
|-<br />
| '''--no_line_commands'''<br />
| Same as '''–-preprocess''' except that line number information is removed from the preprocessed output files.<br />
|-<br />
| '''--c++'''<br />
| Enable compilation of c++. <br />
|-<br />
| '''--c'''<br />
| Enable compilation of C (specifically C89). This is the default.<br />
|-<br />
| '''--include_directory='''<i><dir></i><br><br />
'''--sys_include='''<i><dir></i><br><br />
'''-I'''<i><dir></i><br />
| Add dir to the end of the list of directories searched for <tt>#include</tt>.<br />
|-<br />
| '''--no_stdinc'''<br />
| Do not search the standard system directories for header files. See [[#Search Path|Search Path]] for details.<br />
|-<br />
| '''--define_macro='''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br><br />
'''-D'''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br />
| Define macro <i><name></i> as <i>value</i>. If "=<i>value</i>" is omitted, define <i><name></i> as 1.<br />
|-<br />
| '''--undefine_macro='''<i><name></i><br><br />
'''-U'''<i><name></i><br />
| Remove predefined macro <i><name></i>.<br />
|-<br />
| '''--compatibility='''<i><string></i><br />
| Vendor compatibility mode. String can be "microsoft", "generic" or "gnu". Default is "generic". When "Microsoft" is set, the compiler supports a number of extensions to the C or C++ language that are compatible with the Microsoft family of compilers. "gnu" - instructs the compiler to support language extensions compatible with the Gnu family of compilers.<br />
|-<br />
| '''--no_warning'''<br />
| Suppress all warnings in the compilation phase.<br />
|-<br />
| '''--macros'''<br />
| Resolve macro (preprocessor define) constant value. Pass this flag only if you intend to do script based testing.<br />
|-<br />
| '''--documentation'''<br />
| Extract [https://en.wikipedia.org/wiki/Doxygen doxygen style] source documentation. <br />
|-<br />
| '''--output='''<i><path></i><br><br />
'''-o'''<path><br />
| Output file or directory. The default is the current directory.<br />
|-<br />
| '''--targ_big_endian'''<br />
| Target uses a big endian by representation. The default is little endian.<br />
|-<br />
| '''--targ_plain_char_is_unsigned'''<br />
| Target uses unsigned chars to represent “plain” char. The default is signed.<br />
|-<br />
| '''--targ_adaptive_enum'''<br />
| Target has adaptive enums. The default is no adaptive enums.<br />
|-<br />
| '''--targ_pack_alignment='''<i><align></i><br />
| Target struct pack alignment. The default is 16. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_char='''<i><size></i><br />
| Target platform size of char. Default is 1. Possible values are 1, 2, 4, 8, or 16.<br />
|-<br />
| '''--targ_alignof_char='''<i><align></i><br />
| Target platform alignment of char. Default is 1. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_short='''<i><size></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_alignof_short='''<i><align></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_sizeof_int='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_int='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_long='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long_long='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_long_long='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_float='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_float='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_double='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_long_double='''<i><size></i><br />
| Default is 8<br />
|-<br />
| '''--targ_alignof_long_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_bool_int_kind='''<i><typename></i><br />
| Default is "char".<br />
|-<br />
| '''--targ_wchar_t_int_kind='''<i><typename></i><br />
| Default is "unsigned short".<br />
|-<br />
| '''--targ_size_t_int_kind='''<i><typename></i><br />
| Default is "unsigned int".<br />
|-<br />
| '''--targ_ptrdiff_t_int_kind='''<i><typename></i><br />
| Default is "int".<br />
|-<br />
| '''--options_file='''<i><file></i><br />
| A file that contains command line options. The format is the same as the command line with the only addition that it could be split on multiple lines. A line starting with "#" or ";" symbol is ignored.<br />
This option is necessary if the length of the command line string exceeds system limits. Otherwise it is provided only as a convenience.<br />
<br />
'''''NOTE:''' To simplify the integration in existing build environments other standard compiler options (e.g. ARM [http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0491b/CHDCIEGC.html --via=<file>], GCC [http://gcc.gnu.org/onlinedocs/gcc/Overall-Options.html#Overall-Options @<file>], MSVC [http://msdn.microsoft.com/en-us/library/3te4xt0y(v=VS.90).aspx @<file>]) with similar meaning are also recognized and processed the same way.''<br />
|}<br />
<br />
'''Note''': The [[Framework_Setup#SDK|standard Platform SDKs]] shipped with the Framework contain a set of options files with predefined target settings for several popular CPUs. Please consider using one of them instead of explicitly passing <tt>--targ_*</tt> options on the command line.<br />
<br />
=== Search Path ===<br />
<b>s2scompile</b> by default looks in several different places for headers. It looks for headers requested with <tt>#include <file></tt> in:<br />
<pre><br />
$(STRIDE_DIR)/SDK/Runtime<br />
</pre><br />
<br />
Where $(STRIDE_DIR) is the location where the STRIDE packages are installed following [[Framework_Setup#Directories_and_Files|recommended directory layout]].<br />
<br />
When <i>microsoft</i> mode is specified and $(INCLUDE) enviroment variable is defined (as a ";" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>.<br />
<br />
When <i>gnu</i> mode is specified and $(CPATH) and/or $(C_INCLUDE_PATH) (or $(CPLUS_INCLUDE_PATH) for C++) enviroment variables are defined (as a ":" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>. In addition if $(TARGET_CPP) specifies the target GNU <tt>cpp</tt> (GCC preprocessor or a command line equivalent) it is queried and any given path by it is looked in.<br />
<br />
You can add to this list, before any of the default places, by using the <tt>-I<dir></tt> option.<br />
<br />
You can prevent s2scompile from searching any of the default directories with the <tt>--no_stdinc</tt> option. <tt>-I</tt> options are not ignored as described above when <tt>--no_stdinc</tt> is in effect. <br />
<br />
<b>s2scompile</b> looks for headers requested with <tt>#include "file"</tt> first in the directory containing the current file, then in the same places it would have looked for a header requested with angle brackets.<br />
<br />
=== Examples ===<br />
Refer to the [[Build_Tools#Compiling_multiple_files|Compiling]] section of the Build Tools Examples.<br />
<br />
=== Notes ===<br />
<references/><br />
[[Category:Build_Tools]]</div>Ivailophttps://www.stridewiki.com/index.php?title=Perl_Script_Snippets&diff=14703Perl Script Snippets2018-12-26T23:18:27Z<p>Ivailop: /* Accessing compiler macro values (constants) */</p>
<hr />
<div>__NOTOC__<br />
Below are some brief examples of script test modules that use the [[Perl Script APIs]] for Stride. Most of these examples are incomplete and are only intended to give a quick overview of how this API can be used. <br />
<br />
With any perl module that you write, we recommend that you perform a quick syntax check before attempting to execute the module using the Stride Runner. Syntax checking with warnings is easily accomplished by running with the <tt>-cw</tt> option, e.g.:<br />
<br />
* Windows<br />
perl -I %STRIDE_DIR%\lib\perl -I %STRIDE_DIR%\lib\perl\5.20 -cw MyTests.pm<br />
<br />
* Linux/FreeBSD<br />
perl -I $STRIDE_DIR/lib/perl -I $STRIDE_DIR/lib/perl/5.20 -cw MyTests.pm<br />
<br />
This will compile the perl script without running it, and it will emit any syntax errors that are found.<br />
<br />
== Canonical module format ==<br />
<br />
<source lang="perl"><br />
use strict;<br />
use warnings;<br />
<br />
package MyTests;<br />
use base qw(STRIDE::Test);<br />
use STRIDE::Test;<br />
<br />
sub test_one : Test<br />
{<br />
ASSERT_TRUE(1);<br />
}<br />
<br />
sub test_two : Test<br />
{<br />
ASSERT_TRUE(0);<br />
}<br />
<br />
1;<br />
</source><br />
<br />
== Subroutine attributes to declare test methods and fixtures ==<br />
<br />
<source lang="perl"><br />
<br />
sub a_test : Test {<br />
# test method<br />
}<br />
<br />
sub startup_method : Test(startup) {<br />
# startup fixturing<br />
}<br />
<br />
sub shutdown_method : Test(shutdown) {<br />
# shutdown fixturing<br />
}<br />
<br />
sub setup_method : Test(setup) {<br />
# setup fixturing<br />
}<br />
<br />
sub teardown_method : Test(teardown) {<br />
# teardown fixture<br />
}<br />
</source><br />
<br />
== Test module including POD documentation ==<br />
<br />
<source lang="perl"><br />
package MyTests;<br />
use base qw(STRIDE::Test);<br />
use STRIDE::Test;<br />
<br />
=head1 NAME<br />
<br />
MyTests - example tests<br />
<br />
=head1 DESCRIPTION<br />
<br />
This is MyTests_1, a deeply funky piece of Perl code.<br />
<br />
=head1 METHODS<br />
<br />
=cut<br />
<br />
<br />
=head2 test_one<br />
<br />
this is a simple "passing" test.<br />
<br />
=cut<br />
sub test_one : Test<br />
{<br />
ASSERT_TRUE(1);<br />
}<br />
<br />
<br />
=head2 test_two<br />
<br />
this is a simple "failing" test.<br />
<br />
=cut<br />
sub test_two : Test<br />
{<br />
ASSERT_TRUE(0);<br />
}<br />
<br />
1;<br />
</source><br />
<br />
== Simple expectation test ==<br />
<br />
<source lang="perl"><br />
sub sync_exact : Test { <br />
my $h = TestPointSetup(<br />
ordered => 1,<br />
expected => [<br />
"point a",<br />
"point b",<br />
"point c"<br />
],<br />
unexpected => [ TEST_POINT_EVERYTHING_ELSE ]<br />
);<br />
<br />
#...start source under test, if necessary<br />
<br />
# use Check if the events have all happened by the time <br />
# you validate the test points. Otherwise use Wait with <br />
# a reasonable timeout value.<br />
$h->Check(); <br />
}<br />
</source><br />
<br />
== Expectation test with predicate==<br />
<br />
Here's how to specify a predicate for validating a test point. The predicate <br />
shown is just a stub and doesn't do any actual validation.<br />
<br />
<source lang="perl"><br />
sub _myPredicate<br />
{<br />
my ($test_point, $expected_data) = @_;<br />
# $test_point is a hashref with the following fields:<br />
# label, data, size, bin, file, line<br />
# use the test point data to perform validation and return <br />
# nonzero value on success, 0 on failure.<br />
<br />
return 1;<br />
}<br />
<br />
sub use_a_predicate : Test {<br />
# use arrayref notation to specify label, count, predicate and expected data<br />
# if you want to specify a predicate. Predicates can be specified for some, all<br />
# or none of the test points. The fourth field is optional - it is just passed<br />
# to the predicate as the second argument and is typically used to specify some <br />
# expected data for the predicate to validate against. <br />
my $h = TestPointSetup(<br />
expected => [<br />
["point a", 1, \&_myPredicate, 54321],<br />
"point b",<br />
["point c", 1, \&_myPredicate]<br />
]<br />
);<br />
<br />
$h->Check(); <br />
}<br />
</source><br />
<br />
== Reusing a trace data file as expectation ==<br />
<br />
This examples shows a simple way to reuse captured YAML trace data from a file as your expectation (this is an alternative to specifying the <tt>expected</tt> array directly). This example assumes the ''trace_data.yml'' file lives in the same directory as the test module file, but you are free to change this - just change the <tt>expect_file</tt> argument accordingly.<br />
<br />
<source lang="perl"><br />
# these standard modules are only required for the file <br />
# path logic used to generate a full file path for trace_data.yml<br />
use File::Basename;<br />
use File::Spec;<br />
<br />
sub trace_data : Test { <br />
my $h = TestPointSetup(<br />
ordered => 1,<br />
expect_file => File::Spec->catfile(dirname(__FILE__), 'trace_data.yml'),<br />
);<br />
<br />
# make any function calls necessary to start the SUT, <br />
# then do a Check or Wait, depending on your scenario<br />
<br />
$h->Check(); <br />
}<br />
</source><br />
<br />
== Invoking a function on the target ==<br />
<br />
=== Standalone two-line script for invoking a remote function ===<br />
This simple script shows the minimal code required to make a remote function call of a function that has been enabled with the [[Scl_function | Function Pragrma]] enabling remoting. <br />
<source lang="perl"><br />
use STRIDE;<br />
$STRIDE::Remote->MyRemoteFunction();<br />
</source><br />
More functions can be added to this script by making additional calls using the <tt>$STRIDE::Remote</tt> object. If your remote function accepts arguments, they should be added to the function call parameters (see the [[Perl_Script_APIs#STRIDE::Remote|Perl API Reference]] for more information).<br />
<br />
=== Making calls with test modules ===<br />
<br />
Within test modules, remote functions can be easily invoked using the exported <tt>Remote</tt> object. The following two examples illustrate this.<br />
<br />
==== Blocking syntax (blocks until function returns) ====<br />
<br />
<source lang="perl"><br />
my $retval = Remote->foo(1, "input string");<br />
Remote->bar();<br />
</source><br />
<br />
==== asynchronous execution (return immediately, function continues to execute on device) ====<br />
<br />
<source lang="perl"><br />
my $fh = Remote->async->foo(1, "input string");<br />
my $retval = $fh->Wait(1000); #waits up to one second for the function to return<br />
</source><br />
<br />
== Accessing compiler macro values (constants) ==<br />
<source lang="c"><br />
/* some compilation unit included in the STRIDE compilation process */<br />
#define SOME_DEFINED_VALUE 42<br />
</source><br />
<br />
<source lang="perl"><br />
my $value = Constants->{SOME_DEFINED_VALUE};<br />
</source></div>Ivailophttps://www.stridewiki.com/index.php?title=Perl_Script_Snippets&diff=14702Perl Script Snippets2018-10-16T23:39:06Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
Below are some brief examples of script test modules that use the [[Perl Script APIs]] for Stride. Most of these examples are incomplete and are only intended to give a quick overview of how this API can be used. <br />
<br />
With any perl module that you write, we recommend that you perform a quick syntax check before attempting to execute the module using the Stride Runner. Syntax checking with warnings is easily accomplished by running with the <tt>-cw</tt> option, e.g.:<br />
<br />
* Windows<br />
perl -I %STRIDE_DIR%\lib\perl -I %STRIDE_DIR%\lib\perl\5.20 -cw MyTests.pm<br />
<br />
* Linux/FreeBSD<br />
perl -I $STRIDE_DIR/lib/perl -I $STRIDE_DIR/lib/perl/5.20 -cw MyTests.pm<br />
<br />
This will compile the perl script without running it, and it will emit any syntax errors that are found.<br />
<br />
== Canonical module format ==<br />
<br />
<source lang="perl"><br />
use strict;<br />
use warnings;<br />
<br />
package MyTests;<br />
use base qw(STRIDE::Test);<br />
use STRIDE::Test;<br />
<br />
sub test_one : Test<br />
{<br />
ASSERT_TRUE(1);<br />
}<br />
<br />
sub test_two : Test<br />
{<br />
ASSERT_TRUE(0);<br />
}<br />
<br />
1;<br />
</source><br />
<br />
== Subroutine attributes to declare test methods and fixtures ==<br />
<br />
<source lang="perl"><br />
<br />
sub a_test : Test {<br />
# test method<br />
}<br />
<br />
sub startup_method : Test(startup) {<br />
# startup fixturing<br />
}<br />
<br />
sub shutdown_method : Test(shutdown) {<br />
# shutdown fixturing<br />
}<br />
<br />
sub setup_method : Test(setup) {<br />
# setup fixturing<br />
}<br />
<br />
sub teardown_method : Test(teardown) {<br />
# teardown fixture<br />
}<br />
</source><br />
<br />
== Test module including POD documentation ==<br />
<br />
<source lang="perl"><br />
package MyTests;<br />
use base qw(STRIDE::Test);<br />
use STRIDE::Test;<br />
<br />
=head1 NAME<br />
<br />
MyTests - example tests<br />
<br />
=head1 DESCRIPTION<br />
<br />
This is MyTests_1, a deeply funky piece of Perl code.<br />
<br />
=head1 METHODS<br />
<br />
=cut<br />
<br />
<br />
=head2 test_one<br />
<br />
this is a simple "passing" test.<br />
<br />
=cut<br />
sub test_one : Test<br />
{<br />
ASSERT_TRUE(1);<br />
}<br />
<br />
<br />
=head2 test_two<br />
<br />
this is a simple "failing" test.<br />
<br />
=cut<br />
sub test_two : Test<br />
{<br />
ASSERT_TRUE(0);<br />
}<br />
<br />
1;<br />
</source><br />
<br />
== Simple expectation test ==<br />
<br />
<source lang="perl"><br />
sub sync_exact : Test { <br />
my $h = TestPointSetup(<br />
ordered => 1,<br />
expected => [<br />
"point a",<br />
"point b",<br />
"point c"<br />
],<br />
unexpected => [ TEST_POINT_EVERYTHING_ELSE ]<br />
);<br />
<br />
#...start source under test, if necessary<br />
<br />
# use Check if the events have all happened by the time <br />
# you validate the test points. Otherwise use Wait with <br />
# a reasonable timeout value.<br />
$h->Check(); <br />
}<br />
</source><br />
<br />
== Expectation test with predicate==<br />
<br />
Here's how to specify a predicate for validating a test point. The predicate <br />
shown is just a stub and doesn't do any actual validation.<br />
<br />
<source lang="perl"><br />
sub _myPredicate<br />
{<br />
my ($test_point, $expected_data) = @_;<br />
# $test_point is a hashref with the following fields:<br />
# label, data, size, bin, file, line<br />
# use the test point data to perform validation and return <br />
# nonzero value on success, 0 on failure.<br />
<br />
return 1;<br />
}<br />
<br />
sub use_a_predicate : Test {<br />
# use arrayref notation to specify label, count, predicate and expected data<br />
# if you want to specify a predicate. Predicates can be specified for some, all<br />
# or none of the test points. The fourth field is optional - it is just passed<br />
# to the predicate as the second argument and is typically used to specify some <br />
# expected data for the predicate to validate against. <br />
my $h = TestPointSetup(<br />
expected => [<br />
["point a", 1, \&_myPredicate, 54321],<br />
"point b",<br />
["point c", 1, \&_myPredicate]<br />
]<br />
);<br />
<br />
$h->Check(); <br />
}<br />
</source><br />
<br />
== Reusing a trace data file as expectation ==<br />
<br />
This examples shows a simple way to reuse captured YAML trace data from a file as your expectation (this is an alternative to specifying the <tt>expected</tt> array directly). This example assumes the ''trace_data.yml'' file lives in the same directory as the test module file, but you are free to change this - just change the <tt>expect_file</tt> argument accordingly.<br />
<br />
<source lang="perl"><br />
# these standard modules are only required for the file <br />
# path logic used to generate a full file path for trace_data.yml<br />
use File::Basename;<br />
use File::Spec;<br />
<br />
sub trace_data : Test { <br />
my $h = TestPointSetup(<br />
ordered => 1,<br />
expect_file => File::Spec->catfile(dirname(__FILE__), 'trace_data.yml'),<br />
);<br />
<br />
# make any function calls necessary to start the SUT, <br />
# then do a Check or Wait, depending on your scenario<br />
<br />
$h->Check(); <br />
}<br />
</source><br />
<br />
== Invoking a function on the target ==<br />
<br />
=== Standalone two-line script for invoking a remote function ===<br />
This simple script shows the minimal code required to make a remote function call of a function that has been enabled with the [[Scl_function | Function Pragrma]] enabling remoting. <br />
<source lang="perl"><br />
use STRIDE;<br />
$STRIDE::Remote->MyRemoteFunction();<br />
</source><br />
More functions can be added to this script by making additional calls using the <tt>$STRIDE::Remote</tt> object. If your remote function accepts arguments, they should be added to the function call parameters (see the [[Perl_Script_APIs#STRIDE::Remote|Perl API Reference]] for more information).<br />
<br />
=== Making calls with test modules ===<br />
<br />
Within test modules, remote functions can be easily invoked using the exported <tt>Remote</tt> object. The following two examples illustrate this.<br />
<br />
==== Blocking syntax (blocks until function returns) ====<br />
<br />
<source lang="perl"><br />
my $retval = Remote->foo(1, "input string");<br />
Remote->bar();<br />
</source><br />
<br />
==== asynchronous execution (return immediately, function continues to execute on device) ====<br />
<br />
<source lang="perl"><br />
my $fh = Remote->async->foo(1, "input string");<br />
my $retval = $fh->Wait(1000); #waits up to one second for the function to return<br />
</source><br />
<br />
== Accessing compiler macro values (constants) ==<br />
<source lang="c"><br />
/* some compilation unit included in the STRIDE compilation process */<br />
#define SOME_DEFINED_VALUE 42<br />
</source><br />
<br />
<source lang="perl"><br />
my $value = Remote->SOME_DEFINED_VALUE;<br />
</source></div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14701Release Notes2018-08-13T22:20:28Z<p>Ivailop: /* 5.0.02p */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifiers.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14700Release Notes2018-08-13T22:20:10Z<p>Ivailop: /* 5.0.02o */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable tp process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
=== 5.0.02p ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to process "static_assert" C++11 specifiers.<br />
* [[s2scompile|STRIDE Compiler]] is unable to process SCL defined via "_Pragma" operator.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Test_Pragmas&diff=14699Test Pragmas2018-07-17T20:55:43Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
Test Unit [http://en.wikipedia.org/wiki/Directive_(programming) pragmas] are a set of compiler directives that allow annotations within C and C++ source files that are meaningful to the Stride Build Tools but '''ignored''' by standard C/C++ compilers. During the build process the [[Build Tools]] generates an [[Intercept Module]] that provides [http://en.wikipedia.org/wiki/Test_harness harnessing] for the tests. Refer to the following header file that contains the ''scl_test_class'' pragma.<br />
<br />
'''Header file'''<br />
<source lang=cpp><br />
#include <srtest.h><br />
<br />
class MyTest : public stride::srTest {<br />
public: <br />
void CheckFoo();<br />
void CheckBoo();<br />
};<br />
#pragma scl_test_class(MyTest)<br />
</source><br />
<br />
<br />
== scl_test_class ==<br />
<br />
The ''scl_test_class'' pragma is used to declare a C++ class as a '''Test Unit'''.<br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_test_class(class-name)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''class-name''<br />
| Identifier<br />
| The name of the test unit. This must be the name of an existing C++ class or a struct.<br />
|}<br />
<br />
=== Notes ===<br />
* This pragma requires the compilation language to be C++. If the compilation language is not C++ and this pragma is encountered, then an error is issued and this pragma is ignored.<br />
<br />
* The test class identified:<br />
** must have single public constructor - default or explicit.<br />
** must not be a templated class<br />
** must not be a nested class<br />
** must not be a pure virtual class<br />
** must have one or more member functions that is suitable as a test method. For a member function to be a test method it:<br />
*** must be declared within the test class (a method that is inherited from a base class cannot be a test method)<br />
*** must be declared with public access<br />
*** must have a return type of bool, an integral type (signed or unsigned long, int, short, char) or void.<br />
*** must have an empty parameter list - declared as f() or f(void).<br />
*** must not be a templatized function<br />
*** must not be an overloaded operator<br />
*** must not be a static member.<br />
<br />
* Optionally if desired a set of setup/teardown fixtures could be applied.<br />
<br />
* Optionally if desired the public constructor may have arguments (they must all be of [http://en.wikipedia.org/wiki/Null-terminated_string C-string] and numeric types).<br />
<br />
=== Examples ===<br />
<source lang=cpp><br />
#include <srtest.h><br />
<br />
class MyOtherTest : public stride::srTest<br />
{<br />
public:<br />
// Declaring a constructor for an scl_test_class is optional, but<br />
// if a constructor is declared all arguments must be of plain old data (POD) type.<br />
MyOtherTest(int i, const char* s);<br />
<br />
void CheckItOut();<br />
};<br />
#ifdef _SCL <br />
#pragma scl_test_class(MyOtherTest)<br />
#endif<br />
</source><br />
<br />
<br />
== scl_test_cclass ==<br />
<br />
The ''scl_test_cclass'' pragma is used to declare a "C" language struct (class) to be captured as a '''Test Unit'''. <br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_test_cclass(cclass-name, init-function-name { , deinit-function-name })<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| width="180" | '''Parameters'''<br />
| width="60" | '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''cclass-name''<br />
| Identifier<br />
| The name of the test unit. This is must be the name of an existing struct in C/C++ or a class in C++.<br />
|-<br />
| ''init-function-name''<br />
| Identifier<br />
| The initialization function name. This is synonymous with a class constructor. There must be a prior user-declared function with this name. The first parameter must be a pointer to cclass-name. Additional parameters are left up to the user's implementation.<br />
|-<br />
| ''deinit-function-name (optional)''<br />
| Identifier<br />
| The deinitialization function name. This is synonymous with a class destructor. If declared, there must be a user-declared function with this name. The first parameter must be a pointer to cclass-name. Additional parameters are left up to the user's implementation.<br />
|}<br />
<br />
=== Notes ===<br />
* The cclass-name identified:<br />
** may not appear as a specifier of a prior pragma.<br />
** must be a struct in C.<br />
** must be either a struct or class in C++.<br />
** must be [http://en.wikipedia.org/wiki/Plain_Old_Data_Structures POD] type.<br />
** must not be a template class.<br />
** must not be a nested class.<br />
** must contain at least one member function pointer with a prototype that:<br />
*** returns integral type: void, int, or bool (bool accepted only for C++). <br />
*** has a first parameter that is a pointer to cclass-name.<br />
<br />
* The init-function-name identified:<br />
** must be declared prior to this pragma's declaration.<br />
** must not have been used in any prior or subsequent SCL pragma.<br />
** must have its first parameter declared as a pointer to the identified cclass.<br />
** optionally if desired it may have additional parameters (they must all be of [http://en.wikipedia.org/wiki/Null-terminated_string C-string] and numeric types). <br />
<br />
* The deinit-function-name:<br />
** is optional.<br />
** must be declared prior to this pragma's declaration if it appears in pragma.<br />
** must not have been used in any prior or subsequent SCL pragma.<br />
** must have its first parameter declared as a pointer to the identified class.<br />
<br />
* Optionally if desired a set of setup/teardown fixtures could be applied.<br />
<br />
=== Examples ===<br />
<source lang=c><br />
#include <srtest.h><br />
<br />
typedef struct CClass_Basic_Simple {<br />
int (*pf_TestMethod)(struct CClass_Basic_Simple* pcc);<br />
} CClass_Basic_Simple;<br />
<br />
#ifdef __cplusplus<br />
extern "C" {<br />
#endif<br />
void CClass_Basic_Simple_init(struct CClass_Basic_Simple* pcc);<br />
#ifdef __cplusplus<br />
}<br />
#endif<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_cclass(CClass_Basic_Simple, CClass_Basic_Simple_init)<br />
#endif<br />
</source><br />
<br />
<br />
== scl_test_flist ==<br />
<br />
The ''scl_test_flist'' pragma is used to declare a list of external functions as a '''Test Unit'''. <br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_test_flist(test-unit-name, function-1, function-2..n)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''test-unit-name''<br />
| String<br />
| The name of the test unit. A special '''identifier''' with that name will be synthesized into which the list of external functions will be assembled. <br />
'''''Note:''' this string may not contain a space.''<br />
|- <br />
| ''function-1''<br />
| Identifier<br />
| Name of the first external function to be captured.<br />
|- <br />
| ''function-2..n [Optional]''<br />
| Identifier<br />
| Optional names of second and subsequent external functions to be captured.<br />
|}<br />
<br />
=== Notes ===<br />
<br />
* The external functions must meet the following conditions:<br />
** Their parameter lists must be empty (void).<br />
** They cannot be overloaded.<br />
** They cannot be overloaded operators.<br />
** They may not be template functions.<br />
** They may throw exceptions when compiled in CPP mode.<br />
** They cannot have been previously captured with the ''scl_function'' pragram or the ''scl_test_flist'' pragma. <br />
** They cannot be ''public static class methods''. <br />
** They must return a pass/fail result. The return type may be declared void or an integer type (bool is acceptable in C++ mode). If void is the return type, any calls to the test function default to successful.<br />
<br />
* Once an external function has been captured with scl_test_flist, that function may not then be captured again with the ''scl_function'' pragma, or the ''scl_test_flist'' pragma, or used with any other qualification pragmas.<br />
* Use of this pragma requires an include of ''srtest.h''.<br />
* The test-unit-name may not have been specified with a prior scl_test_flist pragma.<br />
* The test-unit-name may not be the name of an existing routine.<br />
* Optionally if desired a set of setup/teardown fixtures could be applied.<br />
<br />
=== Examples ===<br />
<source lang=c><br />
#include <srtest.h><br />
<br />
#ifdef __cplusplus<br />
extern "C" {<br />
#endif<br />
<br />
int test1();<br />
int test2();<br />
<br />
#ifdef __cplusplus<br />
}<br />
#endif<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_flist("Foo", test1, test2)<br />
#endif<br />
</source><br />
<br />
<br />
== scl_test_setup ==<br />
<br />
The ''scl_test_setup'' pragma declares a member method to be a setup fixture for an existing '''Test Unit'''. The setup method will be called before the execution of each test method.<br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_test_setup(test-unit-name, function-name)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''test-unit-name''<br />
| Identifier<br />
| Name of a captured test unit.<br />
|- <br />
| ''function-name''<br />
| Identifier<br />
| Name of a member function of the test unit to be used as a setup fixture. <br />
|}<br />
<br />
=== Notes ===<br />
* This pragma identifies the setup fixture of an existing test unit, i.e. either a class with ''scl_test_class'' applied to it, a set of functions with ''scl_test_flist'' applied to it, or a C struct with ''scl_test_cclass'' applied to it.<br />
* There may be only one setup fixture per test unit.<br />
<br />
=== Example ===<br />
<source lang=cpp><br />
#include <srtest.h><br />
<br />
class MyTest {<br />
public:<br />
void FooSetup();<br />
void CheckFoo();<br />
};<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_class(MyTest)<br />
#pragma scl_test_setup(MyTest, FooSetup)<br />
#endif<br />
</source><br />
<br />
<br />
== scl_test_teardown ==<br />
<br />
The ''scl_test_teardown'' pragma declares a member method to be a teardown fixture for an existing '''Test Unit'''. The teardown method will be called after the execution of each test method.<br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_test_teardown(test-unit-name, function-name)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''test-unit-name''<br />
| Identifier<br />
| Name of a captured test unit.<br />
|- <br />
| ''function-name''<br />
| Identifier<br />
| Name of a member function of the test unit to be used as a teardown fixture. <br />
|}<br />
<br />
=== Notes ===<br />
* This pragma identifies the setup fixture of an existing test unit, i.e. either a class with ''scl_test_class'' applied to it, a set of functions with ''scl_test_flist'' applied to it, or a C struct with ''scl_test_cclass'' applied to it.<br />
* There may be only one teardown fixture per test unit.<br />
<br />
=== Example ===<br />
<source lang=cpp><br />
class MyTest {<br />
public:<br />
void FooSetup();<br />
void FooTeardown();<br />
void CheckFoo();<br />
};<br />
<br />
#ifdef _SCL<br />
#pragma scl_test_class(MyTest)<br />
#pragma scl_test_setup(MyTest, FooSetup)<br />
#pragma scl_test_teardown(MyTest, FooTeardown)<br />
#endif<br />
</source></div>Ivailophttps://www.stridewiki.com/index.php?title=Pragmas&diff=14698Pragmas2018-07-17T20:48:09Z<p>Ivailop: </p>
<hr />
<div>The Stride pragmas are designed to allow annotation of C/C++ language constructs in such a way as to identify and define messages, function calls, and test units so that they can be transparently intercepted and remoted. During the build process the [[Build Tools | Stride Build Tools]] generate [[Intercept Module]] that provides [http://en.wikipedia.org/wiki/Test_harness harnessing] for the test. <br />
<br />
For details regarding the supported pragmas refer to [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]] document.<br />
<br />
== scl_function ==<br />
The ''scl_function'' pragma allows the user to capture a function. When captured for the purpose of interception ('''intercept-able''') the optional arguments are used to specify how the intercept should be executed.<br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_function(function-name [,context][, name-mangling][, group-id])<br />
<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''function-name''<br />
| Identifier<br />
| Name of the function to capture.<br />
|-<br />
| ''context''<br />
| String<br />
| Optional. Context in which the function is going to be intercepted. Possible values are ''"REFERENCE"'' - intercept at the function call (i.e. where the function is called) or ''"DEFINITION"'' - intercept at the function definition (i.e. where the function is implemented).<br />
|-<br />
| ''name-mangling''<br />
| String<br />
| Optional. Type of [[Name_Mangling|name mangling]] to be used when intercepted. Possible values are ''"EXPLICIT"'' or ''"IMPLICIT"''. If the ''context'' argument is defined the default will be '''IMPLICIT'''. Note that if '''EXPLICIT''' is set the '''srTEST_INTERCEPT('''<function_name>''')''' macro is required. <br />
|-<br />
| ''group-id''<br />
| String<br />
| Optional. User defined identifier representing the group to which this function belongs when enabling interception. The default ''group-id'' is set to '''STRIDE_TEST_GROUP'''. <br />
|}<br />
<br />
<br />
=== Notes ===<br />
* The function must be declared as a designator with external linkage. <br />
* A compilation error is reported if an attempt is made to capture a function more than once.<br />
<br />
=== Examples ===<br />
Using the default "IMPLICIT" ''name-mangling'' and "STRIDE_TEST_GROUP" ''group-id'' when capturing <code>boo()</code><br />
<source lang=c><br />
int foo(int x);<br />
<br />
void boo(void);<br />
<br />
#pragma scl_function(foo)<br />
#pragma scl_function(boo, "DEFINITION")<br />
</source><br />
<br />
<br />
Setting a specific ''name-mangling'' and ''group-id''<br />
<source lang=c><br />
void boo(void);<br />
<br />
#pragma scl_function(boo, "DEFINITION", "IMPLICIT", "MY_TEST_GROUP")<br />
</source><br />
<br />
<br />
== scl_cast == <br />
Constraining is the transformation of a data type so that it behaves like another data type. There are two forms of constraining: type constraining and value constraining (see ''scl_values'' pragma). <br />
<br />
Type constraining, as in the C language, has a source type and a destination type. The source type is the data type that is originally specified (e.g., written in the header file). The destination type is the data type into which the source type is being transformed. <br />
<br />
The scl_cast pragma is used for type constraining. It would commonly be used to map enumerations to other types, or to map a void pointer. The STRIDE host environment treats the constrained (or casted) field as if it were the new type, but the original type size is maintained.<br />
<br />
=== Syntax ===<br />
The following form changes the type inside the specified container (the function or structure):<br />
#pragma scl_cast(global-type-specifier, cast-type)<br />
<br />
The following form changes the type globally:<br />
#pragma scl_cast(container-specifier, field-specifier, cast-type)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''container-specifier''<br />
| String<br />
| Name of the container of the field to be cast<br />
|-<br />
| ''field-specifier''<br />
| String<br />
| Name of the field to be cast<br />
|- <br />
| ''cast-type''<br />
| String<br />
| Name of the new type for the cast result<br />
|- <br />
| ''global-type-specifier''<br />
| String<br />
| Name of the global type to be cast<br />
|}<br />
<br />
=== Notes ===<br />
* scl_cast() can only be used to cast items that are of exactly the same size.<br />
* scl_cast() can only be applied to the integral type and pointer type instances, or typedef names for integral types or pointer types. The type-specifier must designate a pointer type or integral type.<br />
* scl_cast() can be used to cast a data item of type void* to a union type, if all members of the union are of type pointer.<br />
* scl_cast() cannot be applied to bit fields.<br />
* An error will result if scl_cast() is applied to a set of runtime values that intersects with the set of values explicitly specified by any pragma that has appeared earlier (by way of lexical position) in the source code. In other words, scl_cast() cannot be used to "cast away" information conveyed by previous pragmas. (Refer to section 1.2.16, Absolute Specifiers, in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]] for a description and definition of runtime value sets.)<br />
<br />
=== Examples ===<br />
<br />
==== Example 1 ====<br />
<source lang=c><br />
int func(void *p); <br />
<br />
#pragma scl_function(func)<br />
#pragma scl_cast(func, p, int *)<br />
</source><br />
<br />
==== Example 2 ====<br />
<source lang=c><br />
typedef unsigned int u32_t; <br />
typedef enum <br />
{<br />
ONE = 1, <br />
TWO = 2, <br />
THREE = 3<br />
} numbers_e; <br />
<br />
// cast occurrences of u32_t to numbers_e<br />
#pragma scl_cast(u32_t, numbers_e)<br />
<br />
int func(u32_t x); <br />
#pragma scl_function(func)<br />
</source><br />
<br />
<br />
== scl_conform ==<br />
The scl_conform pragma allows the user to define a conformant array within a payload. The payload can be a C structure or a parameter declaration list. The conformant array must be the last item in the payload (e.g., the last field in the structure, or the last parameter in the declaration list). Because of this, only the payload name and the name of the size field in that payload are required. The SCL compiler automatically assumes the conformant array field within the specified payload. <br />
<br />
NOTE: ''For an alternative use case of sized structure please look at scl_struct_sized pragma''.<br />
<br />
=== Syntax ===<br />
#pragma scl_conform(name, size-name, max-size)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''name''<br />
| String<br />
| Name of the structure or function that encapsulates the conformant array<br />
The following restrictions apply:<br />
* The structure type may not be pointed to by a sized pointer.<br />
* The structure type may not be used in an array.<br />
* The structure type may not be a member of an union.<br />
* The structure type may not be a member of any other structure unless it is the last member.<br />
* The structure type may not be passed as a formal parameter or return value of a function (but a pointer to it is allowed).<br />
* The structure type cannot reside within OUT memory block.<br />
|- <br />
| ''size-name''<br />
| Member<br />
| Name of the structure field or function parameter that contains the size of the array<br />
The following restrictions apply:<br />
* The type of the size-name must be an integral type.<br />
* The size-field must reside within the same payload block as the structure or the function payload.<br />
|- <br />
| ''max-size''<br />
| Integer<br />
| Maximum size of the conformant array<br />
|}<br />
<br />
<br />
=== Example ===<br />
<source lang=c><br />
/* Constant defining the maximum array size */<br />
#define MAX_BUFFER_SIZE 20<br />
<br />
/* Structure defining a message payload with a conformant array */<br />
/* The array field must be the last member in the payload */<br />
typedef struct {<br />
int f1;<br />
short bufferSize;<br />
char buffer[1];<br />
} CmdPayload_t;<br />
<br />
/* Use the scl_conform pragma to define the conformant arrays */<br />
#pragma scl_conform( CmdPayload_t, bufferSize, MAX_BUFFER_SIZE )<br />
</source><br />
<br />
<br />
== scl_ptr ==<br />
<br />
The scl_ptr pragma is used to identify a pointer data type and assign it pointer-specific attributes, such as marshaling direction and memory usage. <br />
<br />
=== Syntax ===<br />
#pragma scl_ptr(type-name, direction, usage)<br />
<br />
#pragma scl_ptr(type-name, field-name, direction, usage)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''type-name''<br />
| Type<br />
| Name of the type that contains the pointer. The container type can be a structure, union, the pointer type itself, or a function. If the container type is a structure or union, the pointer is a member and the field-name must be specified. If the container type is a function, then the pointer is a parameter and the field-name must be specified.<br />
|- <br />
| ''field-name [Optional]''<br />
| Member<br />
| Name of the pointer field, which may be a member field contained within a structure/union, or a parameter in the ParameterList of a function. <br />
|- <br />
| ''direction''<br />
| String<br />
| Direction in which the pointer data is marshaled; refer to the Pointer Direction Table below. This affects read and write access to the pointer data.<br />
|- <br />
| ''usage''<br />
| String<br />
| Pointer usage indicator; refer to the Pointer Memory Usage Table below.<br />
|} <br />
<br />
'''Pointer Direction Table'''<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Value'''<br />
| '''Meaning'''<br />
|- <br />
| ''"IN"''<br />
| Specifies that the pointer memory can be used only as input to the receiver of the pointer. The Owner of the interface may only consider this read-only memory.<br />
|-<br />
| ''"OUT"''<br />
| Specifies that the pointer memory can be used to output information. The memory is allocated by the User and only written to by the Owner.<br />
|-<br />
| ''"INOUT"''<br />
| Specifies that the pointer memory can be used as both input and output. The User may send in data when sending the command (or calling the function), and may read the Owner’s output upon receipt of the response (or return of the function).<br />
|-<br />
| ''"RETURN"''<br />
| Specifies that the pointer memory may be read by the User of the interface. The User may only consider this as read-only memory and must not free it.<br />
|-<br />
| ''"INRETURN"''<br />
| Specifies that the pointer memory is allocated by both user and owner. There is no single block of memory pointed to by an "INRETURN" pointer. Rather there is one block on the call (or message send) and a second block on the return (or completion of the two-way message). Thus the first block has the characteristics of an "IN" block and the second the characteristics of a "RETURN" block.<br />
|}<br />
<br />
'''Pointer Memory Usage Table'''<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Value'''<br />
| '''Meaning'''<br />
|- <br />
| ''"PRIVATE"''<br />
| Pointer memory is private and may not be released by the Reader.<br />
|- <br />
| ''"POOL"''<br />
| Pointer memory is created from common pool and must be released by the Reader. <br />
|}<br />
<br />
=== Notes ===<br />
* A compiler error will be reported if an pointer does not point to a fixed size type.<br />
* Response payloads cannot use the "OUT" or "INOUT" direction.<br />
* Pointers with "OUT" or "INOUT" direction cannot indicate POOL pointer usage.<br />
* One-way messages (command and response) cannot have data that contains an "OUT" or "INOUT" Pointer.<br />
* The pointers declared type cannot be pointer to void; e.g., void *. This is considered an opaque pointer.<br />
* For additional information on scl_ptr, including constraints, refer to the section on scl_ptr in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br />
<br />
=== Examples ===<br />
<br />
Two examples using the scl_ptr pragma are shown below:<br />
<br />
# The first example uses the scl_ptr pragma to assign pointer attributes to a structure member and a parameter list member.<br />
# The second example uses the scl_ptr pragma to assign pointer attributes to type definitions.<br />
<br />
==== Example 1 ====<br />
<source lang=c><br />
/* Typedef defining a structure with a member of type pointer to char */<br />
typedef struct<br />
{<br />
int f1;<br />
char * f2;<br />
}data_t;<br />
<br />
/* Function prototype with an "INOUT" pointer of type data_t */<br />
void modifyData( data_t * p );<br />
<br />
/* Use the scl_function pragma to associate a SUID with the function ModifyData */<br />
#pragma scl_function( modifyData )<br />
/* Use the scl_ptr pragma to define the member f2 as a "RETURN" pointer */<br />
#pragma scl_ptr( data_t.f2, "OUT", "PRIVATE" )<br />
/* Use the scl_ptr pragma to define the parameter p as an "INOUT" pointer */<br />
#pragma scl_ptr( modifyData.p, "INOUT", "PRIVATE" ) <br />
</source><br />
<br />
==== Example 2 ====<br />
<source lang=c><br />
/* Typedef defining a pointer as a status type */<br />
typedef int * StatusCode;<br />
<br />
/* Apply scl_ptr to the StatusCode type. It is always an "OUT" pointer type */<br />
#pragma scl_ptr ( StatusCode, "OUT", "PRIVATE" );<br />
<br />
/* Prototype defining a function that returns a pointer to the data structure */<br />
void GetStatus( StatusCode outCode );<br />
<br />
/* Mark getStatus as an SCL-compliant function */<br />
#pragma scl_function ( GetStatus );<br />
</source><br />
<br />
<br />
== scl_ptr_flist ==<br />
<br />
The scl_ptr_flist() pragma is used to specify the candidate functions that are available for a specific function pointer data type.<br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_ptr_flist(type-name, default-name)<br />
<br />
#pragma scl_ptr_flist(type-name, field-name, default-name)<br />
<br />
#pragma scl_ptr_flist(type-name, candidate-1, candidate-2..n)<br />
<br />
#pragma scl_ptr_flist(type-name, field-name, candidate-1, candidate-2..n)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''type-name''<br />
| String<br />
| Name of the type that contains the function pointer<br />
|- <br />
| ''field-name''<br />
| Member<br />
| Name of the pointer member within the struct/union or in the parameter list of the function<br />
|- <br />
| ''candidate-1''<br />
| String<br />
| Name of the candidate function<br />
|-<br />
| ''candidate-2..n [Optional]''<br />
| String<br />
| Optional name(s) of additional candidate function(s)<br />
|- <br />
| ''default-name''<br />
| Quoted string<br />
| Name to be assigned to the default function (quoted string)<br />
|} <br />
<br />
=== Notes ===<br />
* The syntax shown in form 1 of 4 above should only be used when function pointers are part of the command payload.<br />
* The syntax shown in form 2 of 4 above should only be used when returning function pointers.<br />
* A function pointer data type as written in ANSI C merely specifies the format of the prototype. The format of the prototype is the data type of the return value and the datatypes of the parameters, if any. The scl_ptr_flist() pragma is therefore required by the SCL compiler to indicate which SCL-compatible interfaces are associated with a particular function pointer data type.<br />
* When a payload contains a field that is a pointer to a function, it is possible that the receiver of such a payload may make a call using the value received. Because the set of possible functions that might be passed is very large, and because all remotable methods must be identified with a SUID, each such payload value be constrained to identify the specific set of functions that might be passed. These are referred to as the candidates. Each candidate must be known by its name. The scl_ptr_flist() pragma is used for constraining fields of type pointer to function in this way. <br />
* Payload fields of type pointer to function that are not explicitly associated with a list of candidates are treated as if they have been declared as void *.<br />
<br />
<br />
== scl_ptr_opaque ==<br />
<br />
The scl_ptr_opaque pragma is used to specify a pointer data type as pointing to opaque data that should not be marshaled. <br />
<br />
=== Syntax ===<br />
#pragma scl_ptr_opaque(type-name)<br />
<br />
#pragma scl_ptr_opaque(type-name, field-name)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|- <br />
| ''type-name''<br />
| Type<br />
| Name of the type that contains the Pointer. The container type may be the name of a structure, a union, the pointer type itself, or a function. If the container type is a structure or a union, then the pointer is a member and the field-name must be specified. If the container type is a function, then the pointer is a parameter and the field-name must be specified.<br />
|- <br />
| ''field-name [Optional]''<br />
| Member<br />
| Name of the Pointer field, which may be a member field contained within a structure/union, or a parameter in the parameter list of a function. <br />
|}<br />
<br />
=== Notes ===<br />
* An opaque pointer is a pointer that points to opaque data. This means that the receiver of the pointer may not examine the data being pointed to. The meaningful part of an opaque pointer is the pointer value itself, or the pointer address. Opaque pointer are often used for the passing of handles.<br />
* A pointer of type void (i.e., void *) is by default an opaque pointer. No pragma may be applied to a void pointer.<br />
<br />
=== Examples ===<br />
<br />
Two examples using the scl_ptr_opaque pragma are shown below:<br />
<br />
==== Example 1 ====<br />
The first example uses the scl_ptr_opaque pragma to declare a structure member and a parameter list member as an opaque pointer.<br />
<source lang=c><br />
// Typedef defining a structure with a member of type pointer to char //<br />
typedef struct<br />
{<br />
int f1;<br />
char * f2;<br />
}data_t;<br />
<br />
// Function prototype with an INOUT pointer of type data_t //<br />
void modifyData( data_t * p );<br />
<br />
// Use the scl_function pragma to associate a SUID with the function ModifyData //<br />
#pragma scl_function( modifyData )<br />
// Use the scl_ptr_opaque pragma to define the member f2 as opaque //<br />
#pragma scl_ptr_opaque( data_t.f2 )<br />
// Use the scl_ptr_opaque pragma to define the parameter p as opaque //<br />
#pragma scl_ptr_opaque( modifyData.p )<br />
</source><br />
<br />
==== Example 2 ====<br />
The second example uses the scl_ptr_opaque pragma to declare pointer type definitions as opaque.<br />
<source lang=c><br />
// Typedef defining a structure with two members //<br />
typedef struct<br />
{<br />
int f1;<br />
char f2;<br />
}data_t;<br />
<br />
// Typedef defining a pointer to the data strucure //<br />
typedef data_t * pointerToData;<br />
// Prototype defining a function that returns a pointer to the data structure //<br />
data_t * getData( void );<br />
<br />
// Use the scl_ptr_opaque pragma to define the type pointerToData as opaque //<br />
#pragma scl_ptr_opaque( pointerToData )<br />
// Use the scl_function pragma to associate a SUID with the function "getData" //<br />
#pragma scl_function( getData )<br />
// Use the scl_ptr pragma to define "getData" return value as opaque pointer //<br />
#pragma scl_ptr_opaque( getData )<br />
</source><br />
<br />
<br />
== scl_ptr_sized ==<br />
<br />
The scl_ptr_sized pragma is used to identify a pointer data type, and assign to it attributes that are used to point to a series of elements allocated in contiguous memory. The pragma also assigns additional attributes, such as marshaling direction and memory usage.<br />
<br />
=== Syntax ===<br />
#pragma scl_ptr_sized(type-name, direction, usage, max-size)<br />
<br />
#pragma scl_ptr_sized(type-name, direction, usage, max-size, size-field-name)<br />
<br />
#pragma scl_ptr_sized(type-name, field-name, direction, usage, max-size)<br />
<br />
#pragma scl_ptr_sized(type-name, field-name, direction, usage, max-size, size-field-name)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''type-name''<br />
| Type<br />
| Name of the type that contains the pointer. The container type can be a structure, union, the pointer type itself, or a function. If the container type is a structure or union, the pointer is a member and the field-name must be specified. If the container type is a function, then the pointer is a parameter and the field-name must be specified.<br />
|- <br />
| ''field-name [Optional]''<br />
| Member<br />
| Name of the pointer field, which may be a member field contained within a structure/union, or a parameter in the parameter list of a function. <br />
|- <br />
| ''direction''<br />
| String<br />
| Direction in which the pointer data is marshaled; refer to the Pointer Direction Table below. This affects read and write access to the pointer data.<br />
|- <br />
| ''usage''<br />
| String<br />
| Pointer usage indicator; refer to the Pointer Memory Usage Table below.<br />
|-<br />
| ''max-size''<br />
| Integer<br />
| An integer constant that specifies the maximum number of elements pointed to.<br />
|-<br />
| ''size-field-name''<br />
| Member<br />
| The name of the field that specifies the current number of elements pointed to.<br />
|} <br />
<br />
<br />
'''Pointer Direction Table'''<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Value'''<br />
| '''Meaning'''<br />
|- <br />
| ''"IN"''<br />
| Specifies that the pointer memory can be used only as input to the receiver of the pointer. The Owner of the interface may only consider this read-only memory.<br />
|-<br />
| ''"OUT"''<br />
| Specifies that the pointer memory can be used to output information. The memory is allocated by the User and only written to by the Owner.<br />
|-<br />
| ''"INOUT"''<br />
| Specifies that the pointer memory can be used as both input and output. The User may send in data when sending the command (or calling the function), and may read the Owner’s output upon receipt of the response (or return of the function).<br />
|-<br />
| ''"RETURN"''<br />
| Specifies that the pointer memory may be read by the User of the interface. The User may only consider this as read-only memory and must not free it.<br />
|-<br />
| ''"INRETURN"''<br />
| Specifies that the pointer memory is allocated by both user and owner. There is no single block of memory pointed to by an "INRETURN" pointer. Rather there is one block on the call (or message send) and a second block on the return (or completion of the two-way message). Thus the first block has the characteristics of an "IN" block and the second the characteristics of a "RETURN" block.<br />
|}<br />
<br />
<br />
'''Pointer Memory Usage Table'''<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Value'''<br />
| '''Meaning'''<br />
|- <br />
| ''"PRIVATE"''<br />
| Pointer memory is private and may not be released by the Reader.<br />
|- <br />
| ''"POOL"''<br />
| Pointer memory is created from common pool and must be released by the Reader. <br />
|}<br />
<br />
=== Notes ===<br />
* A sized pointer is a pointer to one or more elements of data. There are two types of sized pointers:<br />
:# Fixed-sized always points to the same number of elements as specified by max-size.<br />
:# Variable-sized points to a variable number of elements. The number of elements currently pointed to is indicated by size-field-name, which must be of type integer.<br />
* If the sized pointer is "IN", then size-field-name can be a non-pointer integer type; otherwise it must be a single pointer. In either case, the parameter size-field-name must have the same direction as its associated-sized pointer.<br />
* The type of the pointer cannot be pointer to void; e.g. void *. This is considered an opaque pointer.<br />
<br />
=== Error Conditions ===<br />
* A compiler error will be reported if a pointer does not point to a fixed size type.<br />
* Sized pointers cannot use the "INOUT" direction.<br />
* Response payloads cannot use the "OUT" or "INOUT" direction.<br />
* Pointers with "OUT" or "INOUT" direction cannot indicate "POOL" pointer usage.<br />
* One-way messages (command and response) cannot have data that contains an "OUT" or "INOUT" pointer.<br />
<br />
=== Examples ===<br />
This example uses the scl_ptr_sized pragma to assign pointer attributes to a parameter list member.<br />
<source lang=c><br />
/* Constant defining the maximum buffer size */<br />
#define MAX_BUFFER_SIZE 256<br />
<br />
/* Function prototype with a sized IN pointer of type char */<br />
void MemWrite( char * buffer, int size );<br />
<br />
/* Function prototype with a sized OUT pointer of type char */<br />
void MemRead ( char * buffer, int size );<br />
<br />
/* Use the scl_function pragma to define the function prototypes */<br />
#pragma scl_function(MemWrite)<br />
#pragma scl_function(MemRead)<br />
/* Use the scl_ptr_sized pragma to specify the attributes for the sized pointers */<br />
/* Direction = "IN", memory usage = "PRIVATE", max size = 256, size field name = "size" */<br />
#pragma scl_ptr_sized(MemWrite, buffer, "IN", "PRIVATE", MAX_BUFFER_SIZE, size)<br />
<br />
/* Direction = "OUT", memory usage = "PRIVATE", max size = 256, size field name = "size" */<br />
#pragma scl_ptr_sized(MemRead, buffer, "OUT", "PRIVATE", MAX_BUFFER_SIZE, size)<br />
</source><br />
<br />
<br />
== scl_string ==<br />
<br />
The scl_string pragma identifies a particular array type or pointer type as a string. The string type (ASCII or UNICODE) is derived from the element type (1-byte or 2-byte, respectively).<br />
<br />
=== Syntax ===<br />
#pragma scl_string(type-name, max-size)<br />
<br />
#pragma scl_string(type-name, field-name, max-size)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''type-name''<br />
| Type<br />
| Name of the type that contains the array/pointer:<br><br />
* structure or union<br><br />
* the array/pointer type itself<br><br />
* function name<br><br />
If the container type is a structure or union and the array/pointer is a member, then field-name must be specified. <br />
|- <br />
| ''field-name [Optional]''<br />
| Member<br />
| Optional name of the array/pointer member contained within a structure/union, or the name of the pointer in the parameter list of a function.<br><br />
If type-name is a structure or union and the array/pointer is a member, then field-name must be specified.<br />
|-<br />
| ''max-size''<br />
| Integer<br />
| Specifies the maximum length of the string.<br />
|}<br />
<br />
=== Examples ===<br />
<br />
1. Use the scl_string pragma to specify type definitions as null terminated ASCII strings.<br />
<source lang="c"><br />
#define MAX_STR_SIZE 100<br />
<br />
typedef char ArrayAsAsciiString_t[MAX_STR_SIZE];<br />
#pragma scl_string( ArrayAsAsciiString_t, MAX_STR_SIZE )<br />
<br />
typedef char* PointerAsAsciiString_t; <br />
#pragma scl_string( PointerAsAsciiString_t, MAX_STR_SIZE )<br />
<br />
typedef struct {<br />
char * pointerToAsciiString;<br />
char arrayAsAsciiString[MAX_STR_SIZE];<br />
} Struct_t;<br />
#pragma scl_string( Struct_t, pointerToAsciiString, MAX_STR_SIZE )<br />
#pragma scl_string( Struct_t, arrayAsAsciiString, MAX_STR_SIZE )<br />
</source><br />
<br />
2. Use the scl_string pragma to specify a function argument as null terminated ASCII string.<br />
<source lang="c"><br />
void SetString(const char* pBuf);<br />
#pragma scl_function(SetString)<br />
#pragma scl_string(SetString.pBuf, MAX_STR_SIZE)<br />
<br />
typedef struct {<br />
char * pBuf;<br />
} Struct_t;<br />
void SetSructString(Struct_t tValue);<br />
#pragma scl_function(SetSructString)<br />
#pragma scl_string(SetSructString.tValue.pBuf, MAX_STR_SIZE)<br />
</source><br />
<br />
3. Use the scl_string pragma to specify a function return value as null terminated ASCII string.<br />
<source lang="c"><br />
const char* GetString(void);<br />
#pragma scl_function(GetString)<br />
#pragma scl_string(GetString(), MAX_STR_SIZE)<br />
<br />
typedef struct {<br />
char * pBuf;<br />
} Struct_t;<br />
Struct_t* GetSructString(void);<br />
#pragma scl_function(GetSructString)<br />
#pragma scl_string(GetSructString()->pBuf, MAX_STR_SIZE)<br />
</source><br />
<br />
<br />
== scl_struct_sized ==<br />
The scl_struct_sized pragma is used to identify a sized structure. A sized structure is a C programming convention for representing a structure whose size is variable and defined by one of the members of the structure. This pragma is infrequently used, but must be used, whenever the programmer defined size does not match the C language size of the structure (as calculated by the sizeof macro).<br />
<br />
NOTE: ''For an alternative use case of sized structure please look at scl_conform pragma.''<br />
<br />
=== Syntax ===<br />
#pragma scl_struct_sized(type-name, size-field)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| width="100" | '''Parameters'''<br />
| width="100" | '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''type-name''<br />
| Structure Type<br />
| Identifies a structure type or structure instance whose runtime size is not the same as its C language size and contains a field whose value is the runtime size.<br />
The following restrictions apply:<br />
* The structure type may not be pointed to by a sized pointer.<br />
* The structure type may not be used in an array.<br />
* The structure type may not be a member of an union.<br />
* The structure type may not be a member of any other structure unless it is the last member.<br />
* The structure type may not be used as a formal parameter or return value of a function (but a pointer to it is allowed).<br />
* The structure type cannot reside within OUT memory block.<br />
* If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br />
|-<br />
| ''size-field''<br />
| Member<br />
| Identifies a field within the sized structure whose value determines the actual runtime size of the structure. The following restrictions apply:<br />
* The type of the size-field must be an integral type.<br />
* The value (at runtime) is expected to be greater than the type size of the structure (as determined by the sizeof macro).<br />
* The size-field must reside within the same payload block as the sized structure.<br />
|}<br />
<br />
=== Examples ===<br />
<br />
==== Example 1 ====<br />
This example shows the declaration for a simple sized struct.<br />
<source lang=c><br />
typedef struct {<br />
int size;<br />
int someJunk;<br />
int moreJunk;<br />
} SimpleSizedStruct;<br />
<br />
#ifdef _SCL<br />
#pragma scl_struct_sized(SimpleSizedStruct, size)<br />
#endif<br />
<br />
</source><br />
<br />
==== Example 2 ====<br />
This example shows the declaration of a sized struct containing a variable length array whose actual length is proportional to the value of the size field. In this case the array bound is declared as 1, but by convention is really controlled by the value of the size field. <br />
<source lang=c><br />
<br />
typedef struct {<br />
int size;<br />
int someJunk;<br />
int ary[1]; // variable length array whose length depends on the size<br />
} ConformantArraySizedStruct;<br />
<br />
#ifdef _SCL<br />
#pragma scl_struct_sized(ConformantArraySizedStruct, size)<br />
#endif<br />
<br />
</source><br />
<br />
<br />
== scl_union ==<br />
<br />
Unions are C language constructs that have a set of members, of which at most one can be stored in the union object at any time. The stored member is called the "active" member. The scl_union pragma identifies which union member is the active member when a union is part of a payload.<br />
<br />
=== Syntax ===<br />
<br />
#pragma scl_union(union-name, active-index)<br />
<br />
#pragma scl_union(union-name, discriminant-specification)<br />
<br />
#pragma scl_union(parent-name, union-name, active-index)<br />
<br />
#pragma scl_union(parent-name, union-name, discriminant-specification)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''parent-name''<br />
| String<br />
| Name of structure encapsulating the union<br />
|- <br />
| ''union-name''<br />
| String<br />
| Name of the union<br />
|-<br />
| ''active-index''<br />
| Integer<br />
| Zero-based index for the active overlay<br />
|-<br />
| ''discriminant-specification''<br />
| String<br />
| Field name indicating the active overlay<br />
|}<br />
<br />
=== Notes ===<br />
<br />
For each union that is part of a message or function, there must be a means to determine which member is active. There are two basic methods for identification of the active member: <br />
<br />
:* One union member is designated as always active. The union will be treated as if this member is permanently active, there is no discriminant, nor any way to change the active member. <br />
:* A secondary field is designated as the discriminant and its value determines which (if any) of the union members are active. <br />
<br />
==== Discriminants ====<br />
Unions within the source code are easily identified by the "union" keyword. As discriminants are not easy to identify, the scl_union() pragma is necessary to identify them. The scl_union_activate pragma is optionally used to define a mapping between discriminant values and union members. <br />
<br />
Within a discriminated union, the discriminant value determines the active member of the union, resulting in a mapping between discriminant values and union members. A number of mapping choices are supported: <br />
<br />
:* In the simplest mapping, a discriminant value of n directly identifies the nth union member as active. In other words, a value of 0 would indicate the first union member, a value of 1 would indicate the second, etc. <br />
:* If the discriminant is an enumerated type, it is possible to set up an association between enumeration constants and active members such that the nth enumeration constant (in declared order, not value order) maps to the nth union member.<br />
:* It is also possible to create an explicit map between discriminant value sets and active members by specifying that a particular value or set of values maps to a specific member. <br />
<br />
The following constraints are enforced for the mapping between discriminant values and union members:<br />
<br />
:* A particular discriminant value may map only to a single union member. <br />
:* A particular field may act as a discriminant for more than one union<br />
:* A single union may only have a single discriminant field.<br />
:* The type of the discriminant field must be an integer or enumerated type or must have been cast (using scl_cast()) to an integer or enumerated type. <br />
:* The scl_values() pragma applied to the discriminant field affects the default mapping between discriminant values and union members.<br />
<br />
==== Default Mapping ====<br />
As mentioned previously, the scl_union() pragma is used to identify the discriminant for a union and scl_union_activate() is used to map discriminant values to union members. If there are no scl_union_activate() pragmas for a particular discriminated union, then the mapping between the discriminant and members is said to be default. The default mapping depends on the type of the discriminant: <br />
<br />
:* If the discriminant is one of the standard integer types, or has been cast to one of the standard integer types using scl_cast(), then the value of the discriminant identifies the position of the active member; i.e., a value of 0 indicates the first union member, a value of 1 the second, etc. <br />
:* If the discriminant is an enumerated type or has been cast to an enumerated type, or has had a set of constant values prescribed using scl_values(), then each constant has both a value and a position within the list. It is the position, rather than the value, that identifies the active member. When the discriminant takes on the value of the constant from position n, the nth union member is active. In the case of two constants from the same list have the same value, but different positions, an error is recognized. <br />
<br />
==== Explicit Mappings ====<br />
A union that has at least one scl_union_activate() pragma applied to it is said to have an explicit mapping. When a union has an explicit mapping, there is no default mapping; rather all mapping between discriminant values and union members is prescribed by the set of scl_union_activate() pragmas for the unions. For more details on using scl_union_activate(), click [[scl_union_activate|here]]. <br />
<br />
==== Internal and External Discriminants ====<br />
A union’s discriminant is either internal or external. A union has an external discriminant if the discriminant field is not contained within the union. <br />
<br />
An internal discriminant is one that is located inside the union. If a union has an internal discriminant the following must be true: <br />
:* Every member of the union must have a field that corresponds to the internal discriminant. All such fields must be of exactly the same type, or they must have had exactly the same scl_cast() or scl_values() specifications applied. Furthermore, all such fields must be positioned in exactly the same memory location within the union. If they are located in a payload block other than the one containing the union, then the expression "path" leading to each must be the same in the sense that all corresponding pointers across all the members have exactly the same offsets.<br />
<br />
=== Examples ===<br />
<br />
The following examples illustrate how various discriminant values map to the active member for discriminated unions:<br />
<br />
==== Example 1: Default mapping ====<br />
Discriminant is an integral type. A value of n maps to the nth union member. Members are numbered beginning with zero (0).<br />
<source lang=c><br />
typedef struct {<br />
int disc;<br />
union {<br />
int i;<br />
float f;<br />
} u;<br />
} S1t;<br />
<br />
#pragma scl_union(S1t.u, S1t.disc)<br />
</source><br />
<br />
==== Example 2: Enum-based ====<br />
Discriminant is an enumerated type. The nth enumeration constant (in declared order, not value order) maps to the nth union member.<br />
<source lang=c><br />
typedef enum {<br />
IDX_FIRST = 20,<br />
IDX_SECOND = 4<br />
} e_t;<br />
<br />
typedef struct {<br />
e_t disc;<br />
union {<br />
int i;<br />
float f;<br />
} u;<br />
} S2t;<br />
<br />
#pragma scl_union(S2t.u, S2t.disc)<br />
</source><br />
<br />
==== Example 3: Explicit mapping ====<br />
Discriminant values are explicitly mapped to active union members using scl_union_activate().<br />
<source lang=c><br />
// In the following union:<br />
// discriminant == 4 means 'i' is active<br />
// discriminant == 5 means 'f' is active<br />
typedef struct {<br />
int discriminant;<br />
union {<br />
int i;<br />
float f;<br />
} u;<br />
} S;<br />
<br />
#pragma scl_union (S.u, S.discriminant)<br />
#pragma scl_union_activate (S.u, i, 4)<br />
#pragma scl_union_activate(S.u, f, 5)<br />
</source><br />
<br />
==== Example 4: Discriminant values constrained to enumeration types ====<br />
An integer-based discriminant is constrained (using scl_values) to an enumerated type. This sets up an enum-based mapping as described in Example 2.<br />
<source lang=c><br />
// In the following union:<br />
// discriminant == RED means 'i' is active<br />
// discriminant == GREEN means 'f' is active<br />
// discriminant == BLUE means 'd' is active<br />
typedef enum {<br />
RED,<br />
GREEN,<br />
BLUE<br />
} COLOR;<br />
<br />
typedef struct {<br />
int discriminant;<br />
union {<br />
int i;<br />
float f;<br />
double d;<br />
} u;<br />
} S;<br />
<br />
#pragma scl_union (S.u, S.discriminant)<br />
#pragma scl_values (S.discriminant, COLOR)<br />
</source><br />
<br />
==== Example 5: Default undiscriminated union ====<br />
The union does not have a discriminant. The first member is always assumed to be active.<br />
<source lang=c><br />
//In the following union:<br />
// 'i' is always treated as active<br />
typedef struct {<br />
union {<br />
int i;<br />
float f;<br />
} u;<br />
} S6t;<br />
</source><br />
<br />
==== Example 6: Explicitly prescribed fixed active member for undiscriminated union ====<br />
The union does not have a discriminant. scl_union is used to prescribe a specific member as always active.<br />
<source lang=c><br />
typedef struct {<br />
union {<br />
int i;<br />
float f;<br />
char bytes[4];<br />
} u;<br />
} S6t;<br />
<br />
/* Select field "bytes" as the default member */<br />
#pragma scl_union(S6t.u, 2)<br />
</source><br />
<br />
==== Example 7: Internal discriminant ====<br />
An internal discriminant is located inside the union.<br />
<source lang=c><br />
// Union with internal discriminant:<br />
// discriminant == 0 'um0' is active member<br />
// discriminant == 1 'um1' is active member<br />
// discriminant == 2 'um2' is active member<br />
typedef struct {<br />
int discriminant;<br />
} HEADER;<br />
<br />
typedef struct {<br />
HEADER h;<br />
int x;<br />
} UNION_MEMBER_0;<br />
<br />
typedef struct {<br />
HEADER h;<br />
float f;<br />
} UNION_MEMBER_1;<br />
<br />
typedef struct {<br />
HEADER h;<br />
double d;<br />
} UNION_MEMBER_2;<br />
<br />
typedef union {<br />
UNION_MEMBER_0 um0;<br />
UNION_MEMBER_1 um1;<br />
UNION_MEMBER_2 um2;<br />
} U;<br />
<br />
#pragma scl_union(U, U.um0.h.discriminant)<br />
</source><br />
<br />
==== Example 8: Explicit mapping of multiple discriminant values to a single active member ====<br />
<source lang=c><br />
typedef struct {<br />
int a;<br />
int b;<br />
} type1_t;<br />
<br />
typedef struct {<br />
float x;<br />
float y;<br />
} type2_t;<br />
<br />
typedef struct {<br />
char c1;<br />
char c2;<br />
} type3_t;<br />
<br />
typedef enum {<br />
ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE<br />
} discriminant_t;<br />
<br />
typedef struct {<br />
discriminant_t d;<br />
int e;<br />
union {<br />
type1_t m1; // active when d == ONE or d == TWO or d == THREE<br />
type2_t m2; // active when d == FOUR or d == SIX or d == EIGHT<br />
type3_t m3; // active when d == FIVE or d == SEVEN<br />
} u_main;<br />
} s_t;<br />
<br />
#pragma scl_union (s_t.u_main, s_t.d)<br />
#pragma scl_union_activate(s_t.u_main, m1, ONE, TWO, THREE)<br />
#pragma scl_union_activate(s_t.u_main, m2, FOUR, SIX, EIGHT)<br />
#pragma scl_union_activate(s_t.u_main, m3, FIVE, SEVEN)<br />
</source><br />
<br />
==== Example 9: Unmapped discriminant values indicating no member is active ====<br />
<source lang=c><br />
//Union unmapped discriminant values<br />
//<br />
// discriminant == ZERO 'i' is active member<br />
// discriminant == ONE 'f' is active member<br />
// discriminant == TWO 'd' is active member<br />
// discriminant == THREE or FOUR<br />
// FIVE or SIX or SEVEN no active member<br />
typedef enum {<br />
ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN<br />
} ENUM_TYPE;<br />
<br />
typedef struct {<br />
ENUM_TYPE discriminant;<br />
union {<br />
int i;<br />
float f;<br />
double d;<br />
} u;<br />
} S;<br />
<br />
#pragma scl_union (S.u, S.discriminant)<br />
#pragma scl_union_activate(S.u, i, ZERO)<br />
#pragma scl_union_activate(S.u, f, ONE)<br />
#pragma scl_union_activate(S.u, d, TWO)<br />
</source><br />
<br />
==== Example 10: Discriminant values defined by macros ====<br />
<source lang=c><br />
//One field discriminating multiple unions <br />
//<br />
// discriminant == 1 'i' is active member<br />
// discriminant == 2 'f' is active member<br />
// discriminant == 3 'd' is active member<br />
// <br />
#define ONE 1<br />
#define TWO 2<br />
#define THREE 3<br />
<br />
typedef struct {<br />
int discriminant;<br />
union {<br />
int i;<br />
float f;<br />
double d;<br />
} u;<br />
} S;<br />
<br />
#pragma scl_union (S.u, S.discriminant) // uses 2-parameter form of scl_union<br />
#pragma scl_union_activate (S.u, i, ONE) // the first parameter identifies the union, the second a member in it. <br />
#pragma scl_union_activate (S.u, f, TWO)<br />
#pragma scl_union_activate (S.u, d, THREE)<br />
</source><br />
<br />
<br />
== scl_union_activate ==<br />
<br />
The scl_union_activate pragma provides a means to map discriminant values to specific union members. It can only apply to discriminated unions that have been identified by the scl_union pragma. <br />
<br />
A single scl_union_activate pragma prescribes the set of values for the discriminant and the member that is active for those values. <br />
<br />
=== Syntax ===<br />
#pragma scl_union_activate(container-specifier, union-member-specifier, constant-value-list)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''container-specifier''<br />
| Type<br />
| Name of the structure encapsulating the union<br />
|- <br />
| ''union-member-specifier''<br />
| Member<br />
| The active member of the union<br />
|- <br />
| ''constant-value-list''<br />
| Integer constant expression list<br />
| List of the constant expressions that the discriminant takes on to activate the union member identified in this pragma<br />
|} <br />
<br />
=== Notes ===<br />
:* The discriminant field use in scl_union_activate must have already been identified with the ''scl_union'' pragma.<br />
<br />
=== Examples ===<br />
Refer to the following ''scl_union'' pragma examples of the ''scl_union_activate'' pragma:<br />
:* ''Explicit mapping'': Discriminant values are explicitly mapped to active union members using scl_union_activate().<br />
:* ''Explicit mapping of multiple discriminant values to a single active member''.<br />
:* ''Unmapped discriminant values indicating no member is active''.<br />
:* ''Discriminant values defined by macros''.<br />
<br />
<br />
== scl_values ==<br />
<br />
The scl_values pragma allows a data item to be constrained to a particular set of values.<br />
<br />
=== Syntax ===<br />
#pragma scl_values(global-type-specifier, values-type)<br />
<br />
#pragma scl_values(container-specifier, field-specifier, values-type)<br />
<br />
#pragma scl_values(container-specifier, field-specifier, values-value-1, values-value-2..n)<br />
<br />
#pragma scl_values(global-type-specifier, values-value-1, values-value-2..n)<br />
<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;" <br />
| '''Parameters'''<br />
| '''Type'''<br />
| '''Description'''<br />
|-<br />
| ''global-specifier''<br />
| String<br />
| Name of the global type to be constrained.<br />
|-<br />
| ''values-type''<br />
| String<br />
| Name of the type that enumerates the range of values to which the data item is constrained.<br />
|-<br />
| ''container-specifier''<br />
| String<br />
| Partial identification of the field to be constrained. The container_specifier in combination with the field_specifier completely identify the field to be constrained. <br />
|-<br />
| ''field-specifier''<br />
| String<br />
| Together with the container specifier, completes the identity of the field whose values are to be constrained.<br />
|- <br />
| ''values-value-1''<br />
| Constant expression<br />
| First constant expression to which the data item's value will be constrained.<br />
|-<br />
| ''values-value-2..n [Optional]''<br />
| Constant expression list<br />
| Optional second and subsequent constant expressions, adding to the set of values to which the data item's value will be constrained. These expressions must be comma separated.<br />
|}<br />
<br />
=== Notes ===<br />
* The scl_values pragma may only be applied to items that are of integral type (e.g., signed/unsigned char, short, int, and long), and pointers that have had the scl_ptr_opaque pragma applied to them.<br />
* Each value in the values list is assigned both a symbolic name and an integral value. The symbolic name is: <br />
** The macro name if the value is defined by a macro (the macro name must be a non-parameterized macro).<br />
** The enumerated constant name if the value is an enumeration constant. <br />
** If the constant is not a simple macro name or enumerated constant name (i.e., it is some kind of expression) then the name is the constant expressed as a decimal number, including its sign if the value is negative. <br />
* Two values in the number-list may not have the same symbolic name. <br />
* scl_values() does not change the underlying type of the instances to which it is applied. If those instances are referenced by other pragmas, the type is unaffected; however, the instances will have constrained values.<br />
<br />
=== Examples ===<br />
<br />
==== Example 1: Integer field constrained to enumeration values ====<br />
<source lang=c><br />
typedef enum {<br />
RED,<br />
GREEN,<br />
BLUE<br />
} COLOR;<br />
<br />
int f(int x);<br />
#pragma scl_function(f)<br />
#pragma scl_values(f.x, COLOR)<br />
</source><br />
<br />
==== Example 2: Integer field constrained to a specific set of integer values ====<br />
<source lang=c><br />
#define FIRST 23<br />
#define SECOND 44<br />
#define THIRD 50<br />
#define FOURTH -5<br />
<br />
int f(int x);<br />
#pragma scl_function(f)<br />
#pragma scl_values(f.x, FIRST, SECOND, THIRD, FOURTH)<br />
</source></div>Ivailophttps://www.stridewiki.com/index.php?title=Stride_Sandbox&diff=14697Stride Sandbox2018-07-17T18:31:01Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
Stride's cross-platform capabilities make it possible to use Stride in a '''host-only''' configuration called the '''Sandbox'''. This environment facilitates ''self-training'', ''evaluations'', and ''trying stuff''. It frees you from external hardware dependencies and provides for a rapid ''edit-build-test'' cycle.<br />
<br />
The '''Sandbox''' utilizes the framework's SDK that can be built and executed on the host system. When using the SDK Makefile a simulated target ''native application'' is generated, which we call a '''Test Application (TestApp)'''. The Stride Runner application executes on the same host and communicates with the '''TestApp''' process over a TCP/IP connection. <br />
<br />
The '''Sandbox''' requires the Stride framework package to be setup on your desktop. Refer to the [[Framework Setup | Framework Setup]] article for more information. It also requires that your desktop contains one of the following '''compilers''':<br />
* For Windows, Microsoft Visual Studio 2008 or later is required. If you don't already have Visual Studio, the free [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio_Express Visual C++ Express] can be used (download [https://visualstudio.microsoft.com/vs/express/ here]). <i>In case you have [http://www.cygwin.com Cygwin] installed, the [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection] could be used as an alternative.</i><br />
* For Linux and FreeBSD, the [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection] (included by default in almost all distros) is required.<br />
<br />
== Building ==<br />
<br />
=== SDK Makefile ===<br />
The SDK Makefile is set up by ''default'' so that all <tt>.c</tt> <tt>.cpp</tt> and <tt>.h</tt> files found in the directory <tt>SDK\Windows\sample_src</tt> (or <tt>SDK/Posix/sample_src</tt> for Linux/FreeBSD) are included in the compile and link of the '''testapp''' target.<br />
<br />
Further--as a pre-compilation step--any <tt>.h</tt> files found in <tt>sample_src</tt> are submitted to the [[STRIDE Build Tools]]. This will result in <br />
* the detection of [[Test Pragmas| test pragmas]] used to declare Test Suites in these <tt>.h</tt> files<br />
* the generation of a database (<tt>.sidb</tt>) file required for executing tests<br />
* the generation of an [[Intercept Module]] required for executing tests<br />
<br />
=== Build Steps ===<br />
To begin, be sure that TestApp is not running then perform the following steps:<br />
<br />
NOTE: ''If you experience any build problem please make sure to read [[Troubleshooting Build Problems]] for possible resolution.''<br />
<br />
====Linux/FreeBSD====<br />
<ol><br />
<li>Build the test app using GNU make<br />
<source lang="bash"><br />
make -C "$STRIDE_DIR/SDK/Posix/src" testapp<br />
</source><br />
</li><br />
<li>Note that the following artifacts are produced by the build:<br />
<br />
;<tt>$STRIDE_DIR/SDK/Posix/out/bin/TestApp</tt><br />
: the test application<br />
;<tt>$STRIDE_DIR/SDK/Posix/out/TestApp.sidb</tt><br />
: the STRIDE interface database file which contains metadata describing the interfaces remoted by the test app (along with other data)<br />
</li><br />
</ol><br />
<br />
====Windows====<br />
NOTE: ''In case you have [http://www.cygwin.com Cygwin] and [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection] installed and prefer to use it, please follow the build steps for Linux (see previous section) and ignore the one in here.''<br />
<ol><br />
<li>If using Microsoft Visual Studio, open a [http://msdn.microsoft.com/en-us/library/ms235639(v=vs.100).aspx Visual Studio Command Prompt] to ensure that the compiler and linker are on your PATH.<br />
</li><br />
<li>Build the test app using the supplied GNU make. (You will get Makefile errors if you use the default make.)<br />
<source lang="dos"><br />
"%STRIDE_DIR%\SDK\Windows\bin\make" -C "%STRIDE_DIR%\SDK\Windows\src" testapp<br />
</source><br />
<li>Note that the following artifacts are produced by the build:<br />
<br />
;<tt>%STRIDE_DIR%\SDK\Windows\out\bin\TestApp.exe</tt><br />
: the test application<br />
;<tt>%STRIDE_DIR%\SDK\Windows\out\TestApp.sidb</tt><br />
: the STRIDE interface database file which contains metadata describing the interfaces remoted by the test app (along with other data)<br />
</li><br />
</ol><br />
<br />
== Running ==<br />
The test app we just built does not have any user tests in it. At this point it provides a starting point for test that we will subsequently add.<br />
<br />
However, a set of diagnostic tests that verify operation of the STRIDE runtime itself are always built into the generated TestApp executable. If desired (we recommend you to do so) you could run them by doing the following:<br />
<br />
<ol><br />
<li>Invoke the TestApp. In order to see TestApp's output, we recommend that you manually run in a console window (or Windows equivalent): <br />
;Linux/FreeBSD<br />
<source lang="bash"><br />
$STRIDE_DIR/SDK/Posix/out/bin/TestApp<br />
</source><br />
;Windows<br />
<source lang="dos"><br />
%STRIDE_DIR%\SDK\Windows\out\bin\TestApp<br />
</source><br />
(...or launch from the file explorer)<br />
<br />
<li> Note TestApp's output upon startup.<br />
<pre><br />
--------------------------------------------------<br />
STRIDE Test Console Application.<br />
Enter 'Ctrl+C' to Quit.<br />
--------------------------------------------------<br />
Listening on TCP port 8000<br />
starting up...<br />
"_srThread" thread started.<br />
"stride" thread started.<br />
</pre><br />
</li><br />
<li>From a second console window, invoke <tt>[[STRIDE_Runner|stride]]</tt> as follows, to verify connectivity with the test app and STRIDE runtime operation:<br />
<br/><br />
;Linux/FreeBSD<br />
<source lang="bash"><br />
stride --diagnostics --database="$STRIDE_DIR/SDK/Posix/out/TestApp.sidb" --device=TCP:localhost:8000 --run="*"<br />
</source><br />
;Windows<br />
<source lang="dos"><br />
stride --diagnostics --database="%STRIDE_DIR%\SDK\Windows\out\TestApp.sidb" --device=TCP:localhost:8000 --run="*"<br />
</source><br />
<br />
As the tests run you will see output in both the TestApp (target) and stride (host) console windows.<br />
<br />
The host console window output is shown here:<br />
<pre><br />
Executing diagnostics...<br />
Connecting to device (TCP:localhost:8000)...<br />
runtime version: 5.0.xy <br />
test suite "/Link"<br />
Loopback ..........<br />
Payload Fragmentation<br />
Stub-Proxy Deadlock<br />
Target Characteristics<br />
> 4 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 777.77 ms.<br />
test suite "/Stat"<br />
> 2 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 74.98 ms.<br />
test suite "/Time"<br />
> 2 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 2559.23 ms.<br />
Disconnecting from device...<br />
--------------------------------------------------------------------- <br />
Summary: 8 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 3411.98 ms.<br />
</pre><br />
</li><br />
<li>Note the Summary results shown in the host output; all in use tests should pass.<br />
</li><br />
<li>To exit TestApp, give the target window focus and enter <tt>Ctrl-C</tt>.<br />
</ol><br />
<br />
==Build Problems==<br />
This page describes several common problems encountered when building a STRIDE TestApp using the Sandbox and suggested solutions.<br />
<br />
=== Make Error 1 ===<br />
;Symptom<br />
On Windows, when attempting to build the testapp from the command line, you encounter an error indicating that:<br />
<pre><br />
‘cl’ is not recognized as an internal or external command,<br />
operable program or batch file.<br />
</pre><br />
<br />
For example:<br />
<pre><br />
C:\STRIDE\SDK\Windows\src>..\bin\make.exe testapp<br />
cl -c -nologo -W4 -D_UNICODE -DUNICODE -DWIN32 -D_CONSOLE -DUNDER_NT -I”.” -I”../../Runtime” -I”../../SLAP” -I”../../GRS” -I”../o<br />
ut/src” -I”../sample_src” -GS -Zi -DNDEBUG -MD -O2 -D_LIB -DSTRIDE_STATIC -Fd”../out/desktop-Windows_NT-obj//cl.pdb” -Fo”../out/desktop-Windows_NT-o<br />
bj/srapi.o” ”../../Runtime/srapi.c” <br />
‘cl’ is not recognized as an internal or external command,<br />
operable program or batch file.<br />
make: *** [../out/desktop-Windows_NT-obj/srapi.o] Error 1<br />
</pre><br />
<br />
;Cause<br />
Microsoft Visual Studio 2008 or later is not installed or you are not building from a [http://msdn.microsoft.com/en-us/library/ms235639(v=VS.90).aspx Visual Studio Command Prompt]. <br />
<br />
;Solution<br />
Make sure you have Microsoft Visual Studio 2008 or later installed.<br />
<br />
To ensures that the compiler and linker are on your PATH open a Visual Studio Command prompt: <br />
* Click the Start button, point to All Programs, Microsoft Visual Studio 20XX, Visual Studio Tools, and then click Visual Studio 20XX Command Prompt.<br />
<br />
=== Make Error 2 ===<br />
;Symptom<br />
On Windows, when attempting to build the testapp from the command line the following errors are observed:<br />
<br />
<pre><br />
syntax error near unexpected token `('<br />
syntax error near unexpected token `('<br />
syntax error: unexpected end of file<br />
</pre><br />
<br />
For example:<br />
<pre><br />
C:\stride\SDK\Windows\src>..\bin\make testapp<br />
/bin/sh: -c: line 0: syntax error near unexpected token `('<br />
/bin/sh: -c: line 0: `IF EXIST ../out. (IF NOT EXIST ../out/src mkdir "../out/src") ELSE mkdir "../out" && mkdir "../out/src".'<br />
/bin/sh: -c: line 0: syntax error near unexpected token `('<br />
/bin/sh: -c: line 0: `IF EXIST ../out. (IF NOT EXIST ../out/src mkdir "../out/src") ELSE mkdir "../out" && mkdir "../out/src".'<br />
/bin/sh: -c: line 1: syntax error: unexpected end of file<br />
make: *** [cleanapp] Error 258<br />
</pre><br />
<br />
;Cause<br />
This error occurs because gnu make on Windows will search for an Unix shell (<tt>sh</tt>, <tt>bash</tt> or <tt>csh</tt>) anywhere in your PATH when executing shell commands and only default to DOS shell (<tt>cmd.exe</tt>) when no Unix shell is found. The sandbox Makefile uses DOS shell syntax, so when a Unix shell is found on your PATH, this results to errors like above.<br />
<br />
Most commonly, this problem is caused by an installation of [http://en.wikipedia.org/wiki/Cygwin Cygwin], though it can also be caused by an installation of the QNX Software Development Platform.<br />
<br />
;Solution<br />
<br />
Explicitly specify the DOS shell by invoking make like:<br />
<pre><br />
..\bin\make SHELL=%ComSpec% testapp<br />
</pre><br />
<br />
'''''Note:''' the value of %ComSpec% should be <tt>C:\Windows\system32\cmd.exe</tt>''<br />
<br />
An alternative is to remove any directories from your PATH that contain an Unix shell executable or otherwise prevent such from being found. (e.g. rename its parent directory).<br />
<br />
=== Make Error 3 ===<br />
;Symptom<br />
On Linux, when attempting to build the testapp from the command line, the following error is observed:<br />
<pre><br />
g++: command not found<br />
</pre><br />
<br />
For example:<br />
<pre><br />
# make testapp<br />
g++ -c -I”.” -I”../../Runtime” -I”../../SLAP” -I”../../GRS” -I”../out/src” -I”../sample_src” -fPIC -D_DEBUG -O0 -g3 -Wall -o ”../out/i386-Linux-obj/srtestpp.obj” ”../../Runtime/srtestpp.cpp” <br />
/bin/sh: g++: command not found<br />
make: *** [../out/i386-Linux-obj/srtestpp.obj] Error 127<br />
</pre><br />
<br />
;Cause<br />
The C++ compiler, <tt>g++</tt> can't be found on your PATH.<br />
<br />
Most commonly, this problem is caused by not having a complete installation of [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection].<br />
<br />
;Solution<br />
Make sure you have a complete GNU Compiler Collection installed.<br />
<br />
=== Make Error 4 ===<br />
;Symptom<br />
When building the testapp from the command line, you see the following compiler errors:<br />
<br />
<pre><br />
../out/src/strideIM.cpp(50) : error C3861: '_srTestResultCountReset': identifier not found<br />
../out/src/strideIM.cpp(54) : error C3861: '_srTestSendFinalStatus': identifier not found<br />
../out/src/strideIM.cpp(56) : error C3861: '_srTestAddToTotal': identifier not found<br />
../out/src/strideIM.cpp(56) : error C3861: '_srTestResultGetTotals': identifier not found<br />
...<br />
...<br />
...<br />
</pre><br />
<br />
;Cause<br />
You are using an outdated version of the STRIDE build tools.<br />
<br />
You can see which version of the tools were used to generate your STRIDE sources by looking at the top of the strideIM.cpp source file. The comment block at the top of the file shows this version.<br />
<br />
;Solution<br />
Remove the old tools and/or change your path so that the current tools are used.</div>Ivailophttps://www.stridewiki.com/index.php?title=Troubleshooting_Build_Problems&diff=14696Troubleshooting Build Problems2018-04-02T17:36:25Z<p>Ivailop: </p>
<hr />
<div>This page describes several common problems encountered when building a STRIDE TestApp using the [[Stride_Sandbox | Off-Target Environment]] and suggested solutions.<br />
<br />
== Make Error 1 ==<br />
;Symptom<br />
On Windows, when attempting to build the testapp from the command line, you encounter an error indicating that:<br />
<pre><br />
‘cl’ is not recognized as an internal or external command,<br />
operable program or batch file.<br />
</pre><br />
<br />
For example:<br />
<pre><br />
C:\STRIDE\SDK\Windows\src>..\bin\make.exe testapp<br />
cl -c -nologo -W4 -D_UNICODE -DUNICODE -DWIN32 -D_CONSOLE -DUNDER_NT -I”.” -I”../../Runtime” -I”../../SLAP” -I”../../GRS” -I”../o<br />
ut/src” -I”../sample_src” -GS -Zi -DNDEBUG -MD -O2 -D_LIB -DSTRIDE_STATIC -Fd”../out/desktop-Windows_NT-obj//cl.pdb” -Fo”../out/desktop-Windows_NT-o<br />
bj/srapi.o” ”../../Runtime/srapi.c” <br />
‘cl’ is not recognized as an internal or external command,<br />
operable program or batch file.<br />
make: *** [../out/desktop-Windows_NT-obj/srapi.o] Error 1<br />
</pre><br />
<br />
;Cause<br />
Microsoft Visual Studio 2008 or later is not installed or you are not building from a [http://msdn.microsoft.com/en-us/library/ms235639(v=VS.90).aspx Visual Studio Command Prompt]. <br />
<br />
;Soultion<br />
Make sure you have Microsoft Visual Studio 2008 or later installed.<br />
<br />
To ensures that the compiler and linker are on your PATH open a Visual Studio Command prompt: <br />
* Click the Start button, point to All Programs, Microsoft Visual Studio 20XX, Visual Studio Tools, and then click Visual Studio 20XX Command Prompt.<br />
<br />
== Make Error 2 ==<br />
;Symptom<br />
On Windows, when attempting to build the testapp from the command line the following errors are observed:<br />
<br />
<pre><br />
syntax error near unexpected token `('<br />
syntax error near unexpected token `('<br />
syntax error: unexpected end of file<br />
</pre><br />
<br />
For example:<br />
<pre><br />
C:\stride\SDK\Windows\src>..\bin\make testapp<br />
/bin/sh: -c: line 0: syntax error near unexpected token `('<br />
/bin/sh: -c: line 0: `IF EXIST ../out. (IF NOT EXIST ../out/src mkdir "../out/src") ELSE mkdir "../out" && mkdir "../out/src".'<br />
/bin/sh: -c: line 0: syntax error near unexpected token `('<br />
/bin/sh: -c: line 0: `IF EXIST ../out. (IF NOT EXIST ../out/src mkdir "../out/src") ELSE mkdir "../out" && mkdir "../out/src".'<br />
/bin/sh: -c: line 1: syntax error: unexpected end of file<br />
make: *** [cleanapp] Error 258<br />
</pre><br />
<br />
;Cause<br />
This error occurs because gnu make on Windows will search for an Unix shell (<tt>sh</tt>, <tt>bash</tt> or <tt>csh</tt>) anywhere in your PATH when executing shell commands and only default to DOS shell (<tt>cmd.exe</tt>) when no Unix shell is found. The sandbox Makefile uses DOS shell syntax, so when a Unix shell is found on your PATH, this results to errors like above.<br />
<br />
Most commonly, this problem is caused by an installation of [http://en.wikipedia.org/wiki/Cygwin Cygwin], though it can also be caused by an installation of the QNX Software Development Platform.<br />
<br />
;Solution<br />
<br />
Explicitly specify the DOS shell by invoking make like:<br />
<pre><br />
..\bin\make SHELL=%ComSpec% testapp<br />
</pre><br />
<br />
'''''Note:''' the value of %ComSpec% should be <tt>C:\Windows\system32\cmd.exe</tt>''<br />
<br />
An alternative is to remove any directories from your PATH that contain an Unix shell executable or otherwise prevent such from being found. (e.g. rename its parent directory).<br />
<br />
== Make Error 3 ==<br />
;Symptom<br />
On Linux, when attempting to build the testapp from the command line, the following error is observed:<br />
<pre><br />
g++: command not found<br />
</pre><br />
<br />
For example:<br />
<pre><br />
# make testapp<br />
g++ -c -I”.” -I”../../Runtime” -I”../../SLAP” -I”../../GRS” -I”../out/src” -I”../sample_src” -fPIC -D_DEBUG -O0 -g3 -Wall -o ”../out/i386-Linux-obj/srtestpp.obj” ”../../Runtime/srtestpp.cpp” <br />
/bin/sh: g++: command not found<br />
make: *** [../out/i386-Linux-obj/srtestpp.obj] Error 127<br />
</pre><br />
<br />
;Cause<br />
The C++ compiler, <tt>g++</tt> can't be found on your PATH.<br />
<br />
Most commonly, this problem is caused by not having a complete installation of [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection].<br />
<br />
;Solution<br />
Make sure you have a compele GNU Compiler Collection installed.<br />
<br />
== Make Error 4 ==<br />
;Symptom<br />
When building the testapp from the command line, you see the following compiler errors:<br />
<br />
<pre><br />
../out/src/strideIM.cpp(50) : error C3861: '_srTestResultCountReset': identifier not found<br />
../out/src/strideIM.cpp(54) : error C3861: '_srTestSendFinalStatus': identifier not found<br />
../out/src/strideIM.cpp(56) : error C3861: '_srTestAddToTotal': identifier not found<br />
../out/src/strideIM.cpp(56) : error C3861: '_srTestResultGetTotals': identifier not found<br />
...<br />
...<br />
...<br />
</pre><br />
<br />
;Cause<br />
You are using an outdated version of the STRIDE build tools.<br />
<br />
You can see which version of the tools were used to generate your STRIDE sources by looking at the top of the strideIM.cpp source file. The comment block at the top of the file shows this version.<br />
<br />
;Solution<br />
Remove the old tools and/or change your path so that the current tools are used.<br />
<br />
[[Category:Installation]]</div>Ivailophttps://www.stridewiki.com/index.php?title=Stride_Sandbox&diff=14695Stride Sandbox2018-04-02T17:35:41Z<p>Ivailop: /* Building */</p>
<hr />
<div>__NOTOC__<br />
Stride's cross-platform capabilities make it possible to use Stride in a '''host-only''' configuration called the '''Sandbox'''. This environment facilitates ''self-training'', ''evaluations'', and ''trying stuff''. It frees you from external hardware dependencies and provides for a rapid ''edit-build-test'' cycle.<br />
<br />
The '''Sandbox''' utilizes the framework's SDK that can be built and executed on the host system. When using the SDK Makefile a simulated target ''native application'' is generated, which we call a '''Test Application (TestApp)'''. The Stride Runner application executes on the same host and communicates with the '''TestApp''' process over a TCP/IP connection. <br />
<br />
The '''Sandbox''' requires the Stride framework package to be setup on your desktop. Refer to the [[Framework Setup | Framework Setup]] article for more information. It also requires that your desktop contains one of the following '''compilers''':<br />
* For Windows, Microsoft Visual Studio 2008 or later is required. If you don't already have Visual Studio, the free [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio_Express Visual C++ Express] can be used (download [http://www.microsoft.com/express/download/#webInstall here]). <i>In case you have [http://www.cygwin.com Cygwin] installed, the [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection] could be used as an alternative.</i><br />
* For Linux and FreeBSD, the [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection] (included by default in almost all distros) is required.<br />
<br />
== Building ==<br />
<br />
=== SDK Makefile ===<br />
The SDK Makefile is set up by ''default'' so that all <tt>.c</tt> <tt>.cpp</tt> and <tt>.h</tt> files found in the directory <tt>SDK\Windows\sample_src</tt> (or <tt>SDK/Posix/sample_src</tt> for Linux/FreeBSD) are included in the compile and link of the '''testapp''' target.<br />
<br />
Further--as a pre-compilation step--any <tt>.h</tt> files found in <tt>sample_src</tt> are submitted to the [[STRIDE Build Tools]]. This will result in <br />
* the detection of [[Test Pragmas| test pragmas]] used to declare Test Suites in these <tt>.h</tt> files<br />
* the generation of a database (<tt>.sidb</tt>) file required for executing tests<br />
* the generation of an [[Intercept Module]] required for executing tests<br />
<br />
=== Build Steps ===<br />
To begin, be sure that TestApp is not running then perform the following steps:<br />
<br />
NOTE: ''If you experience any build problem please make sure to read [[Troubleshooting Build Problems]] for possible resolution.''<br />
<br />
====Linux/FreeBSD====<br />
<ol><br />
<li>Build the test app using GNU make<br />
<source lang="bash"><br />
make -C "$STRIDE_DIR/SDK/Posix/src" testapp<br />
</source><br />
</li><br />
<li>Note that the following artifacts are produced by the build:<br />
<br />
;<tt>$STRIDE_DIR/SDK/Posix/out/bin/TestApp</tt><br />
: the test application<br />
;<tt>$STRIDE_DIR/SDK/Posix/out/TestApp.sidb</tt><br />
: the STRIDE interface database file which contains metadata describing the interfaces remoted by the test app (along with other data)<br />
</li><br />
</ol><br />
<br />
====Windows====<br />
NOTE: ''In case you have [http://www.cygwin.com Cygwin] and [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection] installed and prefer to use it, please follow the build steps for Linux (see previous section) and ignore the one in here.''<br />
<ol><br />
<li>If using Microsoft Visual Studio, open a [http://msdn.microsoft.com/en-us/library/ms235639(v=vs.100).aspx Visual Studio Command Prompt] to ensure that the compiler and linker are on your PATH.<br />
</li><br />
<li>Build the test app using the supplied GNU make. (You will get Makefile errors if you use the default make.)<br />
<source lang="dos"><br />
"%STRIDE_DIR%\SDK\Windows\bin\make" -C "%STRIDE_DIR%\SDK\Windows\src" testapp<br />
</source><br />
<li>Note that the following artifacts are produced by the build:<br />
<br />
;<tt>%STRIDE_DIR%\SDK\Windows\out\bin\TestApp.exe</tt><br />
: the test application<br />
;<tt>%STRIDE_DIR%\SDK\Windows\out\TestApp.sidb</tt><br />
: the STRIDE interface database file which contains metadata describing the interfaces remoted by the test app (along with other data)<br />
</li><br />
</ol><br />
<br />
== Running ==<br />
The test app we just built does not have any user tests in it. At this point it provides a starting point for test that we will subsequently add.<br />
<br />
However, a set of diagnostic tests that verify operation of the STRIDE runtime itself are always built into the generated TestApp executable. If desired (we recommend you to do so) you could run them by doing the following:<br />
<br />
<ol><br />
<li>Invoke the TestApp. In order to see TestApp's output, we recommend that you manually run in a console window (or Windows equivalent): <br />
;Linux/FreeBSD<br />
<source lang="bash"><br />
$STRIDE_DIR/SDK/Posix/out/bin/TestApp<br />
</source><br />
;Windows<br />
<source lang="dos"><br />
%STRIDE_DIR%\SDK\Windows\out\bin\TestApp<br />
</source><br />
(...or launch from the file explorer)<br />
<br />
<li> Note TestApp's output upon startup.<br />
<pre><br />
--------------------------------------------------<br />
STRIDE Test Console Application.<br />
Enter 'Ctrl+C' to Quit.<br />
--------------------------------------------------<br />
Listening on TCP port 8000<br />
starting up...<br />
"_srThread" thread started.<br />
"stride" thread started.<br />
</pre><br />
</li><br />
<li>From a second console window, invoke <tt>[[STRIDE_Runner|stride]]</tt> as follows, to verify connectivity with the test app and STRIDE runtime operation:<br />
<br/><br />
;Linux/FreeBSD<br />
<source lang="bash"><br />
stride --diagnostics --database="$STRIDE_DIR/SDK/Posix/out/TestApp.sidb" --device=TCP:localhost:8000 --run="*"<br />
</source><br />
;Windows<br />
<source lang="dos"><br />
stride --diagnostics --database="%STRIDE_DIR%\SDK\Windows\out\TestApp.sidb" --device=TCP:localhost:8000 --run="*"<br />
</source><br />
<br />
As the tests run you will see output in both the TestApp (target) and stride (host) console windows.<br />
<br />
The host console window output is shown here:<br />
<pre><br />
Executing diagnostics...<br />
Connecting to device (TCP:localhost:8000)...<br />
runtime version: 5.0.xy <br />
test suite "/Link"<br />
Loopback ..........<br />
Payload Fragmentation<br />
Stub-Proxy Deadlock<br />
Target Characteristics<br />
> 4 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 777.77 ms.<br />
test suite "/Stat"<br />
> 2 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 74.98 ms.<br />
test suite "/Time"<br />
> 2 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 2559.23 ms.<br />
Disconnecting from device...<br />
--------------------------------------------------------------------- <br />
Summary: 8 passed, 0 failed, 0 in progress, 0 unknown, 0 not in use, 3411.98 ms.<br />
</pre><br />
</li><br />
<li>Note the Summary results shown in the host output; all in use tests should pass.<br />
</li><br />
<li>To exit TestApp, give the target window focus and enter <tt>Ctrl-C</tt>.<br />
</ol><br />
<br />
==Build Problems==<br />
This page describes several common problems encountered when building a STRIDE TestApp using the Sandbox and suggested solutions.<br />
<br />
=== Make Error 1 ===<br />
;Symptom<br />
On Windows, when attempting to build the testapp from the command line, you encounter an error indicating that:<br />
<pre><br />
‘cl’ is not recognized as an internal or external command,<br />
operable program or batch file.<br />
</pre><br />
<br />
For example:<br />
<pre><br />
C:\STRIDE\SDK\Windows\src>..\bin\make.exe testapp<br />
cl -c -nologo -W4 -D_UNICODE -DUNICODE -DWIN32 -D_CONSOLE -DUNDER_NT -I”.” -I”../../Runtime” -I”../../SLAP” -I”../../GRS” -I”../o<br />
ut/src” -I”../sample_src” -GS -Zi -DNDEBUG -MD -O2 -D_LIB -DSTRIDE_STATIC -Fd”../out/desktop-Windows_NT-obj//cl.pdb” -Fo”../out/desktop-Windows_NT-o<br />
bj/srapi.o” ”../../Runtime/srapi.c” <br />
‘cl’ is not recognized as an internal or external command,<br />
operable program or batch file.<br />
make: *** [../out/desktop-Windows_NT-obj/srapi.o] Error 1<br />
</pre><br />
<br />
;Cause<br />
Microsoft Visual Studio 2008 or later is not installed or you are not building from a [http://msdn.microsoft.com/en-us/library/ms235639(v=VS.90).aspx Visual Studio Command Prompt]. <br />
<br />
;Solution<br />
Make sure you have Microsoft Visual Studio 2008 or later installed.<br />
<br />
To ensures that the compiler and linker are on your PATH open a Visual Studio Command prompt: <br />
* Click the Start button, point to All Programs, Microsoft Visual Studio 20XX, Visual Studio Tools, and then click Visual Studio 20XX Command Prompt.<br />
<br />
=== Make Error 2 ===<br />
;Symptom<br />
On Windows, when attempting to build the testapp from the command line the following errors are observed:<br />
<br />
<pre><br />
syntax error near unexpected token `('<br />
syntax error near unexpected token `('<br />
syntax error: unexpected end of file<br />
</pre><br />
<br />
For example:<br />
<pre><br />
C:\stride\SDK\Windows\src>..\bin\make testapp<br />
/bin/sh: -c: line 0: syntax error near unexpected token `('<br />
/bin/sh: -c: line 0: `IF EXIST ../out. (IF NOT EXIST ../out/src mkdir "../out/src") ELSE mkdir "../out" && mkdir "../out/src".'<br />
/bin/sh: -c: line 0: syntax error near unexpected token `('<br />
/bin/sh: -c: line 0: `IF EXIST ../out. (IF NOT EXIST ../out/src mkdir "../out/src") ELSE mkdir "../out" && mkdir "../out/src".'<br />
/bin/sh: -c: line 1: syntax error: unexpected end of file<br />
make: *** [cleanapp] Error 258<br />
</pre><br />
<br />
;Cause<br />
This error occurs because gnu make on Windows will search for an Unix shell (<tt>sh</tt>, <tt>bash</tt> or <tt>csh</tt>) anywhere in your PATH when executing shell commands and only default to DOS shell (<tt>cmd.exe</tt>) when no Unix shell is found. The sandbox Makefile uses DOS shell syntax, so when a Unix shell is found on your PATH, this results to errors like above.<br />
<br />
Most commonly, this problem is caused by an installation of [http://en.wikipedia.org/wiki/Cygwin Cygwin], though it can also be caused by an installation of the QNX Software Development Platform.<br />
<br />
;Solution<br />
<br />
Explicitly specify the DOS shell by invoking make like:<br />
<pre><br />
..\bin\make SHELL=%ComSpec% testapp<br />
</pre><br />
<br />
'''''Note:''' the value of %ComSpec% should be <tt>C:\Windows\system32\cmd.exe</tt>''<br />
<br />
An alternative is to remove any directories from your PATH that contain an Unix shell executable or otherwise prevent such from being found. (e.g. rename its parent directory).<br />
<br />
=== Make Error 3 ===<br />
;Symptom<br />
On Linux, when attempting to build the testapp from the command line, the following error is observed:<br />
<pre><br />
g++: command not found<br />
</pre><br />
<br />
For example:<br />
<pre><br />
# make testapp<br />
g++ -c -I”.” -I”../../Runtime” -I”../../SLAP” -I”../../GRS” -I”../out/src” -I”../sample_src” -fPIC -D_DEBUG -O0 -g3 -Wall -o ”../out/i386-Linux-obj/srtestpp.obj” ”../../Runtime/srtestpp.cpp” <br />
/bin/sh: g++: command not found<br />
make: *** [../out/i386-Linux-obj/srtestpp.obj] Error 127<br />
</pre><br />
<br />
;Cause<br />
The C++ compiler, <tt>g++</tt> can't be found on your PATH.<br />
<br />
Most commonly, this problem is caused by not having a complete installation of [http://en.wikipedia.org/wiki/GNU_Compiler_Collection GNU Compiler Collection].<br />
<br />
;Solution<br />
Make sure you have a complete GNU Compiler Collection installed.<br />
<br />
=== Make Error 4 ===<br />
;Symptom<br />
When building the testapp from the command line, you see the following compiler errors:<br />
<br />
<pre><br />
../out/src/strideIM.cpp(50) : error C3861: '_srTestResultCountReset': identifier not found<br />
../out/src/strideIM.cpp(54) : error C3861: '_srTestSendFinalStatus': identifier not found<br />
../out/src/strideIM.cpp(56) : error C3861: '_srTestAddToTotal': identifier not found<br />
../out/src/strideIM.cpp(56) : error C3861: '_srTestResultGetTotals': identifier not found<br />
...<br />
...<br />
...<br />
</pre><br />
<br />
;Cause<br />
You are using an outdated version of the STRIDE build tools.<br />
<br />
You can see which version of the tools were used to generate your STRIDE sources by looking at the top of the strideIM.cpp source file. The comment block at the top of the file shows this version.<br />
<br />
;Solution<br />
Remove the old tools and/or change your path so that the current tools are used.</div>Ivailophttps://www.stridewiki.com/index.php?title=S2scompile&diff=14694S2scompile2018-04-02T17:30:43Z<p>Ivailop: /* Search Path */</p>
<hr />
<div>__FORCETOC__<br />
== The SCL Compiler Utility ==<br />
<br />
The '''s2scompile''' executable will compile a set of scl files (C/C++ source files with [[SCL Pragmas]]) and produce a <tt>.meta</tt> file for each (assuming that compilation is successful).<ref>.meta files are binary-format intermediate files suitable for input to the [[s2sbind]] utility.</ref><br />
<br />
All warnings and errors that occur during the compilation are written to the standard output device. The compilation for a particular file is considered successful if no errors occur. Otherwise it is unsuccessful. Unsuccessful compilations do not yield <tt>.meta</tt> files.<br />
<br />
Options are validated and any incorrect options diagnosed will result in compilation process failure.<br />
<br />
=== Syntax ===<br />
s2scompile [<i>options</i>] <i>scl_file1</i> [<i>scl_fileN</i>]<br />
<br />
=== Options ===<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;background-color:#ffffcc;" <br />
!width="200pt"|'''Option'''<br />
!width="500pt"|'''Description'''<br />
|- <br />
| '''--version'''<br />
| Print version information.<br />
|- <br />
| '''--preprocess'''<br />
| Do preprocessing only. Write preprocessed text file to the output.<br />
|- <br />
| '''--dependencies'''<br />
| Do preprocessing only. Instead of the normal preprocessing output, generate in the preprocessing output file a list of dependency lines suitable for input to the UNIX make program. <br />
|-<br />
| '''--no_line_commands'''<br />
| Same as '''–-preprocess''' except that line number information is removed from the preprocessed output files.<br />
|-<br />
| '''--c++'''<br />
| Enable compilation of c++. <br />
|-<br />
| '''--c'''<br />
| Enable compilation of C (specifically C89). This is the default.<br />
|-<br />
| '''--include_directory='''<i><dir></i><br><br />
'''--sys_include='''<i><dir></i><br><br />
'''-I'''<i><dir></i><br />
| Add dir to the end of the list of directories searched for <tt>#include</tt>.<br />
|-<br />
| '''--no_stdinc'''<br />
| Do not search the standard system directories for header files. See [[#Search Path|Search Path]] for details.<br />
|-<br />
| '''--define_macro='''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br><br />
'''-D'''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br />
| Define macro <i><name></i> as <i>value</i>. If "=<i>value</i>" is omitted, define <i><name></i> as 1.<br />
|-<br />
| '''--undefine_macro='''<i><name></i><br><br />
'''-U'''<i><name></i><br />
| Remove predefined macro <i><name></i>.<br />
|-<br />
| '''--compatibility='''<i><string></i><br />
| Vendor compatibility mode. String can be "microsoft", "generic" or "gnu". Default is "generic". When "Microsoft" is set, the compiler supports a number of extensions to the C or C++ language that are compatible with the Microsoft family of compilers. "gnu" - instructs the compiler to support language extensions compatible with the Gnu family of compilers.<br />
|-<br />
| '''--no_warning'''<br />
| Suppress all warnings in the compilation phase.<br />
|-<br />
| '''--macros'''<br />
| Resolve macro (preprocessor define) constant value. Pass this flag only if you intend to do script based testing.<br />
|-<br />
| '''--documentation'''<br />
| Extract [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen style] source documentation. <br />
|-<br />
| '''--output='''<i><path></i><br><br />
'''-o'''<path><br />
| Output file or directory. The default is the current directory.<br />
|-<br />
| '''--targ_big_endian'''<br />
| Target uses a big endian by representation. The default is little endian.<br />
|-<br />
| '''--targ_plain_char_is_unsigned'''<br />
| Target uses unsigned chars to represent “plain” char. The default is signed.<br />
|-<br />
| '''--targ_adaptive_enum'''<br />
| Target has adaptive enums. The default is no adaptive enums.<br />
|-<br />
| '''--targ_pack_alignment='''<i><align></i><br />
| Target struct pack alignment. The default is 16. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_char='''<i><size></i><br />
| Target platform size of char. Default is 1. Possible values are 1, 2, 4, 8, or 16.<br />
|-<br />
| '''--targ_alignof_char='''<i><align></i><br />
| Target platform alignment of char. Default is 1. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_short='''<i><size></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_alignof_short='''<i><align></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_sizeof_int='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_int='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_long='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long_long='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_long_long='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_float='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_float='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_double='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_long_double='''<i><size></i><br />
| Default is 8<br />
|-<br />
| '''--targ_alignof_long_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_bool_int_kind='''<i><typename></i><br />
| Default is "char".<br />
|-<br />
| '''--targ_wchar_t_int_kind='''<i><typename></i><br />
| Default is "unsigned short".<br />
|-<br />
| '''--targ_size_t_int_kind='''<i><typename></i><br />
| Default is "unsigned int".<br />
|-<br />
| '''--targ_ptrdiff_t_int_kind='''<i><typename></i><br />
| Default is "int".<br />
|-<br />
| '''--options_file='''<i><file></i><br />
| A file that contains command line options. The format is the same as the command line with the only addition that it could be split on multiple lines. A line starting with "#" or ";" symbol is ignored.<br />
This option is necessary if the length of the command line string exceeds system limits. Otherwise it is provided only as a convenience.<br />
<br />
'''''NOTE:''' To simplify the integration in existing build environments other standard compiler options (e.g. ARM [http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0491b/CHDCIEGC.html --via=<file>], GCC [http://gcc.gnu.org/onlinedocs/gcc/Overall-Options.html#Overall-Options @<file>], MSVC [http://msdn.microsoft.com/en-us/library/3te4xt0y(v=VS.90).aspx @<file>]) with similar meaning are also recognized and processed the same way.''<br />
|}<br />
<br />
'''Note''': The [[Framework_Setup#SDK|standard Platform SDKs]] shipped with the Framework contain a set of options files with predefined target settings for several popular CPUs. Please consider using one of them instead of explicitly passing <tt>--targ_*</tt> options on the command line.<br />
<br />
=== Search Path ===<br />
<b>s2scompile</b> by default looks in several different places for headers. It looks for headers requested with <tt>#include <file></tt> in:<br />
<pre><br />
$(STRIDE_DIR)/SDK/Runtime<br />
</pre><br />
<br />
Where $(STRIDE_DIR) is the location where the STRIDE packages are installed following [[Framework_Setup#Directories_and_Files|recommended directory layout]].<br />
<br />
When <i>microsoft</i> mode is specified and $(INCLUDE) enviroment variable is defined (as a ";" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>.<br />
<br />
When <i>gnu</i> mode is specified and $(CPATH) and/or $(C_INCLUDE_PATH) (or $(CPLUS_INCLUDE_PATH) for C++) enviroment variables are defined (as a ":" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>. In addition if $(TARGET_CPP) specifies the target GNU <tt>cpp</tt> (GCC preprocessor or a command line equivalent) it is queried and any given path by it is looked in.<br />
<br />
You can add to this list, before any of the default places, by using the <tt>-I<dir></tt> option.<br />
<br />
You can prevent s2scompile from searching any of the default directories with the <tt>--no_stdinc</tt> option. <tt>-I</tt> options are not ignored as described above when <tt>--no_stdinc</tt> is in effect. <br />
<br />
<b>s2scompile</b> looks for headers requested with <tt>#include "file"</tt> first in the directory containing the current file, then in the same places it would have looked for a header requested with angle brackets.<br />
<br />
=== Examples ===<br />
Refer to the [[Build_Tools#Compiling_multiple_files|Compiling]] section of the Build Tools Examples.<br />
<br />
=== Notes ===<br />
<references/><br />
[[Category:Build_Tools]]</div>Ivailophttps://www.stridewiki.com/index.php?title=S2scompile&diff=14693S2scompile2018-04-02T17:30:25Z<p>Ivailop: /* Search Path */</p>
<hr />
<div>__FORCETOC__<br />
== The SCL Compiler Utility ==<br />
<br />
The '''s2scompile''' executable will compile a set of scl files (C/C++ source files with [[SCL Pragmas]]) and produce a <tt>.meta</tt> file for each (assuming that compilation is successful).<ref>.meta files are binary-format intermediate files suitable for input to the [[s2sbind]] utility.</ref><br />
<br />
All warnings and errors that occur during the compilation are written to the standard output device. The compilation for a particular file is considered successful if no errors occur. Otherwise it is unsuccessful. Unsuccessful compilations do not yield <tt>.meta</tt> files.<br />
<br />
Options are validated and any incorrect options diagnosed will result in compilation process failure.<br />
<br />
=== Syntax ===<br />
s2scompile [<i>options</i>] <i>scl_file1</i> [<i>scl_fileN</i>]<br />
<br />
=== Options ===<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;background-color:#ffffcc;" <br />
!width="200pt"|'''Option'''<br />
!width="500pt"|'''Description'''<br />
|- <br />
| '''--version'''<br />
| Print version information.<br />
|- <br />
| '''--preprocess'''<br />
| Do preprocessing only. Write preprocessed text file to the output.<br />
|- <br />
| '''--dependencies'''<br />
| Do preprocessing only. Instead of the normal preprocessing output, generate in the preprocessing output file a list of dependency lines suitable for input to the UNIX make program. <br />
|-<br />
| '''--no_line_commands'''<br />
| Same as '''–-preprocess''' except that line number information is removed from the preprocessed output files.<br />
|-<br />
| '''--c++'''<br />
| Enable compilation of c++. <br />
|-<br />
| '''--c'''<br />
| Enable compilation of C (specifically C89). This is the default.<br />
|-<br />
| '''--include_directory='''<i><dir></i><br><br />
'''--sys_include='''<i><dir></i><br><br />
'''-I'''<i><dir></i><br />
| Add dir to the end of the list of directories searched for <tt>#include</tt>.<br />
|-<br />
| '''--no_stdinc'''<br />
| Do not search the standard system directories for header files. See [[#Search Path|Search Path]] for details.<br />
|-<br />
| '''--define_macro='''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br><br />
'''-D'''<i><name></i>['''('''<i>parameter-list</i>''')''']['''='''<i>value</i>]<br />
| Define macro <i><name></i> as <i>value</i>. If "=<i>value</i>" is omitted, define <i><name></i> as 1.<br />
|-<br />
| '''--undefine_macro='''<i><name></i><br><br />
'''-U'''<i><name></i><br />
| Remove predefined macro <i><name></i>.<br />
|-<br />
| '''--compatibility='''<i><string></i><br />
| Vendor compatibility mode. String can be "microsoft", "generic" or "gnu". Default is "generic". When "Microsoft" is set, the compiler supports a number of extensions to the C or C++ language that are compatible with the Microsoft family of compilers. "gnu" - instructs the compiler to support language extensions compatible with the Gnu family of compilers.<br />
|-<br />
| '''--no_warning'''<br />
| Suppress all warnings in the compilation phase.<br />
|-<br />
| '''--macros'''<br />
| Resolve macro (preprocessor define) constant value. Pass this flag only if you intend to do script based testing.<br />
|-<br />
| '''--documentation'''<br />
| Extract [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen style] source documentation. <br />
|-<br />
| '''--output='''<i><path></i><br><br />
'''-o'''<path><br />
| Output file or directory. The default is the current directory.<br />
|-<br />
| '''--targ_big_endian'''<br />
| Target uses a big endian by representation. The default is little endian.<br />
|-<br />
| '''--targ_plain_char_is_unsigned'''<br />
| Target uses unsigned chars to represent “plain” char. The default is signed.<br />
|-<br />
| '''--targ_adaptive_enum'''<br />
| Target has adaptive enums. The default is no adaptive enums.<br />
|-<br />
| '''--targ_pack_alignment='''<i><align></i><br />
| Target struct pack alignment. The default is 16. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_char='''<i><size></i><br />
| Target platform size of char. Default is 1. Possible values are 1, 2, 4, 8, or 16.<br />
|-<br />
| '''--targ_alignof_char='''<i><align></i><br />
| Target platform alignment of char. Default is 1. Possible values are 1, 2, 4, 8 or 16.<br />
|-<br />
| '''--targ_sizeof_short='''<i><size></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_alignof_short='''<i><align></i><br />
| Default is 2.<br />
|-<br />
| '''--targ_sizeof_int='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_int='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_long='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_long_long='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_long_long='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_float='''<i><size></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_alignof_float='''<i><align></i><br />
| Default is 4.<br />
|-<br />
| '''--targ_sizeof_double='''<i><size></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_alignof_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_sizeof_long_double='''<i><size></i><br />
| Default is 8<br />
|-<br />
| '''--targ_alignof_long_double='''<i><align></i><br />
| Default is 8.<br />
|-<br />
| '''--targ_bool_int_kind='''<i><typename></i><br />
| Default is "char".<br />
|-<br />
| '''--targ_wchar_t_int_kind='''<i><typename></i><br />
| Default is "unsigned short".<br />
|-<br />
| '''--targ_size_t_int_kind='''<i><typename></i><br />
| Default is "unsigned int".<br />
|-<br />
| '''--targ_ptrdiff_t_int_kind='''<i><typename></i><br />
| Default is "int".<br />
|-<br />
| '''--options_file='''<i><file></i><br />
| A file that contains command line options. The format is the same as the command line with the only addition that it could be split on multiple lines. A line starting with "#" or ";" symbol is ignored.<br />
This option is necessary if the length of the command line string exceeds system limits. Otherwise it is provided only as a convenience.<br />
<br />
'''''NOTE:''' To simplify the integration in existing build environments other standard compiler options (e.g. ARM [http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0491b/CHDCIEGC.html --via=<file>], GCC [http://gcc.gnu.org/onlinedocs/gcc/Overall-Options.html#Overall-Options @<file>], MSVC [http://msdn.microsoft.com/en-us/library/3te4xt0y(v=VS.90).aspx @<file>]) with similar meaning are also recognized and processed the same way.''<br />
|}<br />
<br />
'''Note''': The [[Framework_Setup#SDK|standard Platform SDKs]] shipped with the Framework contain a set of options files with predefined target settings for several popular CPUs. Please consider using one of them instead of explicitly passing <tt>--targ_*</tt> options on the command line.<br />
<br />
=== Search Path ===<br />
<b>s2scompile</b> by default looks in several different places for headers. It looks for headers requested with <tt>#include <file></tt> in:<br />
<pre><br />
$(STRIDE_DIR)/SDK/Runtime<br />
</pre><br />
<br />
Where $(STRIDE_DIR) is the location where the STRIDE packages are installed following [[Framework_Setup#Directories_and_Files|recomended directory layout]].<br />
<br />
When <i>microsoft</i> mode is specified and $(INCLUDE) enviroment variable is defined (as a ";" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>.<br />
<br />
When <i>gnu</i> mode is specified and $(CPATH) and/or $(C_INCLUDE_PATH) (or $(CPLUS_INCLUDE_PATH) for C++) enviroment variables are defined (as a ":" separated path list) then all of its entries are looked in for headers requested with <tt>#include <file></tt>. In addition if $(TARGET_CPP) specifies the target GNU <tt>cpp</tt> (GCC preprocessor or a command line equivalent) it is queried and any given path by it is looked in.<br />
<br />
You can add to this list, before any of the default places, by using the <tt>-I<dir></tt> option.<br />
<br />
You can prevent s2scompile from searching any of the default directories with the <tt>--no_stdinc</tt> option. <tt>-I</tt> options are not ignored as described above when <tt>--no_stdinc</tt> is in effect. <br />
<br />
<b>s2scompile</b> looks for headers requested with <tt>#include "file"</tt> first in the directory containing the current file, then in the same places it would have looked for a header requested with angle brackets.<br />
<br />
=== Examples ===<br />
Refer to the [[Build_Tools#Compiling_multiple_files|Compiling]] section of the Build Tools Examples.<br />
<br />
=== Notes ===<br />
<references/><br />
[[Category:Build_Tools]]</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14692Framework Setup2018-04-02T17:23:39Z<p>Ivailop: /* Perl Installation (Optional) */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.8.9, 5.10.x, 5.12.x, 5.14.x, 5.16.x, 5.18.x, 5.20.x and 5.22.x of Perl. <br />
<br />
== Windows == <br />
It is required to use the standard '''32-bit''' Perl distributions from [http://www.activestate.com/activeperl/downloads ActiveState].<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
You can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. <br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=STRIDE_Runner&diff=14691STRIDE Runner2018-04-02T17:20:55Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
The '''stride''' executable (a.k.a. Stride Runner) runs script or native target-based tests from a desktop (Windows, Linux or FreeBSD) host computer and optionally uploads results to [http://www.testspace.com Testspace]. <br />
<br />
stride [<i>options</i>] [<i>TU...</i>]<br />
<br />
Each command line option that accepts an argument should be entered with a space between the option and its corresponding argument; i.e.<br />
stride -o argument --option1 argument1<br />
<br />
= Input =<br />
In order to run tests, you must provide the following information to Runner:<br />
<br />
;database file<br />
: This is the .sidb file that is created by the [[Build Tools]] during the target build process. This file contains meta-information used to run tests.<br />
<br />
;device parameters<br />
: This tells how to connect to the target.<br />
<br />
;tests to run<br />
: A set of Test Units and or Test Scripts. <br />
<br />
== Running ==<br />
By default, no tests are run. You need to explicitly list them using the <tt>--run</tt> option.<br />
<br />
=== Order ===<br />
When explicitly specified, Tests are run in the order in which they are given on the command line.<br />
<br />
It is possible to run all Test Units by explicitly specifying a wildcard (*). In that case they are run in alphabetical order.<br />
<br />
=== Rules ===<br />
<br />
* Test Units are specified by name or wildcard<br />
* Scripts are specified by relative or absolute file name <br />
* Tests (scripts or test units) are grouped together within curly braces, i.e. "{" and "}"<br />
* When specifying more than one Test in a group, each Test instance must be delimited by a semicolon.<br />
* When a Test accepts parameters they are passed following the Test name in parentheses comma separated, i.e. "<tt>myTest(param1, param2)</tt>"<br />
* The output of each Test group is placed within a hierarchy of named suites. (The root suite does not have a name.)<br />
* The suite into which a Test group is placed is specified immediately before the group, e.g. ''<tt>suitepath</tt>''<tt>{</tt>''<tt>testunitgroup</tt>''<tt>}</tt><br />
* Hierarchical suite paths are delimited by "/" (forward slash) and are always specified starting from the root.<br />
* If the same Test is specified to be run more than once, and one or more results are to be written to the same suite, the each conflicting Test name is appended with an incrementing count in the form of "(n)". For example: Results from three runs of TestUnit "myTest" are all written to the root suite. The Tests will be reported with the names "myTest" "myTest(1)" and "myTest(2)".<br />
<br />
==== Wildcard Matching ====<br />
The following wildcard characters are recognized in Test Unit specifications:<br />
<br />
* '''<code>*</code>''' (asterisk) matches all Test Units<br />
* '''<code>-</code>''' (hyphen) matches all remaining Test Units (useful when putting Test Units into suites) <br />
<br />
==== Examples ====<br />
<br />
;<code>-r "/{*}"</code><br />
: Run all Test Units and put results into the root-level suite.<br />
<br />
;<code>-r "/Suite{*}"</code><br />
: Run all tests and put results into a suite named "Suite" that is a child of the root suite.<br />
<br />
;<code>-r "/{Test1;Test2;Test3}"</code><br />
: Run the Tests named "Test1", "Test2", and "Test3" in the designated order; put results into the root suite.<br />
<br />
;<code>-r "/{Test1;Test2;Test3}" -r "/SecondPass{Test1}"</code><br />
: Run the Tests named "Test1", "Test2", and "Test3" in the designated order; put results into the root suite. Then run the Test Unit named "Test1" again and put the results into a suite named "SecondPass".<br />
<br />
;<code>-r "/{Test1;Test2;Test3}" -r "/Remaining{-}"</code><br />
: Run the Test Units named "Test1", "Test2", and "Test3" in the designated order; put results into the root suite. Then run all remaining Test Units and put the results into a suite named "Remaining".<br />
<br />
;<code>-r "/Suite1/Suite2{TestA; TestB}"</code><br />
: Run the Tests named "TestA" and "TestB", and put the results into a suite named "Suite2" that is a child of a suite named "Suite1" that is a child of the root. Note that we must enclose the specification in quotes since the specification contains a space.<br />
<br />
;<code>-r "/{TestA(29); TestB(5.67, \"some text\")}"</code><br />
: Run the Tests named "TestA" with parameter 29 and "TestB" with parameters 5.67 and "some text", and put the results into the root suite. Note that we must enclose the specification in quotes since the specification contains spaces and embedded quotes (which needs to be escaped using backslash).<br />
<br />
;<code>-r "TestX; TestY; TestZ"</code><br />
: This is a special convenience syntax. If the suite and grouping braces are omitted, the app runs the the named Test Units and puts their results put into the root suite.<br />
<br />
= Output =<br />
Upon test completion, test output is always written as follows:<br />
<br />
;console output<br />
: A quick summary of results is written to standard output. Test counts are shown for the categories of '''passed''', '''failed''', '''in progress''', and '''not in use'''<br />
<br />
;local xml file<br />
: Detailed results are written to a local xml file. By default, this file is written in the current directory, named as '''"testresult.xml"'''. In addition a '''"testresult.html"''' is generated that could be open in a web browser of your choice. <br />
<br />
;Testspace<br />
: Optionally, you may also publish the results to your [http://www.testspace.com Testspace] upon test completion. Results are uploaded using your Testspace URL and login credentials. You must specify the a destination Testspace project and space names.<br />
<br />
= Options =<br />
{| border="1" cellspacing="0" cellpadding="10" style="align:left;background-color:#ffffcc;" <br />
!width="200pt"|'''Option'''<br />
!width="500pt"|'''Description'''<br />
|- <br />
| '''--database''' [ -d ] ''arg''<br />
| Specifies the name of an existing STRIDE database (.sidb) file that will be used for test execution.<br />
<br />
This can be a relative or absolute path. If the path contains one or more spaces, it must be enclosed in quotes. Under Windows, both DOS and [http://en.wikipedia.org/wiki/Path_(computing)#Uniform_Naming_Convention UNC names] are accepted.<br />
<br />
As a path delimiter you may use either the forward slash or backslash character. (Forward slashes are typically preferred due to the standard use of the backslash as an escape character.)<br />
|- <br />
| '''--device''' ''arg''<br />
| Specifies the parameters to be used to connect to the target device (i.e. TCP:''host'':''port'' or COM''port'':''rate'':''mode''). For example: <br />
* <code>TCP:localhost:8000</code><br />
* <code>COM7:28800:8N1</code><br />
* <code>/dev/ttyS2:57600:8N1</code><br />
|-<br />
| '''--timeout''' ''arg'' (=0)<br />
| Specifies a watchdog timeout (in seconds) per single test function or test method. <br />
Default value is 0. (0 = infinite timeout)<br />
|-<br />
| '''--run''' [ -r ] ''arg''<br />
| Specifies a list of Test Units or Scripts to execute and their order of execution with optional report grouping by suite. You may specify this option many times on the command line to include multiple groupings in a single test. A named Test Suite may be specified more than once to run it multiple times. See [[#Input|Input]] section above for more details.<br />
Any nameless positional option is treated as this option.<br />
|-<br />
| '''--trace''' [ -t ] ''arg'' (=txt)<br />
| Specifies if and how to trace on target instrumentation (functions, messages and test points/logs). <br/><br />
The following types of tracing formats are supported:<br />
* <code>"txt"</code> - single-entry-per-line plain text file<br />
* <code>"yml"</code> - [http://en.wikipedia.org/wiki/Yaml YAML] formated file<br />
* <code>"-"</code> - interactive single-entry-per-line plain text<br />
With the exception of the interactive type all others are attached as an annotation to the output file.<br/><br />
Default value is "txt".<br />
|-<br />
| '''--trace_timeout''' ''arg''<br />
| Specifies a trace timeout (in seconds).<br />
|-<br />
| '''--upload''' [ -u ] ''arg'' (=start)<br />
| Specifies if and how to upload the results to Testspace. Arg specifies type of upload; <br/><br />
The following types of uploads are supported:<br />
* <code>"full"</code> - This causes a new result set to be created and marked complete. <br />
* <code>"start"</code> - This is used to create a new result set and mark it incomplete. An upload of this type should be followed by zero or more uploads that add results and one final upload that finishes the result set.<br />
* <code>"add"</code> - This is used to add more data to an existing incomplete result set. The result set will still be marked incomplete after this upload type.<br />
* <code>"finish"</code> - This is used to add more data to an existing incomplete result set and mark it complete. This is the last step in creating a result set from multiple executions.<br />
Default value is "start". <br />
|-<br />
| '''--testspace''' ''arg''<br />
| Specifies the Testspace URL to which the results will be uploaded, expressed in the following form: <br/><br />
<code><nowiki>user:pwd@<domain>.testspace.com/<project>/<space></nowiki></code> <br/><br />
Where 'domain' is your organization's subdomain, and 'project' and 'space' are the names of related project and space. <br />
|-<br />
| '''--result''' ''arg''<br />
| Name of the output XML result file and optionally, when uploading, the result set name along with folder path (default "root").<br />
The following ways to specify are supported:<br />
* <code>"myfile.xml"</code> - set both, output XML result file and result set name, to be the same.<br />
* <code>"myname|"</code> - set the result set name only, use the default "testresult.xml" as output XML result file.<br />
* <code>"|myfile.xml"</code> - set the output XML result file only, let Testspace to choose the result set name.<br />
* <code>"myname|myfile.xml"</code> - set both, result set name and output XML result file, to be different names.<br />
* <code>"myname/path/to/folder|myfile.xml"</code> - set both, result set name and output XML result file, to be different and upload under an explicit folder path.<br />
* <code>"/path/to/folder|myfile.xml"</code> - set the output XML result file, let Testspace to choose the result set name but upload under an explicit folder path.<br />
Default value is "testresult.xml". <br />
|-<br />
| '''--list'''<br />
| Lists all Test Units and intercepted Functions in the specified Stride database to standard out.<br />
|-<br />
| '''--diagnostics'''<br />
| Performs a set of built-in diagnostic tests on the target. See [[Build_Integration#Running_Diagnostics|Running Diagnostics]] for details.<br />
|-<br />
| '''--log_level''' ''arg'' (=warn)<br />
| Controls the target source [[Test Log |Test Logs]] level. <br/><br />
The following levels are supported:<br />
* <code>"all"</code> - enables all logging<br />
* <code>"info"</code> - enables only INFO and higher<br />
* <code>"warn"</code> - enables only WARN and higher<br />
* <code>"err"</code> - enables only ERROR and higher<br />
* <code>"off"</code> - disables all logging<br />
Default value is "warn". <br />
|-<br />
| '''--options_file''' ''arg''<br />
| Specifies a file from which the program reads command line options. The format is the same as the command line except that options may be split across multiple lines. Lines in an options file that begin with the character '#' are ignored.<br />
|- <br />
| '''--version'''<br />
| Prints version information to the console.<br />
|-<br />
| '''--dry'''<br />
| Dry run, just validate the input without device connection or test execution.<br />
|}<br />
<br />
<br />
=== Using a Proxy ===<br />
If you access the Internet via an HTTP proxy, you must set the environment variables <tt>HTTP_PROXY</tt> and <tt>HTTPS_PROXY</tt> to specify the name and port of the proxy server.<br />
<br />
Symptoms of needing to specify a proxy is the following errors:<br />
<br />
<pre><br />
Unable to proceed. Invalid testspace address or credentials. Couldn't access the specified company. <br />
Failed performing request: [7] Couldn't connect to server<br />
</pre><br />
<pre><br />
Unable to proceed. Failed performing request: [6] Couldn’t resolve host name<br />
</pre><br />
<br />
Define the environment variables in format '''<tt><nowiki>host:port</nowiki></tt>''' where ''host'':''port'' corresponding to your proxy server. For example, on Windows:<br />
> set HTTP_PROXY=myproxy:8765<br />
> set HTTPS_PROXY=myproxy:8765<br />
would instruct the stride runner to use the proxy named <tt>myproxy</tt> on port <tt>8765</tt> to communicate via HTTP and HTTPS protocols.<br />
<br />
If your proxy requires authentication use the format '''<tt><nowiki>username:password@host:port</nowiki></tt>''' where ''username'' and ''password'' are your credentials.</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14690Release Notes2018-04-02T17:19:43Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process.<br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02h ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02i ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02j ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02k ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
=== 5.0.02l ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02m ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02n ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
<br />
=== 5.0.02o ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] integration with [http://help.testspace.com Testspace] has been improved.<br />
* Added support for Perl version 5.22. <br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable process "noexcept" and "constexpr" C++11 specifiers.<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14689Release Notes2018-04-02T16:45:08Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02k ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.01f ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[STRIDE Runtime]] default configuration has been updated to "multi-process" disabled.<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runtime]] may crash in MS ARM64 apps.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Extensions for Visual Studio]] treats "No" and "Empty" ExcludedFromBuild differently in Visual Studio 2012+. <br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
srride.c<br />
stride.props<br />
<br />
=== 5.0.01g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] fails to compile Visual Studio 64-bit "__unaligned" type qualifier.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[STRIDE Runner]] may crash on Linux.</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14688Release Notes2018-04-02T16:28:48Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02k ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite.<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.01f ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] Testspace "suite.*" system variables is deprecated in favor of the new "script.*".<br />
* [[STRIDE Runtime]] default configuration has been updated to "multi-process" disabled.<br />
* [[File_Transfer_Services | File Services]] cross platform handling has been improved.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runtime]] may crash in MS ARM64 apps.<br />
* [[s2scompile|STRIDE Compiler]] incorrectly calculates the size/alignment of synthesized structs<br />
* [[STRIDE Extensions for Visual Studio]] treats "No" and "Empty" ExcludedFromBuild differently in Visual Studio 2012+. <br />
* [[STRIDE Runner]] fails to handle schema/result output in "read-only" directory.<br />
* [[STRIDE Runner]] may handle incorrectly negative integers.<br />
* [[STRIDE Runner]] is missing message response trace payload.<br />
* [[STRIDE Runner]] crashes on multi-command command line with single digit argument.<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
srride.c<br />
stride.props</div>Ivailophttps://www.stridewiki.com/index.php?title=Running_Tests&diff=14687Running Tests2017-10-17T19:20:13Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
Tests are executed using the [[STRIDE Runner | Stride Runner]] controlled by a host computer that is physically connected to the target via a configurable communication channel (TCP/IP or serial port). The application software is required to be running, including the [[STRIDE Runtime | Stride Runtime]], enabling a ''connection'' between the ''Runner'' and ''Runtime''. <br />
<br />
'''Block diagram'''<br />
<br />
<br />
[[Image:Running_Tests.jpg|400px|Connection Block Diagram]] <br />
<br />
<br />
'''Invoking the STRIDE Runner (aka <tt>stride</tt>) from a console'''<br />
<br />
stride --database="path/to/YourTestApp.sidb" --device=TCP:localhost:8000 --run="*"<br />
<br />
Option files can be helpful (i.e. my.opt)<br />
<br />
--database "path/to/YourTestApp.sidb"<br />
--device TCP:localhost:8000<br />
<br />
stride --options_file my.opt --run "*"<br />
<br />
<br />
'''Reviewing your Results'''<br />
<br />
[[Image:Runner_Test_Report.jpg |Example Report]] <br />
<br />
<br />
== Input ==<br />
In order to run tests, you must provide the following information to stride.exe:<br />
<br />
;database file<br />
: This is the .sidb file that is created by the ''Stride Compiler'' during the target build process. This file contains meta-information used to run tests.<br />
<br />
;device parameters<br />
: This defines how to connect to the target.<br />
<br />
;tests to run<br />
: A set of [[Test Unit| Test Units]] compiled in the database. You may also optionally specify named hierarchical suites in which to put the results of the tests you designate.<br />
<br />
<br />
== Output ==<br />
Upon test completion, test output is always written as follows:<br />
<br />
;console output<br />
: A quick summary of results is written to standard output. Test counts are shown for the categories of '''passed''', '''failed''', '''in progress''', and '''not in use'''<br />
<br />
;local xml file<br />
: Detailed results are written to a local xml file. By default, this file is written to the directory where the input Stride database file is located and given the same name as the database file with an extension of ".xml". If you open this file in a web browser, an xsl transform is automatically downloaded and applied before rendering.<br />
<br />
Optionally, you may also publish the results to [http://www.testspace.com Test Space] upon test completion.</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14686Release Notes2016-12-13T02:01:01Z<p>Ivailop: </p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02k ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Release_Notes&diff=14685Release Notes2016-12-13T02:00:24Z<p>Ivailop: /* Minor and Patch releases */</p>
<hr />
<div>__NOTOC__<br />
This page documents the changes in STRIDE releases.<br />
<br />
= 5.0.02x =<br />
The code name for this release is ''South Side''. Released on Apr 21, 2015. <br />
<br />
== Testspace integration ==<br />
Stride Runner integration with [http://help.testspace.com Testspace] has been highly improved.<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* [[s2scompile|STRIDE Compiler]] doesn't support Microsoft preprocessor specific "token-pasting".<br />
* [[STRIDE Runner]] fails on execute test modules with Perl 5.18. <br />
<br />
=== Tests in Scripts ===<br />
* Added support for Perl version 5.20. <br />
* Support for Perl versions 5.14 and older is not provided by default but is available on demand. <br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.02x''' is compatible with the Runtime Version '''5.0.02'''<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.02a ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] local generated result file incorrectly renders links in non-IE browsers. <br />
* [[STRIDE Runner]] incorrectly merges result files with BOM.<br />
* [[STRIDE Runner]] may error out in environments with multi-line variable values.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on results upload in case the Testspace server returns an error.<br />
* [[STRIDE Runner]] is not able to access Testspace Project/Space with white space in the name.<br />
* [[STRIDE Runner]] may silently fail or return incorrect error code.<br />
* [[STRIDE Runner]] times out on target connection when using a custom transport.<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
<br />
=== 5.0.02b ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now reports the implicit "process" test case of a "runnable" suite as NA if no XML result is reported<br />
* [[STRIDE Runner]] console output is much cleaner, need to pass <code>--verbose</code> option to get the old detailed output<br />
* [[STRIDE Runner]] now can consume directly Bullseye, Cobertura, and Clover xml reports. <br />
<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* [[s2scompile|STRIDE Compiler]] is unable process enums with "bool" underlying type.<br />
* [[STRIDE Runner]] may incorrectly handle complex command lines in "runnable" suites.<br />
<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.02c ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[STRIDE Runner]] may not stop on Ctrl-C. <br />
* [[STRIDE Runner]] may not properly parse 3rd party XML results.<br />
* [[STRIDE Runner]] incorrectly sets the mime type of individually uploaded file annotations.<br />
* [[STRIDE Runner]] may not upload results to Testspace in case of HTTP redirect.<br />
* [[STRIDE Runner]] may crash on test cases with very long names.<br />
* [[STRIDE Runner]] may crash on "runnable" suites referencing command line with single digit argument.<br />
<br />
=== 5.0.02d ===<br />
''New features and improvements:'' <br />
* The Linux version of the [[Framework_Setup#Linux.2FFreeBSD|Framework]] now comes with native 64-bit binaries<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Klocwork errors in Runtime source.<br />
* STATUS_DATATYPE_MISALIGNMENT crash in Runtime with VisualStudio 2015 on ARM.<br />
* Runtime fails to compile/run on Apple/iOS.<br />
* [[STRIDE Runner]] may publish multiple result files in random order.<br />
* [[STRIDE Runner]] may not properly escape JUnit annotations' messages.<br />
<br />
''The following Runtime files have been modified:''<br />
srapi.c<br />
srconn.c<br />
srib.c<br />
sribtr.c<br />
srmem.c<br />
srmsgptr.c<br />
srmsgque.c<br />
srmsgrt.c<br />
srmsgsub.c<br />
srstid.c<br />
srsuid.c<br />
srtest.c<br />
srtestutil.c<br />
srtime.c<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palIO.c<br />
palOS.c<br />
stride.c<br />
<br />
=== 5.0.02e ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Race condition in Runtime when [[Test_Point_Testing_in_C/C%2B%2B|srTestPointSetup]] is called more than ones.<br />
* [[STRIDE Runner]] improperly handles invalid result files.<br />
* Intermittent failure in [[Test_Script|Test Scripts]] when run with <code>--log_level=all</code>.<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c<br />
<br />
=== 5.0.02f ===<br />
''New features and improvements:'' <br />
* Default [[STRIDE Runtime]] configuration is now non-multi-process<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* In Testspace, planned STRIDE suites result in failure.<br />
* [[STRIDE Extensions for Visual Studio]] treat "No" and "Empty" ExcludedFromBuild differently<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code that may crash on ARM64 Windows.<br />
* [[File_Transfer_Services | File Services]] on 64-bit [[STRIDE Runner]] not working with 32-bit TestApp<br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
<br />
''The following [[Posix SDK]] files have been modified:''<br />
Makefile<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
Makefile<br />
stride.props<br />
stride.c<br />
<br />
=== 5.0.02g ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] may crash on Linux.<br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces code without Visual Studio 64-bit "__unaligned" type qualifier.<br />
<br />
=== 5.0.02k ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sbind|STRIDE Database Binder]] may crash on Windows when handling matching function declarations with different "calling conventions".<br />
<br />
----<br />
----<br />
<br />
= 5.0.01x = <br />
<br />
The code name of this release is''Warm Waters''. Released on Jun 3, 2014. <br />
<br />
== Testspace Schema execution ==<br />
Now the [[STRIDE Runner]] allows execution of tests defined in a [http://help.testspace.com Testspace] schema.<br />
<br />
=== Input Parameters ===<br />
Passing input parameters per test suite has been implemented. A new Test Class [[ Runtime_Test_Services#method_GetParam | method ]] and C [[ Runtime_Test_Services#srTestGetParam| function]] in the [[STRIDE Runtime]] allow accessing them by name.<br />
<br />
=== Interactive Mode ===<br />
The [[File_Transfer_Services | File Transfer]] subsystem has been updated to allow remote (host) interactive prompt and process execution. In addition the [[STRIDE Runner]] now supports single test case execution.<br />
<br />
== Change Details ==<br />
<br />
=== Fixes ===<br />
''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].''<br />
<br />
* Handling of input payload in [[STRIDE Runner]] times slower compared to output.<br />
* [[STRIDE Runner]] generates report with incorrect timestamps for kernel [[Test Log | Test Logs]].<br />
* [[STRIDE Runner]] may generate a report xml with invalid file annotation content.<br />
<br />
=== Tests in Scripts ===<br />
* Dynamic Test Suites are not supported no more.<br />
<br />
=== Tests in C/C++ ===<br />
* Dynamic Test Suites are not supported no more.<br />
* [[Test_Macros#Assertions|Test Assertion macro]] now by default (controlled via compiler define) throw exceptions.<br />
* [[Test_Macros#Notes|Test Annotation macros]] and [[Test_Log|Test Log macros]] now by default (controlled via compiler define) support variadic arguments.<br />
* Error handling has been improved.<br />
<br />
=== Runtime ===<br />
* STRIDE Host Release '''5.0.01x''' is compatible with the Runtime Version '''5.0.01'''<br />
* SLAP has been move in the core Runtime.<br />
* <tt>srCOMPLEX_TARGET</tt> is set by default now.<br />
* ''All of the Runtime files have been modified. It is recommended that you update them all.''<br />
* ''All [[Posix SDK]] files have been modified.''<br />
* ''All [[Windows SDK]] files have been modified.''<br />
<br />
== Minor and Patch releases ==<br />
<br />
=== 5.0.01a ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now can run executables (optionally in the background) and consume directly JUnit xml report. <br />
* [[STRIDE Runner]] now reports overall suite duration.<br />
* [[STRIDE Runner]] has been updated to handle common suite input defined in folder settings.<br />
* [[STRIDE Runner]] now has improved error handling and supports "dry" run (for fast input validation).<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* Incremental "finish" upload via [[STRIDE Runner]] does not complete the result set.<br />
<br />
=== 5.0.01b ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2sinstrument|STRIDE Instrumentation Generator]] produces incorrect code for function callbacks in a 64-bit build.<br />
* [[Perl_Script_APIs#Assertions|Perl Assertions]] error out with undefined input. <br />
* [[STRIDE Runner]] does not honor timeout for executables and scripts.<br />
* [[STRIDE Runner]] errors out in "dry" run with no database.<br />
* [[STRIDE Extensions for Visual Studio]] error out when solution is opened from a UNC location. <br />
<br />
''The following Runtime files have been modified:''<br />
srcgutil.h<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.props<br />
stride.targets<br />
<br />
=== 5.0.01c ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] traversal of a [http://help.testspace.com Testspace] schema has been optimized.<br />
* [[STRIDE Runner]] now shows the path to local report file and the URL to the uploaded Testspace results.<br />
<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[s2scompile|STRIDE Compiler]] is unable to compile header files with forwardly declared enums.<br />
* [[s2scompile|STRIDE Compiler]] calculates incorrect payload offset for user defined type arguments in a test class constructor.<br />
* [[s2scompile|STRIDE Compiler]] errors out on enums with out of range values.<br />
* [[STRIDE Runner]] is unable to explicitly run "disabled" folder/suite.<br />
* [[STRIDE Runner]] creates empty xsl file on host with no internet connection.<br />
* Static analysis of [[Windows SDK]] source results in a warning.<br />
* [[STRIDE Runtime]] memory pool allocation returns misaligned pointers on 64-bit targets. <br />
<br />
''The following Runtime files have been modified:''<br />
srcfg.h<br />
srtest.h<br />
srmem.c<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
stride.c<br />
<br />
=== 5.0.01d ===<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Windows SDK]] may deadlock on timer stop.<br />
<br />
''The following [[Windows SDK]] files have been modified:''<br />
palOS.c<br />
<br />
=== 5.0.01e ===<br />
''New features and improvements:'' <br />
* [[STRIDE Runner]] now generates a result file that can directly open in any major browser. <br />
* [[STRIDE Runner]] now can upload to a sub-folder in [http://help.testspace.com/ Testspace].<br />
* A new set of [[STRIDE Runner]] Testspace folder settings is defined. Some older settings are deprecated.<br />
* New [[Training]] samples are provided.<br />
''Defects corrected and the customer tracking number associated with them, if any, in brackets []:'' <br />
* [[Test_Point_Testing_in_C/C%2B%2B#srTestPointCheck|srTestPointCheck]] with more expected than actual may never return<br />
* A <code>[section]</code> in Testspace schema "root" settings hides [[STRIDE Runner]] command line options.<br />
* [[STRIDE Runner]] is unable to init/connect when running a Testspace schema sub-folder/suite<br />
* [[STRIDE Runner]] mangles non-STRIDE test suite input<br />
<br />
''The following Runtime files have been modified:''<br />
srtest.c</div>Ivailophttps://www.stridewiki.com/index.php?title=Perl_Script_APIs&diff=14684Perl Script APIs2016-07-27T22:22:46Z<p>Ivailop: /* Methods */</p>
<hr />
<div>__NOTOC__<br />
The Stride perl script model requires you to create perl modules (*.pm files) to group your tests. The following documents the API for the STRIDE::Test base class that you use when creating these modules.<br />
<br />
= STRIDE::Test =<br />
<br />
This is the base class for test modules. It provides the following methods.<br />
<br />
== Declaring Tests ==<br />
<br />
Once you have created a package that inherits from STRIDE::Test, you can declare any subroutine to be a test method by declaring it with the '': Test'' attribute. In addition to test methods, the following attributes declare other kinds of subroutines:<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''subroutine attributes'''<br />
<br />
|-valign="top" <br />
! attribute!! description<br />
<br />
|-valign="top"<br />
| Test<br />
| declares a test method - will be executed automatically when the module is run.<br />
<br />
|-valign="top"<br />
| Test(startup)<br />
| startup method, called once before any of the test methods have been executed.<br />
<br />
|-valign="top"<br />
| Test(shutdown)<br />
| shutdown method, called once after all test methods have been executed.<br />
<br />
|-valign="top"<br />
| Test(setup)<br />
| setup fixture, called before each test method.<br />
<br />
|-valign="top"<br />
| Test(teardown)<br />
| teardown fixture, called after each test method.<br />
<br />
|}<br />
<br />
You are free to declare as many methods as you like with these attributes. When more than one method has been declared with the same attribute, the methods will be called at the appropriate time in the order declared.<br />
<br />
== Methods ==<br />
<br />
These methods are all available in the context of a test module that inherits from STRIDE::Test.<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Methods'''<br />
<br />
|-valign="top" <br />
! name !! description<br />
|-valign="top"<br />
| <source lang="perl">TestCase</source><br />
| returns the default test case object. See [[#TestCase|here]] for more info.<br />
<br />
|-valign="top"<br />
| <source lang="perl">Remote</source><br />
| Returns a [[#STRIDE::Remote|STRIDE::Remote]] object that was initialized with the active database. This object is used for accessing captured at the time of compilation remote functions and constant values (macros and enums).<br />
<br />
|-valign="top"<br />
| <source lang="perl">GetParam(name, defval)</source><br />
| returns an input parameter's value associated with the test suite.<br />
<br />
|-valign="top"<br />
| <source lang="perl">TestCase AddCase(name, description)</source><br />
| creates a new test case and adds it to the test suite.<br />
<br />
|-valign="top"<br />
| <source lang="perl">TestAnnotation AddAnnotation(level, name, description)</source><br />
| creates a new test annotation and adds it to the test suite. The value of ''level'' could be one of the predefined constants:<br />
* '''ANNOTATION_TRACE'''<ref name="const">symbols like these are exported as perl constants - don't quote these values when you use them - rather, use the bare symbols and perl will use the constant value we provide</ref><br />
* '''ANNOTATION_DEBUG'''<br />
* '''ANNOTATION_INFO''' <br />
* '''ANNOTATION_WARNING'''<br />
* '''ANNOTATION_ERROR'''<br />
* '''ANNOTATION_FATAL'''<br />
|<br />
<br />
|-valign="top"<br />
| <source lang="perl">SetData(name, value)</source><br />
| associates a custom name-value pair with the test suite.<br />
<br />
|-valign="top"<br />
| <source lang="perl">TestPointSetup( <br />
expected => [], <br />
unexpected => [],<br />
ordered => 0|1,<br />
strict => 0|1,<br />
continue => 0|1,<br />
expect_file => filepath,<br />
predicate => coderef,<br />
replay_file => filepath,<br />
test_case => case)</source><br />
| Creates a new instance of [[#STRIDE::TestPoint|STRIDE::TestPoint]], automatically passing the default TestCase() as the test case if none is provided. Options are passed using hash-style arguments. The supported arguments are:<br />
; ordered : flag that specifies whether or not the expectation set must occur in the order specified. If set to true, the expectation list is treated as an ordered list, otherwise we assume the list is unordered. Default value is true (ordered processing). <br />
; strict : flag that specifies if the list is exclusive. If strict is specified, then the actual events (within the specified universe of test points) must match the expectation list exactly as specified. If strict processing is disabled, then other test points within the universe are allowed to occur between items specified in the expectation list. The default value is true (strict processing).<br />
; continue : flag that specifies whether the expectation should continue to process test points even after the specified expectation has been minimally satisfied. Normally, a test will complete as soon as the expectation is satisfied. In some circumstances, however, it is necessary to continue waiting until the full timeout period (specified to the Wait function) before exiting. The default value is 0, indicating that the test will exit as soon as it is satisfied (or otherwise fails).<br />
; expected : is an array reference containing elements that are either strings representing the test point labels '''OR''' an anonymous sub-array that contains these four items: '''[label, count, predicate, expected_data]'''. The four element arrayref elements are:<br />
* ''label'' is the test point label (same as the non array argument type). the label is also allowed to be specified using one of the predefined constant values: '''TEST_POINT_ANY_IN_SET'''<ref name="const"/> or '''TEST_POINT_ANY_AT_ALL'''. '''TEST_POINT_ANY_IN_SET''' is used to indicate a place in the expectation list where '''any''' test point that's otherwise explicitly defined in the set is permitted. '''TEST_POINT_ANY_AT_ALL''' is used to indicate a place in the expectation where '''any''' test point in the system is allowed. When either special value is used in the expectation list, a predicate must ''also'' be specified. The test point is only considered satisfied when the predicate returns true. These special values can be used to implement, among other things, startup scenarios where you want to defer your expectation list processing until a particular test point and/or data state have been encountered. When specifying either value in an '''unordered''' expectation, it is only allowed to appear '''once''' in the expectation list and, in that case, it is treated as a startup expectation whereby none of the other test points are processed until the startup expectation has been satisfied (when it's predicate returns true).<br />
* ''count'' is the number of expected occurrences - can be any positive integer value, or the special value '''TEST_POINT_ANY_COUNT'''<ref name="const"/>.<br />
* ''predicate'' must be a perl coderef for a function to call as a predicate. You are free to define your own predicate function OR use on the three [[#Predicates | standard ones]] provided by STRIDE::Test.<br />
* ''expected_data'' will be passed as an argument to the predicate - intended to be used to specify expected data. <br />
If using the array form of expectation, only the label entry is required - the remaining elements are optional.<br />
; unexpected : is an array reference containing labels that are to be treated as failure if they are encountered. For either ''expected'' and ''unexpected'', the special value '''TEST_POINT_EVERYTHING_ELSE'''<ref name="const"/> can be used alone to indicate that any test points not explicitly listed in the set are considered part of this set.<br />
; expect_file : if you have previously captured YAML trace data in a file (using the [[Stride Runner]]), you can specify the file as the source of expectations using this parameter. If you specify a YAML trace file, you should NOT also specify the '''expected''' items as they will be overridden by the YAML trace file.<br />
; predicate : is a perl coderef to a default predicate function to use for all expectation items. If any specific entry in the expectation list has a predicate function, the expectation's predicate will override this global value. By default, no global predicate is assumed and no predicate is called unless specified for each expectation item.<br />
; replay_file : allows you to specify a YAML trace file and '''''input''''' to the current test. If specified, the expectation will be validated against the events specified in the file rather than live events generated by a device under test.<br />
; test_case : allows you to specify a test case to use for reporting the results. This is only useful for advanced users that are generating test cases dynamically within a test method. <br />
<br />
The returned object is of type [[#STRIDE::TestPoint|STRIDE::TestPoint]] and has access to all it's member functions.<br />
<br />
|}<br />
<br />
== Assertions ==<br />
<br />
Each of the following assertion methods are provided for standard comparisons. For each, there there are three different types, depending on the desired behavior upon failure: '''EXPECT''', '''ASSERT''', and '''EXIT'''. '''EXPECT''' checks will fail the current test case but continue executing the test method. '''ASSERT''' checks will fail the current test case and exit the test method immediately. '''EXIT''' checks will fail the current test case, immediately exit the current test method AND cease further execution of the test module.<br />
<br />
For simplicity, we refer to all the macros using a '''''prefix''''' tag - when using the macros in test code, the '''''prefix''''' should be replaced by one of the following: '''EXPECT''', '''ASSERT''', or '''EXIT''', depending on how the test writer wants failures to be handled.<br />
<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Boolean'''<br />
<br />
|- <br />
! macro !! Pass if<br />
|-<br />
| '''''prefix'''''_TRUE(''cond'');<br />
| ''cond'' is true<br />
<br />
|-<br />
| '''''prefix'''''_FALSE(''cond'');<br />
| ''cond'' is false<br />
<br />
|}<br />
<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Comparison'''<br />
|- <br />
! macro !! Pass if<br />
<br />
|-<br />
| '''''prefix'''''_EQ(''val1'', ''val2'');<br />
| ''val1'' == ''val2''<br />
<br />
|-<br />
| '''''prefix'''''_NE(''val1'', ''val2'');<br />
| ''val1'' != ''val2''<br />
<br />
|-<br />
| '''''prefix'''''_LT(''val1'', ''val2'');<br />
| ''val1''<nowiki> < </nowiki>''val2''<br />
<br />
|-<br />
| '''''prefix'''''_LE(''val1'', ''val2'');<br />
| ''val1''<nowiki> <= </nowiki>''val2''<br />
<br />
|-<br />
| '''''prefix'''''_GT(''val1'', ''val2'');<br />
| ''val1'' > ''val2''<br />
<br />
|-<br />
| '''''prefix'''''_GE(''val1'', ''val2'');<br />
| ''val1'' >= ''val2''<br />
<br />
|}<br />
<br />
For all of the value comparison methods ('''_EQ''', '''_NE''', etc.), the comparison is numeric if both arguments are numeric -- otherwise the comparison is a case sensitive string comparison. If case insensitive comparison is needed, simply wrap both arguments with perl's builtin '''lc()''' (lowercase) or '''uc()''' (uppercase) functions.<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Predicates'''<br />
|- <br />
! macro !! Pass if<br />
<br />
|-<br />
| '''''prefix'''''_PRED(''coderef'', ''data'')<br />
| ''&coderef''(''data'') returns true. The predicate function is specified by ''coderef'' with optional data ''data''. The predicate can also return the special value '''TEST_POINT_IGNORE'''<ref name="const"/>' to indicate that the event should be ignored.<br />
<br />
|}<br />
<br />
Each of these expectation methods also supports the following optional named arguments: <br />
; test_case => case : allows you to apply the check to a test case other than the current default<br />
; message => "message" : allows you to specify an additional message to include if the check fails. <br />
<br />
Because these arguments are optional, they are passed using named argument (hash-style) syntax after the required parameters that are shown above.<br />
<br />
== Annotations ==<br />
<br />
The following methods can be used to annotate a test case. Typically these methods are used to add additional information about the state of the test to the report.<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Annotation Methods'''<br />
<br />
|-valign="top" <br />
! name !! description<br />
<br />
|-valign="top"<br />
| <source lang="perl">NOTE_INFO(message)</source><br />
| creates an info note in your test results report.<br />
<br />
|-valign="top"<br />
| <source lang="perl">NOTE_WARN(message)</source><br />
| creates a warning note in your test results report.<br />
<br />
|-valign="top"<br />
| <source lang="perl">NOTE_ERROR(message)</source><br />
| creates an error note in your test results report.<br />
<br />
|}<br />
<br />
Each of these note methods also supports the following optional named arguments: <br />
; test_case => case : allows you to add the note to a test case other than the current default<br />
; file => file : allows you to attach a file along with the annotation message. <br />
; test_point => test_point_hashref : If you are annotating your report in the context of a predicate with a specific test point, you might want to specify the test point using this parameter. This will cause your annotation to be grouped in the final report with the annotation message that corresponds to the test point hit message. By default, a host timestamp value is used to generate the NOTE annotation, which generally causes the NOTE annotations to group toward the end of the test case report.<br />
<br />
Because these arguments are optional, they are passed using named argument (hash-style) syntax after the required parameters that are shown above.<br />
<br />
== Documentation ==<br />
<br />
We have preliminary support for documentation extraction in the test modules using the standard perl POD formatting tokens. <br />
<br />
The POD that you include in your test module currently must follow these conventions:<br />
<br />
* it must begin with a ''head1 NAME'' section and the text of this section must contain the name of the package, preferably near the beginning.<br />
* a ''head1 DESCRIPTION'' can follow the ''NAME'' section. If provided, it will be used as the description of the test suite created for the test unit.<br />
* This NAME/DESCRIPTION block must finish with an empty ''head1 METHODS'' section.<br />
* each of the test methods can be documented by preceding them with a ''head2'' section with the same name as the test method (subroutine name). The text in this section will be used as the testcase description.<br />
<br />
== Predicates ==<br />
<br />
STRIDE expectation testing allows you to specify predicate functions for sophisticated data validation. We provide several standard predicates in the STRIDE::Test package, or you are free to define your own predicate functions.<br />
<br />
=== Builtin Predicates ===<br />
The STRIDE::Test library provides a few standard predicates which you are free to use in your expectations:<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Built-In Predicates'''<br />
<br />
|-valign="top" <br />
! predicate !! description<br />
<br />
|-valign="top"<br />
| '''TestPointStrCmp'''<br />
| does a case '''''sensitive''''' comparison of the test point data and the ''expected_data'' (specified as part of the expectation)<br />
<br />
|-valign="top" <br />
| '''TestPointStrCaseCmp'''<br />
| does a case '''''insensitive''''' comparison of the test point data and the ''expected_data''<br />
<br />
|-valign="top" <br />
| '''TestPointMemCmp'''<br />
| does a bytewise comparison of the test point data and the ''expected_data''<br />
<br />
|-valign="top" <br />
| '''TestPointDefaultCmp'''<br />
| pass-through function that calls '''TestPointMemCmp''' for binary test point data or '''TestPointStrCmp''' otherwise. This is useful as a global predicate since it implements an appropriate default data comparison.<br />
<br />
|}<br />
<br />
=== User Defined Predicates ===<br />
User defined predicates are subroutines of the following form:<br />
<br />
<source lang="perl"><br />
sub myPredicate <br />
{<br />
my ($test_point, $expected_data) = @_;<br />
my $status = 0;<br />
# access the test point data as $test_point->{data}, <br />
# and the label as $test_point->{label}<br />
<br />
# set $status according to whether or not your predicate passes<br />
return $status;<br />
}<br />
</source><br />
<br />
The predicate function is passed two arguments: the current test point and the expected data that was specified as part of the expectation. The test point data is a reference to a hash with the following fields: <br />
; label : the test point label<br />
; data : the data payload for the test point (if any)<br />
; data_as_hex : an alternate form of the data payload, rendered as a string of hex characters<br />
; size : the size of the data payload<br />
; bin : flag indicating whether or not the data payload is binary<br />
; file : the source file for the test point<br />
; line : the line number for the test point<br />
<br />
The expected data is passed as a single scalar, but you can use references to compound data structures (hashes, arrays) if you need more complex expected data.<br />
<br />
The predicate function should return a true value if it passes, false if not, or '''TEST_POINT_IGNORE'''<ref name="const"/> if the test point should be ignored completely.<br />
<br />
= STRIDE::Remote =<br />
<br />
The ''STRIDE::Remote'' class uses perl '''AUTOLOAD'''-ing to provide a convenient syntax for making simple function calls and retrieving database constants in perl. Given any properly initialized ''STRIDE::Test'' object, any captured function or constant (macro) is available directly as method or properties of the exported ''Remote'' object. Constants can also be accessed via the tied hash ''constants'' member. <br />
<br />
For example, given a database with two functions and a macro:<br />
<br />
<source lang="c"><br />
int foo(const char * path);<br />
void bar(double value);<br />
<br />
#define MY_PI_VALUE 3.1415927<br />
</source><br />
<br />
In perl these methods/constants are invokable using the exported ''STRIDE::Test'' Remote object:<br />
<br />
<source lang="perl"><br />
my $retval = Remote->foo("my string");<br />
Remote->bar(Constants->{MY_PI_VALUE});<br />
</source><br />
<br />
== Asynchronous invocation == <br />
<br />
Functions can also be called asynchronously by using the ''async'' delegator within the ''Remote'' object. When invoked this way, the function call will return a handle object that can be used to wait for the function return value - for example:<br />
<br />
<source lang="perl"><br />
my $h = Remote->async->foo("my string");<br />
my $retval = $h->Wait(1000);<br />
</source><br />
<br />
The '''Wait''' function takes one optional argument -- the timeout duration (in milliseconds) that indicates the maximum time to wait for the function to return. If the timeout value is not provided, ''Wait'' will wait indefinitely for the function to return. If a timeout is specified and expires before the function returns, the method with ''die'' with a timeout error message - so you might want to wrap your '''Wait''' call in an <tt>eval{};</tt> statement if you want to gracefully handle the timeout condition.<br />
<br />
= STRIDE::TestPoint =<br />
<br />
STRIDE::TestPoint objects are used to create test point expectation tests. These objects are created using the exported TestPointSetup factory function of the STRIDE::Test class. Once a STRIDE::TestPoint object has been created with the desired expectations, two functions can be called:<br />
<br />
; Wait(timeout) : This method processes test points that have occurred on the target and assesses failure based on the parameters you provided when creating the TestPoint object. The timeout parameter indicates how long (in milliseconds) to Wait for the specified events. If no timeout value is provided, '''Wait''' will proceed indefinitely or until a clear pass/failure determination can be made.<br />
; Check() : this is equivalent to Wait with a very small timeout. As such, it essentially verifies that your specified test points have already been hit.<br />
<br />
= Reporting Model =<br />
<br />
The STRIDE perl framework includes an implementation of our [[Reporting Model]] that is common across all STRIDE components. The Test module gives explicit access to key elements of the report model, Cases and Annotaions. Here are a description of the methods available for each of these Objects.<br />
<br />
== TestCase ==<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Methods'''<br />
<br />
|-valign="top" <br />
! name !! description<br />
<br />
|-valign="top"<br />
| <source lang="perl">SetStatus(status, duration) </source><br />
| sets the test case status. The value of ''status'' could be one of the predefined constants:<br />
* '''TEST_FAIL'''<ref name="const"/><br />
* '''TEST_PASS'''<br />
* '''TEST_NOTINUSE'''<br />
* '''TEST_INPROGRESS'''<br />
* '''TEST_DONE''' - applicable to dynamic cases - sets the status to '''pass''' unless already set to '''fail''' or '''not-in-use'''<br />
<br />
|-valign="top"<br />
| <source lang="perl">TestAnnotation AddAnnotation(level, name, description)</source><br />
| creates a new test annotation and adds it to the test case. The value of ''level'' could be one of the predefined consttants:<br />
* '''ANNOTATION_TRACE'''<ref name="const"/><br />
* '''ANNOTATION_DEBUG'''<br />
* '''ANNOTATION_INFO''' <br />
* '''ANNOTATION_WARNING'''<br />
* '''ANNOTATION_ERROR'''<br />
* '''ANNOTATION_FATAL'''<br />
<br />
|-valign="top"<br />
| <source lang="perl">SetData(name, value)</source><br />
| associates a custom name-value pair with the test case.<br />
<br />
|}<br />
<br />
== TestAnnotation ==<br />
<br />
{| class="prettytable"<br />
| colspan="2" | '''Methods'''<br />
<br />
|-valign="top" <br />
! name !! description<br />
<br />
|-valign="top"<br />
| <source lang="perl">AddComment(label, message)</source><br />
| adds a new comment to the test annotation.<br />
<br />
|}<br />
<br />
== Notes ==<br />
<references/></div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14683Framework Setup2016-07-27T19:41:06Z<p>Ivailop: </p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows and Linux.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86_64)<br />
:<tt>STRIDE_framework-x86_64-linux_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.8.9, 5.10.x, 5.12.x, 5.14.x, 5.16.x, 5.18.x and 5.20.x of Perl. <br />
<br />
== Windows == <br />
It is required to use the standard '''32-bit''' Perl distributions from [http://www.activestate.com/activeperl/downloads ActiveState].<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
You can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. <br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailophttps://www.stridewiki.com/index.php?title=Framework_Setup&diff=14682Framework Setup2016-07-27T19:35:33Z<p>Ivailop: /* Perl Installation (Optional) */</p>
<hr />
<div>= Introduction = <br />
The packages described below contain all of the ''source'' and ''binary'' components required to<br />
* setup a desktop with the '''STRIDE Runner'''<br />
* integrate the '''STRIDE Runtime''' with the target device<br />
* add the '''STRIDE Compiler''' (aka ''Build tools'') to the software build system.<br />
<br />
The desktops supported are Windows, Linux, and FreeBSD.<br />
<br />
= Packages =<br />
Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):<br />
;Windows (x86)<br />
:<tt>STRIDE_framework-windows_5.x.yy.zip</tt><br />
;Linux (x86)<br />
:<tt>STRIDE_framework-linux_5.x.yy.tgz</tt><br />
;FreeBSD (x86)<br />
:<tt>STRIDE_framework-freebsd_5.x.yy.tgz</tt><br />
<br />
Please see the appropriate installation instructions below.<br />
<br />
= Windows =<br />
<br />
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>\stride</tt>). <br />
<br />
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.<br />
<br />
cd \stride<br />
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip<br />
<br />
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>\stride\bin</tt>. <br />
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].<br />
<br />
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).''<br />
<br />
=== Create/Update STRIDE_DIR===<br />
<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>\stride</tt>). If this environment variable does not yet exist, you should create it as a user environment variable.<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>\stride</tt> directory.<br />
<br />
= Linux/FreeBSD =<br />
<br />
The following installation example assumes the the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. You can choose to install to a different location (all instructions below assume you are installing into <tt>~/stride</tt>). <br />
<br />
cd ~/stride<br />
tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz<br />
<br />
Once unzipped, files will have been installed under the <tt>~/stride</tt> directory.<br />
<br />
=== Updated PATH ===<br />
As a final step, you will need to update your <tt>[http://en.wikipedia.org/wiki/Path_(variable) PATH]</tt> environment variable to include <tt>~/stride/bin</tt>. <br />
<br />
If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export PATH=$PATH:~/stride/bin<br />
<br />
For other shells, and more information, please see the following articles:<br />
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].<br />
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]<br />
<br />
=== Create/Update STRIDE_DIR===<br />
Verify that the <tt>STRIDE_DIR</tt> environment variable exists and is set to the root installation directory (<tt>~/stride</tt>). If this environment variable does not yet exist, you should automatically set at each login, add to your <tt>.bashrc</tt>:<br />
export STRIDE_DIR=~/stride<br />
<br />
To confirm installation and display ''help'' run the following command in a console window:<br />
<br />
stride -h<br />
<br />
NOTE: ''In a 64-bit environment the above may fail with errors like: <code>"/lib/ld-linux.so.2: bad ELF interpreter: No such file or directory"</code> or <code>"ELF interpreter /libexec/ld-elf32.so.1 not found"</code>. To resolve this issue install the appropriate 32-bit compatibility libraries for your Linux/FreeBSD distribution:''<br />
<br />
* Debian / Ubuntu<br />
sudo dpkg --add-architecture i386<br />
sudo apt-get install libc6:i386 libstdc++6:i386<br />
* Fedora / CentOS / RHEL<br />
sudo setarch i386 yum install glibc libstdc++<br />
* SUSE<br />
sudo zypper install glibc-32bit libstdc++6-32bit<br />
* Arch<br />
Make sure to enable the [https://wiki.archlinux.org/index.php/Multilib multilib] repository.<br />
sudo pacman lib32-glibc lib32-gcc-libs<br />
* FreeBSD<br />
Make sure to have <code>lib32</code> installed (via [http://www.freebsd.org/cgi/man.cgi?query=sysinstall&apropos=0&sektion=0&manpath=FreeBSD+8.4-RELEASE&arch=default&format=html sysinstall(8)] - Configure|Distributions|lib32) and have your kernel built with:<br />
options COMPAT_FREEBSD32 # Compatible with i386 binaries<br />
<br />
=== Uninstalling ===<br />
To uninstall STRIDE simply:<br />
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. <br />
* Remove <tt>STRIDE_DIR</tt> environment variable.<br />
* Remove <tt>~/stride</tt> directory.<br />
<br />
= Directories and Files =<br />
<br />
To integrate Stride in to your target build system it is required to understand the directories layout and the files inside then. A quick orientation is shown below.<br />
<br />
<u>''NOTE:''</u> ''It's not necessary to understand the workings of Stride to perform evaluation or training. The framework package contains a [[Stride Sandbox]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.''<br />
<br />
==<tt>bin</tt>==<br />
This directory contains the [[Build Tools|Stride Build Tools]] and the [[Stride Runner]].<br />
<br />
The build tools are invoked early on in the target software build process to generate special Stride artifacts that are used in subsequent build steps and later when running tests against the target. When using the Stride Sandbox, these files are needed on the host computer since this is where we are building the target application. In a production environment, these files are needed only on the computer that performs the target software build.<br />
<br />
The [[Stride Runner]] is the program you use to run tests from the host.<br />
<br />
==<tt>lib</tt>==<br />
This directory contains a set of Stride specific core scripting libraries along with prebuild binaries intended to be used for Perl based test scripts.<br />
<br />
==<tt>samples</tt>==<br />
The Samples directory contains a number of source files used for training and evaluation.<br />
<br />
==<tt>SDK</tt>==<br />
This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[STRIDE Runtime]]. These sources are built in to a static libary (e.g. STRIDE Runtime library - <tt>stride.a/lib</tt>) as a dependency of your Test Application. <br />
<br />
The <tt>Posix</tt> and <tt>Windows</tt> directories contain the target operating system specific source and configuration. If you are interested in the details, consult the articles [[Posix SDK]] and [[Windows SDK]]. Each of them contains the following sub-directories:<br />
<br />
*<tt>settings</tt><br />
: This directory contains a set of <tt>stride.XXX.s2scompile</tt> files, where <tt>XXX</tt> coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the [[s2scompile|STRIDE Compiler]], specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for [[STRIDE_Extensions_for_Visual_Studio|building with Visual Studio]].<br />
*<tt>src</tt><br />
: This directory contains the source of the target [[Platform Abstraction Layer]] PAL. In addition there is a sample Makefile used to produce a sandbox TestApp.<br />
<br />
= Perl Installation (Optional) =<br />
If you intend to use '''Test Scripts''' you will need a recent version of Perl (x86 with threads support) installed. <br />
<br />
As of this writing, we support only the versions 5.8.9, 5.10.x, 5.12.x, 5.14.x, 5.16.x, 5.18.x and 5.20.x of Perl. <br />
<br />
== Windows == <br />
It is required to use the standard '''32-bit''' Perl distributions from [http://www.activestate.com/activeperl/downloads ActiveState].<br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
set PATH=...\perl\bin;%PATH%<br />
set PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
You can easily install these packages using the [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html ppm tool]. If you access the Internet via a proxy make sure to read [http://docs.activestate.com/activeperl/5.16/faq/ActivePerl-faq2.html#ppm_and_proxies this]. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:<br />
<br />
ppm install PACKAGE_NAME<br />
<br />
== Linux ==<br />
We recommend you to use the standard '''64-bit''' Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. <br />
<br />
Depending on the way the installation was performed, you may have to update your PATH and reset any custom PERL5LIB, e.g.:<br />
<br />
export PATH=.../perl/bin:$PATH<br />
export PERL5LIB=<br />
<br />
The following additional (non-standard) Perl packages are also required for full functionality of Stride tests in perl:<br />
<br />
* [http://search.cpan.org/perldoc/Time::HiRes Time::HiRes]<br />
* [http://search.cpan.org/perldoc/YAML::XS YAML::XS]<br />
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA]<br />
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM]<br />
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump]<br />
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny]<br />
<br />
The simplest method for installing packages is via the [http://www.perl.com/doc/manual/html/lib/CPAN.html CPAN shell]. If you access the Internet via a proxy make sure to set the appropriate [http://search.cpan.org/dist/CPAN/lib/CPAN.pm#Config_Variables CPAN config variables]. To start the shell in interactive mode:<br />
<br />
perl -MCPAN -e shell<br />
<br />
''<u>NOTE:</u>'' ''If your perl is installed in a system directory (<tt>/usr/bin/perl</tt>, for instance), you will need root access to install shared modules.''<br />
<br />
Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install):<br />
<br />
install PACKAGE_NAME<br />
<br />
The STRIDE perl packages also need to load your system's '''libperl.so''' (shared object file) at runtime. Depending on your system, this file should be loadable from a perl CORE directory or from one of the shared system directories. If you '''DO NOT''' have this shared library on your system, you might need to install a ''libperl-dev'', ''perl-devel'' or ''perl-libs'' package in order to get it. Here is how you can do that on the console of some Linux distributions:<br />
<br />
* Debian / Ubuntu<br />
sudo apt-get install libperl-dev<br />
* Fedora / CentOS / RHEL<br />
sudo yum -y install perl-devel<br />
<br />
== Validation ==<br />
Once you have installed Perl we recommend you to run the following command in a console window:<br />
<br />
<source lang="bash"><br />
stride --diagnostics Perl --output PerlCheck<br />
</source><br />
<br />
If everything was properly set up you should get the following output:<br />
<br />
<pre><br />
Executing diagnostics...<br />
script "/Perl"<br />
> 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms.<br />
---------------------------------------------------------------------<br />
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use, 486.95 ms<br />
<br />
Saving result file...<br />
</pre><br />
<br />
In addition a report file with name <tt>PerlCheck.xml</tt> will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.</div>Ivailop