LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
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 >:
testing::BasicTesterEnvironment< ConfigurationClass > testing::GeometryTesterEnvironment< 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
ConfigurationClassa 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:

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 751 of file unit_test_base.h.

Member Typedef Documentation

template<typename ConfigurationClass >
using testing::BasicTesterEnvironment< ConfigurationClass >::Configuration_t = ConfigurationClass
inherited

Definition at line 563 of file unit_test_base.h.

template<typename ConfigurationClass >
using testing::TesterEnvironment< ConfigurationClass >::TesterEnv_t = TesterEnvironment<ConfigurationClass>
private

Definition at line 753 of file unit_test_base.h.

template<typename ConfigurationClass >
using testing::TesterEnvironment< ConfigurationClass >::TesterEnvBase_t = BasicTesterEnvironment<ConfigurationClass>
private

Definition at line 752 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
Provtype of provider
Parameters
provthe provider to be acquired
Returns
a pointer to the provider
See also
SetupProvider()
Exceptions
runtime_errorif 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 815 of file unit_test_base.h.

816  {
817  if (!providers.acquire(std::move(prov))) throw std::runtime_error("Provider already exists!");
818  return providers.getPointer<Prov>();
819  }
T const * getPointer(std::string label="") const
Retrieve the object of type T stored with the specified label.
Definition: ProviderList.h:357
bool acquire(std::unique_ptr< T > &&obj_ptr, std::string label="")
Registers and gets ownership of the specified object.
Definition: ProviderList.h:265
ProviderList providers
list of available providers
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
Provtype of provider
Interfacetype provider alias
Parameters
provthe 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 887 of file unit_test_base.h.

888  {
889  auto prov_ptr = providers.acquire(prov);
890  providers.set_alias<Prov, Interface>();
891  return prov_ptr;
892  }
bool acquire(std::unique_ptr< T > &&obj_ptr, std::string label="")
Registers and gets ownership of the specified object.
Definition: ProviderList.h:265
ProviderList providers
list of available providers
bool set_alias(std::string alias_label="", std::string prov_label="")
Sets the Alias type as an alias of the Prov provider (with labels)
Definition: ProviderList.h:305
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 1069 of file unit_test_base.h.

References fhicl::ParameterSet::make().

1071  {
1072  fhicl::ParameterSet global_pset;
1073  global_pset = fhicl::ParameterSet::make(cfg);
1074  return global_pset;
1075  } // BasicTesterEnvironment<>::CompileParameterSet()
static ParameterSet make(intermediate_table const &tbl)
Definition: ParameterSet.cc:68
template<typename ConfigurationClass >
Configuration_t const& testing::BasicTesterEnvironment< ConfigurationClass >::Config ( ) const
inlineprotectedinherited

Returns a read-only version of the configuration.

Definition at line 638 of file unit_test_base.h.

638 { return config; }
Configuration_t config
instance of the configurer
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 1117 of file unit_test_base.h.

1118  {
1119  std::string config_path = config.ConfigurationPath();
1120  params = config_path.empty() ? DefaultParameters() : ParseParameters(config_path);
1121  } // BasicTesterEnvironment::Configure()
fhicl::ParameterSet params
full configuration of the test
static fhicl::ParameterSet ParseParameters(std::string config_path)
Fills the test configuration from file or from default.
virtual fhicl::ParameterSet DefaultParameters() const
Creates a full configuration for the test.
Configuration_t config
instance of the configurer
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 650 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

651  {
652  return CompileParameterSet(config.DefaultConfiguration());
653  }
Configuration_t config
instance of the configurer
static fhicl::ParameterSet CompileParameterSet(std::string cfg)
Compiles a parameter set from a string.
template<typename ConfigurationClass >
template<typename Prov >
void testing::TesterEnvironment< ConfigurationClass >::DropProvider ( )
inline

Removes and destroys the specified provider.

Template Parameters
Provtype of provider to be destroyed
Exceptions
runtime_errorif the provider was not present

Definition at line 918 of file unit_test_base.h.

919  {
920  if (!providers.erase<Prov>()) throw std::runtime_error("Provider not present!");
921  }
bool erase(std::string label="")
Drops the object with the specified type and label.
Definition: ProviderList.h:285
ProviderList providers
list of available providers
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_errorand everything provider() method can throw
See also
Provider()

Definition at line 936 of file unit_test_base.h.

References trkf::fill().

937  {
938  details::ProviderPackFiller<TesterEnv_t, lar::ProviderPack<Provs...>, Provs...>::fill(*this,
939  pack);
940  } // FillProviderPack()
void fill(const art::PtrVector< recob::Hit > &hits, int only_plane)
Container for a list of pointers to providers.
Definition: ProviderPack.h:111
TesterEnvironment< ConfigurationClass > TesterEnv_t
template<typename ConfigurationClass >
fhicl::ParameterSet const& testing::BasicTesterEnvironment< ConfigurationClass >::Parameters ( ) const
inlineinherited

Returns the full configuration.

Definition at line 609 of file unit_test_base.h.

609 { return params; }
fhicl::ParameterSet params
full configuration of the test
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_pathfull path of the FHiCL configuration file
Returns
a parameters set with the complete configuration from the file

Definition at line 1083 of file unit_test_base.h.

References fhicl::ParameterSet::make(), and fhicl::parse_document().

1085  {
1086  // configuration file lookup policy
1087  char const* fhicl_env = getenv("FHICL_FILE_PATH");
1088  std::string search_path = fhicl_env ? std::string(fhicl_env) + ":" : ".:";
1089  details::FirstAbsoluteOrLookupWithDotPolicy policy(search_path);
1090 
1091  // parse a configuration file; obtain intermediate form
1093  table = fhicl::parse_document(config_path, policy);
1094 
1095  // translate into a parameter set
1096  fhicl::ParameterSet global_pset;
1097  global_pset = fhicl::ParameterSet::make(table);
1098 
1099  return global_pset;
1100  } // BasicTesterEnvironment<>::ParseParameters()
static ParameterSet make(intermediate_table const &tbl)
Definition: ParameterSet.cc:68
intermediate_table parse_document(std::string const &filename, cet::filepath_maker &maker)
Definition: parse.cc:709
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 925 of file unit_test_base.h.

926  {
927  return providers.getPointer<Prov>();
928  }
T const * getPointer(std::string label="") const
Retrieve the object of type T stored with the specified label.
Definition: ProviderList.h:357
ProviderList providers
list of available providers
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
Provtype of the provider
Exceptions
runtime_errorand 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.

953  {
954  typename Prov::providers_type pack;
955  FillProviderPack(pack);
956  return pack;
957  } // ProviderPackFor()
void FillProviderPack(lar::ProviderPack< Provs... > &pack) const
Fills the specified provider pack with providers.
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 612 of file unit_test_base.h.

References fhicl::ParameterSet::get().

613  {
614  return params.get<fhicl::ParameterSet>(config.ServiceParameterSetPath(service_name));
615  }
fhicl::ParameterSet params
full configuration of the test
Configuration_t config
instance of the configurer
T get(std::string const &key) const
Definition: ParameterSet.h:314
template<typename ConfigurationClass >
void testing::BasicTesterEnvironment< ConfigurationClass >::Setup ( )
protectedvirtualinherited

The complete initialization, ran at construction by default.

Reimplemented in testing::GeometryTesterEnvironment< ConfigurationClass >.

Definition at line 1160 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

1161  {
1162 
1163  //
1164  // get the configuration
1165  //
1166  Configure();
1167 
1168  //
1169  // parse the options specific to the test environment
1170  //
1172 
1173  //
1174  // set up the message facility
1175  //
1177 
1178  //
1179  // Optionally print the configuration
1180  //
1181  {
1182  mf::LogInfo msg("Configuration");
1183  msg << "Complete configuration (";
1184  if (config.ConfigurationPath().empty())
1185  msg << "default";
1186  else
1187  msg << "'" << config.ConfigurationPath() << "'";
1188  msg << "):\n" << Parameters().to_indented_string(1);
1189  }
1190 
1191  mf::LogInfo("Test") << config.ApplicationName() << " base setup complete.";
1192 
1193  } // BasicTesterEnvironment<>::Setup()
fhicl::ParameterSet const & Parameters() const
Returns the full configuration.
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
Configuration_t config
instance of the configurer
virtual void Configure()
Reads and translates the configuration.
void ParseEnvironmentOptions()
Parses the configuration, looking for the test environment options.
std::string to_indented_string() const
virtual void SetupMessageFacility() const
Sets up the message facility.
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 1130 of file unit_test_base.h.

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

1133  {
1134  fhicl::ParameterSet mf_pset;
1135 
1136  if (!pset.get_if_present(config.ServiceParameterSetPath("message"), mf_pset)) {
1137  mf_pset = CompileParameterSet(config.DefaultServiceConfiguration("message"));
1138  std::cout << "Using default message facility configuration:\n"
1139  << mf_pset.to_indented_string(1) << std::endl;
1140  } // if no configuration is available
1141 
1142  mf::StartMessageFacility(mf_pset);
1143  if (!appl_name.empty()) mf::SetApplicationName(appl_name);
1144  mf::SetContextIteration("Initialization");
1145  if (options.MessageLevels) {
1146  std::cout << "Printing message levels in 'MessageFacility' category." << std::endl;
1147 
1148  mf::LogProblem("MessageFacility") << "Error messages are shown.";
1149  mf::LogPrint("MessageFacility") << "Warning messages are shown.";
1150  mf::LogVerbatim("MessageFacility") << "Info messages are shown.";
1151  mf::LogTrace("MessageFacility") << "Debug messages are shown.";
1152  MF_LOG_TRACE("MessageFacility")
1153  << "MF_LOG_TRACE/MF_LOG_DEBUG messages are not compiled away.";
1154  } // if print message levels
1155  mf::LogInfo("MessageFacility") << "MessageFacility started.";
1156  mf::SetContextSinglet("main");
1157  } // BasicTesterEnvironment::SetupMessageFacility()
MaybeLogger_< ELseverityLevel::ELsev_info, true > LogVerbatim
Options_t options
options for the test environment
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
Configuration_t config
instance of the configurer
void SetContextIteration(string const &val)
MaybeLogger_< ELseverityLevel::ELsev_error, true > LogProblem
void StartMessageFacility(fhicl::ParameterSet const &pset, string const &applicationName)
#define MF_LOG_TRACE(id)
std::string to_indented_string() const
bool MessageLevels
print message levels on screen
void SetContextSinglet(string const &val)
MaybeLogger_< ELseverityLevel::ELsev_success, true > LogTrace
static fhicl::ParameterSet CompileParameterSet(std::string cfg)
Compiles a parameter set from a string.
void SetApplicationName(string const &applicationName)
MaybeLogger_< ELseverityLevel::ELsev_warning, true > LogPrint
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 659 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

660  {
661  SetupMessageFacility(Parameters(), config.ApplicationName());
662  }
fhicl::ParameterSet const & Parameters() const
Returns the full configuration.
Configuration_t config
instance of the configurer
virtual void SetupMessageFacility() const
Sets up the message facility.
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
Provtype of provider
Argstype of arguments for the setup function
Parameters
argsarguments for the setup function
Returns
a pointer to the provider set up
Exceptions
runtime_errorif 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 775 of file unit_test_base.h.

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

776  {
777  if (!providers.setup<Prov>(std::forward<Args>(args)...))
778  throw std::runtime_error("Provider already exists!");
779  return providers.getPointer<Prov>();
780  }
T const * getPointer(std::string label="") const
Retrieve the object of type T stored with the specified label.
Definition: ProviderList.h:357
ProviderList providers
list of available providers
bool setup(Args &&...args)
Construct and register an object of type T with specified arguments.
Definition: ProviderList.h:248
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
Interfacetype of provider interface being implemented
Provtype of provider
Argstype of arguments for the setup function
Parameters
argsarguments 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.

839  {
840  auto prov = SetupProvider<Prov>(std::forward<Args>(args)...);
841  providers.set_alias<Prov, Interface>();
842  return prov;
843  }
ProviderList providers
list of available providers
bool set_alias(std::string alias_label="", std::string prov_label="")
Sets the Alias type as an alias of the Prov provider (with labels)
Definition: ProviderList.h:305
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
Provtype of provider
Argstype of arguments for the setup function
Parameters
namethe service name (for configuration retrieval)
argsarguments for the setup function
Returns
a pointer to the provider set up
See also
SetupProvider()
Exceptions
runtime_errorif 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 797 of file unit_test_base.h.

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

798  {
799  return SetupProvider<Prov>(this->ServiceParameters(name, std::forward<Args>(args)...));
800  }
fhicl::ParameterSet ServiceParameters(std::string service_name) const
Returns the configuration of the specified service.
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
Interfacetype of provider interface being implemented
Provtype of provider
Argstype of arguments for the setup function
Parameters
namethe service name (for configuration retrieval)
argsarguments for the setup function
Returns
a pointer to the provider set up
See also
SetupProviderFromService(), SetupProviderFor()
Exceptions
runtime_errorif 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.

866  {
867  auto* prov = SetupProviderFromService<Prov>(name, std::forward<Args>(args)...);
868  providers.set_alias<Prov, Interface>();
869  return prov;
870  }
ProviderList providers
list of available providers
bool set_alias(std::string alias_label="", std::string prov_label="")
Sets the Alias type as an alias of the Prov provider (with labels)
Definition: ProviderList.h:305
template<typename ConfigurationClass >
template<typename Prov >
Prov* testing::TesterEnvironment< ConfigurationClass >::SimpleProviderSetup ( )
inline

Oversimplified provider setup.

Returns
a pointer to the provider
Template Parameters
Provprovider 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 907 of file unit_test_base.h.

908  {
909  return simpleEnvironmentSetup<Prov>(*this);
910  }
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 618 of file unit_test_base.h.

References fhicl::ParameterSet::get().

619  {
620  return params.get<fhicl::ParameterSet>(config.TesterParameterSetPath(test_name));
621  }
fhicl::ParameterSet params
full configuration of the test
Configuration_t config
instance of the configurer
T get(std::string const &key) const
Definition: ParameterSet.h:314
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 624 of file unit_test_base.h.

625  {
626  if (config.MainTesterParameterSetName().empty())
627  return {};
628  else
629  return TesterParameters(config.MainTesterParameterSetName());
630  }
Configuration_t config
instance of the configurer
fhicl::ParameterSet TesterParameters() const
Returns the configuration of the main test (undefined if no main test)

Member Data Documentation

template<typename ConfigurationClass >
ProviderList testing::TesterEnvironment< ConfigurationClass >::providers
protected

list of available providers

Definition at line 960 of file unit_test_base.h.


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