catch2_ext.hpp: Inject our own 'main()', catch2_my_main.cpp, if !defined(CATCH_CONFIG_MAIN)

Our main() function sets the global variable 'catch_auto_run' to 'true',
if executed w/o arguments.

In this case, we set the following benchmark parameter
for a fast benchmark run on compilation:
  --benchmark-warmup-time 1
  --benchmark-confidence-interval 0
  --benchmark-samples 1
  --benchmark-resamples 0
  --benchmark-no-analysis

To run our benchmarks with proper analysis (slowly),
just pass any arguments, like '-v normal'

2 files changed, 120 insertions, 9 deletions

diff --git a/include/jau/test/catch2_ext.hpp b/include/jau/test/catch2_ext.hpp
index a7b9c6f..8a4f6d4 100644
--- a/include/jau/test/catch2_ext.hpp
+++ b/include/jau/test/catch2_ext.hpp
@@ -1,12 +1,34 @@
-//              Copyright Catch2 Authors
-// Distributed under the Boost Software License, Version 1.0.
-//   (See accompanying file LICENSE_1_0.txt or copy at
-//        https://www.boost.org/LICENSE_1_0.txt)
-
-// SPDX-License-Identifier: BSL-1.0
-
-//  Using Catch v3+
-//  ----------------------------------------------------------
+/*
+ * Author: Sven Gothel <[email protected]>
+ * Copyright (c) 2020 Gothel Software e.K.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ *************************************************************************
+ *
+ * Distributed under the Boost Software License, Version 1.0.
+ *  (See accompanying file LICENSE_1_0.txt or copy at
+ *        https://www.boost.org/LICENSE_1_0.txt)
+ *
+ * SPDX-License-Identifier: BSL-1.0
+ */
 
 #ifndef CATCH2_EXT_H
 #define CATCH2_EXT_H
@@ -44,5 +66,9 @@
 
 // }
 
+#if !defined(CATCH_CONFIG_MAIN)
+#include <jau/test/catch2_my_main.cpp>
+#endif /* !defined(CATCH_CONFIG_MAIN) */
+
 #endif // CATCH2_EXT_H
 
diff --git a/include/jau/test/catch2_my_main.cpp b/include/jau/test/catch2_my_main.cpp
new file mode 100644
index 0000000..9352bff
--- /dev/null
+++ b/include/jau/test/catch2_my_main.cpp
@@ -0,0 +1,85 @@
+/*
+ * Author: Sven Gothel <[email protected]>
+ * Copyright (c) 2020 Gothel Software e.K.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ *************************************************************************
+ *
+ * Distributed under the Boost Software License, Version 1.0.
+ *  (See accompanying file LICENSE_1_0.txt or copy at
+ *        https://www.boost.org/LICENSE_1_0.txt)
+ *
+ * SPDX-License-Identifier: BSL-1.0
+ */
+
+#ifndef CATCH2_MY_MAIN_H
+#define CATCH2_MY_MAIN_H
+
+#include <catch2/catch_amalgamated.hpp>
+
+/** Run w/o command-line args, i.e. default CI unit test. */
+bool catch_auto_run;
+
+int main( int argc, char* argv[] )
+{
+  Catch::Session session; // There must be exactly one instance
+
+  catch_auto_run = ( 1 >= argc );
+  fprintf(stderr, "argc %d, auto-run %d\n", argc, catch_auto_run);
+
+  // writing to session.configData() here sets defaults
+  // this is the preferred way to set them
+
+  int returnCode = session.applyCommandLine( argc, argv );
+
+  if( returnCode != 0 ) { // Indicates a command line error
+      return returnCode;
+  }
+
+  if( catch_auto_run ) {
+      const char* my_args[] = { argv[0],
+                                "--benchmark-warmup-time", "1",
+                                "--benchmark-confidence-interval", "0",
+                                "--benchmark-samples", "1",
+                                "--benchmark-resamples", "0",
+                                "--benchmark-no-analysis"
+                              };
+      int res = session.applyCommandLine( sizeof(my_args)/sizeof(char*), my_args );
+      if( 0 != res ) {
+          return res;
+      }
+      // Catch::Config& config = session.config();
+  }
+
+  // writing to session.configData() or session.Config() here
+  // overrides command line args
+  // only do this if you know you need to
+
+  int numFailed = session.run();
+
+  // numFailed is clamped to 255 as some unices only use the lower 8 bits.
+  // This clamping has already been applied, so just return it here
+  // You can also do any post run clean-up here
+  return numFailed;
+}
+
+#endif // CATCH2_MY_MAIN_H
+