Make cpp-boost-beast work after bitrot.

cwilson1776 · cwilson1776 · commit 7ffcfb1246d2 · 2025-03-25T20:37:52.000-04:00
* Fixed names of the approval files for ApiTests.
* Silence warnings due to boost/property_tree/json_parser.hpp
* ApprovalTests only works when not using header-only boost::test
* More clean shutdown of imposter when test(s) fail
* Update petstore-config.yaml test config to add explicit values
  for all tested enpoints, rather than relying on imposter-provided
  default values. As of v4.5.2, imposter's defaults have changed.
* Fixed CppBoostBeastClientCodegen compilation error triggered by
  refactoring of getAdditionalProperties(Schema) -&gt; ModelUtils.
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppBoostBeastClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CppBoostBeastClientCodegen.java
@@ -294,7 +294,7 @@ public String getTypeDeclaration(Schema p) {
             Schema inner = ap.getItems();
             return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
         } else if (ModelUtils.isMapSchema(p)) {
-            Schema inner = getAdditionalProperties(p);
+            Schema inner = ModelUtils.getAdditionalProperties(p);
             return getSchemaType(p) + "<std::string, " + getTypeDeclaration(inner) + ">";
         } else if (ModelUtils.isByteArraySchema(p)) {
             return "std::string";
@@ -369,7 +369,7 @@ public String toDefaultValue(Schema p) {
                 return "\"\"";
             }
         } else if (ModelUtils.isMapSchema(p)) {
-            String inner = getSchemaType(getAdditionalProperties(p));
+            String inner = getSchemaType(ModelUtils.getAdditionalProperties(p));
             return "std::map<std::string, " + inner + ">()";
         } else if (ModelUtils.isArraySchema(p)) {
             ArraySchema ap = (ArraySchema) p;
diff --git a/modules/openapi-generator/src/main/resources/cpp-boost-beast-client/CMakeLists.txt.mustache b/modules/openapi-generator/src/main/resources/cpp-boost-beast-client/CMakeLists.txt.mustache
@@ -42,5 +42,7 @@ target_link_libraries(${LIBRARY_NAME} PUBLIC boost_system ssl crypto)
 
 target_include_directories(${LIBRARY_NAME} PUBLIC model api ${CMAKE_CURRENT_LIST_DIR})
 
+# silence warnings from boost/property_tree/json_parser.hpp
+target_compile_definitions(${LIBRARY_NAME} PRIVATE BOOST_BIND_GLOBAL_PLACEHOLDERS)
 
 install(TARGETS ${LIBRARY_NAME} RUNTIME DESTINATION bin LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)
diff --git a/samples/client/petstore/cpp-boost-beast/CMakeLists.txt b/samples/client/petstore/cpp-boost-beast/CMakeLists.txt
@@ -6,8 +6,12 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
-find_package(Boost 1.66.0 REQUIRED)
+find_package(Boost 1.66 REQUIRED COMPONENTS unit_test_framework)
+if (NOT Boost_FOUND)
+    message(FATAL_ERROR "Cannot find Boost libraries")
+endif ()
 
+include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
 
 # Coverage
 if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
diff --git a/samples/client/petstore/cpp-boost-beast/generated/CMakeLists.txt b/samples/client/petstore/cpp-boost-beast/generated/CMakeLists.txt
@@ -39,5 +39,7 @@ target_link_libraries(${LIBRARY_NAME} PUBLIC boost_system ssl crypto)
 
 target_include_directories(${LIBRARY_NAME} PUBLIC model api ${CMAKE_CURRENT_LIST_DIR})
 
+# silence warnings from boost/property_tree/json_parser.hpp
+target_compile_definitions(${LIBRARY_NAME} PRIVATE BOOST_BIND_GLOBAL_PLACEHOLDERS)
 
 install(TARGETS ${LIBRARY_NAME} RUNTIME DESTINATION bin LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/CMakeLists.txt b/samples/client/petstore/cpp-boost-beast/tests/api/CMakeLists.txt
@@ -21,8 +21,11 @@ target_link_libraries(api_tests
             client
             ${Boost_LIBRARIES})
 
+target_compile_definitions(api_tests
+        PUBLIC
+            BOOST_TEST_DYN_LINK)
 
 add_test(NAME api_tests
         COMMAND_EXPAND_LISTS
         COMMAND
-            ${CMAKE_CURRENT_LIST_DIR}/run_imposter_for_tests.sh ${CMAKE_CURRENT_BINARY_DIR}/api_tests)
+            ${CMAKE_CURRENT_LIST_DIR}/run_imposter_for_tests.sh ${CMAKE_CURRENT_BINARY_DIR}/api_tests)
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/.gitignore b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/.gitignore
@@ -0,0 +1 @@
+*.received.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.findPetsByStatus.approved.txt b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.findPetsByStatus.approved.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.findPetsByStatus_list.approved.txt b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.findPetsByStatus_list.approved.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.findPetsByTags.approved.txt b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.findPetsByTags.approved.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.getPetById_success.approved.txt b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.getPetById_success.approved.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.updatePet_success.approved.txt b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.updatePet_success.approved.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.uploadFile.approved.txt b/samples/client/petstore/cpp-boost-beast/tests/api/approval_files/pet_api_test.ApiTests.PetApiTest.uploadFile.approved.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/imposter_config/petstore-config.yaml b/samples/client/petstore/cpp-boost-beast/tests/api/imposter_config/petstore-config.yaml
@@ -6,6 +6,13 @@ security:
   default: Permit
 
 resources:
+  - path: "/v2/pet/0"
+    method: GET
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: '{ "id": "0", "name": "doggie", "category":[{"id":0, "name":""}], "photoUrls":[""], "tags":[{"id":0, "name":""}], "status": "available" }'
   - path: "/v2/pet/1"
     method: GET
     response:
@@ -61,6 +68,13 @@ resources:
     method: DELETE
     response:
       statusCode: 200
+  - path: "/v2/pet/1/uploadImage"
+    method: POST
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: '{ "code": 0, "type": "", "message": "" }'
   - path: "/v2/pet/findByStatus"
     method: GET
     queryParams:
@@ -84,6 +98,50 @@ resources:
         [{ "id": 1, "name": "cat", "status": "available", "photoUrls":[""] },
          { "id": 2, "name": "dog", "status": "available", "photoUrls":[""] },
          { "id": 3, "name": "mouse", "status": "sold", "photoUrls":[""] }]
+  - path: "/v2/pet/findByTags"
+    method: GET
+    queryParams:
+      tags: "tag_a,tag_b"
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: |
+        [{"id":"0","category":{"id":"0","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"0","name":""}],"status":"available"}]
+  - path: "/v2/pet"
+    method: POST
+    requestHeaders:
+      Accept: "application/json"
+    requestBody:
+      value: |
+        {"id":"0","category":{"id":"0","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"0","name":""}],"status":"available"}
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: |
+        {"id":"0","category":{"id":"0","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"0","name":""}],"status":"available"}
+  - path: "/v2/store/order/0"
+    method: GET
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: |
+        {"id":"0","petId":"0","quantity":"0","shipData":"","status":"placed","complete":"false"}
+  - path: "/v2/store/order"
+    method: POST
+    requestHeaders:
+      Accept: "application/json"
+    requestBody:
+      value: |
+        {"id":"0","petId":"0","quantity":"0","shipData":"","status":"placed","complete":"false"}
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: |
+        {"id":"0","petId":"0","quantity":"0","shipData":"","status":"placed","complete":"false"}
   - path: "/v2/store/order/order_id_ok"
     method: DELETE
     response:
@@ -130,3 +188,12 @@ resources:
       headers:
         Content-Type: "application/json"
       staticData: "token"
+  - path: "/v2/user/myName"
+    method: GET
+    response:
+      statusCode: 200
+      headers:
+        Content-Type: "application/json"
+      staticData: |
+        {"id":"0","username":"myName","firstName":"","lastName":"","email":"","password":"","phone":"","userStatus":"0"}
+
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/main.cpp b/samples/client/petstore/cpp-boost-beast/tests/api/main.cpp
@@ -1,7 +1,7 @@
 #define BOOST_TEST_MODULE ApiTests
 
-//#include <boost/test/unit_test.hpp> // static or dynamic boost build
-#include <boost/test/included/unit_test.hpp> // header only boost
+#include <boost/test/unit_test.hpp> // static or dynamic boost build
+//#include <boost/test/included/unit_test.hpp> // header only boost
 
 #define APPROVALS_BOOSTTEST
 #include "../ApprovalTests.hpp"
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/pet_api_test.cpp b/samples/client/petstore/cpp-boost-beast/tests/api/pet_api_test.cpp
@@ -20,11 +20,14 @@ using namespace org::openapitools::client::api;
 
 namespace {
 struct fixture {
-    fixture() = default;
+
+    explicit fixture()
+        : client(std::make_shared<HttpClientImpl>("localhost", "8080"))
+    {}
 
     ~fixture() = default;
 
-    std::shared_ptr<HttpClient> client = std::make_shared<HttpClientImpl>("localhost", "8080");
+    std::shared_ptr<HttpClient> client;
 };
 }
 
@@ -183,13 +186,13 @@ BOOST_AUTO_TEST_CASE(getPetById_std_exception) {
         BOOST_REQUIRE_THROW(api.getPetById(0), std::exception);
 }
 
-    BOOST_AUTO_TEST_CASE(getPetById_int_exception) {
-        client->setExceptionType(ExceptionType::INT);
-        auto baseClient = std::static_pointer_cast<HttpClient>(client);
-        PetApi api(baseClient);
+BOOST_AUTO_TEST_CASE(getPetById_int_exception) {
+    client->setExceptionType(ExceptionType::INT);
+    auto baseClient = std::static_pointer_cast<HttpClient>(client);
+    PetApi api(baseClient);
 
-        BOOST_REQUIRE_THROW(api.getPetById(0), int);
-    }
+    BOOST_REQUIRE_THROW(api.getPetById(0), int);
+}
 
 
 BOOST_AUTO_TEST_SUITE_END()
diff --git a/samples/client/petstore/cpp-boost-beast/tests/api/run_imposter_for_tests.sh b/samples/client/petstore/cpp-boost-beast/tests/api/run_imposter_for_tests.sh
@@ -15,6 +15,8 @@ fi
 
 
 echo Starting imposter
+# NOTE: as of version 4.5.2, imposter default values have changed
+# https://github.com/imposter-project/imposter-jvm-engine/commit/06abdf394ccb94d6d9b9c3b2e2eb424940386e20
 imposter up -p 8080 ./imposter_config &
 pid=$!
 
@@ -33,6 +35,9 @@ set +x
 sleep 5
 
 echo Running tests: "$@"
+set +e
 "$@"
+ec=$?
 
 imposter down
+exit $ec
diff --git a/samples/client/petstore/cpp-boost-beast/tests/model/CMakeLists.txt b/samples/client/petstore/cpp-boost-beast/tests/model/CMakeLists.txt
@@ -23,5 +23,8 @@ target_link_libraries(model_tests
             client
             ${Boost_LIBRARIES})
 
+target_compile_definitions(api_tests
+        PUBLIC
+            BOOST_TEST_DYN_LINK)
 
-add_test(NAME model_tests COMMAND model_tests)
+add_test(NAME model_tests COMMAND model_tests)
diff --git a/samples/client/petstore/cpp-boost-beast/tests/model/approval_files/.gitignore b/samples/client/petstore/cpp-boost-beast/tests/model/approval_files/.gitignore
@@ -0,0 +1 @@
+*.received.txt
diff --git a/samples/client/petstore/cpp-boost-beast/tests/model/main.cpp b/samples/client/petstore/cpp-boost-beast/tests/model/main.cpp
@@ -1,7 +1,7 @@
 #define BOOST_TEST_MODULE ModelTests
 
-//#include <boost/test/unit_test.hpp> // static or dynamic boost build
-#include <boost/test/included/unit_test.hpp> // header only boost
+#include <boost/test/unit_test.hpp> // static or dynamic boost build
+//#include <boost/test/included/unit_test.hpp> // header only boost
 
 #define APPROVALS_BOOSTTEST
 #include "../ApprovalTests.hpp"
@@ -10,4 +10,4 @@ using namespace ApprovalTests;
 
 // This puts "received" and "approved" files in approval_tests/ sub-directory,
 // keeping the test source directory tidy:
-auto directoryDisposer = Approvals::useApprovalsSubdirectory("approval_files");
+auto directoryDisposer = Approvals::useApprovalsSubdirectory("approval_files");
diff --git a/samples/client/petstore/cpp-boost-beast/tests/model/pet_model_test.cpp b/samples/client/petstore/cpp-boost-beast/tests/model/pet_model_test.cpp
@@ -1,6 +1,10 @@
 #define BOOST_TEST_INCLUDED
 #include <list>
 #include "../ApprovalTests.hpp"
+// silence warning from json_parser.hpp
+#ifndef BOOST_BIND_GLOBAL_PLACEHOLDERS
+# define BOOST_BIND_GLOBAL_PLACEHOLDERS
+#endif
 #include <boost/property_tree/json_parser.hpp>
 #include <boost/property_tree/ptree.hpp>
 #include <boost/test/data/test_case.hpp>
