catch3
Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.
Clonegit clone https://git.progmasoft.com/catch3
Refactor custom precision in floating point stringification
- Commit
1161011dd0c8b08ef26aabf99f1e28ab9604108a- Author
- Martin Hořeňovský ·
- Parents
53a83e855ec5
Changes
include/internal/catch_tostring.cpp | 24 ++-------- include/internal/catch_tostring.h | 10 +--- .../SelfTest/Baselines/compact.sw.approved.txt | 4 ++ .../SelfTest/Baselines/console.std.approved.txt | 4 +- .../SelfTest/Baselines/console.sw.approved.txt | 38 ++++++++++++++- projects/SelfTest/Baselines/junit.sw.approved.txt | 4 +- projects/SelfTest/Baselines/xml.sw.approved.txt | 45 +++++++++++++++++- .../SelfTest/UsageTests/ToStringGeneral.tests.cpp | 55 +++++++++++++--------- 8 files changed, 127 insertions(+), 57 deletions(-) diff --git a/include/internal/catch_tostring.cpp b/include/internal/catch_tostring.cpp index 33d442d6..f59676e7 100644 --- a/include/internal/catch_tostring.cpp +++ b/include/internal/catch_tostring.cpp @@ -234,32 +234,16 @@ std::string StringMaker<std::nullptr_t>::convert(std::nullptr_t) { return "nullptr"; } -int StringMaker<float>::m_precision = 5; +int StringMaker<float>::precision = 5; std::string StringMaker<float>::convert(float value) { - return fpToString(value, m_precision) + 'f'; + return fpToString(value, precision) + 'f'; } -void StringMaker<float>::setPrecision(int precision) { - m_precision = precision; -} - -int StringMaker<float>::getPrecision() { - return m_precision; -} - -int StringMaker<double>::m_precision = 10; +int StringMaker<double>::precision = 10; std::string StringMaker<double>::convert(double value) { - return fpToString(value, m_precision); -} - -void StringMaker<double>::setPrecision(int precision) { - m_precision = precision; -} - -int StringMaker<double>::getPrecision() { - return m_precision; + return fpToString(value, precision); } std::string ratio_string<std::atto>::symbol() { return "a"; } diff --git a/include/internal/catch_tostring.h b/include/internal/catch_tostring.h index 89d0d633..cb248ea9 100644 --- a/include/internal/catch_tostring.h +++ b/include/internal/catch_tostring.h @@ -261,19 +261,13 @@ namespace Catch { template<> struct StringMaker<float> { static std::string convert(float value); - static void setPrecision(int precision); - static int getPrecision(); - private: - static int m_precision; + static int precision; }; template<> struct StringMaker<double> { static std::string convert(double value); - static void setPrecision(int precision); - static int getPrecision(); - private: - static int m_precision; + static int precision; }; template <typename T> diff --git a/projects/SelfTest/Baselines/compact.sw.approved.txt b/projects/SelfTest/Baselines/compact.sw.approved.txt index 259954e4..8447e839 100644 --- a/projects/SelfTest/Baselines/compact.sw.approved.txt +++ b/projects/SelfTest/Baselines/compact.sw.approved.txt @@ -859,6 +859,10 @@ Condition.tests.cpp:<line number>: passed: cpc != 0 for: 0x<hex digits> != 0 Condition.tests.cpp:<line number>: passed: returnsNull() == 0 for: {null string} == 0 Condition.tests.cpp:<line number>: passed: returnsConstNull() == 0 for: {null string} == 0 Condition.tests.cpp:<line number>: passed: 0 != p for: 0 != 0x<hex digits> +ToStringGeneral.tests.cpp:<line number>: passed: str1.size() == 3 + 5 for: 8 == 8 +ToStringGeneral.tests.cpp:<line number>: passed: str2.size() == 3 + 10 for: 13 == 13 +ToStringGeneral.tests.cpp:<line number>: passed: str1.size() == 2 + 5 for: 7 == 7 +ToStringGeneral.tests.cpp:<line number>: passed: str2.size() == 2 + 15 for: 17 == 17 Matchers.tests.cpp:<line number>: passed: "foo", Predicate<const char*>([] (const char* const&) { return true; }) for: "foo" matches undescribed predicate CmdLine.tests.cpp:<line number>: passed: result for: {?} CmdLine.tests.cpp:<line number>: passed: config.processName == "" for: "" == "" diff --git a/projects/SelfTest/Baselines/console.std.approved.txt b/projects/SelfTest/Baselines/console.std.approved.txt index 0a4de923..aa991bd4 100644 --- a/projects/SelfTest/Baselines/console.std.approved.txt +++ b/projects/SelfTest/Baselines/console.std.approved.txt @@ -1299,6 +1299,6 @@ due to unexpected exception with message: Why would you throw a std::string? =============================================================================== -test cases: 266 | 199 passed | 63 failed | 4 failed as expected -assertions: 1449 | 1304 passed | 124 failed | 21 failed as expected +test cases: 267 | 200 passed | 63 failed | 4 failed as expected +assertions: 1453 | 1308 passed | 124 failed | 21 failed as expected diff --git a/projects/SelfTest/Baselines/console.sw.approved.txt b/projects/SelfTest/Baselines/console.sw.approved.txt index 2b998afc..e13a6c23 100644 --- a/projects/SelfTest/Baselines/console.sw.approved.txt +++ b/projects/SelfTest/Baselines/console.sw.approved.txt @@ -6192,6 +6192,40 @@ Condition.tests.cpp:<line number>: PASSED: with expansion: 0 != 0x<hex digits> +------------------------------------------------------------------------------- +Precision of floating point stringification can be set + Floats +------------------------------------------------------------------------------- +ToStringGeneral.tests.cpp:<line number> +............................................................................... + +ToStringGeneral.tests.cpp:<line number>: PASSED: + CHECK( str1.size() == 3 + 5 ) +with expansion: + 8 == 8 + +ToStringGeneral.tests.cpp:<line number>: PASSED: + REQUIRE( str2.size() == 3 + 10 ) +with expansion: + 13 == 13 + +------------------------------------------------------------------------------- +Precision of floating point stringification can be set + Double +------------------------------------------------------------------------------- +ToStringGeneral.tests.cpp:<line number> +............................................................................... + +ToStringGeneral.tests.cpp:<line number>: PASSED: + CHECK( str1.size() == 2 + 5 ) +with expansion: + 7 == 7 + +ToStringGeneral.tests.cpp:<line number>: PASSED: + REQUIRE( str2.size() == 2 + 15 ) +with expansion: + 17 == 17 + ------------------------------------------------------------------------------- Predicate matcher can accept const char* ------------------------------------------------------------------------------- @@ -11389,6 +11423,6 @@ Misc.tests.cpp:<line number> Misc.tests.cpp:<line number>: PASSED: =============================================================================== -test cases: 266 | 183 passed | 79 failed | 4 failed as expected -assertions: 1466 | 1304 passed | 141 failed | 21 failed as expected +test cases: 267 | 184 passed | 79 failed | 4 failed as expected +assertions: 1470 | 1308 passed | 141 failed | 21 failed as expected diff --git a/projects/SelfTest/Baselines/junit.sw.approved.txt b/projects/SelfTest/Baselines/junit.sw.approved.txt index 7f4b43db..a7b77533 100644 --- a/projects/SelfTest/Baselines/junit.sw.approved.txt +++ b/projects/SelfTest/Baselines/junit.sw.approved.txt @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <testsuitesloose text artifact > - <testsuite name="<exe-name>" errors="17" failures="125" tests="1467" hostname="tbd" time="{duration}" timestamp="{iso8601-timestamp}"> + <testsuite name="<exe-name>" errors="17" failures="125" tests="1471" hostname="tbd" time="{duration}" timestamp="{iso8601-timestamp}"> <properties> <property name="filters" value="~[!nonportable]~[!benchmark]~[approvals]"/> <property name="random-seed" value="1"/> @@ -574,6 +574,8 @@ Message.tests.cpp:<line number> <testcase classname="<exe-name>.global" name="Parse test names and tags/empty quoted name" time="{duration}"/> <testcase classname="<exe-name>.global" name="Parse test names and tags/quoted string followed by tag exclusion" time="{duration}"/> <testcase classname="<exe-name>.global" name="Pointers can be compared to null" time="{duration}"/> + <testcase classname="<exe-name>.global" name="Precision of floating point stringification can be set/Floats" time="{duration}"/> + <testcase classname="<exe-name>.global" name="Precision of floating point stringification can be set/Double" time="{duration}"/> <testcase classname="<exe-name>.global" name="Predicate matcher can accept const char*" time="{duration}"/> <testcase classname="<exe-name>.global" name="Process can be configured on command line/empty args don't cause a crash" time="{duration}"/> <testcase classname="<exe-name>.global" name="Process can be configured on command line/default - no arguments" time="{duration}"/> diff --git a/projects/SelfTest/Baselines/xml.sw.approved.txt b/projects/SelfTest/Baselines/xml.sw.approved.txt index fa078ac8..fcd6ff13 100644 --- a/projects/SelfTest/Baselines/xml.sw.approved.txt +++ b/projects/SelfTest/Baselines/xml.sw.approved.txt @@ -7778,6 +7778,47 @@ Nor would this </Expression> <OverallResult success="true"/> </TestCase> + <TestCase name="Precision of floating point stringification can be set" tags="[floatingPoint][toString]" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Section name="Floats" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Expression success="true" type="CHECK" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Original> + str1.size() == 3 + 5 + </Original> + <Expanded> + 8 == 8 + </Expanded> + </Expression> + <Expression success="true" type="REQUIRE" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Original> + str2.size() == 3 + 10 + </Original> + <Expanded> + 13 == 13 + </Expanded> + </Expression> + <OverallResults successes="2" failures="0" expectedFailures="0"/> + </Section> + <Section name="Double" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Expression success="true" type="CHECK" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Original> + str1.size() == 2 + 5 + </Original> + <Expanded> + 7 == 7 + </Expanded> + </Expression> + <Expression success="true" type="REQUIRE" filename="projects/<exe-name>/UsageTests/ToStringGeneral.tests.cpp" > + <Original> + str2.size() == 2 + 15 + </Original> + <Expanded> + 17 == 17 + </Expanded> + </Expression> + <OverallResults successes="2" failures="0" expectedFailures="0"/> + </Section> + <OverallResult success="true"/> + </TestCase> <TestCase name="Predicate matcher can accept const char*" tags="[compilation][matchers]" filename="projects/<exe-name>/UsageTests/Matchers.tests.cpp" > <Expression success="true" type="REQUIRE_THAT" filename="projects/<exe-name>/UsageTests/Matchers.tests.cpp" > <Original> @@ -13728,7 +13769,7 @@ loose text artifact </Section> <OverallResult success="true"/> </TestCase> - <OverallResults successes="1304" failures="142" expectedFailures="21"/> + <OverallResults successes="1308" failures="142" expectedFailures="21"/> </Group> - <OverallResults successes="1304" failures="141" expectedFailures="21"/> + <OverallResults successes="1308" failures="141" expectedFailures="21"/> </Catch> diff --git a/projects/SelfTest/UsageTests/ToStringGeneral.tests.cpp b/projects/SelfTest/UsageTests/ToStringGeneral.tests.cpp index bbcc9a66..69d6320d 100644 --- a/projects/SelfTest/UsageTests/ToStringGeneral.tests.cpp +++ b/projects/SelfTest/UsageTests/ToStringGeneral.tests.cpp @@ -128,28 +128,39 @@ TEST_CASE("String views are stringified like other strings", "[toString][approva #endif -//TEMPLATE_TEST_CASE("Floating-point precision can be set", "[toString][floatingPoint]", float, double) -//{ -// const auto oldPrecision = Catch::StringMaker<TestType>::getPrecision(); -// const auto precision = GENERATE(-1, 0, 3, std::numeric_limits<TestType>::max_digits10); -// const auto expectedLength = unsigned(precision < 0 ? 3 : precision); -// -// CAPTURE( precision ); -// -// if (precision >= 0) -// { -// Catch::StringMaker<TestType>::setPrecision(precision); -// } -// -// // Expected to fail to demonstrate the problem -// const auto str = Catch::StringMaker<TestType>::convert(std::numeric_limits<TestType>::epsilon()); -// CHECK(str.length() >= expectedLength); -// -// if (precision >= 0) -// { -// Catch::StringMaker<TestType>::setPrecision(oldPrecision); -// } -//} +TEST_CASE("Precision of floating point stringification can be set", "[toString][floatingPoint]") { + SECTION("Floats") { + using sm = Catch::StringMaker<float>; + const auto oldPrecision = sm::precision; + + const float testFloat = 1.12345678901234567899f; + auto str1 = sm::convert(testFloat); + sm::precision = 5; + // "1." prefix = 2 chars, f suffix is another char + CHECK(str1.size() == 3 + 5); + + sm::precision = 10; + auto str2 = sm::convert(testFloat); + REQUIRE(str2.size() == 3 + 10); + sm::precision = oldPrecision; + } + SECTION("Double") { + using sm = Catch::StringMaker<double>; + const auto oldPrecision = sm::precision; + + const double testDouble = 1.123456789012345678901234567899; + sm::precision = 5; + auto str1 = sm::convert(testDouble); + // "1." prefix = 2 chars + CHECK(str1.size() == 2 + 5); + + sm::precision = 15; + auto str2 = sm::convert(testDouble); + REQUIRE(str2.size() == 2 + 15); + + sm::precision = oldPrecision; + } +} namespace {