OKTET Labs. Test Environment

OKTET Labs Test Environment (TE) is a software product that is intended to ease creating automated test suites.

Table of Contents

• OKTET Labs. Test Environment
  • Table of Contents
  • Documentation
  • Build
    • Briefly
    • Dependencies
    • External libraries
  • BASH-completion

Documentation

The documentation is built with the ./gen_docs script in the top directory:

export DOXYREST_PREFIX=<path-to-doxyrest>
./gen_docs

It produces a single HTML site under doc/generated/html/ combining two sources:

1. Hand-written guides in doc/sphinx/ — architecture, the user guide, the test suite guide and the per-subsystem pages.

2. API reference generated from the Doxygen comments in the sources.

Doxygen warnings are collected in ./doxygen.warn. Some pictures require ditaa to be installed. Run ./gen_docs -c to check the sources for Doxygen errors without generating anything; see ./gen_docs -h for the other options.

doc/ also holds reference material that is not part of the generated site: the configuration model in doc/cm/, XML schemas in doc/xsd/ and ASN.1 definitions in doc/ndn/.

Build

Details of building TE can be found in the generated documentation.

First thing to do:

export TE_BASE=<TE SOURCES DIR>

Briefly

• To build standalone TE (without an external test suite), run:

  ./dispatcher.sh

  and wait until the build is complete.

• To build a test suite, navigate to the test suite directory and execute:

  ./run.sh

  This script will perform the same actions as dispatcher.sh, but it will also build the test suite libraries and tests.

Dependencies

Dependencies are detailed in the TE build and test suite documentation.

External libraries

Prebuilt external libraries can be requested with the TE_EXT_LIBS macro in builder.conf (see comments in engine/builder/builder.m4). The build then downloads each of them over HTTP from the server named by the TE_EXT_LIBS environment variable, which you are expected to point at a host of your own. It defaults to an OKTET Labs host that is not reachable from outside.

The archives are looked up in ${TE_EXT_LIBS}/<platform>, where <platform> is the second argument of the TE_EXT_LIBS macro, e.g., ${TE_EXT_LIBS}/i686-pc-linux-gnu.

Libraries should be *.tgz archives that contain the lib/ and include/ directories. They are simply unpacked to the installation directory of the corresponding platform.

BASH-completion

If you want to use BASH-completion with TE scripts, add the following line to your ~/.bash_completion file (or any appropriate place):

complete -F _configure_func $default ./dispatcher.sh ./run.sh