Deprecate support for Gaia v5 in favor of Gaia v7 (#2092)

* Remove `--legacy` flag from `upgrade-chain` command

* Remove options related to `legacy` flag

* Remove Proposal::Legacy variant

* Update GAIA_BRANCH parameter

* Rename docker-compose files and update README accordingly

* Update GAIA_BRANCH parameter to v7.0.0 and update README

* Have GAIA_BRANCH point to v7.0.1

* Update gaia versions in docker-compose yml files

* Debug session w/ Sean

* Remove problematic line from gaia.Dockerfile

* Commit generated gaia v7 files

* Update github workflows and CI README

* Remove a bogus argument to docker build

* generated new files, push to dockerhub, update reamdes

* changelog

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Co-authored-by: Adi Seredinschi <adi@informal.systems>
Co-authored-by: Mikhail Zabaluev <mikhail@informal.systems>

.changelog/unreleased/features/1986-gaia-e2e-tests.md

@@ -0,0 +1,2 @@
+- Replaced gaia v5 with v7 in E2E tests.
+  ([#1986](https://github.com/informalsystems/ibc-rs/issues/1986))

.github/workflows/e2e-gaia-current-release.yaml

@@ -1,4 +1,4 @@
-name: End to End testing (Gaia - v5.0.8)
+name: End to End testing (Gaia - v7.0.1)
 on:
   pull_request:
     paths:
@@ -56,4 +56,5 @@ jobs:
       - name: Start chains and relayer
         run: docker-compose -f ci/docker-compose-gaia-current.yml up -d ibc-0 ibc-1 relayer
       - name: Run relayer workflow
+        continue-on-error: false
         run: docker exec relayer /bin/sh -c /relayer/e2e.sh

.github/workflows/e2e-gaia-future-release.yaml → .github/workflows/e2e-gaia-legacy-release.yaml

@@ -37,7 +37,7 @@ env:
   RUSTUP_MAX_RETRIES: 10
 
 jobs:
-  test-end-to-end-future-gaia:
+  test-end-to-end-current-gaia:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
@@ -52,9 +52,8 @@ jobs:
           args: --workspace
       - run: cp ./target/debug/hermes .
       - name: Build relayer image
-        run: docker-compose -f ci/docker-compose-gaia-future.yml build relayer
+        run: docker-compose -f ci/docker-compose-gaia-legacy.yml build relayer
       - name: Start chains and relayer
-        run: docker-compose -f ci/docker-compose-gaia-future.yml up -d ibc-0 ibc-1 relayer
+        run: docker-compose -f ci/docker-compose-gaia-legacy.yml up -d ibc-0 ibc-1 relayer
       - name: Run relayer workflow
-        continue-on-error: false
         run: docker exec relayer /bin/sh -c /relayer/e2e.sh

ci/README.md

@@ -21,41 +21,48 @@ Follow these steps to run the e2e test locally:
 
 __Note__: This assumes you are running this the first time, if not, please ensure you follow the steps to [clean up the containers](#cleaning-up) before running it again.
 
-1. Clone the `ibc-rs` repo
+1. Clone the `ibc-rs` repo.
 
-
-2. Go into the repository folder
+2. Go into the repository folder:
 
     `cd ibc-rs`
 
+3. Build the current up-to-date relayer container image. Make sure you have a
+   copy of the `hermes` binary in the root of the repo, as the docker script
+   expects this. If you don't, you can run `cp ./target/debug/hermes .`. This
+   command might take a few minutes since it will do a fresh compile and build
+   of all modules:
 
-3. Build the relayer container image (this might take a few minutes since it will do a fresh compile and build of all modules)
-
-    `docker-compose -f ci/docker-compose.yml build relayer`
+    `docker-compose -f ci/docker-compose-gaia-current.yml build relayer`
 
+> Note: If you're looking to test on a legacy version of gaia, run:
+> `docker-compose -f ci/docker-compose-gaia-legacy.yml build relayer`.
+> You'll use the `docker-compose-gaia-legacy.yml` configuration instead of
+> `docker-compose-gaia-current.yml` in all cases.
 
 4. Run all the containers (two containers, one for each chain and one for the relayer)
 
-   `docker-compose -f ci/docker-compose.yml up -d ibc-0 ibc-1 relayer`
+   `docker-compose -f ci/docker-compose-gaia-current.yml up -d ibc-0 ibc-1 relayer`
 
-    If everything is successful you should see a message saying:
+    If everything is successful you should see among the output something
+    similar to this:
     ```shell
-    Creating ibc-1 ... done
-    Creating ibc-0 ... done
-    Creating relayer ... done
+    Network ci_relaynet  Created
+    Container ibc-1      Started
+    Container ibc-0      Started
+    Container relayer    Started
     ```
 
     If you want to ensure they are all running properly you can use the command:
 
-    `docker-compose -f ci/docker-compose.yml ps`
+    `docker-compose -f ci/docker-compose-gaia-current.yml ps`
 
-    You should see the message below. Please ensure all containers are in a `Up` state
+    You should see the message below. Please ensure all containers are in a `running` state.
     ```shell
-    Name                Command               State   Ports
-    --------------------------------------------------------
-    ibc-0     gaiad start --home=/chain  ...   Up
-    ibc-1     gaiad start --home=/chain  ...   Up
-    relayer   /bin/sh                          Up
+
+    ibc-0     "/chain/gaia/run-gaia..."   ibc-0         running
+    ibc-1     "/chain/gaia/run-gaia..."   ibc-1         running
+    relayer   "/bin/sh"                   relayer       running
     ```
 
     __Note__: If this is the first time you're running this command, the `informaldev/ibc-0:[RELEASE TAG]` and `informaldev/ibc-1:[RELEASE TAG]` container images will be pulled from the Docker Hub. For instructions on how to update these images in Docker Hub please see the [upgrading the release](#upgrading-chains) section.
@@ -154,26 +161,26 @@ Jan 21 18:46:58.324  INFO relayer::event::monitor: running listener chain.id=ibc
 
 In order to clear up the testing environment and stop the containers you can run the command below
 
-`docker-compose -f ci/docker-compose.yml down`
+`docker-compose -f ci/docker-compose-gaia-current.yml down`
 
 If the command executes successfully you should see the message below:
 
 ```shell
-Stopping relayer ... done
-Stopping ibc-0   ... done
-Stopping ibc-1   ... done
-Removing relayer ... done
-Removing ibc-0   ... done
-Removing ibc-1   ... done
-Removing network ibc-rs_relaynet
+Container relayer    Removed
+Container ibc-1      Removed
+Container ibc-0      Removed
+Network ci_relaynet  Removed
 ```
 
 ### [Upgrading the gaia chains release and generating new container images](#upgrading-chains)
 
 The repository stores the files used to configure and build the chains for the containers. For example, the files for a `gaia` chain release `v5.0.0` can be seen [here](./chains/gaia)
 
 > Note: Please ensure you have gaiad installed on your machine and it matches the version that you're trying to upgrade.
-> You can check but running `gaiad version` in your machine
+> You can check by running `gaiad version` in your machine.
+>
+> If you need to upgrade your local `gaiad` binary, you can follow the steps
+> listed in the Cosmos Hub documentation on [installing the binary](https://hub.cosmos.network/main/getting-started/installation.html).
 
 If you need to generate configuration files for a new gaia release and new containers, please follow the steps below:
 
@@ -198,13 +205,13 @@ __Note__: This will generate the files for the chains in the `/ci/chains/gaia` f
 
 
 5. Update the release for Docker Compose. If this new release should be the default release for running the end to end (e2e) test you need to update the release version in the `docker-compose.yml` file in the `ci` folder of the repository. Open the file and change the release version in all the places required (image name and RELEASE variables. For example, if current release is `v4.0.0` and the new one is `v5.0.0` just do a find and replace with these two values.
-   
+
 Change the version in the image for ibc-0 and ibc-1 services:
-   
+
    ```
    image: "informaldev/ibc-0:v4.0.0"
    ```
-   
+
 And in the relayer service:
 
    ```
@@ -214,9 +221,9 @@ And in the relayer service:
 
 6. Update the CI workflow
 
-There are currently two CI workflows, for running the E2E tests against two versions of gaiad: 
-   - current release: `.github\workflows\e2e-gaia-current-release.yaml`, and
-   - future release: `.github\workflows\e2e-gaia-future-release.yaml`.
+There are currently two CI workflows, for running the E2E tests against two versions of gaiad:
+   - legacy release: `.github\workflows\e2e-gaia-legacy-release.yaml`, and
+   - current release: `.github\workflows\e2e-gaia-current-release.yaml`.
 
 Depending on which of the two setups you have upgraded at the prior steps, change the `name` key in the corresponding workflow file to match with the version of the upgraded gaia used, e.g.:
 

ci/build-chains.sh

@@ -4,7 +4,7 @@
 ## Instead of blindly running this code, read it line by line and understand the dependecies and tasks.
 ## Prerequisites: Log into Docker Hub
 set -eou pipefail
-GAIA_BRANCH="stargate-4" # Requires a version with the `--keyring-backend` option. v2.1 and above.
+GAIA_BRANCH="v7.0.1" # Requires a version with the `--keyring-backend` option. v2.1 and above.
 
 echo "*** Requirements"
 which git && which go && which make && which sed && which jq && which docker

ci/build-ibc-chains.sh

@@ -13,7 +13,7 @@ set -eou pipefail
 # GAIA_BRANCH="v5.0.8" # Requires a version with the `--keyring-backend` option. v2.1 and above.
 
 # For future gaia use this
-GAIA_BRANCH="v6.0.0" # Requires a version with the `--keyring-backend` option. v2.1 and above.
+GAIA_BRANCH="v7.0.1" # Requires a version with the `--keyring-backend` option. v2.1 and above.
 
 # Check if gaiad is installed and if the versions match
 if ! [ -x "$(command -v gaiad)" ]; then
@@ -72,8 +72,8 @@ echo "*** Requirements"
 which docker
 
 echo "*** Create Docker image and upload to Docker Hub"
-docker build --build-arg CHAIN=gaia --build-arg RELEASE=$GAIA_BRANCH --build-arg NAME=ibc-0 -f --no-cache -t informaldev/ibc-0:$GAIA_BRANCH -f "$BASE_DIR/gaia.Dockerfile" .
-docker build --build-arg CHAIN=gaia --build-arg RELEASE=$GAIA_BRANCH --build-arg NAME=ibc-1 -f --no-cache -t informaldev/ibc-1:$GAIA_BRANCH -f "$BASE_DIR/gaia.Dockerfile" .
+docker build --build-arg CHAIN=gaia --build-arg RELEASE=$GAIA_BRANCH --build-arg NAME=ibc-0 --no-cache -t informaldev/ibc-0:$GAIA_BRANCH -f "$BASE_DIR/gaia.Dockerfile" .
+docker build --build-arg CHAIN=gaia --build-arg RELEASE=$GAIA_BRANCH --build-arg NAME=ibc-1 --no-cache -t informaldev/ibc-1:$GAIA_BRANCH -f "$BASE_DIR/gaia.Dockerfile" .
 
 read -p "Press ANY KEY to push image to Docker Hub, or CTRL-C to cancel. " dontcare
 docker push informaldev/ibc-0:$GAIA_BRANCH

ci/chains/gaia/v7.0.1/ibc-0/config/addrbook.json

@@ -0,0 +1,4 @@
+{
+	"key": "f79fd5952365514d9426b513",
+	"addrs": []
+}