You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: To make the process easy we have a simple command that will try and install dependencies
50
+
so that you dont have to.
51
+
52
+
```bash
53
+
yarn starship setup
54
+
```
55
+
56
+
This command will
57
+
58
+
- check (and install) if your system has all the dependencies needed to run the e2e tests wtih Starship
59
+
- fetch the helm charts for Starship
60
+
61
+
## 2. Connect to a kubernetes cluster
62
+
63
+
Inorder to set up the infrastructure, for Starship, we need access to a kubernetes cluster.
64
+
One can either perform connect to a
65
+
66
+
- remote cluster in a managed kubernetes service
67
+
- use kubernetes desktop to spin up a cluster
68
+
- use kind to create a local cluster on local machine
69
+
70
+
To make this easier we have a handy command which will create a local kind cluster and give you access
71
+
to a kubernetes cluster locally.
72
+
73
+
NOTE: Resources constraint on local machine will affect the performance of Starship spinup time
74
+
75
+
```bash
76
+
yarn starship setup-kind
77
+
```
78
+
79
+
Run the following command to check connection to a k8s cluster
80
+
81
+
```bash
82
+
kubectl get pods
83
+
```
84
+
85
+
## 3. Start Starship
86
+
87
+
Now with the dependencies and a kubernetes cluster in handy, we can proceed with creating the mini-cosmos ecosystem
88
+
89
+
Run
90
+
91
+
```bash
92
+
yarn starship deploy
93
+
```
94
+
95
+
We use the config file `configs/config.yaml` as the genesis file to define the topology of the e2e test infra. Change it as required
96
+
97
+
Note: Spinup will take some time, while you wait for the system, can check the progress in another tab with `kubectl get pods`
98
+
99
+
## 4. Run the tests
100
+
101
+
We have everything we need, our desired infrastructure is now running as intended, now we can run
102
+
our end-to-end tests.
103
+
104
+
Run
105
+
106
+
```bash
107
+
npm run starship:test
108
+
```
109
+
110
+
## 5. Stop the infra
111
+
112
+
The tests should be ideompotent, so the tests can be run multiple times (which is recommeded), since the time to spinup is still high (around 5 to 10 mins).
113
+
114
+
Once the state of the mini-cosmos is corrupted, you can stop the deployments with
115
+
116
+
```bash
117
+
npm run starship clean
118
+
```
119
+
120
+
Which will
121
+
122
+
- Stop port-forwarding the traffic to your local
123
+
- Delete all the helm charts deployed
124
+
125
+
## 6. Cleanup kind (optional)
126
+
127
+
If you are using kind for your kubernetes cluster, you can delete it with
128
+
129
+
```bash
130
+
yarn starship clean-kind
131
+
```
132
+
133
+
## Related
134
+
135
+
Checkout these related projects:
136
+
137
+
-[@cosmology/telescope](https://github.com/hyperweb-io/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
138
+
-[@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
139
+
-[chain-registry](https://github.com/hyperweb-io/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
140
+
-[interchain-kit](https://github.com/hyperweb-io/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
141
+
-[create-interchain-app](https://github.com/hyperweb-io/create-interchain-app) Set up a modern Cosmos app by running one command.
142
+
-[interchain-ui](https://github.com/hyperweb-io/interchain-ui) The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
143
+
-[starship](https://github.com/hyperweb-io/starship) Unified Testing and Development for the Interchain.
144
+
145
+
## Credits
146
+
147
+
🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/hyperweb-io)
148
+
149
+
## Disclaimer
150
+
151
+
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
152
+
153
+
No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.
0 commit comments