feat: proposal pre/post test steps

README.md

@@ -70,6 +70,7 @@ 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
+- `prepare-test.sh` is an optional script which can be used to run setup steps _inside_ the container
 
 ## Development
 

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,21 @@ switch (cmd) {
         console.log(chalk.cyan.bold(`Testing ${proposal.proposalName}`));
         const image = imageNameForProposal(proposal, 'test');
         bakeTarget(image.target, values.dry);
+
+        const proposalPath = `${root}/proposals/${proposal.path}`;
+
+        if (fileExists(`${proposalPath}/pre_test.sh`))
+          execSync(`/bin/bash ${proposalPath}/pre_test.sh`, {
+            stdio: 'inherit',
+          });
+
         runTestImage(proposal);
+
+        if (fileExists(`${proposalPath}/post_test.sh`))
+          execSync(`/bin/bash ${proposalPath}/post_test.sh`, {
+            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/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' },
+  );
 };