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 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 leverage the STRIDE Sandbox 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>.


== Installation Packages ==
== 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):
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
;Windows XP
:<tt>STRIDE_framework-windows_4.1.02.zip</tt>
:<tt>STRIDE_framework-windows_4.1.0x.zip</tt>
;Linux
;Linux
:<tt>STRIDE_framework-linux_4.1.02.tgz</tt>
:<tt>STRIDE_framework-linux_4.1.0x.tgz</tt>


Please see the appropriate installation instructions below.
Please see the appropriate installation instructions below.
Line 19: Line 19:


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


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.''
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.''
Line 46: Line 46:


  cd \stride
  cd \stride
  "\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_4.1.02.zip
  "\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_4.1.0x.zip


Once unzipped, files will have been installed under the <tt>\stride</tt> directory.
Once unzipped, files will have been installed under the <tt>\stride</tt> directory.
Line 81: Line 81:


===<tt>Samples</tt>===
===<tt>Samples</tt>===
The Samples directory contains a number of subdirectories, each containing the source for a [[Test Unit Samples|sample test]].
The Samples directory contains a number of sub-directories, each containing the source for a [[Test Unit Samples|sample test]].


===<tt>SDK</tt>===
===<tt>SDK</tt>===
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.)  
This directory contains the sub-directories <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.)  


In addition, there is a directory named either <tt>Linux</tt> or <tt>Windows</tt>, depending on your host operating system.
In addition, there is a directory named either <tt>Linux</tt> or <tt>Windows</tt>, depending on your host operating system.
Line 101: Line 101:
: This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
: This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
*''<tt>out</tt>''
*''<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.
: This directory (and several sub-directories) is created as part of the make process. All of the make targets are written to this directory and its sub-directories.


[[Category:Sandbox & Training]]
[[Category:The Sandbox]]

Revision as of 18:47, 1 February 2010

To leverage the STRIDE Sandbox 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.0x.zip
Linux
STRIDE_framework-linux_4.1.0x.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.0x.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

Prerequisites

The current versions of the STRIDE Framework have only been tested under Windows XP, (SP 2 and greater). If you need to run the framework on Windows Vista or Windows 7, please contact us.

In order to run host-based script modules, you must have a recent build of perl for Windows installed. We recommend the standard distributions from ActiveState.

Unpacking

The following installation example assumes the the installation package is located in your root directory and that the directory \stride exists. You can choose to install to a different location (all instructions below assume you are installing into \stride). 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.0x.zip

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

Executing batch file

Once the framework package has been unpacked, you must execute the framework_install.bat file in the bin. Double click this file to launch it. It should finish within 30 seconds and prompt you to close the window.

Verify Environment Variables

Updated PATH

You must verify that your PATH environment variable includes \stride\bin. If it does not include this path, you must add it.

The PATH is a system environment variable. For instructions on modifying it, please see http://support.microsoft.com/kb/310519.

Create/Update PERL5LIB

In order to run the host script modules in perl, you must ensure that \stride\lib\perl is part of your PERL5LIB setting. If this environment variable does not yet exist, you can create it as a system or user environment variable, although we recommend the former.

Create/Update STRIDE_DIR

Verify that the STRIDE_DIR environment variable exists and is set to the root installation directory (\stride). If this environment variable does not yet exist, you should create it as a system environment variable.

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 sub-directories, each containing the source for a sample test.

SDK

This directory contains the sub-directories 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 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. On windows, this directory also contains two rules files for use in building target apps with Visual Studio.
  • src
This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
  • out
This directory (and several sub-directories) is created as part of the make process. All of the make targets are written to this directory and its sub-directories.