4#include "../application/argumentparser.h"
5#include "../misc/traits.h"
29 operator bool()
const;
32 std::string
testFilePath(
const std::string &relativeTestFilePath)
const;
33 std::string
testDirPath(
const std::string &relativeTestDirPath)
const;
35 std::string
workingCopyPathAs(
const std::string &relativeTestFilePath,
const std::string &relativeWorkingCopyPath,
38 int execApp(
const char *
const *args, std::string &output, std::string &errors,
bool suppressLogging =
false,
int timeout = -1)
const;
42 const std::vector<std::string> &testFilePaths()
const;
43 const std::string &workingDirectory()
const;
44 const char *applicationPath();
45 bool unitsSpecified()
const;
46 const std::vector<const char *> &units()
const;
47 bool onlyListUnits()
const;
51 static const char *appPath();
54 static std::string readTestfilePathFromEnv();
55 static std::vector<std::string> readTestfilePathFromSrcRef();
64 std::vector<std::string> m_testFilesPaths;
65 std::string m_workingDir;
76inline TestApplication::operator bool()
const
86 return TestApplication::s_instance;
102 return m_testFilesPaths;
135 return m_unitsArg.
values();
189inline CPP_UTILITIES_EXPORT int execApp(
const char *
const *args, std::string &output, std::string &errors)
195 const char *appPath,
const char *
const *args, std::string &output, std::string &errors,
bool suppressLogging =
false,
int timeout = -1);
197 const char *appName,
const char *
const *args, std::string &output, std::string &errors,
bool suppressLogging =
false,
int timeout = -1);
203template <
typename Optional, Traits::EnableIf<Traits::IsSpecializationOf<Optional, std::optional>> * =
nullptr>
204inline std::ostream &
operator<<(std::ostream &out,
const Optional &optional)
206 if (optional.has_value()) {
207 return out << *optional;
209 return out <<
"[no value]";
240 return out <<
'0' <<
'x' << std::hex << std::setfill(
'0') << std::setw(2) << unsigned(value.
value) << std::dec;
267template <
typename T, Traits::DisableIf<std::is_
integral<T>> * =
nullptr>
const T &
integralsAsHexNumber(
const T &value)
280#define TESTUTILS_ASSERT_EXEC(args) \
282 const auto returnCode = execApp(args, stdout, stderr); \
283 if (returnCode != 0) { \
284 CPPUNIT_FAIL(::CppUtilities::argsToString("app failed with return code ", returnCode, "\nstdout: ", stdout, "\nstderr: ", stderr)); \
292#define TESTUTILS_ASSERT_LIKE_FLAGS(message, expectedRegex, regexFlags, actualString) \
293 (CPPUNIT_NS::Asserter::failIf(!(std::regex_match(actualString, std::regex(expectedRegex, regexFlags))), \
294 CPPUNIT_NS::Message( \
295 CppUtilities::argsToString('\"', actualString, "\"\n not like\n\"", expectedRegex, '\"'), "Expression: " #actualString, message), \
296 CPPUNIT_SOURCELINE()))
302#define TESTUTILS_ASSERT_LIKE(message, expectedRegex, actualString) \
303 TESTUTILS_ASSERT_LIKE_FLAGS(message, expectedRegex, std::regex::ECMAScript, actualString)
308template <typename Pair, CppUtilities::Traits::EnableIf<CppUtilities::Traits::IsSpecializationOf<Pair, std::pair>> * = nullptr>
309inline std::ostream &operator<<(std::ostream &out, const Pair &pair)
311 return out << "key: " << pair.first << "; value: " << pair.second << '\n';
317template <typename Iteratable, Traits::EnableIf<Traits::IsIteratable<Iteratable>, Traits::Not<Traits::IsString<Iteratable>>> * = nullptr>
318inline std::ostream &operator<<(std::ostream &out, const Iteratable &iteratable)
321 std::size_t index = 0;
322 for (const auto &item : iteratable) {
323 out << std::setw(2) << index << ':' << ' ' << integralsAsHexNumber(item) << '\n';
337constexpr std::size_t operator"" _st(unsigned long long size)
339 return static_cast<std::size_t>(size);
346constexpr std::uint64_t operator"" _uint64(unsigned long long size)
348 return static_cast<std::uint64_t>(size);
355constexpr std::int64_t operator"" _int64(unsigned long long size)
357 return static_cast<std::int64_t>(size);
359} // namespace Literals
360} // namespace CppUtilities
The ArgumentParser class provides a means for handling command line arguments.
const char * firstValue() const
Returns the first parameter value of the first occurrence of the argument.
const std::vector< const char * > & values(std::size_t occurrence=0) const
Returns the parameter values for the specified occurrence of argument.
bool isPresent() const
Returns an indication whether the argument could be detected when parsing.
The AsHexNumber class allows printing values asserted with cppunit (or similar test framework) using ...
AsHexNumber(const T &value)
Constructs a new instance; use asHexNumber() for convenience instead.
The ConfigValueArgument class is an Argument where setCombinable() is true by default.
The OperationArgument class is an Argument where denotesOperation() is true by default.
The TestApplication class simplifies writing test applications that require opening test files.
bool onlyListUnits() const
Returns whether the test application should only list available units and not actually run any tests.
const std::vector< const char * > & units() const
Returns the specified test units.
std::string testFilePath(const std::string &relativeTestFilePath) const
Returns the full path of the test file with the specified relativeTestFilePath.
static const char * appPath()
Returns the application path or an empty string if no application path has been set.
const std::vector< std::string > & testFilePaths() const
Returns the list of directories to look for test files.
bool unitsSpecified() const
Returns whether particular units have been specified.
const char * applicationPath()
Returns the application path or an empty string if no application path has been set.
const std::string & workingDirectory() const
Returns the directory which is supposed to used for storing files created by tests.
static const TestApplication * instance()
Returns the current TestApplication instance.
std::string workingCopyPathAs(const std::string &relativeTestFilePath, const std::string &relativeWorkingCopyPath, WorkingCopyMode mode=WorkingCopyMode::CreateCopy) const
Returns the full path to a working copy of the test file with the specified relativeTestFilePath.
std::string testDirPath(const std::string &relativeTestDirPath) const
Returns the full path of the test directory with the specified relativeTestDirPath.
#define CPP_UTILITIES_EXPORT
Marks the symbol to be exported by the c++utilities library.
Contains all utilities provides by the c++utilities library.
CPP_UTILITIES_EXPORT std::string testFilePath(const std::string &relativeTestFilePath)
Convenience function to invoke TestApplication::testFilePath().
CPP_UTILITIES_EXPORT std::string workingCopyPath(const std::string &relativeTestFilePath, WorkingCopyMode mode=WorkingCopyMode::CreateCopy)
Convenience function to invoke TestApplication::workingCopyPath().
WorkingCopyMode
The WorkingCopyMode enum specifies additional options to influence behavior of TestApplication::worki...
CPP_UTILITIES_EXPORT std::string testDirPath(const std::string &relativeTestDirPath)
Convenience function to invoke TestApplication::testDirPath().
CPP_UTILITIES_EXPORT std::ostream & operator<<(std::ostream &out, Indentation indentation)
bool operator==(const AsHexNumber< T > &lhs, const AsHexNumber< T > &rhs)
Provides operator == required by CPPUNIT_ASSERT_EQUAL.
AsHexNumber< T > asHexNumber(const T &value)
Wraps a value to be printed using the hex system in the error case when asserted with cppunit (or sim...
CPP_UTILITIES_EXPORT std::string workingCopyPathAs(const std::string &relativeTestFilePath, const std::string &relativeWorkingCopyPath, WorkingCopyMode mode=WorkingCopyMode::CreateCopy)
Convenience function to invoke TestApplication::workingCopyPathAs().
AsHexNumber< T > integralsAsHexNumber(const T &value)
Wraps a value to be printed using the hex system in the error case when asserted with cppunit (or sim...