mirror of
https://github.com/NixOS/nix
synced 2025-06-29 02:11:15 +02:00
91b6833686
Today, with the tests inside a `tests` intermingled with the
corresponding library's source code, we have a few problems:
- We have to be careful that wildcards don't end up with tests being
built as part of Nix proper, or test headers being installed as part
of Nix proper.
- Tests in libraries but not executables is not right:
- It means each executable runs the previous unit tests again, because
it needs the libraries.
- It doesn't work right on Windows, which doesn't want you to load a
DLL just for the side global variable . It could be made to work
with the dlopen equivalent, but that's gross!
This reorg solves these problems.
There is a remaining problem which is that sibbling headers (like
`hash.hh` the test header vs `hash.hh` the main `libnixutil` header) end
up shadowing each other. This PR doesn't solve that. That is left as
future work for a future PR.
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
108 lines
2.4 KiB
C++
108 lines
2.4 KiB
C++
#pragma once
|
|
///@file
|
|
|
|
#include <gtest/gtest.h>
|
|
|
|
#include "types.hh"
|
|
#include "environment-variables.hh"
|
|
|
|
namespace nix {
|
|
|
|
/**
|
|
* The path to the unit test data directory. See the contributing guide
|
|
* in the manual for further details.
|
|
*/
|
|
static Path getUnitTestData() {
|
|
return getEnv("_NIX_TEST_UNIT_DATA").value();
|
|
}
|
|
|
|
/**
|
|
* Whether we should update "golden masters" instead of running tests
|
|
* against them. See the contributing guide in the manual for further
|
|
* details.
|
|
*/
|
|
static bool testAccept() {
|
|
return getEnv("_NIX_TEST_ACCEPT") == "1";
|
|
}
|
|
|
|
/**
|
|
* Mixin class for writing characterization tests
|
|
*/
|
|
class CharacterizationTest : public virtual ::testing::Test
|
|
{
|
|
protected:
|
|
/**
|
|
* While the "golden master" for this characterization test is
|
|
* located. It should not be shared with any other test.
|
|
*/
|
|
virtual Path goldenMaster(PathView testStem) const = 0;
|
|
|
|
public:
|
|
/**
|
|
* Golden test for reading
|
|
*
|
|
* @param test hook that takes the contents of the file and does the
|
|
* actual work
|
|
*/
|
|
void readTest(PathView testStem, auto && test)
|
|
{
|
|
auto file = goldenMaster(testStem);
|
|
|
|
if (testAccept())
|
|
{
|
|
GTEST_SKIP()
|
|
<< "Cannot read golden master "
|
|
<< file
|
|
<< "because another test is also updating it";
|
|
}
|
|
else
|
|
{
|
|
test(readFile(file));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Golden test for writing
|
|
*
|
|
* @param test hook that produces contents of the file and does the
|
|
* actual work
|
|
*/
|
|
void writeTest(
|
|
PathView testStem, auto && test, auto && readFile2, auto && writeFile2)
|
|
{
|
|
auto file = goldenMaster(testStem);
|
|
|
|
auto got = test();
|
|
|
|
if (testAccept())
|
|
{
|
|
createDirs(dirOf(file));
|
|
writeFile2(file, got);
|
|
GTEST_SKIP()
|
|
<< "Updating golden master "
|
|
<< file;
|
|
}
|
|
else
|
|
{
|
|
decltype(got) expected = readFile2(file);
|
|
ASSERT_EQ(got, expected);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Specialize to `std::string`
|
|
*/
|
|
void writeTest(PathView testStem, auto && test)
|
|
{
|
|
writeTest(
|
|
testStem, test,
|
|
[](const Path & f) -> std::string {
|
|
return readFile(f);
|
|
},
|
|
[](const Path & f, const std::string & c) {
|
|
return writeFile(f, c);
|
|
});
|
|
}
|
|
};
|
|
|
|
}
|