Chain Upgrade Test

.github/workflows/integration-tests.yml

@@ -5,13 +5,16 @@ on:
     branches:
       - main
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
   pull_request:
 
 env:
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
   ORCHESTRATOR_IMAGE_NAME: ghcr.io/peggyjv/gravity-bridge-orchestrator:main
+  ETHEREUM_IMAGE: ghcr.io/peggyjv/sommelier-hardhat:v3.1.0
+  SOMMELIER_IMAGE: ghcr.io/peggyjv/sommelier-sommelier:v3.1.0
+  ORCHESTRATOR_IMAGE: ghcr.io/peggyjv/gravity-bridge-orchestrator:v0.3.8
 
 jobs:
   sommelier-build:
@@ -109,20 +112,17 @@ jobs:
   integration-tests:
     environment: CI
     runs-on: [self-hosted, linux]
-    needs: [ sommelier-build, hardhat-build ]
+    needs: [sommelier-build, hardhat-build]
     strategy:
       fail-fast: false
       matrix:
-        test_type: [
-          "Cork",
-          "ScheduledCork",
-        ]
+        test_type: ["Cork", "ScheduledCork"]
     steps:
-# Not needed on self hosted test runner that already has go installed
-#       - name: Set up Go 1.16
-#         uses: actions/setup-go@v2
-#         with:
-#           go-version: ^1.16
+      # Not needed on self hosted test runner that already has go installed
+      #       - name: Set up Go 1.16
+      #         uses: actions/setup-go@v2
+      #         with:
+      #           go-version: ^1.16
       - name: checkout
         uses: actions/checkout@v2
       - name: go-cache
@@ -170,3 +170,69 @@ jobs:
         run: ./integration_tests/integration_tests.test -test.failfast -test.v -test.run IntegrationTestSuite -testify.m Test${{ matrix.test_type }}
         env:
           ARCHIVE_NODE_URL: ${{ secrets.ARCHIVE_NODE_URL }}
+
+  upgrade-tests:
+    environment: CI
+    runs-on: [self-hosted, linux]
+    needs: [sommelier-build, hardhat-build]
+    strategy:
+      fail-fast: false
+      matrix:
+        test_type: ["SommChainUpgrade"]
+    steps:
+      # Not needed on self hosted test runner that already has go installed
+      #       - name: Set up Go 1.16
+      #         uses: actions/setup-go@v2
+      #         with:
+      #           go-version: ^1.16
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: go-cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: container-login
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: docker sommelier metadata
+        id: meta-sommelier
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-sommelier
+      - name: docker hardhat metadata
+        id: meta-hardhat
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-hardhat
+      - name: pull sommelier upgrade image
+        run: docker pull ${{ steps.meta-sommelier.outputs.tags }}
+      - name: rename sommelier image
+        run: docker tag ${{ steps.meta-sommelier.outputs.tags }} sommelier:4.0.1
+      - name: pull hardhat image
+        run: docker pull ${{ env.ETHEREUM_IMAGE }}
+      - name: rename hardhat image
+        run: docker tag ${{ env.ETHEREUM_IMAGE }} ethereum:3.1.0
+      - name: pull orchestrator image
+        run: docker pull ${{ env.ORCHESTRATOR_IMAGE }}
+      - name: rename orchestrator image
+        run: docker tag ${{ env.ORCHESTRATOR_IMAGE }} orchestrator:3.1.0
+      - name: pull sommelier 3.1.0 image
+        run: docker pull ${{ env.SOMMELIER_IMAGE }}
+      - name: rename sommelier 3.1.0 image
+        run: docker tag ${{ env.SOMMELIER_IMAGE }} sommelier:3.1.0
+      - name: clean the slate
+        run: make e2e_clean_upgrade_slate
+      - name: build go test binary
+        run: cd upgrade_tests && go test -c
+      - name: Run end to end test
+        run: ./upgrade_tests/upgrade_tests.test -test.failfast -test.v -test.run UpgradeTestSuite -testify.m Test${{ matrix.test_type }}
+        env:
+          ARCHIVE_NODE_URL: ${{ secrets.ARCHIVE_NODE_URL }}

.github/workflows/lint.yml

@@ -23,7 +23,7 @@ jobs:
       - uses: golangci/golangci-lint-action@master
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.37
+          version: v1.49
           args: --timeout 10m
           github-token: ${{ secrets.github_token }}
         if: env.GIT_DIFF

Makefile

@@ -398,3 +398,58 @@ fail:
 	@docker logs orchestrator2 > testlogs/orchestrator2.log 2>&1 || true
 	@docker logs orchestrator3 > testlogs/orchestrator3.log 2>&1 || true
 	@false
+
+
+#####################
+# Upgrade test #
+#####################
+
+ORCHESTRATOR_IMAGE := "ghcr.io/peggyjv/gravity-bridge-orchestrator:v0.3.8"
+SOMMELIER_IMAGE := "ghcr.io/peggyjv/sommelier-sommelier:v3.1.0"
+ETHEREUM_IMAGE := "ghcr.io/peggyjv/sommelier-hardhat:v3.1.0"
+SOMM_IMAGE := hannydevelop/sommelier:4.0.1
+
+e2e_build_upgrade_images: e2e_clean_slate
+	@docker pull $(ORCHESTRATOR_IMAGE)
+	@docker tag $(ORCHESTRATOR_IMAGE) orchestrator:3.1.0
+	@docker build -t sommelier:4.0.1 -f Dockerfile .
+	@docker pull $(ETHEREUM_IMAGE)
+	@docker tag $(ETHEREUM_IMAGE) ethereum:3.1.0
+	@docker pull $(SOMMELIER_IMAGE)
+	@docker tag $(SOMMELIER_IMAGE) sommelier:3.1.0
+e2e_clean_upgrade_slate:
+	@docker rm --force \
+		$(shell docker ps -qa --filter="name=ethereum") \
+		$(shell docker ps -qa --filter="name=sommelier") \
+		$(shell docker ps -qa --filter="name=orchestrator") \
+		1>/dev/null \
+		2>/dev/null \
+		|| true
+	@docker wait \
+		$(shell docker ps -qa --filter="name=ethereum") \
+		$(shell docker ps -qa --filter="name=sommelier") \
+		$(shell docker ps -qa --filter="name=orchestrator") \
+		1>/dev/null \
+		2>/dev/null \
+		|| true
+	@docker network prune --force 1>/dev/null 2>/dev/null || true
+	@cd upgrade_tests && go test -c
+
+e2e_test_chain: e2e_clean_upgrade_slate
+	@upgrade_tests/upgrade_tests.test -test.run TestChain -test.failfast -test.v || make -s fail
+
+e2e_upgrade: e2e_clean_upgrade_slate
+	@E2E_SKIP_CLEANUP=true upgrade_tests/upgrade_tests.test -test.failfast -test.v -test.run UpgradeTestSuite -testify.m TestSommChainUpgrade || make -s fail
+
+fail:
+	@echo 'test failed; dumping container logs into ./testlogs for review'
+	@docker logs ethereum > testlogs/ethereum.log 2>&1 || true
+	@docker logs sommelier0 > testlogs/sommelier0.log 2>&1 || true
+	@docker logs sommelier1 > testlogs/sommelier1.log 2>&1 || true
+	@docker logs sommelier2 > testlogs/sommelier2.log 2>&1 || true
+	@docker logs sommelier3 > testlogs/sommelier3.log 2>&1 || true
+	@docker logs orchestrator0 > testlogs/orchestrator0.log 2>&1 || true
+	@docker logs orchestrator1 > testlogs/orchestrator1.log 2>&1 || true
+	@docker logs orchestrator2 > testlogs/orchestrator2.log 2>&1 || true
+	@docker logs orchestrator3 > testlogs/orchestrator3.log 2>&1 || true
+	@false

app/export.go

@@ -46,7 +46,8 @@ func (app *SommelierApp) ExportAppStateAndValidators(
 
 // prepare for fresh start at zero height
 // NOTE zero height genesis is a temporary feature which will be deprecated
-//      in favour of export at a block height
+//
+//	in favour of export at a block height
 func (app *SommelierApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []string) {
 	applyAllowedAddrs := false
 

integration_tests/chain.go

@@ -91,7 +91,7 @@ func (c *chain) configDir() string {
 	return fmt.Sprintf("%s/%s", c.dataDir, c.id)
 }
 
-func (c *chain) createAndInitValidators(count int) error { // nolint:unused
+func (c *chain) createAndInitValidators(count int) error { //nolint:unused
 	for i := 0; i < count; i++ {
 		node := c.createValidator(i)
 
@@ -144,7 +144,7 @@ func (c *chain) createAndInitValidatorsWithMnemonics(mnemonics []string) error {
 	return nil
 }
 
-func (c *chain) createAndInitOrchestrators(count int) error { // nolint:unused
+func (c *chain) createAndInitOrchestrators(count int) error { //nolint:unused
 	mnemonics := make([]string, count)
 	for i := 0; i < count; i++ {
 		mnemonic, err := createMnemonic()
@@ -194,7 +194,7 @@ func (c *chain) createOrchestrator(index int) *orchestrator {
 	}
 }
 
-func (c *chain) clientContext(nodeURI string, kb *keyring.Keyring, fromName string, fromAddr sdk.AccAddress) (*client.Context, error) { // nolint:unparam
+func (c *chain) clientContext(nodeURI string, kb *keyring.Keyring, fromName string, fromAddr sdk.AccAddress) (*client.Context, error) { //nolint:unparam
 	amino := codec.NewLegacyAmino()
 	interfaceRegistry := sdkTypes.NewInterfaceRegistry()
 	interfaceRegistry.RegisterImplementations((*sdk.Msg)(nil),

integration_tests/genesis.go

@@ -38,7 +38,7 @@ func getGenDoc(path string) (*tmtypes.GenesisDoc, error) {
 	return doc, nil
 }
 
-func addGenesisAccount(path, moniker, amountStr string, accAddr sdk.AccAddress) error { // nolint:unparam
+func addGenesisAccount(path, moniker, amountStr string, accAddr sdk.AccAddress) error { //nolint:unparam
 	serverCtx := server.NewDefaultContext()
 	config := serverCtx.Config
 

integration_tests/keys.go

@@ -9,7 +9,7 @@ import (
 	hdwallet "github.com/miguelmota/go-ethereum-hdwallet"
 )
 
-func createMnemonic() (string, error) { // nolint:unused
+func createMnemonic() (string, error) { //nolint:unused
 	entropySeed, err := bip39.NewEntropy(256)
 	if err != nil {
 		return "", err

integration_tests/setup_test.go

@@ -138,7 +138,7 @@ func (s *IntegrationTestSuite) TearDownSuite() {
 	s.Require().NoError(s.dockerPool.RemoveNetwork(s.dockerNetwork))
 }
 
-func (s *IntegrationTestSuite) initNodes(nodeCount int) { // nolint:unused
+func (s *IntegrationTestSuite) initNodes(nodeCount int) { //nolint:unused
 	s.Require().NoError(s.chain.createAndInitValidators(nodeCount))
 	s.Require().NoError(s.chain.createAndInitOrchestrators(nodeCount))
 
@@ -196,7 +196,7 @@ func (s *IntegrationTestSuite) initNodesWithMnemonics(mnemonics ...string) {
 	}
 }
 
-func (s *IntegrationTestSuite) initEthereum() { // nolint:unused
+func (s *IntegrationTestSuite) initEthereum() { //nolint:unused
 	// generate ethereum keys for validators add them to the ethereum genesis
 	ethGenesis := EthereumGenesis{
 		Difficulty: "0x400",

integration_tests/validator.go

@@ -167,7 +167,7 @@ func (v *validator) createKeyFromMnemonic(name, mnemonic string, passphrase stri
 	return nil
 }
 
-func (v *validator) createKey(name string) error { // nolint:unused
+func (v *validator) createKey(name string) error { //nolint:unused
 	mnemonic, err := createMnemonic()
 	if err != nil {
 		return err
@@ -176,7 +176,7 @@ func (v *validator) createKey(name string) error { // nolint:unused
 	return v.createKeyFromMnemonic(name, mnemonic, "")
 }
 
-func (v *validator) generateEthereumKey() error { // nolint:unused
+func (v *validator) generateEthereumKey() error { //nolint:unused
 	privateKey, err := crypto.GenerateKey()
 	if err != nil {
 		return err

upgrade_tests/Readme.md

@@ -0,0 +1,10 @@
+I couldn't find a way to spin up the chain, using their version number. I've initated an upgrade module, containing the `go.mod` and `go.sum` files. Here's how this suite works:
+
+- Seclude suite to conform previous chain version.
+- Run upgrade to current version.
+- Interact with upgraded version to ensure upgrade was successful.
+
+## Usage For Testing New Upgrades
+- Change Sommelier and Gravity versions in `go.mod`.
+- Work on suite setup files to reflect changes in Sommelier and Gravity.
+- Build docker image of the upgrade version.