From d7aa5f3ee137585a426a580f146b08a415f9a213 Mon Sep 17 00:00:00 2001
From: Orta <ortam@microsoft.com>
Date: Wed, 17 Jun 2020 17:00:46 -0400
Subject: [PATCH] Show a diff when the  public api baselines fail (#39108)

* Add semantic highlighting pt1

* Make the public API unit tests echo out a diff
---
 package.json                          |  1 +
 src/harness/harnessIO.ts              | 14 +++++++++++---
 src/testRunner/unittests/publicApi.ts |  2 +-
 3 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/package.json b/package.json
index ea458d053aa..b8700085ad8 100644
--- a/package.json
+++ b/package.json
@@ -65,6 +65,7 @@
         "chalk": "latest",
         "convert-source-map": "latest",
         "del": "5.1.0",
+        "diff": "^4.0.2",
         "eslint": "6.8.0",
         "eslint-formatter-autolinkable-stylish": "1.1.2",
         "eslint-plugin-import": "2.20.2",
diff --git a/src/harness/harnessIO.ts b/src/harness/harnessIO.ts
index 47a744de208..9f4cef69de2 100644
--- a/src/harness/harnessIO.ts
+++ b/src/harness/harnessIO.ts
@@ -1293,6 +1293,7 @@ namespace Harness {
         export interface BaselineOptions {
             Subfolder?: string;
             Baselinefolder?: string;
+            PrintDiff?: true;
         }
 
         export function localPath(fileName: string, baselineFolder?: string, subfolder?: string) {
@@ -1347,7 +1348,7 @@ namespace Harness {
             return { expected, actual };
         }
 
-        function writeComparison(expected: string, actual: string, relativeFileName: string, actualFileName: string) {
+        function writeComparison(expected: string, actual: string, relativeFileName: string, actualFileName: string, opts?: BaselineOptions) {
             // For now this is written using TypeScript, because sys is not available when running old test cases.
             // But we need to move to sys once we have
             // Creates the directory including its parent if not already present
@@ -1381,7 +1382,14 @@ namespace Harness {
                 else {
                     IO.writeFile(actualFileName, encodedActual);
                 }
-                throw new Error(`The baseline file ${relativeFileName} has changed.`);
+                if (require && opts && opts.PrintDiff) {
+                    const Diff = require("diff");
+                    const patch = Diff.createTwoFilesPatch("Expected", "Actual", expected, actual, "The current baseline", "The new version");
+                    throw new Error(`The baseline file ${relativeFileName} has changed.${ts.ForegroundColorEscapeSequences.Grey}\n\n${patch}`);
+                }
+                else {
+                    throw new Error(`The baseline file ${relativeFileName} has changed.`);
+                }
             }
         }
 
@@ -1391,7 +1399,7 @@ namespace Harness {
                 throw new Error("The generated content was \"undefined\". Return \"null\" if no baselining is required.\"");
             }
             const comparison = compareToBaseline(actual, relativeFileName, opts);
-            writeComparison(comparison.expected, comparison.actual, relativeFileName, actualFileName);
+            writeComparison(comparison.expected, comparison.actual, relativeFileName, actualFileName, opts);
         }
 
         export function runMultifileBaseline(relativeFileBase: string, extension: string, generateContent: () => IterableIterator<[string, string, number]> | IterableIterator<[string, string]> | null, opts?: BaselineOptions, referencedExtensions?: string[]): void {
diff --git a/src/testRunner/unittests/publicApi.ts b/src/testRunner/unittests/publicApi.ts
index 4cf83d6c8fc..80df40e6d9b 100644
--- a/src/testRunner/unittests/publicApi.ts
+++ b/src/testRunner/unittests/publicApi.ts
@@ -10,7 +10,7 @@ describe("unittests:: Public APIs", () => {
         });
 
         it("should be acknowledged when they change", () => {
-            Harness.Baseline.runBaseline(api, fileContent);
+            Harness.Baseline.runBaseline(api, fileContent, { PrintDiff: true });
         });
 
         it("should compile", () => {