Skip to content

Testing interface improvements #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Przemog1 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Testing interface improvements #269

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e944a24
Added option to use custom seed
Przemog1 Apr 16, 2026
a811c16
Added documentation for ITester.h
Przemog1 Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 60 additions & 31 deletions common/include/nbl/examples/Tester/ITester.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,40 +174,29 @@ class ITester
m_queue = m_device->getQueue(m_queueFamily, 0);
}

/**
* @brief Runs tests and verifies their results using a randomly generated seed for test value generation.
*
* @param logFileName Name of the file where test logs will be saved.
* @return true if all tests pass and results are valid, false otherwise.
*/
bool performTestsAndVerifyResults(const std::string& logFileName)
{
m_logFile.open(logFileName, std::ios::out | std::ios::trunc);
if (!m_logFile.is_open())
m_logger->log("Failed to open log file!", system::ILogger::ELL_ERROR);

core::vector<InputTestValues> inputTestValues;
core::vector<TestResults> exceptedTestResults;

inputTestValues.reserve(m_testIterationCount);
exceptedTestResults.reserve(m_testIterationCount);

m_logger->log("TESTS:", system::ILogger::ELL_PERFORMANCE);
for (int i = 0; i < m_testIterationCount; ++i)
{
// Set input thest values that will be used in both CPU and GPU tests
InputTestValues testInput = generateInputTestValues();
// use std library or glm functions to determine expected test values, the output of functions from intrinsics.hlsl will be verified against these values
TestResults expected = determineExpectedResults(testInput);

inputTestValues.push_back(testInput);
exceptedTestResults.push_back(expected);
}

core::vector<TestResults> cpuTestResults = performCpuTests(inputTestValues);
core::vector<TestResults> gpuTestResults = performGpuTests(inputTestValues);

bool pass = verifyAllTestResults(cpuTestResults, gpuTestResults, exceptedTestResults);

m_logger->log("TESTS DONE.", system::ILogger::ELL_PERFORMANCE);
reloadSeed();
return performTestsAndVerifyResults_impl(logFileName);
}

m_logFile.close();
return pass;
/**
* @brief Runs tests and verifies their results using a user-provided seed for test value generation.
*
* @param logFileName Name of the file where test logs will be saved.
* @param seed Custom seed used for generating test values, ensures deterministic and reproducible results
* @return true if all tests pass and results are valid, false otherwise.
*/
bool performTestsAndVerifyResults(const std::string& logFileName, const uint32_t seed)
{
reloadSeed(seed);
return performTestsAndVerifyResults_impl(logFileName);
}

virtual ~ITester()
Expand All @@ -228,7 +217,6 @@ class ITester
ITester(const uint32_t testBatchCount)
: m_testBatchCount(testBatchCount), m_testIterationCount(testBatchCount * m_WorkgroupSize)
{
reloadSeed();
};

virtual bool verifyTestResults(const TestResults& expectedTestValues, const TestResults& testValues, const size_t testIteration, const uint32_t seed, TestType testType) = 0;
Expand Down Expand Up @@ -355,6 +343,41 @@ class ITester
exit(-1);
}

bool performTestsAndVerifyResults_impl(const std::string& logFileName)
{
m_logFile.open(logFileName, std::ios::out | std::ios::trunc);
if (!m_logFile.is_open())
m_logger->log("Failed to open log file!", system::ILogger::ELL_ERROR);

core::vector<InputTestValues> inputTestValues;
core::vector<TestResults> exceptedTestResults;

inputTestValues.reserve(m_testIterationCount);
exceptedTestResults.reserve(m_testIterationCount);

m_logger->log("TESTS:", system::ILogger::ELL_PERFORMANCE);
for (int i = 0; i < m_testIterationCount; ++i)
{
// Set input thest values that will be used in both CPU and GPU tests
InputTestValues testInput = generateInputTestValues();
// use std library or glm functions to determine expected test values, the output of functions from intrinsics.hlsl will be verified against these values
TestResults expected = determineExpectedResults(testInput);

inputTestValues.push_back(testInput);
exceptedTestResults.push_back(expected);
}

core::vector<TestResults> cpuTestResults = performCpuTests(inputTestValues);
core::vector<TestResults> gpuTestResults = performGpuTests(inputTestValues);

bool pass = verifyAllTestResults(cpuTestResults, gpuTestResults, exceptedTestResults);

m_logger->log("TESTS DONE.", system::ILogger::ELL_PERFORMANCE);

m_logFile.close();
return pass;
}

core::vector<TestResults> performCpuTests(const core::vector<InputTestValues>& inputTestValues)
{
core::vector<TestResults> output(m_testIterationCount);
Expand Down Expand Up @@ -404,6 +427,12 @@ class ITester
m_mersenneTwister = std::mt19937(m_seed);
}

void reloadSeed(uint32_t seed)
{
m_seed = seed;
m_mersenneTwister = std::mt19937(seed);
}

template<typename T>
bool compareTestValues(const T& lhs, const T& rhs, const float64_t maxAllowedDifference)
{
Expand Down