CXX-3092 Enable /Gv when building test suite with MSVC

Author: eramongodb

cmake/FetchCatch2.cmake

@@ -30,6 +30,11 @@ function(fetch_catch2)
         string(REPLACE " -Werror" "" CMAKE_C_FLAGS "${CMAKE_C_FLAGS}")
         string(REPLACE " -Werror" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
 
+        # Ensure consistent default calling convention with test executables.
+        if(MSVC)
+            string(APPEND CMAKE_CXX_FLAGS " /Gv")
+        endif()
+
         FetchContent_MakeAvailable(EP_Catch2)
 
         # Avoid building unnecessary targets. Use FetchContent_Declare(EXCLUDE_FROM_ALL) in CMake 3.28 and newer.

examples/CMakeLists.txt

@@ -75,7 +75,7 @@ function(add_examples_executable source)
         RUNTIME_OUTPUT_DIRECTORY ${subdir}
     )
 
-    # Deliberately use `__vectorcall` by default with MSVC to catch missing `__cdecl`.
+    # Use `__vectorcall` by default with MSVC to catch missing `__cdecl`.
     target_compile_options(${target_name} PRIVATE "$<$<CXX_COMPILER_ID:MSVC>:/Gv>")
 
     # Keep build and run targets completely separate.

src/bsoncxx/test/CMakeLists.txt

@@ -36,6 +36,7 @@ add_executable(test_bson
     bson_util_itoa.cpp
     bson_validate.cpp
     bson_value.cpp
+    catch.cpp
     exception_guard.cpp
     json.cpp
     oid.cpp
@@ -62,11 +63,14 @@ target_include_directories(bsoncxx_test_properties INTERFACE
     ${CMAKE_CURRENT_SOURCE_DIR}/../..
 )
 target_compile_definitions(bsoncxx_test_properties INTERFACE ${libbson_definitions})
+# Use `__vectorcall` by default with MSVC to catch missing `__cdecl`.
+target_compile_options(bsoncxx_test_properties INTERFACE "$<$<CXX_COMPILER_ID:MSVC>:/Gv>")
 add_library(bsoncxx::test_properties ALIAS bsoncxx_test_properties)
 
 # Avoid redundant recompilation of catch/main.cpp.
 add_library(bsoncxx_test_properties_with_main INTERFACE)
-target_link_libraries(bsoncxx_test_properties_with_main INTERFACE bsoncxx::test_properties Catch2::Catch2WithMain)
+target_link_libraries(bsoncxx_test_properties_with_main INTERFACE bsoncxx::test_properties)
+target_sources(bsoncxx_test_properties INTERFACE catch.cpp)
 add_library(bsoncxx::test_properties_with_main ALIAS bsoncxx_test_properties_with_main)
 
 target_link_libraries (test_bson PRIVATE bsoncxx::test_properties_with_main)
@@ -158,6 +162,7 @@ set_dist_list(src_bsoncxx_test_DIST
     bson_util_itoa.cpp
     bson_validate.cpp
     bson_value.cpp
+    catch.cpp
     catch.hh
     exception_guard.cpp
     exception_guard.hh

src/bsoncxx/test/catch.cpp

@@ -0,0 +1,21 @@
+// Copyright 2009-present MongoDB, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <bsoncxx/config/prelude.hpp>
+
+#include <catch2/catch_session.hpp>
+
+int BSONCXX_ABI_CDECL main(int argc, char* argv[]) {
+    return Catch::Session().run(argc, argv);
+}

src/mongocxx/test/CMakeLists.txt

@@ -157,10 +157,13 @@ target_include_directories(mongocxx_test_properties INTERFACE
     # Allow `#include <mongocxx/test/...>`.
     ${CMAKE_CURRENT_SOURCE_DIR}/../..
 )
+# Use `__vectorcall` by default with MSVC to catch missing `__cdecl`.
+target_compile_options(mongocxx_test_properties INTERFACE "$<$<CXX_COMPILER_ID:MSVC>:/Gv>")
 add_library(mongocxx::test_properties ALIAS mongocxx_test_properties)
 
 add_library(mongocxx_test_properties_with_main INTERFACE)
-target_link_libraries(mongocxx_test_properties_with_main INTERFACE mongocxx::test_properties Catch2::Catch2WithMain)
+target_link_libraries(mongocxx_test_properties_with_main INTERFACE mongocxx::test_properties)
+target_sources(mongocxx_test_properties_with_main INTERFACE catch.cpp)
 add_library(mongocxx::test_properties_with_main ALIAS mongocxx_test_properties_with_main)
 
 set_property(
@@ -335,6 +338,7 @@ set_dist_list(src_mongocxx_test_DIST
     bulk_write.cpp
     catch_helpers.cpp
     catch_helpers.hh
+    catch.cpp
     change_streams.cpp
     client_helpers.cpp
     client_helpers.hh

src/mongocxx/test/catch.cpp

@@ -0,0 +1,21 @@
+// Copyright 2009-present MongoDB, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <mongocxx/config/prelude.hpp>
+
+#include <catch2/catch_session.hpp>
+
+int MONGOCXX_ABI_CDECL main(int argc, char* argv[]) {
+    return Catch::Session().run(argc, argv);
+}