@digigov/cli-e2e 1.1.0-rc.21 → 2.0.0-298cfc51

package/.rush/temp/shrinkwrap-deps.json

@@ -1,9 +1,10 @@
 {
-  "../../tooling/cli-e2e": "../../tooling/cli-e2e:wyt3w7P/5nmzluUEI15XRq+KGT4JsMSOeZlq+D3tffk=:",
-  "/@playwright/experimental-ct-react@1.41.0(@types/node@18.19.0)(lightningcss@1.22.0)(terser@5.33.0)(vite@4.5.5(@types/node@18.19.0)(lightningcss@1.22.0)(terser@5.33.0))": "Missing shrinkwrap entry!",
+  "../../tooling/cli-e2e": "../../tooling/cli-e2e:7FHeJodyR5vWvAUHQMH4I4T4RwQC6k2u3KHUsQR9JGg=:",
+  "/@playwright/experimental-ct-react@1.41.0(@types/node@22.7.5)(lightningcss@1.22.0)(terser@5.33.0)(vite@5.4.11(@types/node@22.7.5)(lightningcss@1.22.0)(sass-embedded@1.81.0)(terser@5.33.0))": "Missing shrinkwrap entry!",
   "/@playwright/test@1.41.0": "Missing shrinkwrap entry!",
-  "/autoprefixer@10.4.16(postcss@8.4.47)": "Missing shrinkwrap entry!",
-  "/execa@5.0.0": "Missing shrinkwrap entry!",
+  "/autoprefixer@10.4.16(postcss@8.4.49)": "Missing shrinkwrap entry!",
+  "/execa@8.0.1": "Missing shrinkwrap entry!",
   "/playwright-core@1.41.0": "Missing shrinkwrap entry!",
-  "/tailwindcss@3.3.5(ts-node@10.9.2(@types/node@18.19.0)(typescript@5.6.2))": "Missing shrinkwrap entry!"
+  "/publint@0.1.8": "Missing shrinkwrap entry!",
+  "/tailwindcss@3.4.13(ts-node@10.9.2(@types/node@22.7.5)(typescript@5.6.2))": "Missing shrinkwrap entry!"
 }

package/index.js

@@ -1,71 +1,143 @@
-const execa = require('execa');
-const fs = require('fs');
-const path = require('path');
-const {resolveProject, DigigovCommand} = require('@digigov/cli/lib');
-const {spawn} = require('child_process');
-
-module.exports = class E2E extends DigigovCommand {
-  static description = 'e2e digigov projects';
-  static id = 'e2e';
-  dirname = __dirname;
-  static examples = [
-    `$ digigov e2e`,
-  ];
-  static strict = false;
+import fs from "fs";
+import path from "path";
+import { logger, resolveProject, DigigovCommand } from "@digigov/cli/lib";
+import { execa } from "execa";
 
-  static load() {return E2E;}
-  async run() {
-    let playwrightConfigFile = '';
-    const {argv} = this.parse(E2E);
-    const project = resolveProject();
+const command = new DigigovCommand("e2e", import.meta.url);
 
-    if(fs.existsSync(path.join(project.root, 'playwright.config.ts'))) {
-      playwrightConfigFile = 'playwright.config.ts';
-    }
+command
+  .argument("[args...]", "arguments to pass to playwright")
+  .helpOption(false)
+  .allowUnknownOption()
+  .action(runE2e);
 
-    if(fs.existsSync(path.join(project.root, 'playwright-ct.config.ts'))) {
-      playwrightConfigFile = 'playwright-ct.config.ts';
-    }
+export default command;
 
-    if(playwrightConfigFile === '') {
-      throw new Error('The playwright config doesn\'t exist in the project folder.');
-    }
+/**
+ * Run Playwright tests
+ * @param {string[]} args
+ * @param {Record<string, unknown>} options
+ * @param {DigigovCommand} ctx
+ */
+async function runE2e(args, options, ctx) {
+  /** @type {string | null} */
+  const project = resolveProject();
+  let playwrightConfig = getPlaywrightConfig(project.root);
 
-    const relativeProjectPath = project.root.replace(project.workspace.config.rushJsonFolder, '');
-    const dockerCommand = [
-      'run', '--net=host', '--rm', '--init', '-it',
-      'mcr.microsoft.com/playwright:v1.41.0-jammy',
-      '/bin/sh', '-c',
-      'cd /home/pwuser && npx -y playwright@1.41.0 run-server --port 54380 --host 0.0.0.0 '
-    ];
-    const proc = spawn('docker', dockerCommand, {stdio: ['inherit', 'pipe', 'ignore']});
-    await new Promise((resolve, reject) => {
-      proc.stdout.on('data', (data) => {
-        const output = data.toString();
-        if(output.includes('Listening on')) {
-          resolve();
-        }
-      });
-      proc.on('error', (error) => {
-        console.error('Failed to start the Playwright server:', error);
-        reject(error);
-      });
-    });
+  if (!playwrightConfig) {
+    throw new Error("No playwright config found in project folder");
+  }
+
+  logger.debug(`Found playwright config file: ${playwrightConfig}`);
 
-    console.clear();
-    const playwrightProc = execa(`${project.workspace.config.rushJsonFolder}${relativeProjectPath}/node_modules/.bin/playwright`, [`test`, `-c`, `${playwrightConfigFile}`, ...argv], {
-      stdio: ['inherit', 'inherit', 'inherit'],
-      env: {
-        PW_TEST_CONNECT_WS_ENDPOINT: 'ws://127.0.0.1:54380/'
+  const dockerCommand = [
+    "run",
+    "--net=host",
+    "--rm",
+    "--init",
+    "-it",
+    "mcr.microsoft.com/playwright:v1.41.0-jammy",
+    "/bin/sh",
+    "-c",
+    "cd /home/pwuser && npx -y playwright@1.41.0 run-server --port 54380 --host 0.0.0.0 ",
+  ];
+
+  logger.debug(
+    "Starting docker container with command: ",
+    "docker",
+    dockerCommand.join(" "),
+  );
+  const docker = execa("docker", dockerCommand, {
+    stdin: "inherit",
+    stdout: "pipe",
+    stderr: "pipe",
+  });
+
+  logger.debug("Docker container pid:", docker.pid);
+
+  await new Promise((resolve, reject) => {
+    docker.on("message", (message) => {
+      logger.debug("Docker message:", message);
+    });
+    docker.stdout.on("data", (data) => {
+      const output = data.toString();
+      logger.debug("Docker stdout:", output);
+      if (output.includes("Listening on")) {
+        resolve();
       }
     });
+    docker.stderr.on("data", (data) => {
+      const errorOutput = data.toString();
+      logger.error("Docker stderr:", errorOutput);
+    });
+    docker.on("error", (error) => {
+      logger.error("Failed to start the docker container:", error);
+      reject(error);
+    });
+    docker.on("close", (code) => {
+      if (code !== 0) {
+        const msg = `Docker process exited with code ${code}`;
+        logger.error(msg);
+        reject(new Error(msg));
+      }
+    });
+  });
+
+  // if (!options["debug"]) console.clear();
+
+  logger.debug("Starting Playwright tests");
+  try {
+    const playwright = ctx.exec(
+      `playwright`,
+      [`test`, `-c`, playwrightConfig, ...args],
+      {
+        stdio: ["inherit", "inherit", "inherit"],
+        env: {
+          PW_TEST_CONNECT_WS_ENDPOINT: "ws://127.0.0.1:54380/",
+        },
+      },
+    );
+
+    process.on("SIGINT", () => {
+      logger.debug("Received SIGINT, terminating processes...");
+      docker.kill("SIGINT");
+      process.exit(0);
+    });
 
-    proc.on('exit', (code) => {
-      playwrightProc.kill('SIGINT');
-      
+    process.on("SIGTERM", () => {
+      logger.debug("Received SIGTERM, terminating processes...");
+      docker.kill("SIGTERM");
+      process.exit(0);
     });
-    playwrightProc.on('exit', (code) => {
-      process.kill(0);
+    docker.on("exit", () => {
+      logger.debug("Docker process exited");
+      playwright.kill("SIGINT");
+      process.exit(1);
     });
+    playwright.on("exit", () => process.exit(0));
+  } catch (error) {
+    logger.error("Playwright process failed:", error);
+    docker.kill("SIGINT");
+    process.exit(1);
+  }
+}
+
+const EXTENSIONS = [".mts", ".mjs", ".ts", ".js"];
+const FILE_NAMES = ["playwright.config", "playwright-ct.config"];
+
+/**
+ * Get the Playwright config file
+ * @param {string} projectRoot
+ * @returns {string | null} The path to the playwright config file
+ */
+function getPlaywrightConfig(projectRoot) {
+  for (const ext of EXTENSIONS) {
+    for (const name of FILE_NAMES) {
+      const playwrightConfig = path.join(projectRoot, `${name}${ext}`);
+      if (fs.existsSync(playwrightConfig)) {
+        return playwrightConfig;
+      }
+    }
   }
-};
+  return null;
+}

package/package.json

@@ -1,22 +1,30 @@
 {
   "name": "@digigov/cli-e2e",
-  "version": "1.1.0-rc.21",
-  "description": "",
+  "version": "2.0.0-298cfc51",
+  "description": "E2E test plugin for Digigov CLI",
+  "author": "GRNET Devs <devs@lists.grnet.gr>",
+  "license": "BSD-2-Clause",
   "main": "index.js",
+  "type": "module",
   "dependencies": {
-    "execa": "5.0.0"
+    "execa": "8.0.1"
+  },
+  "devDependencies": {
+    "publint": "0.1.8"
   },
   "peerDependencies": {
-    "@digigov/cli": "1.1.1-rc.21",
+    "@digigov/cli": "2.0.0-298cfc51",
     "@playwright/experimental-ct-react": "1.41.0",
     "@playwright/test": "1.41.0",
     "playwright-core": "1.41.0",
     "autoprefixer": "10.4.16",
-    "tailwindcss": "3.3.5"
+    "tailwindcss": "3.4.13"
+  },
+  "exports": {
+    ".": "./index.js",
+    "./playwright-ct.config": "./playwright-ct.config.js"
   },
-  "author": "",
-  "license": "ISC",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "publint": "publint"
   }
 }

package/playwright-ct.config.js

@@ -0,0 +1,111 @@
+import { devices, defineConfig } from "@playwright/experimental-ct-react";
+import { resolveProject } from "@digigov/cli/lib";
+import fs from "fs";
+import path from "path";
+import assert from "node:assert";
+import { createRequire } from "module";
+
+const require = createRequire(import.meta.url);
+
+const alias = {};
+const IS_DOCKER = process.env["IS_DOCKER"] ?? false;
+const WORKERS = parseInt(process.env["TEST_E2E_WORKERS"] ?? "4");
+assert(
+  WORKERS > 0,
+  "TEST_E2E_WORKERS should be a positive integer, was '" +
+    process.env["TEST_E2E_WORKERS"] +
+    "'",
+);
+const project = resolveProject();
+const postcss = fs.existsSync(path.join(project.root, "tailwind.config.js"))
+  ? {
+      plugins: [
+        require("tailwindcss")(
+          require(path.join(project.root, "tailwind.config.js")),
+        ),
+        require("autoprefixer"),
+      ],
+    }
+  : {};
+const EXCLUDE_ALIAS = ["@digigov/css"];
+if (project.src) {
+  alias[project.name] = path.join(project.root, "src");
+} else {
+  alias[project.name] = project.root;
+}
+Object.keys(project.dependencies).forEach((dep) => {
+  if (dep.match(/^(@digigov|@uides)/) && !EXCLUDE_ALIAS.includes(dep)) {
+    if (
+      fs.existsSync(`${path.join(project.root, "node_modules", dep, "src")}`)
+    ) {
+      alias[dep] = path.join(project.root, "node_modules", dep, "src");
+    }
+  }
+});
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ *
+ * @type {import('@playwright/experimental-ct-react').PlaywrightTestConfig}
+ */
+const config = defineConfig({
+  testDir: "./",
+  snapshotPathTemplate:
+    "{testFileDir}/__screenshots__/{projectName}-{arg}{ext}",
+  testMatch: "**/*.test.tsx",
+  testIgnore: [
+    "*src/govgr",
+    "*dist/**/*.test.*",
+    "**/*.spec.*",
+    "__snapshots__",
+    "__stories__",
+    "__mocks__",
+    "__tests__",
+    "__fixtures__",
+  ],
+  /* The base directory, relative to the config file, for snapshot files created with toMatchSnapshot and toHaveScreenshot. */
+  snapshotDir: "./__snapshots__",
+  /* Maximum time one test can run for. */
+  timeout: 10 * 1000,
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 3 : 0,
+  /* Number of worker threads, ie tests that run in parallel. */
+  workers: 1,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [["list"], ["html", { open: "never" }]],
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+
+    /* Port to use for Playwright component endpoint. */
+    ctPort: 3100,
+    ctViteConfig: {
+      resolve: {
+        alias,
+      },
+      css: {
+        postcss,
+      },
+    },
+  },
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "desktop",
+      use: {
+        ...devices["Desktop Chrome"],
+      },
+    },
+    {
+      name: "mobile",
+      use: {
+        ...devices["Galaxy S8"],
+      },
+    },
+  ],
+});
+export default config;

package/playwright-ct.config.ts

@@ -1,85 +0,0 @@
-import type { PlaywrightTestConfig } from '@playwright/experimental-ct-react';
-import { devices, defineConfig } from '@playwright/experimental-ct-react';
-import { resolveProject } from '@digigov/cli/resolveProject';
-import fs from 'fs';
-import path from 'path';
-import assert from 'node:assert';
-const alias = {}
-const IS_DOCKER = process.env['IS_DOCKER'] ?? false;
-const WORKERS = parseInt(process.env['TEST_E2E_WORKERS'] ?? '4');
-assert(WORKERS > 0, "TEST_E2E_WORKERS should be a positive integer, was '" + process.env['TEST_E2E_WORKERS'] +"'");
-const project = resolveProject();
-const postcss = fs.existsSync(path.join(project.root, 'tailwind.config.js')) ? {
-  plugins: [
-    require('tailwindcss')(require(path.join(project.root, 'tailwind.config.js'))),
-    require('autoprefixer'),
-  ]
-} : {}
-const EXCLUDE_ALIAS = ['@digigov/css']
-if(project.src){
-  alias[project.name] = path.join(project.root,'src')
-}else{
-  alias[project.name] = project.root
-}
-Object.keys(project.dependencies).forEach((dep) => {
-  if (dep.match(/^(@digigov|@uides)/) && !EXCLUDE_ALIAS.includes(dep)) {
-    if (fs.existsSync(`${path.join(project.root, 'node_modules', dep, 'src')}`)) {
-      alias[dep] = path.join(project.root, 'node_modules', dep, 'src')
-    }
-  }
-})
-/**
- * See https://playwright.dev/docs/test-configuration.
- */
-const config: PlaywrightTestConfig = defineConfig({
-  testDir: './',
-  snapshotPathTemplate: '{testFileDir}/__screenshots__/{projectName}-{arg}{ext}',
-  testMatch: '**/*.test.tsx',
-  testIgnore: ['*src/govgr', '*dist/**/*.test.*','**/*.spec.*', '__snapshots__', '__stories__', '__mocks__', '__tests__', '__fixtures__'],
-  /* The base directory, relative to the config file, for snapshot files created with toMatchSnapshot and toHaveScreenshot. */
-  snapshotDir: './__snapshots__',
-  /* Maximum time one test can run for. */
-  timeout: 10 * 1000,
-  /* Run tests in files in parallel */
-  fullyParallel: true,
-  /* Fail the build on CI if you accidentally left test.only in the source code. */
-  forbidOnly: !!process.env.CI,
-  /* Retry on CI only */
-  retries: process.env.CI ? 3 : 0,
-  /* Number of worker threads, ie tests that run in parallel. */
-  workers: 1,
-  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: [['list'], ['html', { open: 'never' }]],
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-  use: {
-    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-    trace: 'on-first-retry',
-
-    /* Port to use for Playwright component endpoint. */
-    ctPort: 3100,
-    ctViteConfig: {
-      resolve: {
-        alias
-      },
-      css: {
-        postcss
-      }
-    }
-  },
-  /* Configure projects for major browsers */
-  projects: [
-    {
-      name: 'desktop',
-      use: {
-        ...devices['Desktop Chrome'],
-      },
-    },
-    {
-      name: 'mobile',
-      use: {
-        ...devices['Galaxy S8'],
-      },
-    },
-  ],
-});
-export default config;