test(client): setup e2e tests for diagnostics

publicodes · Jun 14, 2024 · 0e714ce · 0e714ce
1 parent c05939e
commit 0e714ce
Show file tree

Hide file tree

Showing 13 changed files with 395 additions and 105 deletions.
diff --git a/client/package.json b/client/package.json
@@ -17,6 +17,7 @@
   },
   "devDependencies": {
     "@types/vscode": "^1.75.1",
-    "@vscode/test-electron": "^2.2.3"
+    "@vscode/test-electron": "^2.2.3",
+    "glob": "^10.4.1"
   }
 }
diff --git a/client/src/test/completion.test.ts b/client/src/test/completion.test.ts
@@ -7,37 +7,37 @@ import * as vscode from "vscode";
 import * as assert from "assert";
 import { getDocUri, activate } from "./helper";
 
-suite("Should do completion", () => {
-  const docUri = getDocUri("completion.txt");
-
-  test("Completes JS/TS in txt file", async () => {
-    await testCompletion(docUri, new vscode.Position(0, 0), {
-      items: [
-        { label: "JavaScript", kind: vscode.CompletionItemKind.Text },
-        { label: "TypeScript", kind: vscode.CompletionItemKind.Text },
-      ],
-    });
-  });
-});
-
-async function testCompletion(
-  docUri: vscode.Uri,
-  position: vscode.Position,
-  expectedCompletionList: vscode.CompletionList,
-) {
-  await activate(docUri);
-
-  // Executing the command `vscode.executeCompletionItemProvider` to simulate triggering completion
-  const actualCompletionList = (await vscode.commands.executeCommand(
-    "vscode.executeCompletionItemProvider",
-    docUri,
-    position,
-  )) as vscode.CompletionList;
-
-  assert.ok(actualCompletionList.items.length >= 2);
-  expectedCompletionList.items.forEach((expectedItem, i) => {
-    const actualItem = actualCompletionList.items[i];
-    assert.equal(actualItem.label, expectedItem.label);
-    assert.equal(actualItem.kind, expectedItem.kind);
-  });
-}
+// suite("Should do completion", () => {
+//   const docUri = getDocUri("completion.txt");
+//
+//   test("Completes JS/TS in txt file", async () => {
+//     await testCompletion(docUri, new vscode.Position(0, 0), {
+//       items: [
+//         { label: "JavaScript", kind: vscode.CompletionItemKind.Text },
+//         { label: "TypeScript", kind: vscode.CompletionItemKind.Text },
+//       ],
+//     });
+//   });
+// });
+//
+// async function testCompletion(
+//   docUri: vscode.Uri,
+//   position: vscode.Position,
+//   expectedCompletionList: vscode.CompletionList,
+// ) {
+//   await activate(docUri);
+//
+//   // Executing the command `vscode.executeCompletionItemProvider` to simulate triggering completion
+//   const actualCompletionList = (await vscode.commands.executeCommand(
+//     "vscode.executeCompletionItemProvider",
+//     docUri,
+//     position,
+//   )) as vscode.CompletionList;
+//
+//   assert.ok(actualCompletionList.items.length >= 2);
+//   expectedCompletionList.items.forEach((expectedItem, i) => {
+//     const actualItem = actualCompletionList.items[i];
+//     assert.equal(actualItem.label, expectedItem.label);
+//     assert.equal(actualItem.kind, expectedItem.kind);
+//   });
+// }
diff --git a/client/src/test/diagnostics.test.ts b/client/src/test/diagnostics.test.ts
@@ -1,34 +1,58 @@
-/* --------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
-
 import * as vscode from "vscode";
 import * as assert from "assert";
-import { getDocUri, activate } from "./helper";
+import { getDocUri, activate, mainUri, mainPath } from "./helper";
 
-suite("Should get diagnostics", () => {
-  const docUri = getDocUri("diagnostics.txt");
+/**
+ * End-to-end test suite for diagnostics.
+ *
+ * How it works:
+ * 1. Start a vscode instance.
+ * 2. Activate the 'publicodes-language-server' extension in the instance.
+ * 3. Open the main document (main.publicodes).
+ * 4. For each test:
+ *   a. copy the content of the test document to the main document,
+ *   b. save the main document and wait for the diagnostics to be computed.
+ */
 
-  test("Diagnoses uppercase texts", async () => {
-    await testDiagnostics(docUri, [
-      {
-        message: "ANY is all uppercase.",
-        range: toRange(0, 0, 0, 3),
-        severity: vscode.DiagnosticSeverity.Warning,
-        source: "ex",
-      },
+suite("Should get diagnostics", () => {
+  test("Missing name in import macros", async () => {
+    await testDiagnostics(getDocUri("diagnostics-import.publicodes"), [
       {
-        message: "ANY is all uppercase.",
-        range: toRange(0, 14, 0, 17),
-        severity: vscode.DiagnosticSeverity.Warning,
-        source: "ex",
+        message: `[ Erreur dans la macro 'importer!' ]
+Le nom du package est manquant dans la macro 'importer!' dans le fichier: ${mainPath}.
+
+[ Solution ]
+Ajoutez le nom du package dans la macro 'importer!'.
+
+[ Exemple ]
+importer!:
+  depuis:
+    nom: package-name
+  les règles:
+    - ruleA
+    - ruleB
+    ...
+`,
+        range: toRange(0, 0, 0, 9),
+        severity: vscode.DiagnosticSeverity.Error,
+        source: "publicodes",
       },
+    ]);
+  });
+
+  test("Malformed expression", async () => {
+    await testDiagnostics(getDocUri("diagnostics-expressions.publicodes"), [
       {
-        message: "OS is all uppercase.",
-        range: toRange(0, 18, 0, 20),
-        severity: vscode.DiagnosticSeverity.Warning,
-        source: "ex",
+        message: `[ InternalError ]
+➡️  Dans la règle "logement . électricité . photovoltaique"
+✖️  
+Un problème est survenu lors du parsing de l'expression \`autoconsommation + production +\` :
+
+	le parseur Nearley n'a pas réussi à parser l'expression.
+`,
+        range: toRange(0, 0, 0, 39),
+        severity: vscode.DiagnosticSeverity.Error,
+        source: "publicodes",
       },
     ]);
   });
@@ -46,7 +70,7 @@ async function testDiagnostics(
 ) {
   await activate(docUri);
 
-  const actualDiagnostics = vscode.languages.getDiagnostics(docUri);
+  const actualDiagnostics = vscode.languages.getDiagnostics(mainUri);
 
   assert.equal(actualDiagnostics.length, expectedDiagnostics.length);
 

diff --git a/client/src/test/helper.ts b/client/src/test/helper.ts
@@ -1,8 +1,3 @@
-/* --------------------------------------------------------------------------------------------
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
-
 import * as vscode from "vscode";
 import * as path from "path";
 
@@ -11,20 +6,28 @@ export let editor: vscode.TextEditor;
 export let documentEol: string;
 export let platformEol: string;
 
-/**
- * Activates the vscode.lsp-sample extension
- */
+export async function initialize() {
+  doc = await vscode.workspace.openTextDocument(mainUri);
+  editor = await vscode.window.showTextDocument(doc);
+}
+
 export async function activate(docUri: vscode.Uri) {
   // The extensionId is `publisher.name` from package.json
-  const ext = vscode.extensions.getExtension("vscode-samples.lsp-sample")!;
-  await ext.activate();
-  try {
-    doc = await vscode.workspace.openTextDocument(docUri);
-    editor = await vscode.window.showTextDocument(doc);
-    await sleep(2000); // Wait for server activation
-  } catch (e) {
-    console.error(e);
+  const ext = vscode.extensions.getExtension(
+    "EmileRolley.publicodes-language-server",
+  )!;
+  if (!ext.isActive) {
+    await ext.activate();
+    try {
+      await initialize();
+    } catch (e) {
+      console.error(e);
+    }
   }
+  const content = await vscode.workspace.fs.readFile(docUri);
+  await setTestContent(content.toString());
+  await vscode.workspace.saveAll();
+  await sleep(500); // Wait for server activation
 }
 
 async function sleep(ms: number) {
@@ -34,10 +37,14 @@ async function sleep(ms: number) {
 export const getDocPath = (p: string) => {
   return path.resolve(__dirname, "../../testFixture", p);
 };
+
 export const getDocUri = (p: string) => {
   return vscode.Uri.file(getDocPath(p));
 };
 
+export const mainPath = "main.publicodes";
+export const mainUri = getDocUri(mainPath);
+
 export async function setTestContent(content: string): Promise<boolean> {
   const all = new vscode.Range(
     doc.positionAt(0),

diff --git a/client/src/test/index.ts b/client/src/test/index.ts
@@ -4,7 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 import * as path from "path";
 import Mocha from "mocha";
-import * as glob from "glob";
+import { glob } from "glob";
 
 export function run(): Promise<void> {
   // Create the mocha test
@@ -17,27 +17,25 @@ export function run(): Promise<void> {
   const testsRoot = __dirname;
 
   return new Promise((resolve, reject) => {
-    glob("**.test.js", { cwd: testsRoot }, (err, files) => {
-      if (err) {
-        return reject(err);
-      }
+    glob("**.test.js", { cwd: testsRoot })
+      .then((files) => {
+        // Add files to the test suite
+        files.forEach((f) => mocha.addFile(path.resolve(testsRoot, f)));
 
-      // Add files to the test suite
-      files.forEach((f) => mocha.addFile(path.resolve(testsRoot, f)));
-
-      try {
-        // Run the mocha test
-        mocha.run((failures) => {
-          if (failures > 0) {
-            reject(new Error(`${failures} tests failed.`));
-          } else {
-            resolve();
-          }
-        });
-      } catch (err) {
-        console.error(err);
-        reject(err);
-      }
-    });
+        try {
+          // Run the mocha test
+          mocha.run((failures) => {
+            if (failures > 0) {
+              reject(new Error(`${failures} tests failed.`));
+            } else {
+              resolve();
+            }
+          });
+        } catch (err) {
+          console.error(err);
+          reject(err);
+        }
+      })
+      .catch(reject);
   });
 }
diff --git a/client/testFixture/diagnostics-expressions.publicodes b/client/testFixture/diagnostics-expressions.publicodes
@@ -0,0 +1,5 @@
+logement . électricité . photovoltaique:
+  titre: Panneaux photovoltaïques
+  formule:
+    somme:
+      - autoconsommation + production +
diff --git a/client/testFixture/diagnostics-import.publicodes b/client/testFixture/diagnostics-import.publicodes
@@ -0,0 +1,11 @@
+importer!:
+  depuis:
+    # nom: '@incubateur-ademe/publicodes-commun'
+    url: https://github.com/incubateur-ademe/publicodes-commun
+  dans: commun
+  les règles:
+    - intensité électricité
+    - mois par an
+    - semaines par an
+    - jours par semaine
+    - jours par an
diff --git a/client/testFixture/diagnostics.txt b/client/testFixture/diagnostics.txt
diff --git a/client/testFixture/main.publicodes b/client/testFixture/main.publicodes
@@ -0,0 +1,5 @@
+logement . électricité . photovoltaique:
+  titre: Panneaux photovoltaïques
+  formule:
+    somme:
+      - autoconsommation + production +
diff --git a/client/tsconfig.json b/client/tsconfig.json
@@ -3,13 +3,20 @@
     "module": "nodenext",
     "target": "es2021",
     "esModuleInterop": true,
-    "lib": ["es2021"],
+    "lib": [
+      "es2021"
+    ],
     "outDir": "out",
     "rootDir": "src",
     "sourceMap": true,
     "composite": true,
     "incremental": true
   },
-  "include": ["src"],
-  "exclude": ["node_modules", ".vscode-test"]
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    ".vscode-test"
+  ]
 }