a struct holding user configuration for the PHYSLITE tests More...

#include <Configuration.h>

Collaboration diagram for columnar::TestUtils::UserConfiguration:

Public Member Functions
void	loadFromFile (const std::string &filename)
	load configuration overrides from a JSON file

Static Public Member Functions
static UserConfiguration	fromEnvironment ()
	create a UserConfiguration, loading from the file pointed to by the COLUMNAR_TEST_CONFIG environment variable

Public Attributes
std::chrono::seconds	targetTime = std::chrono::seconds(5)
unsigned int	batchSize = 1000
bool	runToolTwice = false
bool	skipShallowCopies = false
bool	measureNonAccessForEmpty = false
	whether to measure non-retrieval for empty containers

Detailed Description

a struct holding user configuration for the PHYSLITE tests

Eventually I can hopefully make this configurable at runtime, but for now this should at least allow me to share the settings between different files, so that they don't need to be all in the same file.

Definition at line 32 of file PhysicsAnalysis/Columnar/ColumnarTestFixtures/ColumnarTestFixtures/Configuration.h.

Member Function Documentation

◆ fromEnvironment()

UserConfiguration columnar::TestUtils::UserConfiguration::fromEnvironment ( )

static

create a UserConfiguration, loading from the file pointed to by the COLUMNAR_TEST_CONFIG environment variable

If the environment variable is not set, returns defaults. If it is set but the file does not exist, throws an error.

Definition at line 40 of file Configuration.cxx.

    {
      UserConfiguration config;
      const char *envPath = std::getenv ("COLUMNAR_TEST_CONFIG");
      if (envPath != nullptr && envPath[0] != '\0')
        config.loadFromFile (envPath);
      return config;
    }

◆ loadFromFile()

void columnar::TestUtils::UserConfiguration::loadFromFile ( const std::string & filename )

load configuration overrides from a JSON file

Only fields present in the JSON are overridden; others keep their defaults.

Definition at line 19 of file Configuration.cxx.

    {
      std::ifstream file (filename);
      if (!file.is_open())
        throw std::runtime_error ("failed to open configuration file: " + filename);
 
      auto json = nlohmann::json::parse (file);
 
      if (json.contains ("targetTime"))
        targetTime = std::chrono::seconds (json["targetTime"].get<int>());
      if (json.contains ("batchSize"))
        batchSize = json["batchSize"].get<unsigned int>();
      if (json.contains ("runToolTwice"))
        runToolTwice = json["runToolTwice"].get<bool>();
      if (json.contains ("skipShallowCopies"))
        skipShallowCopies = json["skipShallowCopies"].get<bool>();
      if (json.contains ("measureNonAccessForEmpty"))
        measureNonAccessForEmpty = json["measureNonAccessForEmpty"].get<bool>();
    }