Desktop Installation: Difference between revisions

From STRIDE Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
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 this upcoming version, please see [[Package Installation for Version 4.1.02]].  
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>.


Each STRIDE Framework package is distributed as a compressed archive; installing the package consists of decompressing the archive to your local disk.  
== Installation Packages ==
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.tgz</tt>


Please see the appropriate installation instructions below.


;STRIDE SDK
== Linux Installation==
: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.
# Extract the package to the <tt>stride</tt> directory


== SDK (''includes STRIDE Runtime'') ==
For example:
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 [[The Sandbox]].
=== 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 ../STRIDE4.1_sdk-linux_4.1.xx.zip
  tar -zxvf ../STRIDE_framework-linux_4.1.02.tgz


Once unzipped, files will have been installed under <tt>~/stride/SDK</tt>.
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.''


==== 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.
=== Update Your PATH ===
As a final step, you will need to update your PATH environment variable to include <tt>~/stride/bin</tt>.  


  cd \stride
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>:
"\Program Files\7-Zip\7z" x ..\STRIDE4.1_sdk-windows_4.1.xx.zip
  export PATH=$PATH:~/stride/bin


Once unzipped, files will have been installed under <tt>\stride\SDK</tt>.
For other shells, and more information, please see the following articles:
 
* [http://www.linuxheadquarters.com/howto/basic/path.shtml http://www.linuxheadquarters.com/howto/basic/path.shtml].
== Samples ==
* [http://en.wikipedia.org/wiki/Environment_variable#UNIX http://en.wikipedia.org/wiki/Environment_variable]
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===
== Windows 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".
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.
 
====Linux====
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.
 
cd ~/stride
unzip ../STRIDE4.1_samples_4.1.xx.zip
 
Once unzipped, files will have been installed under <tt>~/stride/Samples</tt>.
 
====Windows====
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 ..\STRIDE4.1_samples_4.1.xx.zip
  "\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_4.1.02.zip
 
Once unzipped, files will have been installed under <tt>\stride\Samples</tt>.


== Build Tools ==
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.
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]].
=== Updating Your PATH ===
 
As a final step, you must update your <tt>PATH</tt> environment variable to include <tt>\stride\bin</tt>.
=== 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.
 
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 Runner|stride]], the program you run on your host computer to run STRIDE tests on your target.
 
For more information, see  [[Stride Runner|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 <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_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 <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.
 
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 <tt>PATH</tt> to include <tt>~/stride/bin</tt>.
 
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
 
For other shells, and more information, please see the following articles:
* [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====
Update your <tt>PATH</tt> environment variable to include <tt>\stride\bin</tt>.


For instructions, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].
For instructions, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519].
 
== Installed Directories and Files ==
 
= Installed Directories and Files =


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.
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.
Line 164: Line 84:
: 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.
: 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.


=== 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 00:45, 23 September 2009

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. For installation instructions for the earlier version, please see Package Installation for Version 4.1.01.

Installation Packages

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
STRIDE_framework-windows_4.1.02.zip
Linux
STRIDE_framework-linux_4.1.02.tgz

Please see the appropriate installation instructions below.

Linux Installation

Unzip the Installation Package

  1. Create a directory named stride in your home directory.
  2. Extract the package to the stride directory

For example: 

cd ~/stride
tar -zxvf ../STRIDE_framework-linux_4.1.02.tgz

Note: This assumes that the installation package 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.


Update Your PATH

As a final step, you will need to update your PATH environment variable 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 Installation

The following installation example assumes the the installation package 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 ..\STRIDE_framework-windows_4.1.02.zip

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

Updating Your PATH

As a final step, you must update your PATH environment variable to include \stride\bin.

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

Installed Directories and Files

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.

If you are interested in the details, consult the articles Linux SDK and Windows SDK.

bin

This directory contains the STRIDE Build Tools and the STRIDE Runner.

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 STRIDE Runner is the program you use to run tests from the host.

Samples

The Samples directory contains a number of subdirectories, each containing the source for a sample test.

SDK

This directory contains the subdirectories GRS, Runtime, and SLAP, which contain source code that comprises the STRIDE Runtime. These sources are built into the STRIDE Runtime library as a dependency of the testapp target. (See src directory below.)

In addition, there is a directory named either Linux or Windows, depending on your host operating system.

SDK\Windows or SDK/Linux

This directory (Windows or Linux contains the following directories:

  • bin (Windows only)
Contains GNU make program files (GNU make is already present on Linux systems)
  • sample_src
This directory is originally empty. The sandbox is set up so that any files in this directory are included in the TestApp build.
  • settings
This directory contains the single file stride.s2scompile. This file, used by the s2scompile 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.
  • src
This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
  • out
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.
Retrieved from "https://www.stridewiki.com/index.php?title=Desktop_Installation&oldid=11468"