From d42b502dbce669b17c29bea85e5a2c30dbe7c24a Mon Sep 17 00:00:00 2001 From: 0xPatrick Date: Fri, 30 Aug 2024 12:49:41 -0400 Subject: [PATCH] feat: `make start` single command start - closes: #9855 --- multichain-testing/Makefile | 12 +++++++++ multichain-testing/README.md | 48 ++++++++++++++++++++++-------------- 2 files changed, 41 insertions(+), 19 deletions(-) diff --git a/multichain-testing/Makefile b/multichain-testing/Makefile index 8cb22b48f38..3fe90607fed 100644 --- a/multichain-testing/Makefile +++ b/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 + diff --git a/multichain-testing/README.md b/multichain-testing/README.md index bd24c17d6d9..cb090092cde 100644 --- a/multichain-testing/README.md +++ b/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,7 +23,7 @@ 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 @@ -32,19 +31,31 @@ 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