Using Environment
[Using instructions]

Class Environment allows easy access to path informations, system environment variables and command line arguments. More...

Collaboration diagram for Using Environment:

---

Detailed Description

Class Environment allows easy access to path informations, system environment variables and command line arguments.

This class allows to manage/access/change the informations as described in the following section. It is the task of the application itself to make use of this information in a suitable way corresponding to the application's purpose. The class Environment itself simply provides the information and makes no use of it.

The following features are supported.

• Path of Executable (Runtime):
  get the path of the currently running executable (full path or only drive)

• Path of Sources (Compile time):
  get the path where the sources were compiled (you may need this path to access data/config files stored within the source directories):
  • full path or drive
  • cut off part of the source dir
  • explicitly set the complete directory path

• Path for output and reference files:
  
  • get/set the directory to generate test output files (e.g. protocols)
  • get/set directory to read some reference files from (e.g. valid data to be compared during testing

• Command Line Parameters
  Assumed syntax for command line params is "-optionName [optionValue]"
  arguments not matching this rule are simply ignored, e.g. "--option" (used by Boost.Test) is skipped when parsing the command line
  • get/set command line param as strings
  • get/set command line param as arbitrary (streamable) numeric types

• System Environment Variables
  
  • get/set environment variable as string
  • get/set environment variable as arbitrary (streamable) numeric types

• Name of user and computer
  

• General functions
  
  • get textual description for a system error code
  • start an arbitrary executable file

Examples of Usage:

 #include "TestToolBox\EnvironmentImpl.h"
 namespace TTB = TestToolBox;

 // define input path somewhere within source directories
 // Remark: at startup the source directory is the directory
 // where file environmentImpl.h is stored
 TTB::TheEnvironment()->CutSourceDirAfter("\\SW-Root\\");
 std::string myInputFilePath = TTB::TheEnvironment()->GetSourceDir()
     + "MyInputFiles\\TestCaseA.input"

 // accessing command line
 if (TTB::TheEnvironment()->IsExistingCommandLineOption("-trace"))
 {
     ...
 }
 long numOfExecutions = TTB::TheEnvironment()->GetCommandLineOptionVal<long>("-numExecutions")

 // accessing environment variable
 bool produceDetailedOutput = TTB::TheEnvironment()->GetSystemEnvVariableVal<bool>("DetailedOutput");

 // Display a textual description of a system error code as received via
 // return value or via GetLastError()
 if (!SomeSystemFunctionCall())
 {
     DWORD errCode = ::GetLastError();
     cout << "Function failed, reason: "
         << TTB::Environment::GetErrorDescription(errCode).c_str() << std::endl;

 // Start notepad to display some test results
 TTB::Environment::StartExeFile("notepad.exe","c:\tmp\MyTestResults.txt");

See also:

Environment.h (File documentation)

TestToolBox::Environment (class documentation)

TestEnvironment (unit test for class Environment)