test_environment.h

// -*-c++-*-
#ifndef STORMM_TEST_ENVIRONMENT_H
#define STORMM_TEST_ENVIRONMENT_H
 
#include <string>
#include <vector>
#include "copyright.h"
#include "Constants/behavior.h"
#include "Namelists/command_line_parser.h"
#include "unit_test_enumerators.h"
 
namespace stormm {
namespace testing {
 
using constants::ExceptionResponse;
using namelist::CommandLineParser;
  
class TestEnvironment {
public:

  TestEnvironment(int argc, const char* argv[], CommandLineParser *clip,
                  TmpdirStatus tmpdir_required = TmpdirStatus::NOT_REQUIRED,
                  ExceptionResponse policy = ExceptionResponse::WARN);
 
  TestEnvironment(int argc, const char* argv[],
                  TmpdirStatus tmpdir_required = TmpdirStatus::NOT_REQUIRED,
                  ExceptionResponse policy = ExceptionResponse::WARN);
 
  TestEnvironment(int argc, const char* argv[], ExceptionResponse policy);

  ~TestEnvironment();

  TestVerbosity getVerbosity() const;

  double getTolerance() const;

  int getRandomSeed() const;

  std::string getStormmHomePath() const;

  std::string getStormmSourcePath() const;

  std::string getTemporaryDirectoryPath() const;

  bool getTemporaryDirectoryAccess() const;

  bool doIntensiveTests() const;

  std::vector<std::string> getListOfFilesCreated() const;

  SnapshotOperation takeSnapshot() const;

  bool getDisplayTimingsOrder() const;

  void setFileRemoval(const bool remove_files_in);
  
  void logFileCreated(const std::string &path);

  void logDirectoryCreated(const std::string &path);
  void logDirectoryCreated(const std::vector<std::string> &paths);
 
private:

  CommandLineParser user_mods;
  
  TestVerbosity verbose_level;

  double general_tolerance;

  int random_seed;

  std::string stormm_home_path;

  std::string stormm_source_path;

  std::string tmpdir_path;

  bool tmpdir_created;

  bool tmpdir_writeable;

  std::vector<std::string> files_created;

  std::vector<std::string> directories_created;

  bool remove_files;

  bool do_intensive_tests;
  
  SnapshotOperation snapshot_behavior;

  bool display_time;
};
 
} // namespace testing
} // namespace stormm
 
#endif