testing::GeometryTesterEnvironment< ConfigurationClass > Class Template Reference

Environment for a geometry test. More...

#include "geometry_unit_test_base.h"

Inheritance diagram for testing::GeometryTesterEnvironment< ConfigurationClass >:

Public Types
using	SharedGeoPtr_t = GeoResources_t::ResourcePtr_t
using	Configuration_t = ConfigurationClass

Public Member Functions
	GeometryTesterEnvironment (bool bSetup=true)
	Constructor: sets everything up and declares the test started. More...
virtual	~GeometryTesterEnvironment ()
	Destructor: closing remarks. More...
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...
	GeometryTesterEnvironment (ConfigurationClass const &cfg_obj, bool bSetup=true)
	Setup from a configuration. More...
	GeometryTesterEnvironment (ConfigurationClass &&cfg_obj, bool bSetup=true)
	Setup from a configuration. More...
geo::GeometryCore const *	Geometry () const
	Returns a pointer to the geometry. More...
SharedGeoPtr_t	SharedGeometry () const
	Returns a pointer to the geometry. 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 geo::GeometryCore const *	GlobalGeometry ()
static SharedGeoPtr_t	SharedGlobalGeometry ()
	Returns the current global geometry instance (may be nullptr if none) More...
static fhicl::ParameterSet	CompileParameterSet (std::string cfg)
	Compiles a parameter set from a string. More...

Protected Types
using	ChannelMapClass = typename ConfigurationClass::ChannelMapClass

Protected Member Functions
virtual void	Setup ()
	The complete initialization, ran at construction by default. More...
virtual std::unique_ptr< geo::GeometryCore >	CreateNewGeometry () const
	Creates a new geometry. More...
virtual void	SetupGeometry ()
	Sets up the geometry (creates and registers it) More...
Configuration_t const &	Config () const
	Returns a read-only version of the configuration. 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	RegisterGeometry (SharedGeoPtr_t new_geom)
	Get ownership of the specified geometry and registers it as global. More...
virtual void	RegisterGeometry (geo::GeometryCore const *new_geom)
	Get ownership of the specified geometry and registers it as global. 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	TesterEnvironment_t = TesterEnvironment< ConfigurationClass >
	Base class. More...
using	GeoResources_t = TestSharedGlobalResource< geo::GeometryCore const >
	this implements the singleton interface More...

Private Attributes
ConfigurationClass	config
	instance of the configurer More...
SharedGeoPtr_t	geom
	pointer to the geometry More...

Detailed Description

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

Environment for a geometry test.

---

Template Parameters

ConfigurationClass

a class providing compile-time configuration

The test environment is set up on construction.

The environment provides:

• Geometry() method to access geometry (as a constant pointer)
• Parameters() method returning the complete FHiCL configuration
• TesterParameters() method returning the configuration for the test

This class or a derived one can be used as global fixture for unit tests that require the presence of geometry (in the form of geo::GeometryCore instance).

Unfortunately Boost does not give any control on the initialization of the object, so everything must be ready to go as hard coded. The ConfigurationClass class tries to alleviate that. That is another, small static class that GeometryTesterEnvironment uses to get its parameters.

The requirements for the ConfigurationClass are:

• ChannelMapClass: concrete type of channel mapping algorithm class
• std::string ApplicationName(): the application name
• std::string ConfigurationPath(): path to the configuration file
• std::string GeometryParameterSetPath(): FHiCL path to the configuration of the geometry; in art is "services.Geometry"
• std::string TesterParameterSetPath(): FHiCL path to the configuration of the geometry
• std::string DefaultGeometryConfiguration() returning a FHiCL string to be parsed to extract the default geometry configuration
• std::string DefaultTesterConfiguration() returning a FHiCL string to be parsed to extract the default test configuration

Whether the configuration comes from a file or from the two provided defaults, it is always expected within the parameter set paths: the default configuration must also contain that path.

Note that there is no room for polymorphism here since the setup happens on construction. Some methods are declared virtual in order to allow to tweak some steps of the set up, but it's not trivial to create a derived class that works correctly: the derived class must declare a new default constructor, and that default constructor must call the protected constructor (GeometryTesterEnvironment<ConfigurationClass>(no_setup))

Definition at line 190 of file geometry_unit_test_base.h.

Member Typedef Documentation

template<typename ConfigurationClass >

using testing::GeometryTesterEnvironment< ConfigurationClass >::ChannelMapClass = typename ConfigurationClass::ChannelMapClass

protected

Definition at line 254 of file geometry_unit_test_base.h.

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::GeometryTesterEnvironment< ConfigurationClass >::GeoResources_t = TestSharedGlobalResource<geo::GeometryCore const>

private

this implements the singleton interface

Definition at line 196 of file geometry_unit_test_base.h.

template<typename ConfigurationClass >

using testing::GeometryTesterEnvironment< ConfigurationClass >::SharedGeoPtr_t = GeoResources_t::ResourcePtr_t

Definition at line 199 of file geometry_unit_test_base.h.

template<typename ConfigurationClass >

using testing::GeometryTesterEnvironment< ConfigurationClass >::TesterEnvironment_t = TesterEnvironment<ConfigurationClass>

private

Base class.

Definition at line 193 of file geometry_unit_test_base.h.

Constructor & Destructor Documentation

template<typename ConfigurationClass >

testing::GeometryTesterEnvironment< ConfigurationClass >::GeometryTesterEnvironment ( bool  bSetup = true )

inline

Constructor: sets everything up and declares the test started.

The configuration is from a default-constructed ConfigurationClass. This is suitable for use as Boost unit test fixture.

Definition at line 207 of file geometry_unit_test_base.h.

                                                  : TesterEnvironment_t(false)
    {
      if (bSetup) Setup();
    }

template<typename ConfigurationClass >

testing::GeometryTesterEnvironment< ConfigurationClass >::GeometryTesterEnvironment ( ConfigurationClass const &  cfg_obj, bool  bSetup = true  )

inline

Setup from a configuration.

Parameters

configurer

an instance of ConfigurationClass

The configuration is from the specified configurer class.

This constructor allows to use a non-default-constructed configuration. This can't be used (at best of my knowledge) when using this class as Boost unit test fixture.

In the r-value-reference constructor, the configurer is moved.

Definition at line 225 of file geometry_unit_test_base.h.

      : TesterEnvironment_t(cfg_obj, false)
    {
      if (bSetup) Setup();
    }

template<typename ConfigurationClass >

testing::GeometryTesterEnvironment< ConfigurationClass >::GeometryTesterEnvironment ( ConfigurationClass &&  cfg_obj, bool  bSetup = true  )

inline

Setup from a configuration.

Parameters

configurer

an instance of ConfigurationClass

The configuration is from the specified configurer class.

This constructor allows to use a non-default-constructed configuration. This can't be used (at best of my knowledge) when using this class as Boost unit test fixture.

In the r-value-reference constructor, the configurer is moved.

Definition at line 230 of file geometry_unit_test_base.h.

      : TesterEnvironment_t(std::move(cfg_obj), false)
    {
      if (bSetup) Setup();
    }

template<typename ConfigurationClass >

testing::GeometryTesterEnvironment< ConfigurationClass >::~GeometryTesterEnvironment ( )

virtual

Destructor: closing remarks.

Definition at line 283 of file geometry_unit_test_base.h.

  {

    mf::LogInfo("Test") << config.ApplicationName() << " completed.";

  } // GeometryTesterEnvironment<>::~GeometryTesterEnvironment()

Member Function Documentation

template<typename ConfigurationClass >

template<typename Prov >

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

inlineinherited

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 815 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 )

inlineinherited

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

References fhicl::ParameterSet::make().

  {
    fhicl::ParameterSet global_pset;
    global_pset = fhicl::ParameterSet::make(cfg);
    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 638 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 1117 of file unit_test_base.h.

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

template<typename ConfigurationClass >

std::unique_ptr< geo::GeometryCore > testing::GeometryTesterEnvironment< ConfigurationClass >::CreateNewGeometry ( ) const

protectedvirtual

Creates a new geometry.

Sets the geometry of the standard detector up.

---

This function sets up the geometry according to the provided information:

• the configuration must contain enough information to locate the geometry description file
• we trust that that geometry works well with the ChannelMapClass specified in ConfigurationClass

Definition at line 302 of file geometry_unit_test_base.h.

References fhicl::ParameterSet::get().

  {

    std::string ProviderParameterSetPath = this->Config().GeometryParameterSetPath();

    //
    // create the new geometry service provider
    //
    fhicl::ParameterSet ProviderConfig =
      this->Parameters().template get<fhicl::ParameterSet>(ProviderParameterSetPath);
    auto new_geom = std::make_unique<geo::GeometryCore>(ProviderConfig);

    std::string RelativePath = ProviderConfig.get<std::string>("RelativePath", "");

    std::string GDMLFileName = RelativePath + ProviderConfig.get<std::string>("GDML"),
                ROOTFileName = RelativePath + ProviderConfig.get<std::string>("ROOT");

    // Search all reasonable locations for the geometry file;
    // we see if by any chance art's FW_SEARCH_PATH directory is set and try
    // there;
    // if not, we do expect the path to be complete enough for ROOT to cope.
    cet::search_path sp("FW_SEARCH_PATH");

    std::string ROOTfile;
    if (!sp.find_file(ROOTFileName, ROOTfile)) ROOTfile = ROOTFileName;

    // we really don't care of GDML file, since we are not going to run Geant4
    std::string GDMLfile;
    if (!sp.find_file(GDMLFileName, GDMLfile)) {
      mf::LogWarning("CreateNewGeometry") << "GDML file '" << GDMLfile << "' not found.";
    }

    // initialize the geometry with the files we have found
    new_geom->LoadGeometryFile(GDMLfile, ROOTfile);

    //
    // create the new channel map
    //
    auto const SortingParameters = ProviderConfig.get<fhicl::ParameterSet>("SortingParameters", {});

    // connect the channel map with the geometry, that shares ownsership
    // (we give up ours at the end of this method)
    new_geom->ApplyChannelMap(std::make_unique<ChannelMapClass>(SortingParameters));

    return new_geom;
  } // GeometryTesterEnvironment<>::CreateNewGeometry()

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().

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

template<typename ConfigurationClass >

template<typename Prov >

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

inlineinherited

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 918 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

inlineinherited

Fills the specified provider pack with providers.

Exceptions

runtime_error

and everything provider() method can throw

See also

Provider()

Definition at line 936 of file unit_test_base.h.

References trkf::fill().

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

template<typename ConfigurationClass >

geo::GeometryCore const* testing::GeometryTesterEnvironment< ConfigurationClass >::Geometry ( ) const

inline

Returns a pointer to the geometry.

Definition at line 242 of file geometry_unit_test_base.h.

{ return geom.get(); }

template<typename ConfigurationClass >

static geo::GeometryCore const* testing::GeometryTesterEnvironment< ConfigurationClass >::GlobalGeometry ( )

inlinestatic

Returns the current global geometry instance

Exceptions

std::out_of_range

if not present

Definition at line 248 of file geometry_unit_test_base.h.

{ return &GeoResources_t::Resource(); }

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.

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

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

  {
    // 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;
    table = fhicl::parse_document(config_path, policy);

    // translate into a parameter set
    fhicl::ParameterSet global_pset;
    global_pset = fhicl::ParameterSet::make(table);

    return global_pset;
  } // BasicTesterEnvironment<>::ParseParameters()

template<typename ConfigurationClass >

template<typename Prov >

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

inlineinherited

Return the specified provider (throws if not available)

Definition at line 925 of file unit_test_base.h.

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

template<typename ConfigurationClass >

template<typename Prov >

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

inlineinherited

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 >

void testing::GeometryTesterEnvironment< ConfigurationClass >::RegisterGeometry ( SharedGeoPtr_t  new_geom )

protectedvirtual

Get ownership of the specified geometry and registers it as global.

Definition at line 350 of file geometry_unit_test_base.h.

  {
    // update the current geometry, that becomes owner;
    // also update the global one if it happens to be already our previous
    // (in this case, it becomes co-owner)
    SharedGeoPtr_t my_old_geom = geom;
    geom = new_geom;
    // if the global geometry is already the one we register, don't bother
    if (SharedGlobalGeometry() != new_geom)
      GeoResources_t::ReplaceDefaultSharedResource(my_old_geom, new_geom);
  } // GeometryTesterEnvironment<>::RegisterGeometry()

template<typename ConfigurationClass >

virtual void testing::GeometryTesterEnvironment< ConfigurationClass >::RegisterGeometry ( geo::GeometryCore const *  new_geom )

inlineprotectedvirtual

Get ownership of the specified geometry and registers it as global.

Definition at line 265 of file geometry_unit_test_base.h.

References lar::standalone::SetupGeometry().

    {
      RegisterGeometry(SharedGeoPtr_t(new_geom));
    }

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().

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

template<typename ConfigurationClass >

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

protectedvirtual

The complete initialization, ran at construction by default.

Reimplemented from testing::BasicTesterEnvironment< ConfigurationClass >.

Definition at line 377 of file geometry_unit_test_base.h.

References lar::standalone::SetupGeometry().

  {

    //
    // parse configuration, set up message facility
    //
    TesterEnvironment_t::Setup();

    //
    // set up the geometry
    //
    SetupGeometry();

    mf::LogInfo("Test") << config.ApplicationName() << " Geometry setup complete.";

  } // GeometryTesterEnvironment<>::Setup()

template<typename ConfigurationClass >

void testing::GeometryTesterEnvironment< ConfigurationClass >::SetupGeometry ( )

protectedvirtual

Sets up the geometry (creates and registers it)

Definition at line 363 of file geometry_unit_test_base.h.

  {
    //
    // horrible, shameful hack to support the "new" testing environment
    // while the old one, informally deprecated, is still around;
    // we will have TWO versions of GeometryCore around.
    // Ugh.
    //
    RegisterGeometry(CreateNewGeometry()); // old
    // new
    this->template AcquireProvider<geo::GeometryCore>(CreateNewGeometry());
  } // GeometryTesterEnvironment<>::SetupGeometry()

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().

  {
    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.";
      MF_LOG_TRACE("MessageFacility")
        << "MF_LOG_TRACE/MF_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 659 of file unit_test_base.h.

References lar::standalone::SetupMessageFacility().

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

template<typename ConfigurationClass >

template<typename Prov , typename... Args>

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

inlineinherited

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 775 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 )

inlineinherited

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  )

inlineinherited

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 797 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  )

inlineinherited

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 >

SharedGeoPtr_t testing::GeometryTesterEnvironment< ConfigurationClass >::SharedGeometry ( ) const

inline

Returns a pointer to the geometry.

Definition at line 243 of file geometry_unit_test_base.h.

{ return geom; }

template<typename ConfigurationClass >

static SharedGeoPtr_t testing::GeometryTesterEnvironment< ConfigurationClass >::SharedGlobalGeometry ( )

inlinestatic

Returns the current global geometry instance (may be nullptr if none)

Definition at line 251 of file geometry_unit_test_base.h.

{ return GeoResources_t::ShareResource(); }

template<typename ConfigurationClass >

template<typename Prov >

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

inlineinherited

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 907 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 618 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 624 of file unit_test_base.h.

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

Member Data Documentation

template<typename ConfigurationClass >

ConfigurationClass testing::GeometryTesterEnvironment< ConfigurationClass >::config

private

instance of the configurer

Definition at line 275 of file geometry_unit_test_base.h.

template<typename ConfigurationClass >

SharedGeoPtr_t testing::GeometryTesterEnvironment< ConfigurationClass >::geom

private

pointer to the geometry

Definition at line 277 of file geometry_unit_test_base.h.

template<typename ConfigurationClass >

ProviderList testing::TesterEnvironment< ConfigurationClass >::providers

protectedinherited

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:

• larcorealg/v09_13_01/source/larcorealg/TestUtils/geometry_unit_test_base.h