chore(smoke-tests): move files into its own package (#6625)

kraenhansen · web-flow · commit 1d2c9764ff03 · 2025-01-17T14:35:58.000+01:00
* Add smoke-test package

* Move files and fix package

* Remove extraneous "undici-type" dep

* Update CI to use the new package
diff --git a/.evergreen/functions.yml b/.evergreen/functions.yml
@@ -687,7 +687,7 @@ functions:
           if [[ "$IS_OSX" == "true" ]]; then
             echo "Disabling clipboard usage in e2e tests (TODO: https://jira.mongodb.org/browse/BUILD-14780)"
             export COMPASS_E2E_DISABLE_CLIPBOARD_USAGE="true"
-            npm run --unsafe-perm --workspace compass-e2e-tests smoketest -- --package=osx_dmg
+            npm run --unsafe-perm --workspace @mongodb-js/compass-smoke-tests start -- --package=osx_dmg
             # TODO: osx_zip
           fi
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/compass-e2e-tests/.gitignore b/packages/compass-e2e-tests/.gitignore
@@ -4,7 +4,3 @@ fixtures/*.csv
 fixtures/*.json
 hadron-build-info.json
 
-# Ignoring sandboxes (created per test run)
-.smoke-sandboxes/
-# Cache of downloaded binaries
-.smoke-downloads/
diff --git a/packages/compass-e2e-tests/.prettierignore b/packages/compass-e2e-tests/.prettierignore
@@ -4,8 +4,3 @@ fixtures
 .nyc_output
 coverage
 hadron-build-info.json
-
-# Ignoring sandboxes (created per test run)
-.smoke-sandboxes/
-# Cache of downloaded binaries
-.smoke-downloads/
diff --git a/packages/compass-e2e-tests/package.json b/packages/compass-e2e-tests/package.json
@@ -73,7 +73,6 @@
     "semver": "^7.6.2",
     "tree-kill": "^1.2.2",
     "ts-node": "^10.9.1",
-    "undici-types": "^6",
     "webdriverio": "^9.4.1",
     "why-is-node-running": "^2.3.0",
     "xvfb-maybe": "^0.2.1",
diff --git a/packages/compass-smoke-tests/.depcheckrc b/packages/compass-smoke-tests/.depcheckrc
@@ -0,0 +1,3 @@
+ignores:
+ - '@mongodb-js/prettier-config-compass'
+ - '@mongodb-js/tsconfig-compass'
diff --git a/packages/compass-smoke-tests/.eslintignore b/packages/compass-smoke-tests/.eslintignore
@@ -0,0 +1,7 @@
+.nyc-output
+dist
+
+# Sandboxes (created per test run)
+.sandboxes/
+# Cache of downloaded files
+.downloads/
diff --git a/packages/compass-smoke-tests/.eslintrc.js b/packages/compass-smoke-tests/.eslintrc.js
@@ -0,0 +1,16 @@
+module.exports = {
+  root: true,
+  extends: ['@mongodb-js/eslint-config-compass'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      rules: {
+        'no-console': 0,
+      },
+    },
+  ],
+};
diff --git a/packages/compass-smoke-tests/.gitignore b/packages/compass-smoke-tests/.gitignore
@@ -0,0 +1,4 @@
+# Sandboxes (created per test run)
+.sandboxes/
+# Cache of downloaded files
+.downloads/
diff --git a/packages/compass-smoke-tests/.prettierignore b/packages/compass-smoke-tests/.prettierignore
@@ -0,0 +1,8 @@
+.nyc_output
+dist
+coverage
+
+# Sandboxes (created per test run)
+.sandboxes/
+# Cache of downloaded files
+.downloads/
diff --git a/packages/compass-smoke-tests/.prettierrc.json b/packages/compass-smoke-tests/.prettierrc.json
@@ -0,0 +1 @@
+"@mongodb-js/prettier-config-compass"
diff --git a/packages/compass-smoke-tests/package.json b/packages/compass-smoke-tests/package.json
@@ -0,0 +1,45 @@
+{
+  "name": "@mongodb-js/compass-smoke-tests",
+  "description": "Smoke test suite for Compass app installers",
+  "author": {
+    "name": "MongoDB Inc",
+    "email": "compass@mongodb.com"
+  },
+  "private": true,
+  "bugs": {
+    "url": "https://jira.mongodb.org/projects/COMPASS/issues",
+    "email": "compass@mongodb.com"
+  },
+  "homepage": "https://github.com/mongodb-js/compass",
+  "version": "1.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mongodb-js/compass.git"
+  },
+  "compass:exports": {},
+  "license": "SSPL",
+  "scripts": {
+    "start": "ts-node src/cli.ts",
+    "typecheck": "tsc -p tsconfig.json",
+    "eslint": "eslint",
+    "prettier": "prettier",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "depcheck": "compass-scripts check-peer-deps && depcheck",
+    "check": "npm run typecheck && npm run lint && npm run depcheck",
+    "check-ci": "npm run check",
+    "reformat": "npm run eslint . -- --fix && npm run prettier -- --write ."
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "@mongodb-js/eslint-config-compass": "^1.2.1",
+    "@mongodb-js/prettier-config-compass": "^1.1.1",
+    "@mongodb-js/tsconfig-compass": "^1.1.1",
+    "depcheck": "^1.4.1",
+    "eslint": "^7.25.0",
+    "hadron-build": "^25.6.1",
+    "lodash": "^4.17.21",
+    "prettier": "^2.7.1",
+    "typescript": "^5.0.4",
+    "yargs": "^17.7.2"
+  }
+}
diff --git a/packages/compass-smoke-tests/src/build-info.ts b/packages/compass-smoke-tests/src/build-info.ts
@@ -180,7 +180,7 @@ export function readPackageDetails(
 export function writeAndReadPackageDetails(
   context: SmokeTestsContext
 ): PackageDetails {
-  const compassDir = path.resolve(__dirname, '../../../compass');
+  const compassDir = path.resolve(__dirname, '../../compass');
   const infoArgs = {
     format: 'json',
     dir: compassDir,
diff --git a/packages/compass-smoke-tests/src/cli.ts b/packages/compass-smoke-tests/src/cli.ts
@@ -7,19 +7,16 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { pick } from 'lodash';
 import { installMacDMG } from './installers/mac-dmg';
-import { execute } from './installers/helpers';
+import { execute } from './execute';
 import {
   type PackageDetails,
   readPackageDetails,
   writeAndReadPackageDetails,
-} from './helpers/smoke-test/build-info';
-import { createSandbox } from './helpers/smoke-test/directories';
-import { downloadFile } from './helpers/smoke-test/downloads';
-import {
-  type PackageKind,
-  SUPPORTED_PACKAGES,
-} from './helpers/smoke-test/packages';
-import { type SmokeTestsContext } from './helpers/smoke-test/context';
+} from './build-info';
+import { createSandbox } from './directories';
+import { downloadFile } from './downloads';
+import { type PackageKind, SUPPORTED_PACKAGES } from './packages';
+import { type SmokeTestsContext } from './context';
 import { installMacZIP } from './installers/mac-zip';
 
 const SUPPORTED_PLATFORMS = ['win32', 'darwin', 'linux'] as const;
diff --git a/packages/compass-smoke-tests/src/context.ts b/packages/compass-smoke-tests/src/context.ts
diff --git a/packages/compass-smoke-tests/src/directories.ts b/packages/compass-smoke-tests/src/directories.ts
@@ -4,7 +4,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 
 function ensureSandboxesDirectory() {
-  const sandboxesPath = path.resolve(__dirname, '../../.smoke-sandboxes');
+  const sandboxesPath = path.resolve(__dirname, '../.sandboxes');
   if (!fs.existsSync(sandboxesPath)) {
     fs.mkdirSync(sandboxesPath, { recursive: true });
   }
@@ -24,7 +24,7 @@ export function createSandbox() {
 }
 
 export function ensureDownloadsDirectory() {
-  const downloadsPath = path.resolve(__dirname, '../../.smoke-downloads');
+  const downloadsPath = path.resolve(__dirname, '../.downloads');
   if (!fs.existsSync(downloadsPath)) {
     fs.mkdirSync(downloadsPath, { recursive: true });
   }
diff --git a/packages/compass-smoke-tests/src/downloads.ts b/packages/compass-smoke-tests/src/downloads.ts
@@ -2,10 +2,6 @@ import assert from 'node:assert';
 import fs from 'node:fs';
 import path from 'node:path';
 import stream from 'node:stream';
-import { type fetch as undiciFetch } from 'undici-types';
-
-// Hacking types here because the DOM types doesn't match the fetch implemented by Node.js
-const fetch = globalThis.fetch as unknown as typeof undiciFetch;
 
 import { ensureDownloadsDirectory } from './directories';
 
diff --git a/packages/compass-smoke-tests/src/execute.ts b/packages/compass-smoke-tests/src/execute.ts
diff --git a/packages/compass-smoke-tests/src/installers/mac-dmg.ts b/packages/compass-smoke-tests/src/installers/mac-dmg.ts
@@ -2,7 +2,7 @@ import path from 'node:path';
 import fs from 'node:fs';
 
 import type { InstalledAppInfo, InstallablePackage } from './types';
-import { execute } from './helpers';
+import { execute } from '../execute';
 
 export function installMacDMG({
   appName,
diff --git a/packages/compass-smoke-tests/src/installers/mac-zip.ts b/packages/compass-smoke-tests/src/installers/mac-zip.ts
@@ -2,7 +2,7 @@ import path from 'node:path';
 import fs from 'node:fs';
 
 import type { InstalledAppInfo, InstallablePackage } from './types';
-import { execute } from './helpers';
+import { execute } from '../execute';
 
 export function installMacZIP({
   appName,
diff --git a/packages/compass-smoke-tests/src/installers/types.ts b/packages/compass-smoke-tests/src/installers/types.ts
diff --git a/packages/compass-smoke-tests/src/packages.ts b/packages/compass-smoke-tests/src/packages.ts
diff --git a/packages/compass-smoke-tests/tsconfig.json b/packages/compass-smoke-tests/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+ignores:`
	`2`	`+ - '@mongodb-js/prettier-config-compass'`
	`3`	`+ - '@mongodb-js/tsconfig-compass'`