Desktop Installation

From STRIDE Wiki
Revision as of 21:49, 23 August 2010 by Ivailop (talk | contribs) (→‎Perl)
Jump to navigation Jump to search

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 (x86)
STRIDE_framework-windows_4.2.0x.zip
Linux (x86)
STRIDE_framework-linux_4.2.0x.tgz

Please see the appropriate installation instructions below.

Windows

Perl

If you intend to use STRIDE Script modules for testing in script, you will need a recent version of perl (x86) installed. As of this writing, we support versions 5.8.9, 5.10.x and 5.12.x. We recommend the standard distributions from ActiveState.

The following additional (non-standard) perl packages are also required for full functionality of STRIDE tests in perl:

If you are using an ActiveState distribution, you can easily install these packages using the ppm tool. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing: 

ppm install PACKAGE_NAME

NOTE: If you access the Internet via a proxy make sure to read <a href="http://docs.activestate.com/activeperl/5.10/faq/ActivePerl-faq2.html#ppm_and_proxies">this</a>.

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.2.0x.zip

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

Verify Environment Variables

Updated PATH

As a final step, you will need to update your PATH environment variable to include \stride\bin. For instructions on modifying it, please see http://support.microsoft.com/kb/310519.

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 user environment variable.

Create/Update PERL5LIB

In order to run the host script modules in perl, you must ensure that the following two directories are part of your PERL5LIB environment variable:

  • \stride\lib\perl
  • \stride\lib\perl\5.X.Y (where X matches your minor version of perl. The sub-minor version (Y) does not typically need to match, but we include to let you know which source version our files were built against. If your version of perl does not match any of the versions we provide, please consider upgrading.

If this environment variable does not yet exist, you can create it as a system or user environment variable, although we recommend the former. Unique directory paths should be separated by a semicolon when creating this environment variable.

Uninstalling

To uninstall STRIDE simply:

  • Remove any reference to \stride\bin in your PATH environment variable.
  • Remove STRIDE_DIR environment variable.
  • Remove any reference to \stride\lib\perl in your PERL5LIB environment variable.
  • Remove \stride directory.
  • Uninstall Perl packages:

Linux

Perl

If you intend to use STRIDE Script modules for testing in script, you will need a recent version of perl (x86) installed. As of this writing, we support versions 5.8.9 and 5.10.x, and 5.12.x. Our STRIDE perl libraries have a few dependencies on standard packages that might not be installed on your system:

If your perl is installed in a system directory (/usr/bin/perl, for instance), you will need root access to install shared modules. The simplest method for installing packages is via the CPAN shell. To start the shell in interactive mode: 

sudo perl -MCPAN -eshell

Once in the shell, search for and install the latest stable version of PACKAGE_NAME (the package to install): 

install PACKAGE_NAME

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 or perl-devel package in order to get it.

Unpacking

The following installation example assumes the the installation package is located in your home 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. 

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

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

Verify Environment Variables

Updated 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:

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 automatically set at each login, add to your .bashrc: 

export STRIDE_DIR=~/stride

Create/Update PERL5LIB

In order to run the host script modules in perl, you must ensure that the following two directories are part of your PERL5LIB environment variable:

  • ~/stride/lib/perl
  • ~/stride/lib/perl/5.X.Y -- where X matches your minor version of perl. The sub-minor version (Y) does not typically need to match, but we include it so that we know which exact perl source version our files were built against. If your version of perl does not match any of the versions we provide, please consider upgrading.

If this environment variable does not yet exist, you should automatically set at each login, add to your .bashrc: 

export PERL5LIB=$PERL5LIB:~/stride/lib/perl:~/stride/lib/perl/5.X.Y

Unique directory paths should be separated by a colon when creating this environment variable.

Uninstalling

To uninstall STRIDE simply:

  • Remove any reference to ~/stride/bin in your PATH environment variable.
  • Remove STRIDE_DIR environment variable.
  • Remove any reference to ~/stride/lib/perl in your PERL5LIB environment variable.
  • Remove ~/stride directory.
  • Uninstall Perl Packages

Directories and Files

It's not necessary to understand the workings of the STRIDE framework to perform evaluation or training. The desktop package contains an Off-Target Environment that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality. A quick orientation to the Off-Target Environment's directories and files are 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 an Off-Target Environment installation, 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.

The STRIDE Runner is the program you use to run tests from the host.

lib

This directory contains a set of STRIDE specific core scripting libraries along with prebuild binaries intended to be used for testing in scripts.

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.

License Activation

The Stride Runner executable requires a valid license to run. The first time you execute stride (and any other time a valid license is not found), you will be prompted to accept the Stride Framework License Agreement. If you accept the agreement, you will then be prompted to enter a license activation code: 

> stride 

By continuing, you affirm that you have read and agree to the terms of the license 
agreement included as a file named: "LICENSE-stride.txt" in the original install package.
Do you wish to continue? (y/n) ->

At this point, enter the activation code supplied by S2 Technologies to perform Internet activation and download of your license. You must be connected to the Internet for this to succeed. 

Please enter your license activation code: XXXX-XXXX-XXXX-XXXX

Next execute the Stride Runner again to verify that the license is found and valid. If you provide no arguments, you should see the following error 

  Unable to proceed. Missing database file.

..in which case, your license is working properly!

Once you have a valid license on your computer, the Internet connection is no longer necessary (except for results upload to STRIDE Test Space).

NOTE: Be sure that the clock on your host machine is set correctly. The license server will not issue a license if your clock is set to a date earlier that the current date. (We have seen this occur when using a virtual machine as a host, since the VM's clock is not synchronized with the host machine's clock.)

NOTE: If you access the Internet via an HTTP proxy please follow these simple instructions to resolve any connectivity issues. The licensing stack does not currently support the use of authenticated proxies. If your http proxy requires authentication, then you will have to request a manually signed license - please follow the instructions here

Desktop Validation

Once you have installed STRIDE and activated your license, we recommend you to run the following command in a console window: 

stride --device NULL --output diagnostics --diagnostics Perl

If everything was properly set up you should get the following output: 

Loading database...
Executing diagnostics...
  script "diagnostics.pl"
    > 3 passed, 0 failed, 0 in progress, 0 not in use.
  ---------------------------------------------------------------------
  Summary: 3 passed, 0 failed, 0 in progress, 0 not in use.

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

In addition a report file with name diagnostics.xml will be created in the current directory. If interested in the details you could open that report file in a browser of your choice.

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