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/package.json

@@ -25,13 +25,15 @@
     "chalk": "^5.4.1",
     "cosmjs-types": "^0.9.0",
     "execa": "^9.5.2",
-    "glob": "^11.0.1"
+    "glob": "^11.0.1",
+    "tmp": "0.2.3"
   },
   "devDependencies": {
     "@agoric/cosmic-proto": "0.5.0-u18.5",
     "@types/better-sqlite3": "^7.6.12",
     "@types/glob": "^8.1.0",
     "@types/node": "^18.19.50",
+    "@types/tmp": "0.2.6",
     "ava": "^6.2.0",
     "ts-blank-space": "^0.5.1",
     "tsup": "^8.3.6",

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

@@ -117,7 +117,7 @@ switch (cmd) {
         console.log(chalk.cyan.bold(`Testing ${proposal.proposalName}`));
         const image = imageNameForProposal(proposal, 'test');
         bakeTarget(image.target, values.dry);
-        runTestImage(proposal);
+        runTestImage({ proposal });
         // 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

@@ -32,7 +32,12 @@ ENV UPGRADE_TO=${to}
 RUN echo '. /usr/src/upgrade-test-scripts/env_setup.sh' >> ~/.bashrc
 
 # copy scripts
-COPY --link --chmod=755 ./upgrade-test-scripts/env_setup.sh ./upgrade-test-scripts/run_prepare_zero.sh /usr/src/upgrade-test-scripts/
+${createCopyCommand(
+  [],
+  './upgrade-test-scripts/env_setup.sh',
+  './upgrade-test-scripts/run_prepare_zero.sh',
+  '/usr/src/upgrade-test-scripts/',
+)}
 SHELL ["/bin/bash", "-c"]
 # this is the only layer that starts ag0
 RUN /usr/src/upgrade-test-scripts/run_prepare_zero.sh
@@ -75,8 +80,18 @@ 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 --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/
+${createCopyCommand(
+  ['host', 'node_modules', 'test', 'test.sh'],
+  `./proposals/${path}`,
+  `/usr/src/proposals/${path}`,
+)}
+${createCopyCommand(
+  [],
+  './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"]
 RUN ./run_prepare.sh ${path}
@@ -100,8 +115,19 @@ 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 --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/
+${createCopyCommand(
+  ['host', 'node_modules', 'test', 'test.sh'],
+  `./proposals/${path}`,
+  `/usr/src/proposals/${path}`,
+)}
+${createCopyCommand(
+  ['test.sh'],
+  './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}
 
 COPY --link --from=prepare-${proposalName} /root/.agoric /root/.agoric
@@ -122,15 +148,27 @@ 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}
+${createCopyCommand(
+  ['host', 'node_modules', 'test', 'test.sh'],
+  `./proposals/${path}`,
+  `/usr/src/proposals/${path}`,
+)}
 
 WORKDIR /usr/src/upgrade-test-scripts
 
 # First stage of this proposal so install its deps.
-COPY --link ./upgrade-test-scripts/install_deps.sh /usr/src/upgrade-test-scripts/
+${createCopyCommand(
+  [],
+  './upgrade-test-scripts/install_deps.sh',
+  '/usr/src/upgrade-test-scripts/',
+)}
 RUN --mount=type=cache,target=/root/.yarn ./install_deps.sh ${path}
 
-COPY --link --chmod=755 ./upgrade-test-scripts/*eval* /usr/src/upgrade-test-scripts/
+${createCopyCommand(
+  [],
+  './upgrade-test-scripts/*eval*',
+  '/usr/src/upgrade-test-scripts/',
+)}
 SHELL ["/bin/bash", "-c"]
 RUN ./run_eval.sh ${path}
 `;
@@ -149,7 +187,12 @@ FROM ${previousStage}-${proposalName} as use-${proposalName}
 
 WORKDIR /usr/src/upgrade-test-scripts
 
-COPY --link --chmod=755 ./upgrade-test-scripts/run_use.sh ./upgrade-test-scripts/start_agd.sh /usr/src/upgrade-test-scripts/
+${createCopyCommand(
+  [],
+  './upgrade-test-scripts/run_use.sh',
+  './upgrade-test-scripts/start_agd.sh',
+  '/usr/src/upgrade-test-scripts/',
+)}
 SHELL ["/bin/bash", "-c"]
 RUN ./run_use.sh ${path}
 ENTRYPOINT ./start_agd.sh
@@ -171,11 +214,19 @@ 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}
+${createCopyCommand(
+  ['host', 'node_modules'],
+  `./proposals/${path}`,
+  `/usr/src/proposals/${path}`,
+)}
 
 WORKDIR /usr/src/upgrade-test-scripts
 
-COPY --link --chmod=755 ./upgrade-test-scripts/run_test.sh /usr/src/upgrade-test-scripts/
+${createCopyCommand(
+  [],
+  './upgrade-test-scripts/run_test.sh',
+  '/usr/src/upgrade-test-scripts/',
+)}
 SHELL ["/bin/bash", "-c"]
 ENTRYPOINT ./run_test.sh ${path}
 `;
@@ -196,6 +247,18 @@ FROM ${useImage} as latest
   },
 };
 
+export const createCopyCommand = (
+  exclusionList: Array<string>,
+  ...files: Array<string>
+) =>
+  [
+    'COPY',
+    '--link',
+    '--chmod=755',
+    ...exclusionList.map(excluded => `--exclude=${excluded}`),
+    ...files,
+  ].join(' ');
+
 export function writeBakefileProposals(
   allProposals: ProposalInfo[],
   platforms?: Platform[],

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

@@ -1,7 +1,29 @@
-import { execSync } from 'node:child_process';
-import { realpathSync } from 'node:fs';
+import { spawnSync } from 'node:child_process';
+import { existsSync, realpathSync } from 'node:fs';
+import { resolve as resolvePath } from 'node:path';
+import { fileSync as createTempFile } from 'tmp';
 import { ProposalInfo, imageNameForProposal } from './proposals.js';
 
+const createMessageFile = (proposal: ProposalInfo) =>
+  createTempFile({ prefix: proposal.proposalName });
+
+const executeHostScriptIfPresent = (
+  extraEnv: typeof process.env,
+  proposal: ProposalInfo,
+  scriptName: string,
+) => {
+  const scriptPath = `${resolvePath('.')}/proposals/${proposal.path}/host/${scriptName}`;
+  if (existsSync(scriptPath)) {
+    console.log(
+      `Running script ${scriptName} for proposal ${proposal.proposalName}`,
+    );
+    spawnSync(scriptPath, {
+      env: { ...process.env, ...extraEnv },
+      stdio: 'inherit',
+    });
+  }
+};
+
 /**
  * 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,40 +36,101 @@ 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' });
+export const runTestImage = ({
+  extraDockerArgs = [],
+  proposal,
+  removeContainerOnExit = true,
+}: {
+  extraDockerArgs?: Array<string>;
+  proposal: ProposalInfo;
+  removeContainerOnExit?: boolean;
+}) => {
+  const { name: messageFilePath, removeCallback: removeTempFileCallback } =
+    createMessageFile(proposal);
+
+  const containerFilePath = '/root/message-file-path';
+
+  try {
+    executeHostScriptIfPresent(
+      {
+        MESSAGE_FILE_PATH: messageFilePath,
+      },
+      proposal,
+      'before-test-run.sh',
+    );
+
+    console.log(`Running test image for proposal ${proposal.proposalName}`);
+    const { name } = imageNameForProposal(proposal, 'test');
+    spawnSync(
+      'docker',
+      [
+        'run',
+        '--env',
+        `MESSAGE_FILE_PATH=${containerFilePath}`,
+        '--mount',
+        `source=${messageFilePath},target=${containerFilePath},type=bind`,
+        ...(removeContainerOnExit ? ['--rm'] : []),
+        ...propagateSlogfile(process.env),
+        ...extraDockerArgs,
+        name,
+      ],
+      { stdio: 'inherit' },
+    );
+
+    executeHostScriptIfPresent(
+      {
+        MESSAGE_FILE_PATH: messageFilePath,
+      },
+      proposal,
+      'after-test-run.sh',
+    );
+  } finally {
+    removeTempFileCallback();
+  }
 };
 
 export const debugTestImage = (proposal: ProposalInfo) => {
   const { name } = imageNameForProposal(proposal, 'test');
   console.log(
     `
   Starting chain of test image for proposal ${proposal.proposalName}
-  
+
   To get an interactive shell in the container, use an IDE feature like "Attach Shell" or this command:'
-  
+
     docker exec -ti $(docker ps -q -f ancestor=${name}) bash
-  
+
   And within that shell:
     cd /usr/src/proposals/${proposal.path} && ./test.sh
-  
+
   To edit files you can use terminal tools like vim, or mount the container in your IDE.
   In VS Code the command is:
     Dev Containers: Attach to Running Container...
   `,
   );
-
-  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' });
+  return runTestImage({
+    extraDockerArgs: [
+      '--entrypoint',
+      '/usr/src/upgrade-test-scripts/start_agd.sh',
+      '--interactive',
+      '--publish',
+      '1317:1317',
+      '--publish',
+      '9090:9090',
+      '--publish',
+      '26657:26657',
+      '--tty',
+    ],
+    proposal,
+    removeContainerOnExit: false,
+  });
 };