Merge pull request #36 from approvals/existing_catch_main

Support Existing catch main

ApprovalTests/integrations/catch/Catch2Approvals.h

@@ -5,8 +5,14 @@
 #include "ApprovalTests/namers/ApprovalTestNamer.h"
 
 // <SingleHpp unalterable>
+#if defined(APPROVALS_CATCH_EXISTING_MAIN)
+    #define APPROVALS_CATCH
+    #define CATCH_CONFIG_RUNNER
+#elif defined(APPROVALS_CATCH)
+    #define CATCH_CONFIG_MAIN
+#endif
+
 #ifdef APPROVALS_CATCH
-#define CATCH_CONFIG_MAIN
 
 #include <Catch.hpp>
 

build/relnotes_X.X.X.md

@@ -1,7 +1,7 @@
 * **Breaking changes**
     * None
 * **New features**
-    * None
+    * Support for [Existing Catch Project - with your main()](/doc/UsingCatch.md#existing-project---with-your-main)
 * **Bug fixes**
     * None
 * **Other changes**

doc/Features.md

@@ -15,6 +15,7 @@ To change this file edit the source file and then execute ./run_markdown_templat
 ## Contents
 
   * [vNext](#vnext)
+    * [Existing Catch Project - with your main()](#existing-catch-project---with-your-main)
   * [v.5.1.0](#v510)
     * [Continuous Integration Builds](#continuous-integration-builds)
     * [Approving multiple files in one test](#approving-multiple-files-in-one-test)
@@ -36,6 +37,10 @@ To change this file edit the source file and then execute ./run_markdown_templat
 
 ## vNext
 
+### Existing Catch Project - with your main()
+
+See [Existing Project - with your main()](/doc/UsingCatch.md#existing-project---with-your-main).
+
 ## v.5.1.0
 
 ### Continuous Integration Builds

doc/UsingCatch.md

@@ -71,11 +71,27 @@ If you have a Catch (1 or 2) project with your own `main.cpp` that contains the
 
 If you have [supplied your own `main()` for Catch](https://github.com/catchorg/Catch2/blob/master/docs/own-main.md#top), you will need to teach it how to supply test names to Approval Tests.
 
-There is not yet a streamlined way of doing this.
+You should make the following additions to your own source file that contains `main()`.  
 
-For now, please see the code in [ApprovalTests/Catch2Approvals.h](/ApprovalTests/integrations/catch/Catch2Approvals.h) for the code you will need to add to your `main.cpp`.
+<!-- snippet: catch_existing_main -->
+<a id='snippet-catch_existing_main'/></a>
+```cpp
+// main.cpp:
+
+// Add these two lines to your main:
+#define APPROVALS_CATCH_EXISTING_MAIN
+#include "ApprovalTests.hpp"
 
-If it would be helpful for us to provide an easier way to do this, please let us know, via the contact details in [Contributing to ApprovalTests.cpp](/doc/Contributing.md#top). 
+int main( int argc, char* argv[] )
+{
+    // your existing setup...
+    int result = Catch::Session().run( argc, argv );
+    // your existing clean-up...
+    return result;
+}
+```
+<sup>[snippet source](/examples/catch2_existing_main/main.cpp#L1-L15) / [anchor](#snippet-catch_existing_main)</sup>
+<!-- endsnippet -->
 
 
 ---

doc/mdsource/Features.source.md

@@ -8,6 +8,10 @@ toc
 
 ## vNext
 
+### Existing Catch Project - with your main()
+
+See [Existing Project - with your main()](/doc/UsingCatch.md#existing-project---with-your-main).
+
 ## v.5.1.0
 
 ### Continuous Integration Builds

doc/mdsource/UsingCatch.source.md

@@ -47,11 +47,9 @@ If you have a Catch (1 or 2) project with your own `main.cpp` that contains the
 
 If you have [supplied your own `main()` for Catch](https://github.com/catchorg/Catch2/blob/master/docs/own-main.md#top), you will need to teach it how to supply test names to Approval Tests.
 
-There is not yet a streamlined way of doing this.
+You should make the following additions to your own source file that contains `main()`.  
 
-For now, please see the code in [ApprovalTests/Catch2Approvals.h](/ApprovalTests/integrations/catch/Catch2Approvals.h) for the code you will need to add to your `main.cpp`.
-
-If it would be helpful for us to provide an easier way to do this, please let us know, via the contact details in [Contributing to ApprovalTests.cpp](/doc/Contributing.md#top). 
+snippet: catch_existing_main
 
 
 ---

examples/CMakeLists.txt

@@ -1 +1,2 @@
+add_subdirectory(catch2_existing_main)
 add_subdirectory(googletest_existing_main)

examples/catch2_existing_main/CMakeLists.txt

@@ -0,0 +1,11 @@
+project(catch2_existing_main)
+set(CMAKE_CXX_STANDARD 11)
+add_executable(${PROJECT_NAME}
+        main.cpp
+        Catch2ApprovalsTests.cpp
+        )
+target_link_libraries(${PROJECT_NAME} ApprovalTests catch2)
+target_include_directories(${PROJECT_NAME}
+        PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tests/Catch2_Tests)
+
+add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})

examples/catch2_existing_main/Catch2ApprovalsTests.TestStreamableObject.approved.txt

@@ -0,0 +1 @@
+42

examples/catch2_existing_main/Catch2ApprovalsTests.cpp

@@ -0,0 +1,9 @@
+#include "Catch.hpp"
+#include "ApprovalTests/Approvals.h"
+
+using namespace ApprovalTests;
+
+TEST_CASE("TestStreamableObject")
+{
+    Approvals::verify(42);
+}

examples/catch2_existing_main/main.cpp

@@ -0,0 +1,15 @@
+// begin-snippet: catch_existing_main
+// main.cpp:
+
+// Add these two lines to your main:
+#define APPROVALS_CATCH_EXISTING_MAIN
+#include "ApprovalTests.hpp"
+
+int main( int argc, char* argv[] )
+{
+    // your existing setup...
+    int result = Catch::Session().run( argc, argv );
+    // your existing clean-up...
+    return result;
+}
+// end-snippet