Moose::UnitUtils::ScopedTestDirectory Class Reference

Run a unit test from a unique temporary working directory. More...

#include <MooseUnitUtils.h>

Public Member Functions
	ScopedTestDirectory (const std::vector< std::filesystem::path > &inputs)
	~ScopedTestDirectory ()
	ScopedTestDirectory (const ScopedTestDirectory &)=delete
ScopedTestDirectory &	operator= (const ScopedTestDirectory &)=delete
const std::filesystem::path &	path () const

Static Private Member Functions
static std::filesystem::path	createPath ()

Private Attributes
const std::filesystem::path	_original_path
	Working directory to restore upon destruction.
const std::filesystem::path	_path
	Unique temporary working directory.

Detailed Description

Run a unit test from a unique temporary working directory.

The provided inputs are copied into the temporary directory using their file names. The original working directory is restored and the temporary directory is removed upon destruction.

Definition at line 140 of file MooseUnitUtils.h.

Constructor & Destructor Documentation

ScopedTestDirectory() [1/2]

Moose::UnitUtils::ScopedTestDirectory::ScopedTestDirectory ( const std::vector< std::filesystem::path > &  inputs )

explicit

Definition at line 42 of file MooseUnitUtils.C.

  : _original_path(std::filesystem::current_path()), _path(createPath())
{
  try
  {
    for (const auto & input : inputs)
      std::filesystem::copy(
          input, _path / input.filename(), std::filesystem::copy_options::recursive);
    std::filesystem::current_path(_path);
  }
  catch (...)
  {
    std::error_code ec;
    std::filesystem::remove_all(_path, ec);
    throw;
  }
}

~ScopedTestDirectory()

Moose::UnitUtils::ScopedTestDirectory::~ScopedTestDirectory

(

)

Definition at line 60 of file MooseUnitUtils.C.

{
  std::error_code ec;
  std::filesystem::current_path(_original_path, ec);
  if (!ec)
    std::filesystem::remove_all(_path, ec);
}

ScopedTestDirectory() [2/2]

Moose::UnitUtils::ScopedTestDirectory::ScopedTestDirectory ( const ScopedTestDirectory &  )

delete

Member Function Documentation

createPath()

std::filesystem::path Moose::UnitUtils::ScopedTestDirectory::createPath ( )

staticprivate

Definition at line 69 of file MooseUnitUtils.C.

{
  while (true)
  {
    const auto path = generatePath();
    if (std::filesystem::create_directory(path))
      return path;
  }
}

operator=()

ScopedTestDirectory & Moose::UnitUtils::ScopedTestDirectory::operator= ( const ScopedTestDirectory &  )

delete

path()

const std::filesystem::path & Moose::UnitUtils::ScopedTestDirectory::path ( ) const

inline

Returns

The path to the temporary working directory.

Definition at line 152 of file MooseUnitUtils.h.

{ return _path; }

Referenced by createPath().

Member Data Documentation

_original_path

const std::filesystem::path Moose::UnitUtils::ScopedTestDirectory::_original_path

private

Working directory to restore upon destruction.

Definition at line 158 of file MooseUnitUtils.h.

Referenced by ~ScopedTestDirectory().

_path

const std::filesystem::path Moose::UnitUtils::ScopedTestDirectory::_path

private

Unique temporary working directory.

Definition at line 160 of file MooseUnitUtils.h.

Referenced by path(), ScopedTestDirectory(), and ~ScopedTestDirectory().

---

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

• include/utils/MooseUnitUtils.h
• src/utils/MooseUnitUtils.C