Desktop Installation: Difference between revisions
(134 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
== 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 | ;Windows (x86) | ||
:<tt>STRIDE_framework- | :<tt>STRIDE_framework-windows_5.x.yy.zip</tt> | ||
;Linux | ;Linux (x86) | ||
:<tt>STRIDE_framework- | :<tt>STRIDE_framework-linux_5.x.yy.tgz</tt> | ||
;FreeBSD (x86) | |||
:<tt>STRIDE_framework-freebsd_5.x.yy.tgz</tt> | |||
Please see the appropriate installation instructions below. | Please see the appropriate installation instructions below. | ||
== | == Windows Installation == | ||
=== Unpacking === | === Unpacking === | ||
The following installation example assumes the the installation package is located in your | 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>). | ||
The example uses the open source [http://www.7-zip.org/ 7-Zip] utility to unzip the archive. | |||
cd \stride | |||
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.zip | |||
Once unzipped, files will have been installed under the <tt>\stride</tt> directory. | |||
=== Verify Environment Variables === | |||
==== Updated PATH ==== | |||
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>. | |||
For instructions on modifying it, please see [http://support.microsoft.com/kb/310519 http://support.microsoft.com/kb/310519]. | |||
NOTE: ''Make sure to insert '''no spaces''' before and after the semicolon separators(;).'' | |||
==== Create/Update STRIDE_DIR==== | |||
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. | |||
To confirm installation and display ''help'' run the following command in a console window: | |||
stride -h | |||
=== Uninstalling === | |||
To uninstall STRIDE simply: | |||
* Remove any reference to <tt>\stride\bin</tt> in your <tt>PATH</tt> environment variable. | |||
* Remove <tt>STRIDE_DIR</tt> environment variable. | |||
* Remove <tt>\stride</tt> directory. | |||
== Linux/FreeBSD Installation == | |||
=== Unpacking === | |||
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>). | |||
cd ~/stride | cd ~/stride | ||
tar -zxvf ../STRIDE_framework- | tar -zxvf ../STRIDE_framework-linux_5.x.yy.tgz | ||
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 23: | Line 57: | ||
==== Updated PATH ==== | ==== Updated PATH ==== | ||
As a final step, you will need to update your PATH environment variable to include <tt>~/stride/bin</tt>. | 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>. | ||
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>: | 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>: | ||
Line 33: | Line 67: | ||
==== Create/Update STRIDE_DIR==== | ==== Create/Update STRIDE_DIR==== | ||
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>. | 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>: | ||
export STRIDE_DIR=~/stride | |||
To confirm installation and display ''help'' run the following command in a console window: | |||
stride -h | |||
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:'' | |||
* Debian / Ubuntu | |||
sudo dpkg --add-architecture i386 | |||
sudo apt-get install libc6:i386 libstdc++6:i386 | |||
* Fedora / CentOS / RHEL | |||
sudo setarch i386 yum install glibc libstdc++ | |||
* FreeBSD | |||
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: | |||
options COMPAT_FREEBSD32 # Compatible with i386 binaries | |||
* <tt>~/stride/ | === Uninstalling === | ||
* <tt>~/stride | To uninstall STRIDE simply: | ||
* Remove any reference to <tt>~/stride/bin</tt> in your <tt>PATH</tt> environment variable. | |||
* Remove <tt>STRIDE_DIR</tt> environment variable. | |||
* Remove <tt>~/stride</tt> directory. | |||
== Directories and Files == | |||
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. | |||
<u>''NOTE:''</u> ''It's not necessary to understand the workings of the STRIDE framework to perform evaluation or training. The desktop package contains an [[STRIDE Off-Target Environment]] that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.'' | |||
=== | ===<tt>bin</tt>=== | ||
This directory contains the [[Build Tools|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. | |||
===<tt>lib</tt>=== | |||
This directory contains a set of STRIDE specific core scripting libraries along with prebuild binaries intended to be used for [[Test Modules Overview|testing in scripts]]. | |||
The | ===<tt>Samples</tt>=== | ||
The Samples directory contains a number of sub-directories, each containing the source for a [[Samples|sample test]]. | |||
== | ===<tt>SDK</tt>=== | ||
= | This directory contains the sub-directories <tt>Posix/Windows</tt> and <tt>Runtime</tt>, which contain source code that comprises the [[Runtime_Reference|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. | ||
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: | |||
*<tt>settings</tt> | |||
: 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|use in building target apps with Visual Studio]]. | |||
*<tt>src</tt> | |||
: 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. | |||
== Perl Installation (Optional) == | |||
<u>''NOTE:''</u> ''This is '''NOT''' required if only [[Test_Units_Overview|tests in C/C++]] will be run.'' | |||
If you intend to use [[Test Modules Overview|STRIDE Script modules]] for testing in script, you will need a recent version of Perl (x86 with threads support) installed. | |||
As of this writing, we support only the 32-bit 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. | |||
=== | === Windows === | ||
It is required to use the standard 32-bit Perl distributions from [http://www.activestate.com/activeperl/downloads ActiveState]. | |||
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl: | |||
* [http://search.cpan.org/perldoc/Class::ISA Class::ISA] | |||
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM] | |||
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump] | |||
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny] | |||
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: | |||
You | |||
ppm install PACKAGE_NAME | |||
=== | === Linux/FreeBSD === | ||
We recommend you to use the standard 32-bit Perl distribution that comes with your OS version or one provided by [http://www.activestate.com/activeperl/downloads ActiveState]. In case you need to manually build from source make sure to configure "shared library" (<tt>-Duseshrplib</tt>), "thread support" (<tt>-Duseithreads</tt>) and no "64-bit support" (<tt>-Uuse64bitall</tt> and for versions 5.16 and older also <tt>-Uuse64bitint</tt>): | |||
<pre> | |||
./Configure -des –Duseshrplib –Duseithreads -Uuse64bitall -Uuse64bitint -Dprefix=${HOME}/perl-516-x86 -Darchname=i686-linux -Accflags="-m32 -march=i686" -Aldflags="-m32 -march=i686" -Alddlflags="-shared -m32 -march=i686" | |||
</pre> | |||
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl: | |||
* | * [http://search.cpan.org/perldoc/YAML::XS YAML::XS] | ||
* | * [http://search.cpan.org/perldoc/Class::ISA Class::ISA] | ||
* [http://search.cpan.org/perldoc/Pod::POM Pod::POM] | |||
* [http://search.cpan.org/perldoc/Devel::Symdump Devel::Symdump] | |||
* [http://search.cpan.org/perldoc/Config::Tiny Config::Tiny] | |||
If | 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. 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: | ||
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'', ''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: | |||
* Debian / Ubuntu | |||
sudo apt-get install libperl-dev | |||
* Fedora / CentOS / RHEL | |||
sudo yum -y install perl-devel | |||
=== Validation === | |||
Once you have installed Perl we recommend you to run the following command in a console window: | |||
= | <source lang="bash"> | ||
stride --diagnostics Perl --output PerlCheck | |||
</source> | |||
If everything was properly set up you should get the following output: | |||
<pre> | |||
Loading database... | |||
Executing diagnostics... | |||
script "diagnostics.pl" | |||
> 2 passed, 0 failed, 0 in progress, 0 not in use. | |||
--------------------------------------------------------------------- | |||
Summary: 2 passed, 0 failed, 0 in progress, 0 not in use. | |||
Disconnecting from device... | |||
Saving result file... | |||
</pre> | |||
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. | |||
[[Category: | [[Category:Installation]] |
Latest revision as of 20:10, 25 June 2015
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_5.x.yy.zip
- Linux (x86)
- STRIDE_framework-linux_5.x.yy.tgz
- FreeBSD (x86)
- STRIDE_framework-freebsd_5.x.yy.tgz
Please see the appropriate installation instructions below.
Windows Installation
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 example uses the open source 7-Zip utility to unzip the archive.
cd \stride "\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_5.x.yy.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.
NOTE: Make sure to insert no spaces before and after the semicolon separators(;).
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.
To confirm installation and display help run the following command in a console window:
stride -h
Uninstalling
To uninstall STRIDE simply:
- Remove any reference to \stride\bin in your PATH environment variable.
- Remove STRIDE_DIR environment variable.
- Remove \stride directory.
Linux/FreeBSD Installation
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).
cd ~/stride tar -zxvf ../STRIDE_framework-linux_5.x.yy.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:
- http://www.linuxheadquarters.com/howto/basic/path.shtml.
- http://en.wikipedia.org/wiki/Environment_variable
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
To confirm installation and display help run the following command in a console window:
stride -h
NOTE: In a 64-bit environment the above may fail with errors like: "/lib/ld-linux.so.2: bad ELF interpreter: No such file or directory"
or "ELF interpreter /libexec/ld-elf32.so.1 not found"
. To resolve this issue install the appropriate 32-bit compatibility libraries for your Linux/FreeBSD distribution:
- Debian / Ubuntu
sudo dpkg --add-architecture i386 sudo apt-get install libc6:i386 libstdc++6:i386
- Fedora / CentOS / RHEL
sudo setarch i386 yum install glibc libstdc++
- FreeBSD
Make sure to have lib32
installed (via sysinstall(8) - Configure|Distributions|lib32) and have your kernel built with:
options COMPAT_FREEBSD32 # Compatible with i386 binaries
Uninstalling
To uninstall STRIDE simply:
- Remove any reference to ~/stride/bin in your PATH environment variable.
- Remove STRIDE_DIR environment variable.
- Remove ~/stride directory.
Directories and Files
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.
NOTE: It's not necessary to understand the workings of the STRIDE framework to perform evaluation or training. The desktop package contains an STRIDE Off-Target Environment that utilizes a SDK that is set up with appropriate options and settings to enable "out of the box" functionality.
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 Posix/Windows and Runtime, which contain source code that comprises the STRIDE Runtime. These sources are built in to a static libary (e.g. STRIDE Runtime library - stride.a/lib) as a dependency of your Test Application.
The Posix and Windows 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:
- settings
- This directory contains a set of stride.XXX.s2scompile files, where XXX coresponds to the target CPU architecture (i.e. X86, ARM...). These files, used by the STRIDE Compiler, specify target CPU characteristics (endian-ness, data sizes and alignments). On Windows, this directory also contains a set of files for use in building target apps with Visual Studio.
- src
- 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.
Perl Installation (Optional)
NOTE: This is NOT required if only tests in C/C++ will be run.
If you intend to use STRIDE Script modules for testing in script, you will need a recent version of Perl (x86 with threads support) installed.
As of this writing, we support only the 32-bit 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.
Windows
It is required to use the standard 32-bit Perl distributions from ActiveState.
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:
You can easily install these packages using the ppm tool. If you access the Internet via a proxy make sure to read this. Simple command-line installation of PACKAGE_NAME (the package to install) typically just requires typing:
ppm install PACKAGE_NAME
Linux/FreeBSD
We recommend you to use the standard 32-bit Perl distribution that comes with your OS version or one provided by ActiveState. In case you need to manually build from source make sure to configure "shared library" (-Duseshrplib), "thread support" (-Duseithreads) and no "64-bit support" (-Uuse64bitall and for versions 5.16 and older also -Uuse64bitint):
./Configure -des –Duseshrplib –Duseithreads -Uuse64bitall -Uuse64bitint -Dprefix=${HOME}/perl-516-x86 -Darchname=i686-linux -Accflags="-m32 -march=i686" -Aldflags="-m32 -march=i686" -Alddlflags="-shared -m32 -march=i686"
The following additional (non-standard) Perl packages are also required for full functionality of STRIDE tests in perl:
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. If you access the Internet via a proxy make sure to set the appropriate CPAN config variables. 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, 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:
- Debian / Ubuntu
sudo apt-get install libperl-dev
- Fedora / CentOS / RHEL
sudo yum -y install perl-devel
Validation
Once you have installed Perl we recommend you to run the following command in a console window:
stride --diagnostics Perl --output PerlCheck
If everything was properly set up you should get the following output:
Loading database... Executing diagnostics... script "diagnostics.pl" > 2 passed, 0 failed, 0 in progress, 0 not in use. --------------------------------------------------------------------- Summary: 2 passed, 0 failed, 0 in progress, 0 not in use. Disconnecting from device... Saving result file...
In addition a report file with name PerlCheck.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.