chore(ci): gh test-project typescript actions (#1383)

Author: Tobbe

.github/actions/actionsLib.mjs

@@ -1,4 +1,3 @@
-/* eslint-env node */
 // @ts-check
 
 import fs from 'node:fs'
@@ -21,9 +20,17 @@ export const CEDAR_FRAMEWORK_PATH = fileURLToPath(
  * @param {ExecOptions} options
  */
 function execWithEnv(command, { env = {}, ...rest } = {}) {
+  /** @type {{ [key: string]: string }} */
+  const processEnv = Object.fromEntries(
+    Object.entries(process.env).filter(
+      /** @returns {entry is [string, string]} */
+      (entry) => entry[1] !== undefined,
+    ),
+  )
+
   return getExecOutput(command, undefined, {
     env: {
-      ...process.env,
+      ...processEnv,
       ...env,
     },
     ...rest,
@@ -74,7 +81,7 @@ export async function createCacheKeys({
   const baseKey = [
     baseKeyPrefix,
     process.env.RUNNER_OS,
-    process.env.GITHUB_REF.replaceAll('/', '-'),
+    process.env.GITHUB_REF?.replaceAll('/', '-'),
     await hashFiles(path.join('__fixtures__', 'test-project')),
   ].join('-')
 

.github/actions/actionsLibLocally.mts

@@ -0,0 +1,164 @@
+import { spawn } from 'node:child_process'
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import type { ExecOptions } from '@actions/exec'
+
+export const CEDAR_FRAMEWORK_PATH = fileURLToPath(
+  new URL('../../', import.meta.url),
+)
+
+export function setOutput(key: string, value: string) {
+  console.log(`setOutput: ${key} = ${value}`)
+}
+
+export function getInput(key: string) {
+  console.log(`getInput: ${key}`)
+  return ''
+}
+
+/**
+ * This is an approximation of `getExecOutput` from `@actions/exec` that can be
+ * used locally (i.e. outside of GitHub Actions) for testing.
+ */
+function getExecOutput(
+  command: string,
+  args?: string[],
+  options: ExecOptions = {},
+): Promise<{ stdout: string; stderr: string }> {
+  return new Promise((resolve, reject) => {
+    const { cwd, env, silent = false, input } = options
+
+    const child = spawn(command, args ?? [], {
+      cwd,
+      env,
+      shell: true,
+      stdio: ['pipe', 'pipe', 'pipe'],
+    })
+
+    let stdout = ''
+    let stderr = ''
+
+    child.stdout.on('data', (chunk: string | Buffer) => {
+      const text = chunk.toString()
+      stdout += text
+
+      if (!silent) {
+        process.stdout.write(text)
+      }
+    })
+
+    child.stderr.on('data', (chunk: string | Buffer) => {
+      const text = chunk.toString()
+      stderr += text
+
+      if (!silent) {
+        process.stderr.write(text)
+      }
+    })
+
+    child.on('error', (error) => {
+      reject(error)
+    })
+
+    child.on('close', (code) => {
+      if (code === 0) {
+        resolve({ stdout, stderr })
+        return
+      }
+
+      const error = new Error(
+        `Command failed with exit code ${code}: ${command}`,
+      ) as Error & {
+        code?: number | null
+        stdout?: string
+        stderr?: string
+      }
+
+      error.code = code
+      error.stdout = stdout
+      error.stderr = stderr
+
+      reject(error)
+    })
+
+    if (input !== undefined) {
+      child.stdin.write(input)
+    }
+
+    child.stdin.end()
+  })
+}
+
+function execWithEnv(command: string, { env = {}, ...rest }: ExecOptions = {}) {
+  const processEnv: Record<string, string> = Object.fromEntries(
+    Object.entries(process.env).filter(
+      (entry): entry is [string, string] => entry[1] !== undefined,
+    ),
+  )
+
+  return getExecOutput(command, undefined, {
+    env: {
+      ...processEnv,
+      ...env,
+    },
+    ...rest,
+  })
+}
+
+export function createExecWithEnvInCwd(cwd: string) {
+  return function (command: string, options: Omit<ExecOptions, 'cwd'> = {}) {
+    return execWithEnv(command, { cwd, ...options })
+  }
+}
+
+export const execInFramework = createExecWithEnvInCwd(CEDAR_FRAMEWORK_PATH)
+
+/**
+ * @param commandLine command to execute (can include additional args). Must be
+ *   correctly escaped.
+ * @param options exec options.  See ExecOptions
+ * @returns exit code
+ */
+type ExecInProject = (
+  commandLine: string,
+  options?: Omit<ExecOptions, 'cwd'>,
+) => Promise<unknown>
+
+export async function setUpRscTestProject(
+  testProjectPath: string,
+  fixtureName: string,
+  core: { setOutput: (key: string, value: string) => void },
+  execInProject: ExecInProject,
+) {
+  core.setOutput('test-project-path', testProjectPath)
+
+  console.log('Cedar Framework Path', CEDAR_FRAMEWORK_PATH)
+  console.log('testProjectPath', testProjectPath)
+
+  const fixturePath = path.join(
+    CEDAR_FRAMEWORK_PATH,
+    '__fixtures__',
+    fixtureName,
+  )
+  const cedarBinPath = path.join(
+    CEDAR_FRAMEWORK_PATH,
+    'packages/cli/dist/index.js',
+  )
+  const cfwBinPath = path.join(CEDAR_FRAMEWORK_PATH, 'packages/cli/dist/cfw.js')
+
+  console.log(`Creating project at ${testProjectPath}`)
+  console.log()
+  fs.cpSync(fixturePath, testProjectPath, { recursive: true })
+
+  console.log('Syncing framework')
+  await execInProject(`node ${cfwBinPath} project:tarsync --verbose`, {
+    env: { CFW_PATH: CEDAR_FRAMEWORK_PATH },
+  })
+  console.log()
+
+  console.log(`Building project in ${testProjectPath}`)
+  await execInProject(`node ${cedarBinPath} build -v`)
+  console.log()
+}

.github/actions/set-up-rsa-project/action.yaml

@@ -3,7 +3,7 @@ description: Sets up an RSA project for smoke-tests
 
 runs:
   using: node24
-  main: 'setUpRsaProjectGitHub.mjs'
+  main: 'setUpRsaProjectGitHub.mts'
 
 outputs:
   test-project-path:

…up-rsa-project/setUpRsaProjectGitHub.mjs …up-rsa-project/setUpRsaProjectGitHub.mts.github/actions/set-up-rsa-project/setUpRsaProjectGitHub.mjs renamed to .github/actions/set-up-rsa-project/setUpRsaProjectGitHub.mts .github/actions/set-up-rsa-project/setUpRsaProjectGitHub.mjs renamed to .github/actions/set-up-rsa-project/setUpRsaProjectGitHub.mts

@@ -1,17 +1,16 @@
-/* eslint-env node */
-// @ts-check
-
 import path from 'node:path'
 
 import core from '@actions/core'
 
 import { createExecWithEnvInCwd, setUpRscTestProject } from '../actionsLib.mjs'
 
 const testProjectAndFixtureName = 'test-project-rsa'
+
 const testProjectPath = path.join(
   path.dirname(process.cwd()),
   testProjectAndFixtureName,
 )
+
 const execInProject = createExecWithEnvInCwd(testProjectPath)
 
 setUpRscTestProject(

.github/actions/set-up-rsa-project/setUpRsaProjectLocally.mjs

@@ -0,0 +1,29 @@
+import os from 'node:os'
+import path from 'node:path'
+
+import {
+  createExecWithEnvInCwd,
+  setOutput,
+  setUpRscTestProject,
+} from '../actionsLibLocally.mts'
+
+const testProjectAndFixtureName = 'test-project-rsa'
+
+const testProjectPath = path.join(
+  os.tmpdir(),
+  'cedar',
+  testProjectAndFixtureName,
+  // ":" is problematic with paths
+  new Date().toISOString().split(':').join('-'),
+)
+
+const core = { setOutput }
+
+const execInProject = createExecWithEnvInCwd(testProjectPath)
+
+setUpRscTestProject(
+  testProjectPath,
+  testProjectAndFixtureName,
+  core,
+  execInProject,
+)

.github/actions/set-up-rsa-project/setUpRsaProjectLocally.mts

@@ -6,6 +6,6 @@
     "module": "esnext",
     "moduleResolution": "node",
     "skipLibCheck": false,
-    "jsx": "react-jsx"
+    "allowImportingTsExtensions": true
   }
 }

…actions/set-up-rsa-project/jsconfig.json …actions/set-up-rsa-project/tsconfig.json.github/actions/set-up-rsa-project/jsconfig.json renamed to .github/actions/set-up-rsa-project/tsconfig.json .github/actions/set-up-rsa-project/jsconfig.json renamed to .github/actions/set-up-rsa-project/tsconfig.json

@@ -3,7 +3,7 @@ description: Sets up an RSC project for smoke-tests
 
 runs:
   using: node24
-  main: 'setUpRscProjectGitHub.mjs'
+  main: 'setUpRscProjectGitHub.mts'
 
 outputs:
   test-project-path: