feat: proposal pre/post test steps

README.md

@@ -70,6 +70,10 @@ If the proposal is _pending_ and does not yet have a number, use a letter. The p
 - `package.json` specifies what kind of proposal it is in a `agoricProposal` field. If it's a "Software Upgrade Proposal" it also includes additional parameters.
 - `use.sh` is the script that will be run in the USE stage of the build
 - `test.sh` is the script that will be _included_ in the TEST stage of the build, and run in CI
+- `setup-test.sh` is an optional script which can be used to run setup steps _inside_ the container. It runs _before_ the chain starts.
+- `teardown-test.sh` is an optional script which can be used to run teardown steps _inside_ the container. It runs _after_ the chain stops.
+- `before-test-run.sh` is an optional script which can be used to run setup steps on the _host_ (like starting a follower). It runs _before_ the container launches. It needs to be placed in the **host** folder.
+- `after-test-run.sh` is an optional script which can be used to run teardown steps on the _host_ (like stopping a follower). It runs _after_ the container exits. It needs to be placed in the **host** folder.
 
 ## Development
 

packages/synthetic-chain/public/upgrade-test-scripts/run_test.sh

@@ -28,10 +28,10 @@ source ./env_setup.sh
 
 cd /usr/src/proposals/"$PROPOSAL/" || fail "Proposal $PROPOSAL does not exist"
 
-if test -f prepare-test.sh
+if test -f setup-test.sh
 then
-  echo "[$PROPOSAL] Running prepare-test.sh"
-  ./prepare-test.sh
+  echo "[$PROPOSAL] Running setup-test.sh"
+  ./setup-test.sh
 fi
 
 echo "[$PROPOSAL] Starting agd"
@@ -44,3 +44,9 @@ echo "[$PROPOSAL] Running test.sh."
 echo "[$PROPOSAL] Testing completed."
 
 killAgd
+
+if test -f teardown-test.sh
+then
+  echo "[$PROPOSAL] Running teardown-test.sh"
+  ./teardown-test.sh
+fi

packages/synthetic-chain/src/cli/cli.ts

@@ -5,6 +5,7 @@
 import chalk from 'chalk';
 import assert from 'node:assert';
 import { execSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { parseArgs } from 'node:util';
 import {
@@ -63,6 +64,8 @@ Until https://github.com/docker/roadmap/issues/371, attempting it will error as
 Instead use a builder that supports multiplatform such as depot.dev.
 `;
 
+const fileExists = (name: string) => existsSync(name);
+
 /**
  * Put into places files that building depends upon.
  */
@@ -117,7 +120,20 @@ switch (cmd) {
         console.log(chalk.cyan.bold(`Testing ${proposal.proposalName}`));
         const image = imageNameForProposal(proposal, 'test');
         bakeTarget(image.target, values.dry);
+
+        const proposalHostScriptsDirectoryPath = `${root}/proposals/${proposal.path}/host`;
+
+        const afterHookScriptPath = `${proposalHostScriptsDirectoryPath}/after-test-run.sh`;
+        const beforeHookScriptPath = `${proposalHostScriptsDirectoryPath}/before-test-run.sh`;
+
+        fileExists(beforeHookScriptPath) &&
+          execSync(beforeHookScriptPath, { stdio: 'inherit' });
+
         runTestImage(proposal);
+
+        fileExists(afterHookScriptPath) &&
+          execSync(afterHookScriptPath, { stdio: 'inherit' });
+
         // delete the image to reclaim disk space. The next build
         // will use the build cache.
         execSync('docker system df', { stdio: 'inherit' });

packages/synthetic-chain/src/cli/dockerfileGen.ts

@@ -75,7 +75,7 @@ ENV \
     UPGRADE_INFO=${JSON.stringify(encodeUpgradeInfo(upgradeInfo))} \
     SKIP_PROPOSAL_VALIDATION=${skipProposalValidation}
 
-COPY --exclude=test --exclude=test.sh --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
+COPY --exclude=host --exclude=test --exclude=test.sh --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
 COPY --link --chmod=755 ./upgrade-test-scripts/env_setup.sh ./upgrade-test-scripts/run_prepare.sh ./upgrade-test-scripts/start_to_to.sh /usr/src/upgrade-test-scripts/
 WORKDIR /usr/src/upgrade-test-scripts
 SHELL ["/bin/bash", "-c"]
@@ -100,7 +100,7 @@ FROM ghcr.io/agoric/agoric-sdk:${sdkImageTag} as execute-${proposalName}
 WORKDIR /usr/src/upgrade-test-scripts
 
 # base is a fresh sdk image so set up the proposal and its dependencies
-COPY --exclude=test --exclude=test.sh --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
+COPY --exclude=host --exclude=test --exclude=test.sh --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
 COPY --link --chmod=755 ./upgrade-test-scripts/env_setup.sh ./upgrade-test-scripts/run_execute.sh  ./upgrade-test-scripts/start_to_to.sh ./upgrade-test-scripts/install_deps.sh /usr/src/upgrade-test-scripts/
 RUN --mount=type=cache,target=/root/.yarn ./install_deps.sh ${path}
 
@@ -122,7 +122,7 @@ RUN ./run_execute.sh ${planName}
 # EVAL ${proposalName}
 FROM use-${lastProposal.proposalName} as eval-${proposalName}
 
-COPY --exclude=test --exclude=test.sh --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
+COPY --exclude=host --exclude=test --exclude=test.sh --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
 
 WORKDIR /usr/src/upgrade-test-scripts
 
@@ -171,7 +171,7 @@ FROM use-${proposalName} as test-${proposalName}
 # Previous stages copied excluding test files (see COPY above). It would be good
 # to copy only missing files, but there may be none. Fortunately, copying extra
 # does not invalidate other images because nothing depends on this layer.
-COPY --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
+COPY --exclude=host --link --chmod=755 ./proposals/${path} /usr/src/proposals/${path}
 
 WORKDIR /usr/src/upgrade-test-scripts
 

packages/synthetic-chain/src/cli/run.ts

@@ -1,7 +1,24 @@
-import { execSync } from 'node:child_process';
+import { spawnSync } from 'node:child_process';
 import { realpathSync } from 'node:fs';
 import { ProposalInfo, imageNameForProposal } from './proposals.js';
 
+const propagateMessageFilePath = (env: typeof process.env) => {
+  const fileName = 'message-file-path.tmp';
+  const { HOME } = env;
+
+  const containerFilePath = `/root/${fileName}`;
+  const filePath = `${HOME}/${fileName}`;
+
+  spawnSync('touch', [filePath]);
+
+  return [
+    '--env',
+    `MESSAGE_FILE_PATH=${containerFilePath}`,
+    '--mount',
+    `source=${filePath},target=${containerFilePath},type=bind`,
+  ];
+};
+
 /**
  * Used to propagate a SLOGFILE environment variable into Docker containers.
  * Any file identified by such a variable will be created if it does not already
@@ -14,17 +31,32 @@ const propagateSlogfile = env => {
   const { SLOGFILE } = env;
   if (!SLOGFILE) return [];
 
-  execSync('touch "$SLOGFILE"');
-  return ['-e', 'SLOGFILE', '-v', `"$SLOGFILE:${realpathSync(SLOGFILE)}"`];
+  spawnSync('touch', [SLOGFILE]);
+
+  return [
+    '--env',
+    `SLOGFILE=${SLOGFILE}`,
+    '--volume',
+    `${SLOGFILE}:${realpathSync(SLOGFILE)}`,
+  ];
 };
 
 export const runTestImage = (proposal: ProposalInfo) => {
   console.log(`Running test image for proposal ${proposal.proposalName}`);
   const { name } = imageNameForProposal(proposal, 'test');
-  const slogOpts = propagateSlogfile(process.env);
-  // 'rm' to remove the container when it exits
-  const cmd = `docker run ${slogOpts.join(' ')} --rm ${name}`;
-  execSync(cmd, { stdio: 'inherit' });
+  spawnSync(
+    'docker',
+    [
+      'run',
+      '--network',
+      'host',
+      '--rm',
+      ...propagateSlogfile(process.env),
+      ...propagateMessageFilePath(process.env),
+      name,
+    ],
+    { stdio: 'inherit' },
+  );
 };
 
 export const debugTestImage = (proposal: ProposalInfo) => {
@@ -46,8 +78,24 @@ export const debugTestImage = (proposal: ProposalInfo) => {
   `,
   );
 
-  const slogOpts = propagateSlogfile(process.env);
   // start the chain with ports mapped
-  const cmd = `docker run ${slogOpts.join(' ')} --publish 26657:26657 --publish 1317:1317 --publish 9090:9090 --interactive --tty --entrypoint /usr/src/upgrade-test-scripts/start_agd.sh ${name}`;
-  execSync(cmd, { stdio: 'inherit' });
+  spawnSync(
+    'docker',
+    [
+      'run',
+      '--entrypoint',
+      '/usr/src/upgrade-test-scripts/start_agd.sh',
+      '--interactive',
+      '--publish',
+      '26657:26657',
+      '--publish',
+      '1317:1317',
+      '--publish',
+      '9090:9090',
+      '--tty',
+      ...propagateSlogfile(process.env),
+      name,
+    ],
+    { stdio: 'inherit' },
+  );
 };