testing::TesterEnvironment< ConfigurationClass > Class Template Reference

A test environment with some support for service providers. More...

#include "unit_test_base.h"

Inheritance diagram for testing::TesterEnvironment< ConfigurationClass >:

Public Types
using	Configuration_t = ConfigurationClass

Public Member Functions
template<typename Prov , typename... Args>
Prov *	SetupProvider (Args &&...args)
	Sets a service provider up by calling its testing::setupProvider() More...
template<typename Prov , typename... Args>
Prov *	SetupProviderFromService (std::string name, Args &&...args)
	Sets a service provider up by calling its testing::setupProvider() More...
template<typename Prov >
Prov *	AcquireProvider (std::unique_ptr< Prov > &&prov)
	Acquires a service provider. More...
template<typename Interface , typename Prov , typename... Args>
Prov *	SetupProviderFor (Args &&...args)
	Sets a provider up, recording it as implementation of Interface. More...
template<typename Interface , typename Prov , typename... Args>
Prov *	SetupProviderFromServiceFor (std::string name, Args &&...args)
	Sets a provider up, recording it as implementation of Interface. More...
template<typename Interface , typename Prov >
Prov *	AcquireProviderFor (std::unique_ptr< Prov > &&prov)
	Acquires a service provider implementing an interface. More...
template<typename Prov >
Prov *	SimpleProviderSetup ()
	Oversimplified provider setup. More...
template<typename Prov >
void	DropProvider ()
	Removes and destroys the specified provider. More...
template<typename Prov >
Prov const *	Provider () const
	Return the specified provider (throws if not available) More...
template<typename... Provs>
void	FillProviderPack (lar::ProviderPack< Provs... > &pack) const
	Fills the specified provider pack with providers. More...
template<typename Prov >
Prov::providers_type	ProviderPackFor () const
	Returns a provider pack for the specified provider. More...
Configuration retrieval
fhicl::ParameterSet const &	Parameters () const
	Returns the full configuration. More...
fhicl::ParameterSet	ServiceParameters (std::string service_name) const
	Returns the configuration of the specified service. More...
fhicl::ParameterSet	TesterParameters (std::string test_name) const
	Returns the configuration of the specified test. More...
fhicl::ParameterSet	TesterParameters () const
	Returns the configuration of the main test (undefined if no main test) More...

Static Public Member Functions
static fhicl::ParameterSet	CompileParameterSet (std::string cfg)
	Compiles a parameter set from a string. More...

Protected Member Functions
Configuration_t const &	Config () const
	Returns a read-only version of the configuration. More...
virtual void	Setup ()
	The complete initialization, ran at construction by default. More...
virtual void	Configure ()
	Reads and translates the configuration. More...
virtual fhicl::ParameterSet	DefaultParameters () const
	Creates a full configuration for the test. More...
virtual void	SetupMessageFacility (fhicl::ParameterSet const &pset, std::string appl_name="") const
	Sets up the message facility. More...
virtual void	SetupMessageFacility () const
	Sets up the message facility. More...

Static Protected Member Functions
static fhicl::ParameterSet	ParseParameters (std::string config_path)
	Fills the test configuration from file or from default. More...

Protected Attributes
ProviderList	providers
	list of available providers More...

Private Types
using	TesterEnvBase_t = BasicTesterEnvironment< ConfigurationClass >
using	TesterEnv_t = TesterEnvironment< ConfigurationClass >

Detailed Description

template<typename ConfigurationClass>
class testing::TesterEnvironment< ConfigurationClass >

A test environment with some support for service providers.

Template Parameters

ConfigurationClass

a class providing compile-time configuration

This test environment extends BasicTesterEnvironment with some basic support for service providers.

Service provider support

This environment makes it available the method Provider<Prov>(), which returns a pointer to the provider of type Prov.

All providers must be set up after the test environment is constructed. The environment provides the following facilities:

• SetupProvider() to set up a service provider with generic arguments
• SetupProviderFromService() to set up a service provider with a parameter set extracted from the configuration
• AcquireProvider() to register a service provider already available
• DropProvider() to destroy an existing provider

The set up methods support a For variant (e.g. SetupProviderFor()) to register the provider also under the type of its interface. For example, if LArPropertiesStandard is an implementation of LArProperties, the call:

env.SetupProviderFor<LArProperties, LArPropertiesStandard>(pset);

will set up a LArPropertiesStandard provider just like

env.SetupProvider<LArPropertiesStandard>(pset);

would, and it makes the provider available as LArProperties too, so that both calls:

env.Provider<LArProperties>();
env.Provider<LArPropertiesStandard>();

are valid and return the same provider.

Use as test fixture

The providers must be set up after the test environment is constructed. This also means an additional complication for fixtures that require to be constructed in a final state, as it is the case for Boost unit test suite fixtures. In these cases, a class should publicly derive from TesterEnvironment, and the necessary setup should be added into the constructor of this derived class.

Note that, as in the case of BasicTesterEnvironment, in this case there is no room for polymorphism here since the setup need to happen on construction.

Definition at line 747 of file unit_test_base.h.

Member Typedef Documentation

template<typename ConfigurationClass >

using testing::BasicTesterEnvironment< ConfigurationClass >::Configuration_t = ConfigurationClass

inherited

Definition at line 564 of file unit_test_base.h.

template<typename ConfigurationClass >

using testing::TesterEnvironment< ConfigurationClass >::TesterEnv_t = TesterEnvironment<ConfigurationClass>

private

Definition at line 751 of file unit_test_base.h.

template<typename ConfigurationClass >

using testing::TesterEnvironment< ConfigurationClass >::TesterEnvBase_t = BasicTesterEnvironment<ConfigurationClass>

private

Definition at line 750 of file unit_test_base.h.

Member Function Documentation

template<typename ConfigurationClass >

template<typename Prov >

Prov* testing::TesterEnvironment< ConfigurationClass >::AcquireProvider ( std::unique_ptr< Prov > &&  prov )

inline

Acquires a service provider.

Template Parameters

Prov	type of provider

Parameters

prov	the provider to be acquired

Returns

a pointer to the provider

See also

SetupProvider()

Exceptions

runtime_error

if the provider already exists

This method registers and takes ownership of the specified provider. It is similar to SetupProvider() except that user is in charge of the preliminary creation and setup of the provider.

Definition at line 814 of file unit_test_base.h.

      {
        if (!providers.acquire(std::move(prov)))
          throw std::runtime_error("Provider already exists!");
        return providers.getPointer<Prov>();
      }

template<typename ConfigurationClass >

template<typename Interface , typename Prov >

Prov* testing::TesterEnvironment< ConfigurationClass >::AcquireProviderFor ( std::unique_ptr< Prov > &&  prov )

inline

Acquires a service provider implementing an interface.

Template Parameters

Prov	type of provider
Interface	type provider alias

Parameters

prov	the provider to be acquired

Returns

a pointer to the provider

See also

SetupProviderFor(), AcquireProvider()

This method registers and takes ownership of the specified provider, like AcquireProvider() does. It also registers the provider as an implementation of Interface class, as SetupProviderFor does. It is similar to SetupProvider() except that user is in charge of the preliminar creation and setup of the provider.

Definition at line 888 of file unit_test_base.h.

      {
        auto prov_ptr = providers.acquire(prov);
        providers.set_alias<Prov, Interface>();
        return prov_ptr;
      }

template<typename ConfigurationClass >

fhicl::ParameterSet testing::BasicTesterEnvironment< ConfigurationClass >::CompileParameterSet ( std::string  cfg )

staticinherited

Compiles a parameter set from a string.

---

Returns

a parameters set with the complete configuration

Definition at line 1086 of file unit_test_base.h.

References fhicl::make_ParameterSet(), and testing::BasicTesterEnvironment< ConfigurationClass >::ParseParameters().

Referenced by testing::BasicTesterEnvironment< ConfigurationClass >::~BasicTesterEnvironment().

  {
    fhicl::ParameterSet global_pset;
    fhicl::make_ParameterSet(cfg, global_pset);
    return global_pset;
  } // BasicTesterEnvironment<>::CompileParameterSet()

template<typename ConfigurationClass >

Configuration_t const& testing::BasicTesterEnvironment< ConfigurationClass >::Config ( ) const

inlineprotectedinherited

Returns a read-only version of the configuration.

Definition at line 636 of file unit_test_base.h.

{ return config; }

template<typename ConfigurationClass >

void testing::BasicTesterEnvironment< ConfigurationClass >::Configure ( )

protectedvirtualinherited

Reads and translates the configuration.

Fills the configuration.

---

The complete configuration (message facility and services) is read and saved, hence accessible by Parameters() method.

The configuration file path is taken by default from the first argument of the test. If that first argument is not present or empty, the default configuration path is received from the configurer. If the configuration path is still empty, a hard-coded configuration is used; otherwise, the FHiCL file specified in that path is parsed and used as full configuration.

Definition at line 1136 of file unit_test_base.h.

References testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

                                                             {
    std::string config_path = config.ConfigurationPath();
    params = config_path.empty()?
      DefaultParameters(): ParseParameters(config_path);
  } // BasicTesterEnvironment::Configure()

template<typename ConfigurationClass >

virtual fhicl::ParameterSet testing::BasicTesterEnvironment< ConfigurationClass >::DefaultParameters ( ) const

inlineprotectedvirtualinherited

Creates a full configuration for the test.

Returns

a parameters set with the complete configuration

Definition at line 648 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

      { return CompileParameterSet(config.DefaultConfiguration()); }

template<typename ConfigurationClass >

template<typename Prov >

void testing::TesterEnvironment< ConfigurationClass >::DropProvider ( )

inline

Removes and destroys the specified provider.

Template Parameters

Prov	type of provider to be destroyed

Exceptions

runtime_error

if the provider was not present

Definition at line 916 of file unit_test_base.h.

      { 
        if (!providers.erase<Prov>())
          throw std::runtime_error("Provider not present!");
      }

template<typename ConfigurationClass >

template<typename... Provs>

void testing::TesterEnvironment< ConfigurationClass >::FillProviderPack ( lar::ProviderPack< Provs... > &  pack ) const

inline

Fills the specified provider pack with providers.

Exceptions

runtime_error

and everything provider() method can throw

See also

Provider()

Definition at line 933 of file unit_test_base.h.

References trkf::fill().

      {
         details::ProviderPackFiller
           <TesterEnv_t, lar::ProviderPack<Provs...>, Provs...>
           ::fill
           (*this, pack);
      } // FillProviderPack()

template<typename ConfigurationClass >

fhicl::ParameterSet const& testing::BasicTesterEnvironment< ConfigurationClass >::Parameters ( ) const

inlineinherited

Returns the full configuration.

Definition at line 606 of file unit_test_base.h.

{ return params; }

template<typename ConfigurationClass >

fhicl::ParameterSet testing::BasicTesterEnvironment< ConfigurationClass >::ParseParameters ( std::string  config_path )

staticprotectedinherited

Fills the test configuration from file or from default.

Returns the configuration from a FHiCL file.

If a FHiCL configuration file is specified, the configuration of the test is read from it according to the parameter set path of the test. Otherwise, it is parsed from the default one provided by the configurer.Parses from file and returns a FHiCL data structure

---

Parameters

config_path

full path of the FHiCL configuration file

Returns

a parameters set with the complete configuration from the file

Definition at line 1102 of file unit_test_base.h.

References fhicl::make_ParameterSet(), and fhicl::parse_document().

Referenced by testing::BasicTesterEnvironment< ConfigurationClass >::CompileParameterSet().

  {
    // configuration file lookup policy
    char const* fhicl_env = getenv("FHICL_FILE_PATH");
    std::string search_path = fhicl_env? std::string(fhicl_env) + ":": ".:";
    details::FirstAbsoluteOrLookupWithDotPolicy policy(search_path);
    
    // parse a configuration file; obtain intermediate form
    fhicl::intermediate_table table;
    fhicl::parse_document(config_path, policy, table);
    
    // translate into a parameter set
    fhicl::ParameterSet global_pset;
    fhicl::make_ParameterSet(table, global_pset);
    
    return global_pset;
  } // BasicTesterEnvironment<>::ParseParameters()

template<typename ConfigurationClass >

template<typename Prov >

Prov const* testing::TesterEnvironment< ConfigurationClass >::Provider ( ) const

inline

Return the specified provider (throws if not available)

Definition at line 924 of file unit_test_base.h.

      { return providers.getPointer<Prov>(); }

template<typename ConfigurationClass >

template<typename Prov >

Prov::providers_type testing::TesterEnvironment< ConfigurationClass >::ProviderPackFor ( ) const

inline

Returns a provider pack for the specified provider.

Template Parameters

Prov	type of the provider

Exceptions

runtime_error

and everything provider() method can throw

See also

FillProviderPack()

The provider is required to have a providers_type type defined as an specialisation of lar::ProviderPack.

Definition at line 952 of file unit_test_base.h.

      {
         typename Prov::providers_type pack;
         FillProviderPack(pack);
         return pack;
      } // ProviderPackFor()

template<typename ConfigurationClass >

fhicl::ParameterSet testing::BasicTesterEnvironment< ConfigurationClass >::ServiceParameters ( std::string  service_name ) const

inlineinherited

Returns the configuration of the specified service.

Definition at line 609 of file unit_test_base.h.

References fhicl::ParameterSet::get().

      {
        return params.get<fhicl::ParameterSet>
          (config.ServiceParameterSetPath(service_name));
      }

template<typename ConfigurationClass >

void testing::BasicTesterEnvironment< ConfigurationClass >::Setup ( )

protectedvirtualinherited

The complete initialization, ran at construction by default.

Definition at line 1185 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

    {
    
    //
    // get the configuration
    //
    Configure();
    
    //
    // parse the options specific to the test environment
    //
    ParseEnvironmentOptions();
    
    //
    // set up the message facility
    //
    SetupMessageFacility();
    
    //
    // Optionally print the configuration
    //
    {
      mf::LogInfo msg("Configuration");
      msg << "Complete configuration (";
      if (config.ConfigurationPath().empty()) msg << "default";
      else msg << "'" << config.ConfigurationPath() << "'";
      msg << "):\n" << Parameters().to_indented_string(1);
    }
    
    
    mf::LogInfo("Test") << config.ApplicationName() << " base setup complete.";
    
  } // BasicTesterEnvironment<>::Setup()

template<typename ConfigurationClass >

void testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility ( fhicl::ParameterSet const &  pset, std::string  appl_name = ""  ) const

protectedvirtualinherited

Sets up the message facility.

Sets the message facility up.

---

Message facility configuration is expected in "services.message" parameter set. If not there, the default configuration is used.

Definition at line 1151 of file unit_test_base.h.

References fhicl::ParameterSet::get_if_present(), LOG_TRACE, mf::SetApplicationName(), mf::SetContextIteration(), mf::SetContextSinglet(), mf::StartMessageFacility(), and fhicl::ParameterSet::to_indented_string().

  {
    fhicl::ParameterSet mf_pset;
    
    if
      (!pset.get_if_present(config.ServiceParameterSetPath("message"), mf_pset))
    {
      mf_pset
        = CompileParameterSet(config.DefaultServiceConfiguration("message"));
      std::cout << "Using default message facility configuration:\n"
        << mf_pset.to_indented_string(1) << std::endl;
    } // if no configuration is available
    
    mf::StartMessageFacility(mf_pset);
    if (!appl_name.empty()) mf::SetApplicationName(appl_name);
    mf::SetContextIteration("Initialization");
    if (options.MessageLevels) {
      std::cout << "Printing message levels in 'MessageFacility' category."
        << std::endl;
      
      mf::LogProblem("MessageFacility") << "Error messages are shown.";
      mf::LogPrint("MessageFacility") << "Warning messages are shown.";
      mf::LogVerbatim("MessageFacility") << "Info messages are shown.";
      mf::LogTrace("MessageFacility") << "Debug messages are shown.";
      LOG_TRACE("MessageFacility")
        << "LOG_TRACE/LOG_DEBUG messages are not compiled away.";
    } // if print message levels
    mf::LogInfo("MessageFacility") << "MessageFacility started.";
    mf::SetContextSinglet("main");
  } // BasicTesterEnvironment::SetupMessageFacility()

template<typename ConfigurationClass >

virtual void testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility ( ) const

inlineprotectedvirtualinherited

Sets up the message facility.

Sets the message facility up.

---

Message facility configuration is expected in "services.message" parameter set. If not there, the default configuration is used.

Definition at line 655 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

Referenced by testing::BasicTesterEnvironment< ConfigurationClass >::Configure().

      { SetupMessageFacility(Parameters(), config.ApplicationName()); }

template<typename ConfigurationClass >

template<typename Prov , typename... Args>

Prov* testing::TesterEnvironment< ConfigurationClass >::SetupProvider ( Args &&...  args )

inline

Sets a service provider up by calling its testing::setupProvider()

Template Parameters

Prov	type of provider
Args	type of arguments for the setup function

Parameters

args	arguments for the setup function

Returns

a pointer to the provider set up

Exceptions

runtime_error

if the provider already exists

See also

SetupProviderFor(), AcquireProvider()

A provider of type Prov is created, set up and recorded. Provider setup is delegated to testing::setupProvider function specific to the provider itself (that is, testing::setupProvider<Prov>(args...)) to which the setup arguments are forwarded. If the provider already exists, an exception is thrown.

Definition at line 773 of file unit_test_base.h.

References testing::details::CommandLineArguments::args.

      {
        if (!providers.setup<Prov>(std::forward<Args>(args)...))
          throw std::runtime_error("Provider already exists!");
        return providers.getPointer<Prov>();
      }

template<typename ConfigurationClass >

template<typename Interface , typename Prov , typename... Args>

Prov* testing::TesterEnvironment< ConfigurationClass >::SetupProviderFor ( Args &&...  args )

inline

Sets a provider up, recording it as implementation of Interface.

Template Parameters

Interface	type of provider interface being implemented
Prov	type of provider
Args	type of arguments for the setup function

Parameters

args	arguments for the setup function

Returns

a pointer to the provider set up

See also

SetupProvider()

This method performs the same type of setup as SetupProvider(). In addition, it registers the provider as an implementation of Interface. This means that the provider can be obtained not only with provider<Prov>(), which returns a pointer to the actual class Prov, but also as provider<Interface>(), which returns a pointer to the base class Interface.

Definition at line 838 of file unit_test_base.h.

References testing::details::CommandLineArguments::args.

      {
        auto prov = SetupProvider<Prov>(std::forward<Args>(args)...);
        providers.set_alias<Prov, Interface>();
        return prov;
      }

template<typename ConfigurationClass >

template<typename Prov , typename... Args>

Prov* testing::TesterEnvironment< ConfigurationClass >::SetupProviderFromService ( std::string  name, Args &&...  args  )

inline

Sets a service provider up by calling its testing::setupProvider()

Template Parameters

Prov	type of provider
Args	type of arguments for the setup function

Parameters

name	the service name (for configuration retrieval)
args	arguments for the setup function

Returns

a pointer to the provider set up

See also

SetupProvider()

Exceptions

runtime_error

if the provider already exists

A provider of type Prov is created, set up and recorded. Provider setup is attempted by constructing the provider with a parameter set from the registered configuration of service with specified name.

Definition at line 795 of file unit_test_base.h.

References testing::details::CommandLineArguments::args.

      {
        return SetupProvider<Prov>
          (this->ServiceParameters(name, std::forward<Args>(args)...));
      }

template<typename ConfigurationClass >

template<typename Interface , typename Prov , typename... Args>

Prov* testing::TesterEnvironment< ConfigurationClass >::SetupProviderFromServiceFor ( std::string  name, Args &&...  args  )

inline

Sets a provider up, recording it as implementation of Interface.

Template Parameters

Interface	type of provider interface being implemented
Prov	type of provider
Args	type of arguments for the setup function

Parameters

name	the service name (for configuration retrieval)
args	arguments for the setup function

Returns

a pointer to the provider set up

See also

SetupProviderFromService(), SetupProviderFor()

Exceptions

runtime_error

if the provider already exists

This method performs the same type of setup as SetupProviderFromService(). In addition, it registers the provider as an implementation of Interface. This means that the provider can be obtained not only with provider<Prov>(), which returns a pointer to the actual class Prov, but also as provider<Interface>(), which returns a pointer to the base class Interface.

Definition at line 865 of file unit_test_base.h.

References testing::details::CommandLineArguments::args.

      {
        auto* prov
          = SetupProviderFromService<Prov>(name, std::forward<Args>(args)...);
        providers.set_alias<Prov, Interface>();
        return prov;
      }

template<typename ConfigurationClass >

template<typename Prov >

Prov* testing::TesterEnvironment< ConfigurationClass >::SimpleProviderSetup ( )

inline

Oversimplified provider setup.

Returns

a pointer to the provider

Template Parameters

Prov	provider type

This is a one-step setup of the specified provider.

It is available only if Prov provider comes with an implementation of testing::SimpleEnvironmentSetupClass that explains how to set up an environment.

Definition at line 908 of file unit_test_base.h.

{ return simpleEnvironmentSetup<Prov>(*this); }

template<typename ConfigurationClass >

fhicl::ParameterSet testing::BasicTesterEnvironment< ConfigurationClass >::TesterParameters ( std::string  test_name ) const

inlineinherited

Returns the configuration of the specified test.

Definition at line 616 of file unit_test_base.h.

References fhicl::ParameterSet::get().

      {
        return params.get<fhicl::ParameterSet>
          (config.TesterParameterSetPath(test_name));
      }

template<typename ConfigurationClass >

fhicl::ParameterSet testing::BasicTesterEnvironment< ConfigurationClass >::TesterParameters ( ) const

inlineinherited

Returns the configuration of the main test (undefined if no main test)

Definition at line 623 of file unit_test_base.h.

      {
        if (config.MainTesterParameterSetName().empty()) return {};
        else return TesterParameters(config.MainTesterParameterSetName());
      }

Member Data Documentation

template<typename ConfigurationClass >

ProviderList testing::TesterEnvironment< ConfigurationClass >::providers

protected

list of available providers

Definition at line 961 of file unit_test_base.h.

---

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

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