Refactor to use test wrapper script

Author: CarlosNZ

package.json

@@ -49,7 +49,7 @@
     "start": "yarn build && cd build && node server.js",
     "build": "./utils/build_all.sh",
     "test": "jest --runInBand",
-    "test_snapshot": "yarn test --forceExit eventTesting",
+    "test_snapshot": "ts-node src/components/actions/dev_tools/testing/testSnapshot.ts --test",
     "pg": "exec ./utils/postgraphile_launch.sh",
     "pg_permissions": "exec ./utils/postgraphile_launch_permissions.sh",
     "dev_pg": "concurrently --kill-others-on-fail \"yarn dev\"  \"yarn pg\"",

src/components/actions/dev_tools/eventTesting.test.ts

@@ -0,0 +1,2 @@
+export * from './routes'
+export * from './testTrigger'

src/components/actions/dev_tools/index.ts

@@ -0,0 +1,65 @@
+/*
+Wrapper for snapshot/build testing suite. The wrapper is so we can capture the
+result of the test and act on it accordingly.
+*/
+
+import { execSync } from 'child_process'
+import { existsSync, readFileSync } from 'fs'
+import { TEST_SCRIPT_FOLDER, SNAPSHOT_FOLDER } from '../../../../constants'
+
+const isManualTest = process.argv[2] === '--test'
+
+const lastArg = process.argv.pop() as string
+
+const inputTest = lastArg.match(/\.ts$/) || lastArg === '--test' ? null : lastArg
+
+if (inputTest) console.log('Requested test suite', inputTest)
+
+let testScriptFile: string | undefined
+let snapshotName: string | undefined
+
+// Check for test script in either (in this order):
+// - "snapshot_test_scripts" folder -- match {inputTest}.json
+// - snapshot named ${inputTest} -- look for "tests.json" within
+// - .env file: BUILD_TEST_SNAPSHOT
+if (!inputTest) {
+  console.log('No test file or snapshot specified, checking .env file...')
+  snapshotName = process.env.BUILD_TEST_SNAPSHOT
+  testScriptFile = `${SNAPSHOT_FOLDER}/${process.env.BUILD_TEST_SNAPSHOT}/tests.json`
+  if (!snapshotName) {
+    console.log('NO SNAPSHOT DEFINED IN .env')
+    process.exit(0)
+  }
+} else {
+  if (existsSync(`${TEST_SCRIPT_FOLDER}/${inputTest}.json`)) {
+    testScriptFile = `${TEST_SCRIPT_FOLDER}/${inputTest}.json`
+    const testScript = JSON.parse(readFileSync(testScriptFile, 'utf-8'))
+    snapshotName = testScript.snapshot
+    console.log('Test script found:', `${inputTest}.json`)
+  } else {
+    console.log(`${inputTest} not found in "snapshot_test_scripts". Checking snapshots...`)
+    if (existsSync(`${SNAPSHOT_FOLDER}/${inputTest}/tests.json`)) {
+      testScriptFile = `${SNAPSHOT_FOLDER}/${inputTest}/tests.json`
+      const testScript = JSON.parse(readFileSync(testScriptFile, 'utf-8'))
+      snapshotName = testScript.snapshot
+      console.log('Test script found in snapshot:', snapshotName)
+    } else {
+      console.log(`Test file not found in snapshot ${inputTest}`)
+      process.exit(0)
+    }
+  }
+}
+
+export const runTests = async () => {
+  try {
+    execSync(`yarn test --forceExit triggerEvents ${testScriptFile} ${snapshotName}`, {
+      stdio: 'inherit',
+    })
+    return true
+  } catch {
+    console.error('FAILED TEST :(')
+    return false
+  }
+}
+
+if (isManualTest) runTests()

src/components/actions/dev_tools/testing/testSnapshot.ts

@@ -0,0 +1,36 @@
+// Configure a snapshot to be used with this test suite.
+import { readFileSync } from 'fs'
+import { loadActionPlugins } from '../../../pluginsConnect'
+import { RequestProps, testTrigger } from '../'
+import useSnapshot from '../../../../components/snapshots/useSnapshot'
+import { TEST_SCRIPT_FOLDER, SNAPSHOT_FOLDER } from '../../../../constants'
+
+interface TestData {
+  name: string
+  input: RequestProps
+  output: Partial<ReturnType<typeof testTrigger>>
+}
+
+const snapshotName = process.argv.pop() as string
+const testScriptFile = process.argv.pop() as string
+
+console.log(testScriptFile, snapshotName)
+
+const testData: TestData[] = JSON.parse(readFileSync(testScriptFile, 'utf-8')).tests
+
+beforeAll((done) => {
+  if (!snapshotName) done('No valid snapshot')
+  // Load snapshot
+  useSnapshot({ snapshotName }).then(({ success }) => {
+    if (success) done()
+    else done('Failed to load snapshot')
+  })
+  loadActionPlugins()
+})
+
+testData.forEach(({ name, input, output }) => {
+  test(name, async () => {
+    const result = await testTrigger(input)
+    expect(result).toMatchObject(output)
+  })
+})

src/components/actions/dev_tools/testing/triggerEvents.test.ts

@@ -2,7 +2,8 @@ require('dotenv').config()
 import readlineSync from 'readline-sync'
 import { writeFileSync } from 'fs'
 import { promisify } from 'util'
-import { exec as execCallback, execSync } from 'child_process'
+import { exec as execCallback } from 'child_process'
+import { runTests } from '../src/components/actions/dev_tools/testing/testSnapshot'
 
 const exec = promisify(execCallback)
 const FRONT_END_PATH = process.env.FRONT_END_PATH
@@ -31,11 +32,13 @@ const release = async () => {
 
   console.log('Starting build tests...')
 
-  try {
-    execSync(`yarn test_snapshot ${TEST_SUITE}`, { stdio: 'inherit' })
-  } catch {
-    console.log('Build test FAIL!\n')
-    process.exit(1)
+  const result = await runTests()
+
+  if (!result) {
+    console.log(
+      `CAUTION: The test suite in ${TEST_SUITE} did not pass. Are you sure you wish to proceed with this build?`
+    )
+    if (!(await userRespondsYes())) process.exit(0)
   }
 
   const releaseType: ReleaseType = (process.argv[2] || '--prerelease') as ReleaseType