Change Bazel XML support to depend upon BAZEL_TEST

catchorg · Jun 13, 2022 · 856080f · 856080f
1 parent d32fca4
commit 856080f
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 13 deletions.
diff --git a/BUILD.bazel b/BUILD.bazel
@@ -7,7 +7,6 @@ expand_template(
     out = "catch2/catch_user_config.hpp",
     substitutions = {
         "#cmakedefine CATCH_CONFIG_ANDROID_LOGWRITE": "",
-        "#cmakedefine CATCH_CONFIG_BAZEL_SUPPORT": "#define CATCH_CONFIG_BAZEL_SUPPORT",
         "#cmakedefine CATCH_CONFIG_NO_COLOUR_WIN32": "",
         "#cmakedefine CATCH_CONFIG_COLOUR_WIN32": "",
         "#cmakedefine CATCH_CONFIG_COUNTER": "",
@@ -88,4 +87,4 @@ cc_library(
     linkstatic = True,
     visibility = ["//visibility:public"],
     deps = [":catch2"],
-)
+)
diff --git a/CMake/CatchConfigOptions.cmake b/CMake/CatchConfigOptions.cmake
@@ -26,7 +26,6 @@ endmacro()
 
 set(_OverridableOptions
   "ANDROID_LOGWRITE"
-  "BAZEL_SUPPORT"
   "COLOUR_WIN32"
   "COUNTER"
   "CPP11_TO_STRING"

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -98,10 +98,9 @@ is equivalent with the out-of-the-box experience.
 
 
 ## Bazel support
-When `CATCH_CONFIG_BAZEL_SUPPORT` is defined, Catch2 will register a `JUnit`
+When `env BAZEL_TEST=1` is defined by the Bazel test enviroment, Catch2 will register a `JUnit`
 reporter writing to a path pointed by `XML_OUTPUT_FILE` provided by Bazel.
 
-> `CATCH_CONFIG_BAZEL_SUPPORT` was [introduced](https://github.com/catchorg/Catch2/pull/2399) in Catch2 3.0.1.
 
 ## C++11 toggles
 

diff --git a/src/catch2/catch_config.cpp b/src/catch2/catch_config.cpp
@@ -59,7 +59,9 @@ namespace Catch {
             } );
         }
 
-#if defined( CATCH_CONFIG_BAZEL_SUPPORT )
+        if (std::getenv( "BAZEL_TEST" ))
+        {
+
         // Register a JUnit reporter for Bazel. Bazel sets an environment
         // variable with the path to XML output. If this file is written to
         // during test, Bazel will not generate a default XML output.
@@ -71,15 +73,15 @@ namespace Catch {
 #        pragma warning( push )
 #        pragma warning( disable : 4996 )
 #    endif
-        const auto bazelOutputFilePtr = std::getenv( "XML_OUTPUT_FILE" );
+            const auto bazelOutputFilePtr = std::getenv( "XML_OUTPUT_FILE" );
 #    if defined( _MSC_VER )
 #        pragma warning( pop )
 #    endif
-        if ( bazelOutputFilePtr != nullptr ) {
-            m_data.reporterSpecifications.push_back(
-                { "junit", std::string( bazelOutputFilePtr ), {}, {} } );
+            if ( bazelOutputFilePtr != nullptr ) {
+                m_data.reporterSpecifications.push_back(
+                    { "junit", std::string( bazelOutputFilePtr ), {}, {} } );
+            }
         }
-#endif
 
 
         // We now fixup the reporter specs to handle default output spec,

diff --git a/src/catch2/catch_user_config.hpp.in b/src/catch2/catch_user_config.hpp.in
@@ -165,7 +165,6 @@
 // ------
 
 
-#cmakedefine CATCH_CONFIG_BAZEL_SUPPORT
 #cmakedefine CATCH_CONFIG_DISABLE_EXCEPTIONS
 #cmakedefine CATCH_CONFIG_DISABLE_EXCEPTIONS_CUSTOM_HANDLER
 #cmakedefine CATCH_CONFIG_DISABLE

diff --git a/tests/ExtraTests/CMakeLists.txt b/tests/ExtraTests/CMakeLists.txt
@@ -135,6 +135,7 @@ add_test(NAME CATCH_CONFIG_BAZEL_REPORTER-1
 set_tests_properties(CATCH_CONFIG_BAZEL_REPORTER-1
   PROPERTIES
     LABELS "uses-python"
+    ENVIRONMENT "BAZEL_TEST=1"
 )
 
 

diff --git a/tests/TestScripts/testBazelReporter.py b/tests/TestScripts/testBazelReporter.py
@@ -18,7 +18,7 @@
 a junit reporter that writes to the provided path.
 
 Requires 2 arguments, path to Catch2 binary configured with
-`CATCH_CONFIG_BAZEL_SUPPORT`, and the output directory for the output file.
+`env BAZEL_TEST=1`, and the output directory for the output file.
 """
 if len(sys.argv) != 3:
     print("Wrong number of arguments: {}".format(len(sys.argv)))