multichain-testing: make start single command start (#10002)

closes: #9855

## Description
Adds a `pod-readiness.ts` script and documents a single command (`make start`) setup for starship multichain-testing.

Reviewers, please pull this down and try something like `make start && yarn test test/basic-flows.test.ts` to verify it's working.

### Security Considerations
n/a

### Scaling Considerations
n/a

### Documentation Considerations
Includes updated documentation.

### Testing Considerations
Manually tested by author and reviewers. In CI, the starship gh action does this check for us so this script is not needed there.

### Upgrade Considerations
n/a

multichain-testing/Makefile

@@ -91,3 +91,15 @@ provision-smart-wallet:
 # view agoric swingset logs from slog file, until we can set `DEBUG=SwingSet:vat,SwingSet:ls`
 tail-slog:
 	kubectl exec -i agoriclocal-genesis-0 -c validator -- tail -f slog.slog
+
+###############################################################################
+###                           Start All                                     ###
+###############################################################################
+
+.PHONY: wait-for-pods
+wait-for-pods:
+	node_modules/.bin/tsx scripts/pod-readiness.ts
+
+.PHONY: start
+start: install wait-for-pods port-forward fund-provision-pool override-chain-registry
+

multichain-testing/README.md

@@ -2,10 +2,9 @@
 
 End-to-end testing environment for fully simulated chains, powered by [Starship](https://docs.cosmology.zone/starship).
 
-
 ## Configuration
 
-The current commands will read from [`config.yaml`](./config.yaml) to build a multi-chain teting environment. Currently, the image includes `agoric`, `osmosis`, and `cosmos-hub` chains and a hermes relayer between each.
+The current commands will read from [`config.yaml`](./config.yaml) to build a multi-chain testing environment. Currently, the image includes `agoric`, `osmosis`, and `cosmoshub` chains and a hermes relayer between each.
 
 The `agoric` software revision includes the vats necessary for building and testing orchestration applications:
 - vat-network
@@ -24,27 +23,39 @@ yarn install
 
 Ensure you have Kubernetes available. See https://docs.cosmology.zone/starship/get-started/step-2.
 
-The following will install `kubectl`, `kind`, `helm`, and `yq` as needed.
+The following will install `kubectl`, `kind`, `helm`, and `yq` as needed:
 
 ```sh
 make clean setup
 ```
 
 ## Getting Started
 
+You can start everything with a single command:
+
+```sh
+make start
+```
+
+This command will:
+1. Install the Helm chart and start the Starship service
+2. Wait for all pods to be ready
+3. Set up port forwarding
+4. Fund the provision pool
+5. Override the chain registry
+
+The process may take 7-12 minutes to complete. You'll see status updates as the pods come online.
+
+Alternatively, you can run the steps individually:
+
 ```sh
 # install helm chart and start starship service
 make install
 
 # wait for all pods to spin up
-watch kubectl get pods
-```
-
-**Wait 10-12** minutes. It takes some time for the above to finish setting up. The watch command should show a table in which the STATUS of every pod is Running.
+make wait-for-pods
 
-
-```bash
-# expose ports on your local machine. useful for testing dapps
+# expose ports on your local machine (useful for testing dapps)
 make port-forward
 
 # set up Agoric testing environment
@@ -53,7 +64,7 @@ make fund-provision-pool override-chain-registry
 
 If you get an error like "connection refused", you need to wait longer, until all the pods are Running.
 
-# Cleanup
+## Cleanup
 
 ```sh
 # stop the containers and port-forwarding
@@ -63,10 +74,9 @@ make stop
 make clean
 ```
 
-
 ## Logs
 
-You can use the following commmands to view logs:
+You can use the following commands to view logs:
 
 ```sh
 # agoric slogfile
@@ -98,12 +108,12 @@ make fund-wallet COIN=20000000ubld ADDR=$ADDR
 make provision-smart-wallet ADDR=$ADDR
 ```
 
-# Chain Registry
+## Chain Registry
 
 These only work if you've done `make port-forward`.
 
-http://localhost:8081/chains/agoriclocal
-http://localhost:8081/chains/osmosislocal
-http://localhost:8081/chains/gaialocal
-http://localhost:8081/chains/agoriclocal/keys
-http://localhost:8081/ibc
+- http://localhost:8081/chains/agoriclocal
+- http://localhost:8081/chains/osmosislocal
+- http://localhost:8081/chains/gaialocal
+- http://localhost:8081/chains/agoriclocal/keys
+- http://localhost:8081/ibc

multichain-testing/scripts/pod-readiness.ts

@@ -0,0 +1,36 @@
+import { execa } from 'execa';
+import { sleep } from '../tools/sleep.ts';
+
+const checkPodsReadiness = async (): Promise<boolean> => {
+  const { stdout } = await execa('kubectl', ['get', 'pods']);
+  console.clear();
+  console.log('Current pod status:');
+  console.log(stdout);
+
+  const lines = stdout.split('\n').slice(1); // Skip the header line
+  return (
+    lines.length > 0 &&
+    lines.every(line => {
+      const [, ready] = line.split(/\s+/);
+      const [readyCount, totalCount] = ready.split('/');
+      return readyCount === totalCount;
+    })
+  );
+};
+
+const main = async () => {
+  console.log('Starting pod readiness check...');
+  for (;;) {
+    const allReady = await checkPodsReadiness();
+    if (allReady) {
+      console.log('All pods are ready!');
+      process.exit(0);
+    }
+    await sleep(2 * 1_000);
+  }
+};
+
+main().catch(error => {
+  console.error('An error occurred:', error);
+  process.exit(1);
+});