run the read-only test suite for read-only compass builds

Author: lerouxb

packages/compass-smoke-tests/src/cli.ts

@@ -6,6 +6,7 @@ import { SUPPORTED_TESTS } from './tests/types';
 import { type SmokeTestsContext } from './context';
 import { SUPPORTED_PACKAGES } from './packages';
 import { testTimeToFirstQuery } from './tests/time-to-first-query';
+import { testReadOnly } from './tests/read-only';
 import { testAutoUpdateFrom } from './tests/auto-update-from';
 import { testAutoUpdateTo } from './tests/auto-update-to';
 
@@ -123,6 +124,8 @@ async function run() {
 
     if (testName === 'time-to-first-query') {
       await testTimeToFirstQuery(context);
+    } else if (testName === 'read-only') {
+      await testReadOnly(context);
     } else if (testName === 'auto-update-from') {
       await testAutoUpdateFrom(context);
     } else if (testName === 'auto-update-to') {

packages/compass-smoke-tests/src/tests/read-only.ts

@@ -0,0 +1,57 @@
+import fs from 'node:fs';
+import { type SmokeTestsContext } from '../context';
+import { execute } from '../execute';
+import { getInstaller } from '../installers';
+import { createSandbox } from '../directories';
+import { getTestSubject } from '../test-subject';
+
+export async function testReadOnly(context: SmokeTestsContext) {
+  const sandboxPath = createSandbox();
+  const { kind, appName, filepath } = await getTestSubject({
+    ...context,
+    sandboxPath,
+  });
+
+  try {
+    const install = getInstaller(kind);
+
+    const { appPath, uninstall } = install({
+      appName,
+      filepath,
+      destinationPath: sandboxPath,
+    });
+
+    try {
+      execute(
+        'npm',
+        [
+          'run',
+          '--unsafe-perm',
+          'test-packaged',
+          '--workspace',
+          'compass-e2e-tests',
+          '--',
+          '--test-filter=read-only',
+        ],
+        {
+          // We need to use a shell to get environment variables setup correctly
+          shell: true,
+          env: {
+            ...process.env,
+            COMPASS_APP_NAME: appName,
+            COMPASS_APP_PATH: appPath,
+          },
+        }
+      );
+    } finally {
+      await uninstall();
+    }
+  } finally {
+    if (context.skipCleanup) {
+      console.log(`Skipped cleaning up sandbox: ${sandboxPath}`);
+    } else {
+      console.log(`Cleaning up sandbox: ${sandboxPath}`);
+      fs.rmSync(sandboxPath, { recursive: true });
+    }
+  }
+}

packages/compass-smoke-tests/src/tests/types.ts

@@ -1,5 +1,6 @@
 export const SUPPORTED_TESTS = [
   'time-to-first-query',
+  'read-only',
   'auto-update-from',
   'auto-update-to',
 ] as const;