F!! Added CrossPlatformReporters, with VSCode (#204)

Co-Authored-By: Llewellyn Falco <[email protected]>
Co-Authored-By: Nitsan Avni <[email protected]>

ApprovalTests/CMakeLists.txt

@@ -84,6 +84,8 @@ add_library(${PROJECT_NAME}
         reporters/CommandReporter.cpp
         reporters/ConvertForCygwin.h
         reporters/ConvertForCygwin.cpp
+        reporters/CrossPlatformReporters.h
+        reporters/CrossPlatformReporters.cpp
         reporters/CustomReporter.h
         reporters/CustomReporter.cpp
         reporters/DefaultFrontLoadedReporter.h

ApprovalTests/reporters/CrossPlatformReporters.cpp

@@ -0,0 +1,23 @@
+#include "ApprovalTests/reporters/CrossPlatformReporters.h"
+
+#include "DiffPrograms.h"
+
+namespace ApprovalTests
+{
+    namespace CrossPlatform
+    {
+        VisualStudioCodeReporter::VisualStudioCodeReporter()
+            : GenericDiffReporter(DiffPrograms::CrossPlatform::VS_CODE())
+        {
+        }
+
+        CrossPlatformDiffReporter::CrossPlatformDiffReporter()
+            : FirstWorkingReporter({
+                  // begin-snippet: cross_platform_diff_reporters
+                  new VisualStudioCodeReporter(),
+                  // end-snippet
+              })
+        {
+        }
+    }
+}

ApprovalTests/reporters/CrossPlatformReporters.h

@@ -0,0 +1,22 @@
+#pragma once
+
+#include "ApprovalTests/reporters/GenericDiffReporter.h"
+#include "ApprovalTests/reporters/FirstWorkingReporter.h"
+
+namespace ApprovalTests
+{
+    namespace CrossPlatform
+    {
+        class VisualStudioCodeReporter : public GenericDiffReporter
+        {
+        public:
+            VisualStudioCodeReporter();
+        };
+
+        class CrossPlatformDiffReporter : public FirstWorkingReporter
+        {
+        public:
+            CrossPlatformDiffReporter();
+        };
+    }
+}

ApprovalTests/reporters/DiffPrograms.cpp

@@ -13,6 +13,15 @@ namespace ApprovalTests
     namespace DiffPrograms
     {
 
+        namespace CrossPlatform
+        {
+            APPROVAL_TESTS_MACROS_ENTRY(
+                VS_CODE,
+                DiffInfo("code",
+                         "-d {Received} {Approved}",
+                         Type::TEXT))
+        }
+
         namespace Mac
         {
             APPROVAL_TESTS_MACROS_ENTRY(

ApprovalTests/reporters/DiffPrograms.h

@@ -6,6 +6,11 @@ namespace ApprovalTests
 {
     namespace DiffPrograms
     {
+        namespace CrossPlatform
+        {
+            DiffInfo VS_CODE();
+        }
+
         namespace Mac
         {
             DiffInfo DIFF_MERGE();

ApprovalTests/reporters/DiffReporter.cpp

@@ -4,14 +4,16 @@
 #include "WindowsReporters.h"
 #include "MacReporters.h"
 #include "LinuxReporters.h"
+#include "CrossPlatformReporters.h"
 
 namespace ApprovalTests
 {
     DiffReporter::DiffReporter()
         : FirstWorkingReporter({new EnvironmentVariableReporter(),
                                 new Mac::MacDiffReporter(),
                                 new Linux::LinuxDiffReporter(),
-                                new Windows::WindowsDiffReporter()})
+                                new Windows::WindowsDiffReporter(),
+                                new CrossPlatform::CrossPlatformDiffReporter()})
     {
     }
 }

ApprovalTests/reporters/ReporterFactory.cpp

@@ -6,6 +6,7 @@
 #include "ApprovalTests/reporters/CIBuildOnlyReporter.h"
 #include "ApprovalTests/reporters/ClipboardReporter.h"
 #include "ApprovalTests/reporters/CombinationReporter.h"
+#include "ApprovalTests/reporters/CrossPlatformReporters.h"
 #include "ApprovalTests/reporters/DefaultFrontLoadedReporter.h"
 #include "ApprovalTests/reporters/DefaultReporter.h"
 #include "ApprovalTests/reporters/DiffReporter.h"
@@ -87,6 +88,8 @@ namespace ApprovalTests
         APPROVAL_TESTS_REGISTER_REPORTER(Windows::KDiff3Reporter);
         APPROVAL_TESTS_REGISTER_REPORTER(Windows::VisualStudioCodeReporter);
 
+        APPROVAL_TESTS_REGISTER_REPORTER(CrossPlatform::VisualStudioCodeReporter);
+
         return map;
     }
 

doc/Reporters.md

@@ -71,6 +71,12 @@ new VisualStudioCodeReporter(),
 <sup><a href='/ApprovalTests/reporters/WindowsReporters.cpp#L94-L104' title='Snippet source file'>snippet source</a> | <a href='#snippet-windows_diff_reporters' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
+## Cross-platform
+
+These are all based on the diff tool being in the [`PATH`](https://en.wikipedia.org/wiki/PATH_(variable)).
+
+snippet: cross_platform_diff_reporters
+
 ## Registering a default reporter
 
 At present, the default Reporter is the DiffReporter. Whenever you call Approvals, you have the chance to pass in your own Reporter. However, if you would like to change what the default reporter is when you don't pass in a specific Reporter, you can do this at a global or per-test level, by adding the line:

doc/how_tos/SubmitANewReporterToApprovalTests.md

@@ -170,6 +170,13 @@ The steps are the same as above, except that in the second step, you will edit:
 * [ApprovalTests/reporters/LinuxReporters.h](https://github.com/approvals/ApprovalTests.cpp/blob/master/ApprovalTests/reporters/LinuxReporters.h)
 * [ApprovalTests/reporters/LinuxReporters.cpp](https://github.com/approvals/ApprovalTests.cpp/blob/master/ApprovalTests/reporters/LinuxReporters.cpp)
 
+## Adding a new Cross Platform reporter
+
+To add a reporter that will run on all 3 platforms, the steps are the same as above, except that in the second step, you will edit:
+
+* [ApprovalTests/reporters/CrossPlatformReporters.h](https://github.com/approvals/ApprovalTests.cpp/blob/master/ApprovalTests/reporters/CrossPlatformReporters.h)
+* [ApprovalTests/reporters/CrossPlatformReporters.cpp](https://github.com/approvals/ApprovalTests.cpp/blob/master/ApprovalTests/reporters/CrossPlatformReporters.cpp)
+
 ---
 
 [Back to User Guide](/doc/README.md#top)

tests/DocTest_Tests/reporters/CommandLineReporterTests.cpp

@@ -3,6 +3,7 @@
 #include "ApprovalTests/reporters/WindowsReporters.h"
 #include "ApprovalTests/reporters/MacReporters.h"
 #include "ApprovalTests/reporters/LinuxReporters.h"
+#include "ApprovalTests/reporters/CrossPlatformReporters.h"
 
 #include <vector>
 
@@ -58,7 +59,11 @@ TEST_CASE("Test Command Lines")
         std::make_shared<Linux::SublimeMergeFlatpakReporter>(),
         std::make_shared<Linux::SublimeMergeRepositoryPackageReporter>(),
         std::make_shared<Linux::SublimeMergeDirectDownloadReporter>(),
-        std::make_shared<Linux::KDiff3Reporter>()};
+        std::make_shared<Linux::KDiff3Reporter>(),
+
+        // Cross-platform
+        std::make_shared<CrossPlatform::VisualStudioCodeReporter>()};
+
     for (const auto& reporter : reporters)
     {
         reporter->useCygwinConversions(false);

tests/DocTest_Tests/reporters/approval_tests/CommandLineReporterTests.Test_Command_Lines.approved.txt

@@ -114,4 +114,8 @@ windows: start "" "kdiff3" "a.txt" "b.txt" -m -o "b.txt"
 unix   : "kdiff3" "a.txt" "b.txt" -m -o "b.txt" &
 cygwin : "$(cygpath 'kdiff3')" "$(cygpath -aw 'a.txt')" "$(cygpath -aw 'b.txt')" -m -o "$(cygpath -aw 'b.txt')" &
 
+windows: start "" "code" -d "a.txt" "b.txt"
+unix   : "code" -d "a.txt" "b.txt" &
+cygwin : "$(cygpath 'code')" -d "$(cygpath -aw 'a.txt')" "$(cygpath -aw 'b.txt')" &
+
 

tests/DocTest_Tests/reporters/approval_tests/ReporterFactoryTests.Verify_all_valid_env_var_values.approved.txt

@@ -2,6 +2,7 @@ AutoApproveIfMissingReporter
 AutoApproveReporter
 CIBuildOnlyReporter
 ClipboardReporter
+CrossPlatform::VisualStudioCodeReporter
 DefaultFrontLoadedReporter
 DefaultReporter
 DiffReporter