Utopia::TestTools::BaseInfrastructure< RNGType > Struct Template Reference

A base class for an infrastructure fixture. More...

#include <fixtures.hh>

Inheritance diagram for Utopia::TestTools::BaseInfrastructure< RNGType >:

Public Types
using	RNG = RNGType
	The random number generator type to use.
using	Config = DataIO::Config
	Make the config type more easily available.

Public Member Functions
	BaseInfrastructure (const std::string &config_file_path="")
	Construct the BaseInfrastructure fixture.
	~BaseInfrastructure ()
	Destruct the BaseInfrastructure fixture, tearing down the test logger.

Public Attributes
const Config	cfg
	The test configuration.
std::shared_ptr< spdlog::logger >	log
	A logger to use during the test or to pass to entities that need it.
std::shared_ptr< RNG >	rng
	The shared random number generator instance, randomly seeded.

Detailed Description

template<class RNGType = Utopia::DefaultRNG>
struct Utopia::TestTools::BaseInfrastructure< RNGType >

A base class for an infrastructure fixture.

If a YAML configuration file is to be loaded, the fixture needs to be derived from and the path to the YAML file needs to be specified

Member Typedef Documentation

Config

template<class RNGType = Utopia::DefaultRNG>

using Utopia::TestTools::BaseInfrastructure< RNGType >::Config = DataIO::Config

Make the config type more easily available.

RNG

template<class RNGType = Utopia::DefaultRNG>

using Utopia::TestTools::BaseInfrastructure< RNGType >::RNG = RNGType

The random number generator type to use.

Constructor & Destructor Documentation

BaseInfrastructure()

template<class RNGType = Utopia::DefaultRNG>

Utopia::TestTools::BaseInfrastructure< RNGType >::BaseInfrastructure ( const std::string &  config_file_path = "" )

inline

Construct the BaseInfrastructure fixture.

    :
        // Load a configuration file, if a file path was given
        cfg([&config_file_path](){
            if (config_file_path.size()) {
                return YAML::LoadFile(config_file_path);
            }
            return Config{};
        }()),
 
        // Set up a test logger
        log([](){
            auto logger = spdlog::get("test");
 
            // Create it only if it does not already exist
            if (not logger) {
                logger = spdlog::stdout_color_mt("test");
            }
 
            // Set level and global logging pattern
            logger->set_level(spdlog::level::trace);
            spdlog::set_pattern("[%T.%e] [%^%l%$] [%n]  %v");
            // "[HH:MM:SS.mmm] [level(colored)] [logger]  <message>"
 
            return logger;
        }()),
 
        // Set up random number generator (with random seed)
        rng(std::make_shared<RNG>(std::random_device()()))
    {
        log->info("BaseInfrastructure fixture set up.");
        if (config_file_path.size()) {
            log->info("Test configuration loaded from:  {}", config_file_path);
        }
        else {
            log->info("No test configuration file loaded.");
        }
    }

~BaseInfrastructure()

template<class RNGType = Utopia::DefaultRNG>

Utopia::TestTools::BaseInfrastructure< RNGType >::~BaseInfrastructure ( )

inline

Destruct the BaseInfrastructure fixture, tearing down the test logger.

                           {
        spdlog::drop("test");
    }

Member Data Documentation

cfg

template<class RNGType = Utopia::DefaultRNG>

const Config Utopia::TestTools::BaseInfrastructure< RNGType >::cfg

The test configuration.

Note

It will only be loaded if a configuration file path is given during construction of this base class. To specify a file, derive from this fixture and pass the path to the base class constructor.

log

template<class RNGType = Utopia::DefaultRNG>

std::shared_ptr<spdlog::logger> Utopia::TestTools::BaseInfrastructure< RNGType >::log

A logger to use during the test or to pass to entities that need it.

rng

template<class RNGType = Utopia::DefaultRNG>

std::shared_ptr<RNG> Utopia::TestTools::BaseInfrastructure< RNGType >::rng

The shared random number generator instance, randomly seeded.

---

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

• include/utopia/core/testtools/fixtures.hh