Move NameGenerator to util (#1428)

Fixes for #876
XRPLF · Jun 18, 2024 · 119b1ab · 119b1ab
1 parent 0064490
commit 119b1ab
Show file tree

Hide file tree

Showing 21 changed files with 95 additions and 283 deletions.
diff --git a/tests/common/util/NameGenerator.hpp b/tests/common/util/NameGenerator.hpp
@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of clio: https://github.com/XRPLF/clio
+    Copyright (c) 2024, the clio developers.
+
+    Permission to use, copy, modify, and distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#pragma once
+
+#include <string>
+
+namespace tests::util {
+
+static auto const NameGenerator = [](auto const& info) { return info.param.testName; };
+
+}  // namespace tests::util
diff --git a/tests/unit/rpc/JsonBoolTests.cpp b/tests/unit/rpc/JsonBoolTests.cpp
@@ -17,6 +17,7 @@
 */
 //==============================================================================
 #include "rpc/common/JsonBool.hpp"
+#include "util/NameGenerator.hpp"
 
 #include <boost/json/parse.hpp>
 #include <boost/json/value_to.hpp>
@@ -37,16 +38,6 @@ struct JsonBoolTestsCaseBundle {
 
 class JsonBoolTests : public TestWithParam<JsonBoolTestsCaseBundle> {
 public:
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<JsonBoolTestsCaseBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-
     static auto
     generateTestValuesForParametersTest()
     {
@@ -72,7 +63,7 @@ INSTANTIATE_TEST_CASE_P(
     JsonBoolCheckGroup,
     JsonBoolTests,
     ValuesIn(JsonBoolTests::generateTestValuesForParametersTest()),
-    JsonBoolTests::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(JsonBoolTests, Parse)

diff --git a/tests/unit/rpc/handlers/AMMInfoTests.cpp b/tests/unit/rpc/handlers/AMMInfoTests.cpp
@@ -23,6 +23,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/AMMInfo.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -66,15 +67,7 @@ struct AMMInfoParamTestCaseBundle {
     std::string expectedErrorMessage;
 };
 
-struct AMMInfoParameterTest : public RPCAMMInfoHandlerTest, public WithParamInterface<AMMInfoParamTestCaseBundle> {
-    struct NameGenerator {
-        std::string
-        operator()(auto const& info) const
-        {
-            return static_cast<AMMInfoParamTestCaseBundle>(info.param).testName;
-        }
-    };
-};
+struct AMMInfoParameterTest : public RPCAMMInfoHandlerTest, public WithParamInterface<AMMInfoParamTestCaseBundle> {};
 
 static auto
 generateTestValuesForParametersTest()
@@ -106,7 +99,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAMMInfoGroup1,
     AMMInfoParameterTest,
     ValuesIn(generateTestValuesForParametersTest()),
-    AMMInfoParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AMMInfoParameterTest, InvalidParams)

diff --git a/tests/unit/rpc/handlers/AccountInfoTests.cpp b/tests/unit/rpc/handlers/AccountInfoTests.cpp
@@ -24,6 +24,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/AccountInfo.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -62,17 +63,7 @@ struct AccountInfoParamTestCaseBundle {
 
 // parameterized test cases for parameters check
 struct AccountInfoParameterTest : public RPCAccountInfoHandlerTest,
-                                  public WithParamInterface<AccountInfoParamTestCaseBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<AccountInfoParamTestCaseBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-};
+                                  public WithParamInterface<AccountInfoParamTestCaseBundle> {};
 
 static auto
 generateTestValuesForParametersTest()
@@ -114,7 +105,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAccountInfoGroup1,
     AccountInfoParameterTest,
     ValuesIn(generateTestValuesForParametersTest()),
-    AccountInfoParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AccountInfoParameterTest, InvalidParams)

diff --git a/tests/unit/rpc/handlers/AccountNFTsTests.cpp b/tests/unit/rpc/handlers/AccountNFTsTests.cpp
@@ -23,6 +23,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/AccountNFTs.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -66,17 +67,7 @@ struct AccountNFTParamTestCaseBundle {
 
 // parameterized test cases for parameters check
 struct AccountNFTParameterTest : public RPCAccountNFTsHandlerTest,
-                                 public WithParamInterface<AccountNFTParamTestCaseBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<AccountNFTParamTestCaseBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-};
+                                 public WithParamInterface<AccountNFTParamTestCaseBundle> {};
 
 static auto
 generateTestValuesForParametersTest()
@@ -155,7 +146,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAccountNFTsGroup1,
     AccountNFTParameterTest,
     ValuesIn(generateTestValuesForParametersTest()),
-    AccountNFTParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AccountNFTParameterTest, InvalidParams)

diff --git a/tests/unit/rpc/handlers/AccountObjectsTests.cpp b/tests/unit/rpc/handlers/AccountObjectsTests.cpp
@@ -23,6 +23,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/AccountObjects.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -71,17 +72,7 @@ struct AccountObjectsParamTestCaseBundle {
 
 // parameterized test cases for parameters check
 struct AccountObjectsParameterTest : public RPCAccountObjectsHandlerTest,
-                                     public WithParamInterface<AccountObjectsParamTestCaseBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<AccountObjectsParamTestCaseBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-};
+                                     public WithParamInterface<AccountObjectsParamTestCaseBundle> {};
 
 static auto
 generateTestValuesForParametersTest()
@@ -180,7 +171,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAccountObjectsGroup1,
     AccountObjectsParameterTest,
     ValuesIn(generateTestValuesForParametersTest()),
-    AccountObjectsParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AccountObjectsParameterTest, InvalidParams)

diff --git a/tests/unit/rpc/handlers/AccountOffersTests.cpp b/tests/unit/rpc/handlers/AccountOffersTests.cpp
@@ -23,6 +23,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/AccountOffers.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -62,17 +63,7 @@ struct AccountOfferParamTestCaseBundle {
 
 // parameterized test cases for parameters check
 struct AccountOfferParameterTest : public RPCAccountOffersHandlerTest,
-                                   public WithParamInterface<AccountOfferParamTestCaseBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<AccountOfferParamTestCaseBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-};
+                                   public WithParamInterface<AccountOfferParamTestCaseBundle> {};
 
 static auto
 generateTestValuesForParametersTest()
@@ -151,7 +142,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAccountOffersGroup1,
     AccountOfferParameterTest,
     ValuesIn(generateTestValuesForParametersTest()),
-    AccountOfferParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AccountOfferParameterTest, InvalidParams)

diff --git a/tests/unit/rpc/handlers/AccountTxTests.cpp b/tests/unit/rpc/handlers/AccountTxTests.cpp
@@ -23,6 +23,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/AccountTx.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -63,15 +64,6 @@ struct AccountTxParamTestCaseBundle {
 // parameterized test cases for parameters check
 struct AccountTxParameterTest : public RPCAccountTxHandlerTest,
                                 public WithParamInterface<AccountTxParamTestCaseBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            return info.param.testName;
-        }
-    };
-
     static auto
     generateTestValuesForParametersTest()
     {
@@ -401,7 +393,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAccountTxGroup1,
     AccountTxParameterTest,
     ValuesIn(AccountTxParameterTest::generateTestValuesForParametersTest()),
-    AccountTxParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AccountTxParameterTest, CheckParams)
@@ -1564,17 +1556,7 @@ struct AccountTxTransactionBundle {
 
 // parameterized test cases for parameters check
 struct AccountTxTransactionTypeTest : public RPCAccountTxHandlerTest,
-                                      public WithParamInterface<AccountTxTransactionBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<AccountTxTransactionBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-};
+                                      public WithParamInterface<AccountTxTransactionBundle> {};
 
 static auto
 generateTransactionTypeTestValues()
@@ -2049,7 +2031,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCAccountTxTransactionTypeTest,
     AccountTxTransactionTypeTest,
     ValuesIn(generateTransactionTypeTestValues()),
-    AccountTxTransactionTypeTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(AccountTxTransactionTypeTest, SpecificTransactionType)

diff --git a/tests/unit/rpc/handlers/BookChangesTests.cpp b/tests/unit/rpc/handlers/BookChangesTests.cpp
@@ -23,6 +23,7 @@
 #include "rpc/common/Types.hpp"
 #include "rpc/handlers/BookChanges.hpp"
 #include "util/Fixtures.hpp"
+#include "util/NameGenerator.hpp"
 #include "util/TestObject.hpp"
 
 #include <boost/json/parse.hpp>
@@ -60,17 +61,7 @@ struct BookChangesParamTestCaseBundle {
 
 // parameterized test cases for parameters check
 struct BookChangesParameterTest : public RPCBookChangesHandlerTest,
-                                  public WithParamInterface<BookChangesParamTestCaseBundle> {
-    struct NameGenerator {
-        template <class ParamType>
-        std::string
-        operator()(testing::TestParamInfo<ParamType> const& info) const
-        {
-            auto bundle = static_cast<BookChangesParamTestCaseBundle>(info.param);
-            return bundle.testName;
-        }
-    };
-};
+                                  public WithParamInterface<BookChangesParamTestCaseBundle> {};
 
 static auto
 generateTestValuesForParametersTest()
@@ -92,7 +83,7 @@ INSTANTIATE_TEST_CASE_P(
     RPCBookChangesGroup1,
     BookChangesParameterTest,
     ValuesIn(generateTestValuesForParametersTest()),
-    BookChangesParameterTest::NameGenerator{}
+    tests::util::NameGenerator
 );
 
 TEST_P(BookChangesParameterTest, InvalidParams)