Merge branch 'main' into fix/port-forward

clients/js/__output__/custom-pod-ports.yaml

@@ -7,6 +7,7 @@ chains:
   defaultPorts:
     rpc: 26657
     grpc: 9090
+    grpc-web: 9091
     rest: 1317
     exposer: 8081
     faucet: 8000

clients/js/packages/cli/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.10.2](https://github.com/cosmology-tech/starship/compare/@starship-ci/[email protected]...@starship-ci/[email protected]) (2024-10-03)
+
+**Note:** Version bump only for package @starship-ci/cli
+
 ## [2.10.1](https://github.com/cosmology-tech/starship/compare/@starship-ci/[email protected]...@starship-ci/[email protected]) (2024-09-17)
 
 **Note:** Version bump only for package @starship-ci/cli

clients/js/packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@starship-ci/cli",
-  "version": "2.10.1",
+  "version": "2.10.2",
   "author": "Dan Lynch <[email protected]>",
   "description": "Starship CLI",
   "main": "index.js",
@@ -55,7 +55,7 @@
     "@types/js-yaml": "^4.0.9"
   },
   "dependencies": {
-    "@starship-ci/client": "^2.9.1",
+    "@starship-ci/client": "^2.9.2",
     "chalk": "^4.1.0",
     "deepmerge": "^4.3.1",
     "inquirerer": "^1.9.0",

clients/js/packages/cli/src/utils.ts

@@ -38,7 +38,8 @@ export const params: string[] = [
   'repo',
   'repoUrl',
   'chart',
-  'namespace'
+  'namespace',
+  'timeout'
 ];
 
 export const loadConfig = (argv: any): Config => {
@@ -89,6 +90,8 @@ Command-line Options:
                         Will overide config file settings for name.
   --version <ver>   Specify the version of the Helm chart, default: v0.2.6.
                         Will overide config file settings for version.
+  --timeout <time>  Specify the timeout for the Helm operations, default: 10m.
+                        Will overide config file settings for timeout.
 
 Examples:
   $ starship start --config ./config/two-chain.yaml

clients/js/packages/client/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.9.2](https://github.com/cosmology-tech/starship/compare/@starship-ci/[email protected]...@starship-ci/[email protected]) (2024-10-03)
+
+**Note:** Version bump only for package @starship-ci/client
+
 ## [2.9.1](https://github.com/cosmology-tech/starship/compare/@starship-ci/[email protected]...@starship-ci/[email protected]) (2024-09-17)
 
 **Note:** Version bump only for package @starship-ci/client

clients/js/packages/client/__tests__/__snapshots__/client.config.test.ts.snap

@@ -11,7 +11,7 @@ helm repo update
 helm search repo starship/devnet --version v0.2.3
 Call: deploy()
 Log: Installing the helm chart. This is going to take a while.....
-helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3
+helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3 --timeout 10m
 Log: Run "starship get-pods" to check the status of the cluster
 Call: startPortForward()
 Log: Attempting to stop any existing port-forwards...
@@ -46,7 +46,7 @@ exports[`StarshipClient setup 2`] = `
 "helm repo add starship https://cosmology-tech.github.io/starship/
 helm repo update
 helm search repo starship/devnet --version v0.2.3
-helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3
+helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3 --timeout 10m
 ps -ef | grep -i 'kubectl port-forward' | grep -v 'grep' | awk '{print $2}'
 sleep 2
 kubectl port-forward pods/osmosis-1-genesis-0 26657:26657 > /dev/null 2>&1 &

clients/js/packages/client/__tests__/__snapshots__/client.ports.test.ts.snap

@@ -11,7 +11,7 @@ helm repo update
 helm search repo starship/devnet --version v0.2.3
 Call: deploy()
 Log: Installing the helm chart. This is going to take a while.....
-helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3
+helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3 --timeout 10m
 Log: Run "starship get-pods" to check the status of the cluster
 Call: startPortForward()
 Log: Attempting to stop any existing port-forwards...
@@ -44,7 +44,7 @@ exports[`StarshipClient setup 2`] = `
 "helm repo add starship https://cosmology-tech.github.io/starship/
 helm repo update
 helm search repo starship/devnet --version v0.2.3
-helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3
+helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3 --timeout 10m
 ps -ef | grep -i 'kubectl port-forward' | grep -v 'grep' | awk '{print $2}'
 sleep 2
 kubectl port-forward pods/osmosis-1-genesis-0 1317:6767676 > /dev/null 2>&1 &

clients/js/packages/client/__tests__/__snapshots__/client.test.ts.snap

@@ -9,7 +9,7 @@ helm repo update
 helm search repo starship/devnet --version v0.2.3
 Call: deploy()
 Log: Installing the helm chart. This is going to take a while.....
-helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3
+helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3 --timeout 10m
 Log: Run "starship get-pods" to check the status of the cluster
 Call: startPortForward()
 Log: Attempting to stop any existing port-forwards...
@@ -44,7 +44,7 @@ exports[`StarshipClient setup 2`] = `
 "helm repo add starship https://cosmology-tech.github.io/starship/
 helm repo update
 helm search repo starship/devnet --version v0.2.3
-helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3
+helm install -f ../../__fixtures__/config.yaml osmojs starship/devnet --version v0.2.3 --timeout 10m
 ps -ef | grep -i 'kubectl port-forward' | grep -v 'grep' | awk '{print $2}'
 sleep 2
 kubectl port-forward pods/osmosis-1-genesis-0 26657:26657 > /dev/null 2>&1 &

clients/js/packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@starship-ci/client",
-  "version": "2.9.1",
+  "version": "2.9.2",
   "author": "Dan Lynch <[email protected]>",
   "description": "Starship CI Client",
   "main": "index.js",

clients/js/packages/client/src/client.ts

@@ -22,6 +22,7 @@ export interface StarshipContext {
   namespace?: string;
   verbose?: boolean;
   curdir?: string;
+  timeout?: string;
 }
 
 export const defaultStarshipContext: Partial<StarshipContext> = {
@@ -30,7 +31,8 @@ export const defaultStarshipContext: Partial<StarshipContext> = {
   repoUrl: 'https://cosmology-tech.github.io/starship/',
   chart: 'starship/devnet',
   namespace: '',
-  version: ''
+  version: '',
+  timeout: '10m'
 };
 
 export interface PodPorts {
@@ -47,7 +49,7 @@ export interface PodPorts {
 }
 
 const defaultName: string = 'starship';
-const defaultVersion: string = 'v0.2.13';
+const defaultVersion: string = 'v0.2.14';
 
 // TODO talk to Anmol about moving these into yaml, if not already possible?
 const defaultPorts: PodPorts = {
@@ -395,6 +397,8 @@ export class StarshipClient implements StarshipClientI {
       this.ctx.chart,
       '--version',
       this.config.version,
+      '--timeout',
+      this.ctx.timeout,
       ...this.getDeployArgs(),
       ...options
     ];
@@ -507,12 +511,35 @@ export class StarshipClient implements StarshipClientI {
       { log: false, silent: true }
     ).trim();
 
-    const [phase, readyList, restartCountList, reason] = result.split(/\s+/);
+    // Ensure the output contains valid fields to split
+    const parts = result.split(/\s+/);
+    if (parts.length < 3) {
+      this.log(
+        chalk.red(`Unexpected pod status output for ${podName}: ${result}`)
+      );
+      return;
+    }
+
+    const [phase, readyList, restartCountList, reason] = parts;
+
+    // Validate readyList and restartCountList before applying split
+    if (!readyList || !restartCountList) {
+      this.log(
+        chalk.red(
+          `Invalid ready or restart count for pod ${podName}: ${result}`
+        )
+      );
+      return;
+    }
+
     const ready = readyList.split(',').every((state) => state === 'true');
     const restarts = restartCountList
       .split(',')
       .reduce((acc, count) => acc + parseInt(count, 10), 0);
 
+    // check for repeated image pull errors
+    this.checkImagePullFailures(podName);
+
     this.podStatuses.set(podName, {
       phase,
       ready,
@@ -568,6 +595,74 @@ export class StarshipClient implements StarshipClientI {
     });
   }
 
+  public checkImagePullFailures(podName: string): void {
+    // Fetch events from kubectl describe for the given pod
+    const eventLines = this.getPodEventsFromDescribe(podName);
+    const errorPattern = /Failed to pull image/;
+    const imageErrors: { [image: string]: number } = {};
+
+    // Parse through event lines to identify image pull failures
+    eventLines.forEach((line) => {
+      const message = line || '';
+      if (errorPattern.test(message)) {
+        const imageMatch = message.match(/image "(.*?)"/);
+        if (imageMatch && imageMatch[1]) {
+          const imageName = imageMatch[1];
+          imageErrors[imageName] = (imageErrors[imageName] || 0) + 1;
+        }
+      }
+    });
+
+    // Log errors for images that have failed more than twice
+    Object.entries(imageErrors).forEach(([imageName, errorCount]) => {
+      if (errorCount >= 3) {
+        this.log(
+          `${chalk.red(
+            `
+            Error: Image '${imageName}' failed to pull ${errorCount} times for pod ${podName}.
+            Please check the image name and ensure it is correct.
+            Run "starship stop" to stop the deployment which would be in stuck state.
+            `
+          )}`
+        );
+        this.exit(1);
+      }
+    });
+  }
+
+  private getPodEventsFromDescribe(podName: string): string[] {
+    // Execute the 'kubectl describe pod' command
+    const result = this.exec(
+      ['kubectl', 'describe', 'pod', podName, ...this.getArgs()],
+      { log: false, silent: true }
+    );
+
+    // Check if the command was successful
+    if (result.code !== 0) {
+      this.log(
+        chalk.red(`Failed to describe pod ${podName}: ${result.stderr}`)
+      );
+      return [];
+    }
+
+    const describeOutput = result.stdout;
+
+    // Extract the 'Events' section from the describe output
+    const eventsSection = describeOutput.split('Events:')[1];
+    if (!eventsSection) {
+      this.log(chalk.yellow(`No events found for pod ${podName}`));
+      return [];
+    }
+
+    // Split the events section into individual lines
+    const eventLines = eventsSection
+      .split('\n')
+      .filter((line) => line.trim() !== '');
+    this.log(`event lints: ${eventLines.join('\n')}`);
+
+    return eventLines;
+  }
+
   private forwardPort(
     chain: Chain,
     localPort: number,

docs/pages/config/chains.mdx

@@ -351,3 +351,22 @@ chains:
       coins: 100000000000000uion
 ```
 
+## `readinessProbe` (optional)
+The `readinessProbe` directive allows you to set the readiness probe for the chain pods. This is useful when you want to test a chain with specific readiness probe settings.
+Note, this is the same as the [kubernetes readiness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
+
+```yaml
+chains:
+- id: osmosis-1
+  name: osmosis
+  numValidators: 1
+  readinessProbe:
+    exec:
+      command:
+      - bash
+      - -c
+      - |
+        $CHAIN_BIN status 2>&1 | jq -e '.SyncInfo.catching_up == false'
+    initialDelaySeconds: 60
+    periodSeconds: 20
+```

starship/charts/devnet/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.14
+version: 0.2.15
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

starship/charts/devnet/defaults.yaml

@@ -689,6 +689,9 @@ defaultChains:
             trap 'kill $killer 2>/dev/null' EXIT
             # Return the test's exit code, whether it succeeded, failed, or was killed.
             wait $tester
+      initialDelaySeconds: 10
+      periodSeconds: 10
+      timeoutSeconds: 15
   kujira:
     image: ghcr.io/cosmology-tech/starship/kujira:v1.1.0
     home: /root/.kujira

starship/charts/devnet/templates/chains/cosmos/genesis.yaml

@@ -287,10 +287,10 @@ spec:
             httpGet:
               path: /status
               port: 26657
-            {{- end }}
             initialDelaySeconds: 10
             periodSeconds: 10
             timeoutSeconds: 15
+            {{- end }}
           {{- end }}
         - name: exposer
           image: {{ $.Values.exposer.image }}

starship/charts/devnet/templates/chains/cosmos/validator.yaml

@@ -292,10 +292,10 @@ spec:
             httpGet:
               path: /status
               port: 26657
-            {{- end }}
             initialDelaySeconds: 10
             periodSeconds: 10
             timeoutSeconds: 15
+            {{- end }}
           {{- end }}
         - name: exposer
           image: {{ $.Values.exposer.image }}

starship/charts/devnet/values.schema.json

@@ -556,6 +556,9 @@
                 "amount"
               ]
             }
+          },
+          "readinessProbe": {
+            "type": "object"
           }
         },
         "additionalProperties": false,