testing::BasicEnvironmentConfiguration Struct Reference

Class holding a configuration for a test environment. More...

#include "unit_test_base.h"

Inheritance diagram for testing::BasicEnvironmentConfiguration:

Public Member Functions
	BasicEnvironmentConfiguration ()
	Default constructor; this is what is used in Boost unit test. More...
	BasicEnvironmentConfiguration (int argc, char **argv)
	Constructor: acquires parameters from the command line. More...
	BasicEnvironmentConfiguration (std::string name)
	Constructor; accepts the name as parameter. More...
	BasicEnvironmentConfiguration (int argc, char **argv, std::string name)
Access to configuration
Name of the application
std::string	ApplicationName () const
	Path to the configuration file. More...
std::string	ConfigurationPath () const
	Path to the configuration file. More...
std::string	TesterParameterSetPath (std::string name) const
	FHiCL path for the configuration of the test algorithm. More...
std::string	MainTesterParameterSetName () const
	Name of the test algorithm instance. More...
std::string	MainTesterParameterSetPath () const
	FHiCL path for the configuration of the test algorithm. More...
std::string	ServiceParameterSetPath (std::string name) const
	FHiCL path for the configuration of the service. More...
std::string	DefaultTesterConfiguration (std::string tester_name) const
	A string describing default parameter set to configure specified test. More...
std::string	DefaultServiceConfiguration (std::string service_name) const
	A string describing the default parameter set to configure the test. More...
std::string	DefaultConfiguration () const
	A string describing the full default parameter set. More...
std::string	ExecutablePath () const
	Returns the name of the executable as started. More...
std::vector< std::string > const &	EexcutableArguments () const
	Returns the list of non-Boost-test arguments on the command line. More...
Set configuration
void	SetApplicationName (std::string name)
	Sets the name of the application. More...
void	SetConfigurationPath (std::string path)
	Sets the path to the configuration file. More...
void	SetMainTesterParameterSetName (std::string name)
	Sets the FHiCL name for the configuration of the test algorithm. More...
void	SetTesterParameterSetPath (std::string test_name, std::string path)
	Sets the FHiCL path for the configuration of a test algorithm. More...
void	SetMainTesterParameterSetPath (std::string path)
	Sets the FHiCL path for the configuration of the main test algorithm. More...
void	SetServiceParameterSetPath (std::string service_name, std::string path)
	Sets the FHiCL path for the configuration of a test algorithm. More...
void	AddDefaultServiceConfiguration (std::string service_name, std::string service_cfg)
	Adds a default configuration for the specified service. More...
void	AddDefaultTesterConfiguration (std::string tester_name, std::string tester_cfg)
	Adds a default configuration for the specified tester. More...
void	AddDefaultTesterConfiguration (std::string tester_cfg)
	Adds a default configuration for the main tester. More...

Protected Types
using	ConfigurationMap_t = std::map< std::string, std::string >
using	PathMap_t = std::map< std::string, std::string >

Protected Member Functions
void	ParseCommandLine (int argc, char **argv)
	Extracts arguments from the command line, uses first one as config path. More...
void	DefaultInit ()
	Initialize with some default values. More...
std::string	BuildDefaultServiceConfiguration () const
	A string describing the full default parameter set. More...
std::string	BuildDefaultTestConfiguration () const
	A string describing the full default parameter set. More...
std::string	BuildDefaultConfiguration () const
	A string describing the full default parameter set. More...

Static Protected Member Functions
static std::string	DefaultApplicationName ()
	Returns the default test name. More...
static std::string	BuildServiceConfiguration (ConfigurationMap_t const &services)
	A string with the service section from service parameter sets. More...
static std::string	BuildTestConfiguration (ConfigurationMap_t const &analyzers)
	A string with the physics section from analyzer parameter sets. More...
static std::string	BuildConfiguration (ConfigurationMap_t const &services, ConfigurationMap_t const &modules)
	A string describing the full default parameter set. More...

Protected Attributes
std::string	appl_name
	name of the application More...
std::string	config_path
	configuration file path More...
std::string	main_test_name
	name of main test algorithm More...
std::string	main_test_path
	path of main test algorithm configuration More...
ConfigurationMap_t	services_default_cfg
	Configuration of all the services. More...
ConfigurationMap_t	analyzers_default_cfg
	Configuration of all the analyzer modules. More...
PathMap_t	test_paths
	Set of paths for tester configuration. More...
PathMap_t	service_paths
	Set of paths for service configuration. More...

Private Attributes
details::CommandLineArguments	arguments
	command line arguments More...

Detailed Description

Class holding a configuration for a test environment.

---

This class needs to be fully constructed by the default constructor in order to be useful as Boost unit test fixture. It is supposed to be passed as a template parameter to another class that can store an instance of it and extract configuration information from it.

Definition at line 124 of file unit_test_base.h.

Member Typedef Documentation

using testing::BasicEnvironmentConfiguration::ConfigurationMap_t = std::map<std::string, std::string>

protected

Definition at line 260 of file unit_test_base.h.

using testing::BasicEnvironmentConfiguration::PathMap_t = std::map<std::string, std::string>

protected

Definition at line 261 of file unit_test_base.h.

Constructor & Destructor Documentation

testing::BasicEnvironmentConfiguration::BasicEnvironmentConfiguration ( )

inline

Default constructor; this is what is used in Boost unit test.

Definition at line 127 of file unit_test_base.h.

{ DefaultInit(); }

testing::BasicEnvironmentConfiguration::BasicEnvironmentConfiguration ( int  argc, char **  argv  )

inline

Constructor: acquires parameters from the command line.

Definition at line 130 of file unit_test_base.h.

                                                         : BasicEnvironmentConfiguration()
    {
      ParseCommandLine(argc, argv);
    }

testing::BasicEnvironmentConfiguration::BasicEnvironmentConfiguration ( std::string  name )

inline

Constructor; accepts the name as parameter.

Definition at line 136 of file unit_test_base.h.

References mf::SetApplicationName().

                                                  : BasicEnvironmentConfiguration()
    {
      SetApplicationName(name);
    }

testing::BasicEnvironmentConfiguration::BasicEnvironmentConfiguration ( int  argc, char **  argv, std::string  name  )

inline

Definition at line 141 of file unit_test_base.h.

References mf::SetApplicationName().

      : BasicEnvironmentConfiguration(argc, argv)
    {
      SetApplicationName(name);
    }

Member Function Documentation

void testing::BasicEnvironmentConfiguration::AddDefaultServiceConfiguration ( std::string  service_name, std::string  service_cfg  )

inline

Adds a default configuration for the specified service.

Definition at line 237 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration::SetDefaultGeometryConfiguration().

    {
      services_default_cfg[service_name] = service_cfg;
    }

void testing::BasicEnvironmentConfiguration::AddDefaultTesterConfiguration ( std::string  tester_name, std::string  tester_cfg  )

inline

Adds a default configuration for the specified tester.

Definition at line 243 of file unit_test_base.h.

    {
      analyzers_default_cfg[tester_name] = tester_cfg;
    }

void testing::BasicEnvironmentConfiguration::AddDefaultTesterConfiguration ( std::string  tester_cfg )

inline

Adds a default configuration for the main tester.

Definition at line 249 of file unit_test_base.h.

References util::empty().

    {
      if (MainTesterParameterSetName().empty()) {
        throw std::logic_error("Request adding configuration of non-existent main tester");
      }
      AddDefaultTesterConfiguration(MainTesterParameterSetName(), tester_cfg);
    }

std::string testing::BasicEnvironmentConfiguration::ApplicationName ( ) const

inline

Path to the configuration file.

Definition at line 150 of file unit_test_base.h.

{ return appl_name; }

static std::string testing::BasicEnvironmentConfiguration::BuildConfiguration ( ConfigurationMap_t const &  services, ConfigurationMap_t const &  modules  )

inlinestaticprotected

A string describing the full default parameter set.

Definition at line 362 of file unit_test_base.h.

    {
      std::string cfg;
      cfg += BuildServiceConfiguration(services);
      cfg += BuildTestConfiguration(modules);
      return cfg;
    } // BuildConfiguration()

std::string testing::BasicEnvironmentConfiguration::BuildDefaultConfiguration ( ) const

inlineprotected

A string describing the full default parameter set.

Definition at line 325 of file unit_test_base.h.

    {
      return BuildConfiguration(services_default_cfg, analyzers_default_cfg);
    }

std::string testing::BasicEnvironmentConfiguration::BuildDefaultServiceConfiguration ( ) const

inlineprotected

A string describing the full default parameter set.

Definition at line 313 of file unit_test_base.h.

    {
      return BuildServiceConfiguration(services_default_cfg);
    }

std::string testing::BasicEnvironmentConfiguration::BuildDefaultTestConfiguration ( ) const

inlineprotected

A string describing the full default parameter set.

Definition at line 319 of file unit_test_base.h.

    {
      return BuildTestConfiguration(analyzers_default_cfg);
    }

static std::string testing::BasicEnvironmentConfiguration::BuildServiceConfiguration ( ConfigurationMap_t const &  services )

inlinestaticprotected

A string with the service section from service parameter sets.

Definition at line 331 of file unit_test_base.h.

    {
      std::string cfg;
      cfg += "\nservices: {";
      for (auto const& service_info : services) {
        cfg += "\n  " + service_info.first + ": {";
        cfg += "\n" + service_info.second;
        cfg += "\n  } # " + service_info.first;
      } // for services
      cfg += "\n} # services"
             "\n";
      return cfg;
    } // BuildServiceConfiguration()

static std::string testing::BasicEnvironmentConfiguration::BuildTestConfiguration ( ConfigurationMap_t const &  analyzers )

inlinestaticprotected

A string with the physics section from analyzer parameter sets.

Definition at line 346 of file unit_test_base.h.

    {
      std::string cfg;
      cfg += "\nphysics: {"
             "\n  analyzers: {";
      for (auto const& module_info : analyzers) {
        cfg += "\n  " + module_info.first + ": {";
        cfg += "\n" + module_info.second;
        cfg += "\n  } # " + module_info.first;
      } // for analyzers
      cfg += "\n  } # analyzers"
             "\n} # physics";
      return cfg;
    } // BuildServiceConfiguration()

std::string testing::BasicEnvironmentConfiguration::ConfigurationPath ( ) const

inline

Path to the configuration file.

Definition at line 153 of file unit_test_base.h.

{ return config_path; }

static std::string testing::BasicEnvironmentConfiguration::DefaultApplicationName ( )

inlinestaticprotected

Returns the default test name.

Definition at line 269 of file unit_test_base.h.

{ return "Test"; }

std::string testing::BasicEnvironmentConfiguration::DefaultConfiguration ( ) const

inline

A string describing the full default parameter set.

Definition at line 193 of file unit_test_base.h.

{ return BuildDefaultConfiguration(); }

void testing::BasicEnvironmentConfiguration::DefaultInit ( )

inlineprotected

Initialize with some default values.

Definition at line 289 of file unit_test_base.h.

References mf::SetApplicationName().

    {
      SetApplicationName(DefaultApplicationName());
      SetMainTesterParameterSetName("");
      // a destination which will react to all messages from DEBUG up:
      AddDefaultServiceConfiguration("message",
                                     R"(
           debugModules: [ '*' ]
           destinations : {
             stdout: {
               type:      cout
               threshold: DEBUG
               categories: {
                 default: {
                   limit: -1
                 }
               } // categories
             } // stdout
             statistics: {type:cout}
           } // destinations
         )");
    } // DefaultInit()

std::string testing::BasicEnvironmentConfiguration::DefaultServiceConfiguration ( std::string  service_name ) const

inline

A string describing the default parameter set to configure the test.

Definition at line 187 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration::DefaultGeometryConfiguration().

    {
      return services_default_cfg.at(service_name);
    }

std::string testing::BasicEnvironmentConfiguration::DefaultTesterConfiguration ( std::string  tester_name ) const

inline

A string describing default parameter set to configure specified test.

Definition at line 181 of file unit_test_base.h.

    {
      return analyzers_default_cfg.at(tester_name);
    }

std::vector<std::string> const& testing::BasicEnvironmentConfiguration::EexcutableArguments ( ) const

inline

Returns the list of non-Boost-test arguments on the command line.

Definition at line 199 of file unit_test_base.h.

{ return arguments.Arguments(); }

std::string testing::BasicEnvironmentConfiguration::ExecutablePath ( ) const

inline

Returns the name of the executable as started.

Definition at line 196 of file unit_test_base.h.

{ return arguments.Executable(); }

std::string testing::BasicEnvironmentConfiguration::MainTesterParameterSetName ( ) const

inline

Name of the test algorithm instance.

Definition at line 163 of file unit_test_base.h.

{ return main_test_name; }

std::string testing::BasicEnvironmentConfiguration::MainTesterParameterSetPath ( ) const

inline

FHiCL path for the configuration of the test algorithm.

Definition at line 166 of file unit_test_base.h.

    {
      return MainTesterParameterSetName().empty() ?
               "" :
               TesterParameterSetPath(MainTesterParameterSetName());
    }

void testing::BasicEnvironmentConfiguration::ParseCommandLine ( int  argc, char **  argv  )

inlineprotected

Extracts arguments from the command line, uses first one as config path.

Definition at line 282 of file unit_test_base.h.

    {
      arguments.ParseArguments(argc, argv);
      if (arguments.hasArgument(0)) SetConfigurationPath(arguments.Argument(0)); // first argument
    }

std::string testing::BasicEnvironmentConfiguration::ServiceParameterSetPath ( std::string  name ) const

inline

FHiCL path for the configuration of the service.

Definition at line 174 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration::GeometryParameterSetPath().

    {
      auto iPath = service_paths.find(name);
      return (iPath == service_paths.end()) ? ("services." + name) : iPath->second;
    } // ServiceParameterSetPath()

void testing::BasicEnvironmentConfiguration::SetApplicationName ( std::string  name )

inline

Sets the name of the application.

Definition at line 207 of file unit_test_base.h.

{ appl_name = name; }

void testing::BasicEnvironmentConfiguration::SetConfigurationPath ( std::string  path )

inline

Sets the path to the configuration file.

Definition at line 210 of file unit_test_base.h.

{ config_path = path; }

void testing::BasicEnvironmentConfiguration::SetMainTesterParameterSetName ( std::string  name )

inline

Sets the FHiCL name for the configuration of the test algorithm.

Definition at line 213 of file unit_test_base.h.

{ main_test_name = name; }

void testing::BasicEnvironmentConfiguration::SetMainTesterParameterSetPath ( std::string  path )

inline

Sets the FHiCL path for the configuration of the main test algorithm.

Definition at line 222 of file unit_test_base.h.

References util::empty().

    {
      if (MainTesterParameterSetName().empty()) {
        throw std::logic_error("Request setting configuration of non-existent main tester");
      }
      SetTesterParameterSetPath(MainTesterParameterSetName(), path);
    }

void testing::BasicEnvironmentConfiguration::SetServiceParameterSetPath ( std::string  service_name, std::string  path  )

inline

Sets the FHiCL path for the configuration of a test algorithm.

Definition at line 231 of file unit_test_base.h.

Referenced by testing::BasicGeometryEnvironmentConfiguration::SetGeometryParameterSetPath().

    {
      service_paths[service_name] = path;
    }

void testing::BasicEnvironmentConfiguration::SetTesterParameterSetPath ( std::string  test_name, std::string  path  )

inline

Sets the FHiCL path for the configuration of a test algorithm.

Definition at line 216 of file unit_test_base.h.

    {
      test_paths[test_name] = path;
    }

std::string testing::BasicEnvironmentConfiguration::TesterParameterSetPath ( std::string  name ) const

inline

FHiCL path for the configuration of the test algorithm.

Definition at line 156 of file unit_test_base.h.

    {
      auto iPath = test_paths.find(name);
      return (iPath == test_paths.end()) ? ("physics.analyzers." + name) : iPath->second;
    }

Member Data Documentation

ConfigurationMap_t testing::BasicEnvironmentConfiguration::analyzers_default_cfg

protected

Configuration of all the analyzer modules.

Definition at line 274 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::appl_name

protected

name of the application

Definition at line 263 of file unit_test_base.h.

details::CommandLineArguments testing::BasicEnvironmentConfiguration::arguments

private

command line arguments

Definition at line 372 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::config_path

protected

configuration file path

Definition at line 264 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::main_test_name

protected

name of main test algorithm

Definition at line 265 of file unit_test_base.h.

std::string testing::BasicEnvironmentConfiguration::main_test_path

protected

path of main test algorithm configuration

Definition at line 266 of file unit_test_base.h.

PathMap_t testing::BasicEnvironmentConfiguration::service_paths

protected

Set of paths for service configuration.

Definition at line 279 of file unit_test_base.h.

ConfigurationMap_t testing::BasicEnvironmentConfiguration::services_default_cfg

protected

Configuration of all the services.

Definition at line 272 of file unit_test_base.h.

PathMap_t testing::BasicEnvironmentConfiguration::test_paths

protected

Set of paths for tester configuration.

Definition at line 277 of file unit_test_base.h.

---

The documentation for this struct was generated from the following file:

• larcorealg/v10_00_02/source/larcorealg/TestUtils/unit_test_base.h