Difference between revisions of "Desktop Installation"

From STRIDE Wiki
Jump to: navigation, search
Line 1: Line 1:
−
To perform [[Sandbox Evaluation & Training]], you need to install the STRIDE Framework package on your PC. Prior to version 4.1.02 (released in October 2009), the framework was distributed using a set of four separate archives. Starting with version 4.1.02 the framework is distributed as a single archive. <u>For installation instructions for the earlier version, please see [[Package Installation for Version 4.1.01]]</u>.
+
To perform [[Sandbox Evaluation & Training]], you need to install the following packages on your PC. Starting with version 4.1.02 (released in October 2009), the framework is distributed using a single archives. For installation instructions for the earlier version, please see [[Package Installation for Version 4.1.02]].  
  
−
== Installation Packages ==
+
Each STRIDE Framework package is distributed as a compressed archive; installing the package consists of decompressing the archive to your local disk.  
−
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):
 
−
;Windows XP
 
−
:<tt>STRIDE_framework-windows_4.1.02.zip</tt>
 
−
;Linux
 
−
:<tt>STRIDE_framework-linux_4.1.02.zip</tt>
 
  
−
Please see the appropriate installation instructions below.
 
  
−
= Linux Installation =
+
;STRIDE SDK
 +
:STRIDE runtime, and build resources targeting the host operating system (Windows or Linux)
 +
;STRIDE Samples
 +
:Sample tests
 +
;STRIDE BuildTools
 +
:Executables that augment the build process, providing automatic test harness generation from source files
 +
;STRIDE HostTools
 +
:The STRIDE test runner application -- for production (non-sandbox) installations, this is the only package that needs to be installed on the host PC.
  
−
=== Unzip the Installation Package ===
 
−
# Create a directory named <tt>stride</tt> in your home directory.
 
−
# Unzip the package to the <tt>stride</tt> directory
 
  
−
For example:
+
== SDK (''includes STRIDE Runtime'') ==
 +
The SDK is intended to be used primarily as an off-target evaluation or development sandbox. This allows you to use STRIDE in a small, controlled environment without needing to make changes to your target build.
 +
 +
For more information, see [[Sandbox Evaluation]].
 +
=== Installation ===
 +
SDKs are distributed as zip archives. To install, run an unzipping utility, maintaining the directory structure of the archived files. We recommend that you create a parent directory named "stride" into which you upzip the archive.
 +
 
 +
==== Linux ====
 +
The following installation example assumes that the SDK archive is located in your home directory and that the directory <tt>~/stride</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
  
 
  cd ~/stride
 
  cd ~/stride
−
  unzip ../STRIDE_framework-linux_4.1.02.zip
+
  unzip ../STRIDE4.1_sdk-linux_4.1.xx.zip
 +
 
 +
Once unzipped, files will have been installed under <tt>~/stride/SDK</tt>.
 +
 
 +
==== Windows ====
 +
The following installation example assumes the the SDK archive is located in your root directory and that the directory <tt>\stride</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
 +
 
 +
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.
  
−
Note: ''This assumes that the installation package is located in your home directory and that the directory <tt>~/stride</tt> exists. The version numbers in your archive file name may be different than those shown in the example.''
+
cd \stride
 +
"\Program Files\7-Zip\7z" x ..\STRIDE4.1_sdk-windows_4.1.xx.zip
  
−
=== Set Execute Mode on STRIDE Executable Files ===
+
Once unzipped, files will have been installed under <tt>\stride\SDK</tt>.
−
In order to be able to execute the STRIDE-related programs, you must set the execute bit on the following files in the <tt>~/stride/bin</tt> directory:
 
−
* <tt>doxygen</tt>
 
−
* <tt>s2sbind</tt>
 
−
* <tt>s2scompile</tt>
 
−
* <tt>s2scpfe</tt>
 
−
* <tt>s2sinstrument</tt>
 
−
* <tt>stride</tt>
 
  
−
For example:
+
== Samples ==
 +
The Test Unit samples are a collection of source code that demonstrates the techniques for creating and executing test code on a target application, in both C and C++ development environments.
  
−
cd ~/stride/bin
+
For more information, see [[Test Unit Samples]].
−
chmod +x doxygen stride s2*
 
  
 +
===Installation===
 +
The Test Unit samples are distributed as a zip archive. To install, run an unzipping utility, maintaining the directory structure of the archived files. We recommend that you unzip the archive into a parent directory named "stride".
  
−
=== Update Your PATH ===
+
====Linux====
−
As a final step, you will need to update your PATH environment variable to include <tt>~/stride/bin</tt>.  
+
The following installation example assumes that the Samples archive is located in your home directory and that the directory <tt>~/stride</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
  
−
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>:
+
  cd ~/stride
−
  export PATH=$PATH:~/stride/bin
+
unzip ../STRIDE4.1_samples_4.1.xx.zip
  
−
For other shells, and more information, please see the following articles:
+
Once unzipped, files will have been installed under <tt>~/stride/Samples</tt>.
−
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].
 
−
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]
 
  
−
= Windows Installation =
+
====Windows====
−
The following installation example assumes the the installation package is located in your root directory and that the directory <tt>\stride</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
+
The following installation example assumes the the Samples archive is located in your root directory and that the directory <tt>\stride</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
  
 
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.
 
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.
  
 
  cd \stride
 
  cd \stride
−
  "\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_4.1.02.zip
+
  "\Program Files\7-Zip\7z" x ..\STRIDE4.1_samples_4.1.xx.zip
 +
 
 +
Once unzipped, files will have been installed under <tt>\stride\Samples</tt>.
 +
 
 +
== Build Tools ==
 +
The STRIDE Build Tools are a set of command line utilities that perform the Stride compile/build process as part of your target build.
 +
 
 +
For more information, see [[Build Tools]].
 +
 
 +
=== Installation ===
 +
The build tools are distributed as zip archives on Windows and tgz archives on Linux. To install, run the appropriate decompression utility. It's recommended that these files be placed in a location that is on your PATH as they are run as part of an application build.
 +
 
 +
==== Linux ====
 +
The following installation example assumes that the build tools archive is located in your home directory and that the directory <tt>~/stride/bin</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
 +
 
 +
cd ~/stride/bin
 +
tar xvzf ~/STRIDE4.1_buildtools-linux-gcc41_4.1.xx.tgz
 +
 
 +
==== Windows ====
 +
The following installation example assumes the the build tools archive is located in your root directory and that the directory <tt>\stride\bin</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
 +
 
 +
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.
  
−
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.
+
cd \stride\bin
 +
"\Program Files\7-Zip\7z" x \STRIDE4.1_buildtools-windows_4.1.xx.zip
  
−
=== Updating Your PATH ===
+
== Host Tools ==
−
As a final step, you must update your <tt>PATH</tt> environment variable to include <tt>\stride\bin</tt>.
+
The Host Tools package includes [[Stride Runner|stride]], the program you run on your host computer to run STRIDE tests on your target.
  
−
For instructions, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].
+
For more information, see [[Stride Runner|stride]].
  
−
= Installed Directories and Files =
+
=== Installation ===
 +
The host tools package is distributed as a zip archive on Windows and a tgz archive on Linux. To install, run the appropriate decompression utility. It's recommended that these files be placed in a location that is on your PATH.
  
−
It's not necessary to understand the workings of the STRIDE framework to perform sandbox evaluation or training. The SDK is set up with appropriate options and settings to enable "out of the box" functionality. A quick orientation to the sandbox directories and files is shown below.
+
==== Linux ====
 +
The following installation example assumes that the host tools archive is located in your home directory and that the directory <tt>~/stride/bin</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
  
−
If you are interested in the details, consult the articles [[Linux SDK]] and [[Windows SDK]].
+
cd ~/stride/bin
 +
tar xvzf ~/STRIDE4.1_hosttools-linux-gcc41_4.1.xx.tgz
  
−
===<tt>bin</tt>===
+
==== Windows ====
−
This directory contains the [[Build Tools|STRIDE Build Tools]] and the [[STRIDE Runner]].
+
The following installation example assumes the the host tools archive is located in your root directory and that the directory <tt>\stride\bin</tt> exists. The version numbers in your archive file name may be different than those shown in the example.
  
−
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. In a sandbox installation, these files are needed on the host computer since this is where we are building the target application. In a production off-target environment, these files are needed only on the computer that performs the target software build.
+
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive.
  
−
The [[STRIDE Runner]] is the program you use to run tests from the host.  
+
cd \stride\bin
 +
"\Program Files\7-Zip\7z" x \STRIDE4.1_hosttools-windows_4.1.xx.zip
  
−
===<tt>Samples</tt>===
+
==Update Your PATH==
−
The Samples directory contains a number of subdirectories, each containing the source for a [[Test Unit Samples|sample test]].
+
As a final step, you need to update your PATH environment variable to include the STRIDE executable files.
  
−
===<tt>SDK</tt>===
+
====Linux====
−
This directory contains the subdirectories <tt>GRS</tt>, <tt>Runtime</tt>, and <tt>SLAP</tt>, which contain source code that comprises the STRIDE Runtime. These sources are built into the STRIDE Runtime library as a dependency of the <tt>testapp</tt> target. (See <tt>src</tt> directory below.)
+
Update your <tt>PATH</tt> to include <tt>~/stride/bin</tt>.
  
−
In addition, there is a directory named either <tt>Linux</tt> or <tt>Windows</tt>, depending on your host operating system.
+
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>:
 +
export PATH=$PATH:~/stride/bin
  
−
====<tt>SDK\Windows</tt> or <tt>SDK/Linux</tt>====
+
For other shells, and more information, please see the following articles:
−
This directory (<tt>Windows</tt> or <tt>Linux</tt> contains the following directories:
+
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].
 +
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]
  
−
*;<tt>bin</tt> ''(Windows only)''
+
====Windows====
−
: Contains GNU make program files (GNU make is already present on Linux systems)
+
Update your <tt>PATH</tt> environment variable to include <tt>\stride\bin</tt>.
−
*;<tt>sample_src</tt>
 
−
: This directory is originally empty. The sandbox is set up so that any files in this directory are included in the TestApp build.
 
−
*;<tt>settings</tt>
 
−
: This directory contains the single file <tt>stride.s2scompile</tt>. This file, used by the <tt>s2scompile</tt> program, specifies target CPU characteristics (endian-ness, data sizes and alignments). Since the SDK targets an x86 processor, its characteristics are reflected in the file. 
 
−
*;<tt>src</tt>
 
−
: This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
 
−
*;''<tt>out</tt>''
 
−
: This directory (and several subdirectories) is created as part of the make process. All of the make targets are written to this directory and its subdirectories.
 
  
 +
For instructions, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].
  
 +
=== Related Topics ===
 +
* [[Activating Your STRIDE License]]
 +
* [[Stride_Runner#Environment_Variables|Environment Variable Setup]]
  
 
[[Category:Deployment]]
 
[[Category:Deployment]]
 
[[Category:Sandbox & Training]]
 
[[Category:Sandbox & Training]]

Revision as of 13:43, 9 September 2009

To perform Sandbox Evaluation & Training, you need to install the following packages on your PC. Starting with version 4.1.02 (released in October 2009), the framework is distributed using a single archives. For installation instructions for the earlier version, please see Package Installation for Version 4.1.02.

Each STRIDE Framework package is distributed as a compressed archive; installing the package consists of decompressing the archive to your local disk.


STRIDE SDK
STRIDE runtime, and build resources targeting the host operating system (Windows or Linux)
STRIDE Samples
Sample tests
STRIDE BuildTools
Executables that augment the build process, providing automatic test harness generation from source files
STRIDE HostTools
The STRIDE test runner application -- for production (non-sandbox) installations, this is the only package that needs to be installed on the host PC.


SDK (includes STRIDE Runtime)

The SDK is intended to be used primarily as an off-target evaluation or development sandbox. This allows you to use STRIDE in a small, controlled environment without needing to make changes to your target build.

For more information, see Sandbox Evaluation.

Installation

SDKs are distributed as zip archives. To install, run an unzipping utility, maintaining the directory structure of the archived files. We recommend that you create a parent directory named "stride" into which you upzip the archive.

Linux

The following installation example assumes that the SDK archive is located in your home directory and that the directory ~/stride exists. The version numbers in your archive file name may be different than those shown in the example. 

cd ~/stride
unzip ../STRIDE4.1_sdk-linux_4.1.xx.zip

Once unzipped, files will have been installed under ~/stride/SDK.

Windows

The following installation example assumes the the SDK archive is located in your root directory and that the directory \stride exists. The version numbers in your archive file name may be different than those shown in the example.

The example uses the open source 7-Zip utility to unzip the archive. 

cd \stride
"\Program Files\7-Zip\7z" x ..\STRIDE4.1_sdk-windows_4.1.xx.zip

Once unzipped, files will have been installed under \stride\SDK.

Samples

The Test Unit samples are a collection of source code that demonstrates the techniques for creating and executing test code on a target application, in both C and C++ development environments.

For more information, see Test Unit Samples.

Installation

The Test Unit samples are distributed as a zip archive. To install, run an unzipping utility, maintaining the directory structure of the archived files. We recommend that you unzip the archive into a parent directory named "stride".

Linux

The following installation example assumes that the Samples archive is located in your home directory and that the directory ~/stride exists. The version numbers in your archive file name may be different than those shown in the example. 

cd ~/stride
unzip ../STRIDE4.1_samples_4.1.xx.zip

Once unzipped, files will have been installed under ~/stride/Samples.

Windows

The following installation example assumes the the Samples archive is located in your root directory and that the directory \stride exists. The version numbers in your archive file name may be different than those shown in the example.

The example uses the open source 7-Zip utility to unzip the archive. 

cd \stride
"\Program Files\7-Zip\7z" x ..\STRIDE4.1_samples_4.1.xx.zip

Once unzipped, files will have been installed under \stride\Samples.

Build Tools

The STRIDE Build Tools are a set of command line utilities that perform the Stride compile/build process as part of your target build.

For more information, see Build Tools.

Installation

The build tools are distributed as zip archives on Windows and tgz archives on Linux. To install, run the appropriate decompression utility. It's recommended that these files be placed in a location that is on your PATH as they are run as part of an application build.

Linux

The following installation example assumes that the build tools archive is located in your home directory and that the directory ~/stride/bin exists. The version numbers in your archive file name may be different than those shown in the example. 

cd ~/stride/bin
tar xvzf ~/STRIDE4.1_buildtools-linux-gcc41_4.1.xx.tgz

Windows

The following installation example assumes the the build tools archive is located in your root directory and that the directory \stride\bin exists. The version numbers in your archive file name may be different than those shown in the example.

The example uses the open source 7-Zip utility to unzip the archive. 

cd \stride\bin
"\Program Files\7-Zip\7z" x \STRIDE4.1_buildtools-windows_4.1.xx.zip

Host Tools

The Host Tools package includes stride, the program you run on your host computer to run STRIDE tests on your target.

For more information, see stride.

Installation

The host tools package is distributed as a zip archive on Windows and a tgz archive on Linux. To install, run the appropriate decompression utility. It's recommended that these files be placed in a location that is on your PATH.

Linux

The following installation example assumes that the host tools archive is located in your home directory and that the directory ~/stride/bin exists. The version numbers in your archive file name may be different than those shown in the example. 

cd ~/stride/bin
tar xvzf ~/STRIDE4.1_hosttools-linux-gcc41_4.1.xx.tgz

Windows

The following installation example assumes the the host tools archive is located in your root directory and that the directory \stride\bin exists. The version numbers in your archive file name may be different than those shown in the example.

The example uses the open source 7-Zip utility to unzip the archive. 

cd \stride\bin
"\Program Files\7-Zip\7z" x \STRIDE4.1_hosttools-windows_4.1.xx.zip

Update Your PATH

As a final step, you need to update your PATH environment variable to include the STRIDE executable files.

Linux

Update your PATH to include ~/stride/bin.

If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your .bashrc: 

export PATH=$PATH:~/stride/bin

For other shells, and more information, please see the following articles:

Windows

Update your PATH environment variable to include \stride\bin.

For instructions, please see http://support.microsoft.com/kb/310519.

Related Topics

Retrieved from "https://www.stridewiki.com/index.php?title=Desktop_Installation&oldid=11244"