Basic e2e tests (#163)

common/config/rush/command-line.json

@@ -53,6 +53,13 @@
       "name": "dogfood",
       "summary": "(CUSTOM) Globally installs local builds of @cadl-lang/compiler and cadl-vscode.",
       "shellCommand": "node eng/scripts/dogfood.js"
+    },
+    {
+      "commandKind": "global",
+      "safeForSimultaneousRushProcesses": true,
+      "name": "e2e",
+      "summary": "(CUSTOM) Runs the e2e tests",
+      "shellCommand": "node e2e/e2e-tests.js"
     }
   ],
   /**

e2e/.gitignore

@@ -0,0 +1,8 @@
+# In this test we always want to get the latest published cadl libraries for test.
+basic-latest/package-lock.json
+
+# This test is generated on the fly.
+basic-current/package.json
+basic-current/package-lock.json
+
+

e2e/basic-current/main.cadl

@@ -0,0 +1,2 @@
+import "@cadl-lang/rest";
+import "@cadl-lang/openapi3";

e2e/basic-latest/main.cadl

@@ -0,0 +1,2 @@
+import "@cadl-lang/rest";
+import "@cadl-lang/openapi3";

e2e/basic-latest/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "basic-latest",
+  "dependencies": {
+    "@cadl-lang/compiler": "latest",
+    "@cadl-lang/rest": "latest",
+    "@cadl-lang/openapi3": "latest"
+  },
+  "private": true
+}

e2e/e2e-tests.js

@@ -0,0 +1,95 @@
+// @ts-check
+import { repoRoot, run } from "../eng/scripts/helpers.js";
+import { join } from "path";
+import { existsSync, readdirSync, rmSync, writeFileSync } from "fs";
+
+const e2eTestDir = join(repoRoot, "e2e");
+const npxCmd = process.platform === "win32" ? "npx.cmd" : "npx";
+
+function main() {
+  const packages = packPackages();
+  testBasicLatest(packages);
+  testBasicCurrentTgz(packages);
+}
+main();
+
+function packPackages() {
+  run("rush", ["publish", "--publish", "--pack", "--include-all"]);
+  const outputFolder = join(repoRoot, "common/temp/artifacts/packages");
+  const files = readdirSync(outputFolder);
+  console.log("Built packages:", files);
+
+  function resolvePackage(start) {
+    return join(
+      outputFolder,
+      files.find((x) => x.startsWith(start))
+    );
+  }
+
+  return {
+    "@cadl-lang/compiler": resolvePackage("cadl-lang-compiler-"),
+    "@cadl-lang/openapi3": resolvePackage("cadl-lang-openapi3-"),
+    "@cadl-lang/rest": resolvePackage("cadl-lang-rest-"),
+  };
+}
+
+function runCadl(compilerTgz, args, options) {
+  run(npxCmd, ["-p", compilerTgz, "cadl", ...args], { ...options });
+}
+
+function testBasicLatest(packages) {
+  const basicLatestDir = join(e2eTestDir, "basic-latest");
+  const outputDir = join(basicLatestDir, "cadl-output");
+  console.log("Clearing basic-latest output");
+  rmSync(outputDir, { recursive: true, force: true });
+  console.log("Cleared basic-latest output");
+
+  console.log("Installing basic-latest dependencies");
+  runCadl(packages["@cadl-lang/compiler"], ["install"], { cwd: basicLatestDir });
+  console.log("Installed basic-latest dependencies");
+
+  console.log("Running cadl compile .");
+  runCadl(packages["@cadl-lang/compiler"], ["compile", "."], { cwd: basicLatestDir });
+  console.log("Completed cadl compile .");
+
+  if (existsSync(join(outputDir, "openapi.json"))) {
+    console.log("Output created successfully.");
+  } else {
+    throw new Error("Test basic latest failed to produce output openapi.json");
+  }
+}
+
+function testBasicCurrentTgz(packages) {
+  const basicCurrentDir = join(e2eTestDir, "basic-current");
+  const outputDir = join(basicCurrentDir, "cadl-output");
+  console.log("Clearing basic-current");
+  rmSync(outputDir, { recursive: true, force: true });
+  console.log("Cleared basic-current");
+
+  console.log("Generating package.json for basic-current");
+  const packageJson = {
+    name: "basic-latest",
+    dependencies: {
+      "@cadl-lang/compiler": packages["@cadl-lang/compiler"],
+      "@cadl-lang/rest": packages["@cadl-lang/rest"],
+      "@cadl-lang/openapi3": packages["@cadl-lang/openapi3"],
+    },
+    private: true,
+  };
+  writeFileSync(join(basicCurrentDir, "package.json"), JSON.stringify(packageJson, null, 2));
+  console.log("Generated package.json for basic-current");
+
+  console.log("Installing basic-latest dependencies");
+  runCadl(packages["@cadl-lang/compiler"], ["install"], { cwd: basicCurrentDir });
+  console.log("Installed basic-latest dependencies");
+
+  console.log("Running cadl compile .");
+  runCadl(packages["@cadl-lang/compiler"], ["compile", "."], { cwd: basicCurrentDir });
+  console.log("Completed cadl compile .");
+
+  if (existsSync(join(outputDir, "openapi.json"))) {
+    console.log("Output created successfully.");
+  } else {
+    throw new Error("Test basic latest failed to produce output openapi.json");
+  }
+}

e2e/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

eng/pipelines/pull-request-common.yml

@@ -32,3 +32,6 @@ steps:
 
   - script: node eng/scripts/check-for-changed-files.js
     displayName: Check Git Status For Changed Files
+
+  - script: node common/scripts/install-run-rush.js e2e
+    displayName: E2E Tests