refactor: auto-generate snapshot test cases from folders (#104)

Author: tal-sapan

packages/language-server/test/snapshots/xml-view-diagnostics/snapshots-diagnostics-spec.ts

@@ -0,0 +1,35 @@
+import * as klawSync from "klaw-sync";
+import { map, forEach, filter } from "lodash";
+import { basename, relative, dirname } from "path";
+import {
+  snapshotTestLSPDiagnostic,
+  toSourcesTestDir,
+  INPUT_FILE_NAME,
+} from "./snapshots-utils";
+
+describe(`The language server diagnostics capability`, () => {
+  // The test files are in the source dir, not lib
+  const snapshotTestsDir = toSourcesTestDir(__dirname);
+  const klawItems = klawSync(snapshotTestsDir, { nodir: true });
+  const inputFiles = filter(klawItems, (item) => {
+    return item.path.endsWith(INPUT_FILE_NAME);
+  });
+  const testDirs = map(inputFiles, (_) => dirname(_.path));
+
+  forEach(testDirs, (dirPath) => {
+    const dirName = basename(dirPath);
+
+    // UNCOMMENT THE LINES BELOW AND CHANGE onlyTestDirName TO ONLY RUN A SPECIFIC SNAPSHOT TEST
+    // const onlyTestDirName = "my-test-dir";
+    // if (dirName !== onlyTestDirName) {
+    //   return;
+    // }
+
+    it(`Can create diagnostic for ${dirName.replace(/-/g, " ")} (${relative(
+      snapshotTestsDir,
+      dirPath
+    )})`, async () => {
+      await snapshotTestLSPDiagnostic(dirPath);
+    });
+  });
+});

packages/language-server/test/snapshots/xml-view-diagnostics/snapshots-utils.ts

@@ -1,4 +1,4 @@
-import { resolve, sep } from "path";
+import { resolve, sep, relative, dirname } from "path";
 import { Diagnostic, Range } from "vscode-languageserver-types";
 import { TextDocument } from "vscode-languageserver";
 import { readJsonSync, readFileSync } from "fs-extra";
@@ -14,38 +14,76 @@ export const OUTPUT_LSP_RESPONSE_FILE_NAME = "output-lsp-response.json";
 export async function snapshotTestLSPDiagnostic(
   testDir: string
 ): Promise<void> {
+  const pkgJsonPath = require.resolve(
+    "@ui5-language-assistant/language-server/package.json"
+  );
+  const languageServerDir = dirname(pkgJsonPath);
+  // This is the project root directory
+  const rootDir = resolve(languageServerDir, "..", "..");
+
+  // Note: the original `input.xml` snippet acts as **both**:
+  //   - The sample input.
+  //   - A snapshot for marker ranges.
+  const originalXMLSnippet = readInputXMLSnippet(testDir, false);
   const diagnosticsSnapshots = readSnapshotDiagnosticsLSPResponse(testDir);
+
+  // Check consistency of the ranges between the input xml and the snapshot response
+  // (for example, if one of them was changed manually)
+  const snapshotRanges = map(diagnosticsSnapshots, (_) => _.range);
+  const snapshotXMLWithMarkedRanges = computeXMLWithMarkedRanges(
+    testDir,
+    snapshotRanges
+  );
+
+  expect(
+    originalXMLSnippet,
+    `The XML input snippet range markers don't match the snapshot response ranges. Did you forget to run "yarn update-snapshots"?
+     Input xml is at: ${relative(rootDir, getInputXMLSnippetPath(testDir))}
+     Snapshot response is at: ${relative(
+       rootDir,
+       getSnapshotDiagnosticsLSPResponsePath(testDir)
+     )}`
+  ).to.equal(snapshotXMLWithMarkedRanges);
+
   const newlyComputedDiagnostics = await computeNewDiagnosticLSPResponse(
     testDir
   );
   expect(
     newlyComputedDiagnostics,
-    "Snapshot Mismatch in LSP Diagnostics response"
+    `Snapshot Mismatch in LSP Diagnostics response. 
+     Snapshot is at: ${relative(
+       rootDir,
+       getSnapshotDiagnosticsLSPResponsePath(testDir)
+     )}`
   ).to.deep.equal(diagnosticsSnapshots);
 
   const newlyCommutedRanges = map(newlyComputedDiagnostics, (_) => _.range);
   const newlyComputedXMLWithMarkedRanges = computeXMLWithMarkedRanges(
     testDir,
     newlyCommutedRanges
   );
-  // Note the original `input.xml` snippet acts as **both**:
-  //   - The sample input.
-  //   - A snapshot for marker ranges.
-  const originalXMLSnippet = readInputXMLSnippet(testDir, false);
+
   expect(
     originalXMLSnippet,
-    "The XML input snippet range markers are incorrect"
+    `The XML input snippet range markers are incorrect. 
+     Snapshot is at: ${relative(rootDir, getInputXMLSnippetPath(testDir))}`
   ).to.equal(newlyComputedXMLWithMarkedRanges);
 }
 
-export function readSnapshotDiagnosticsLSPResponse(
-  testDir: string
-): Diagnostic[] {
-  const sourcesTestDir = toSourcesTestDir(testDir);
-  const lspResponsePath = resolve(
+export function getSnapshotDiagnosticsLSPResponsePath(
+  sourcesTestDir: string
+): string {
+  const snapshotResponsePath = resolve(
     sourcesTestDir,
     OUTPUT_LSP_RESPONSE_FILE_NAME
   );
+  return snapshotResponsePath;
+}
+
+export function readSnapshotDiagnosticsLSPResponse(
+  sourcesTestDir: string
+): Diagnostic[] {
+  const lspResponsePath = getSnapshotDiagnosticsLSPResponsePath(sourcesTestDir);
   const expectedDiagnostics = readJsonSync(lspResponsePath);
   return expectedDiagnostics;
 }
@@ -108,8 +146,7 @@ export function computeXMLWithMarkedRanges(
   return xmlSnippetWithRangeMarkers;
 }
 
-export function getInputXMLSnippetPath(testDir: string): string {
-  const sourcesTestDir = toSourcesTestDir(testDir);
+export function getInputXMLSnippetPath(sourcesTestDir: string): string {
   const inputXMLSnippetPath = resolve(sourcesTestDir, INPUT_FILE_NAME);
   return inputXMLSnippetPath;
 }
@@ -127,7 +164,7 @@ function readInputXMLSnippet(
   return xmlOriginalContent;
 }
 
-function toSourcesTestDir(libTestDir: string): string {
+export function toSourcesTestDir(libTestDir: string): string {
   // replace TypeScript output dir (lib) with the corresponding sources (test) dir.
   return libTestDir.replace(sep + "lib", "");
 }