Merge pull request #271 from electrocucaracha/improve_ci

Refactor GitHub workflows

Author: ashcherbakov

.github/dependabot.yml

@@ -0,0 +1,21 @@
+---
+# Copyright 2022 Samsung Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/verify.yml

@@ -13,65 +13,75 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Go
-# name: verify TODO rename (requires repo settings update)
-
+name: Check Unit and Integration tests
 # yamllint disable-line rule:truthy
 on:
   push:
-    branches: [master]
+    branches:
+      - master
   pull_request:
-    branches: [master, issue-99-cosmos-upgrade-v0.44]
+    branches:
+      - master
+      - issue-99-cosmos-upgrade-v0.44
   workflow_dispatch:
 
 jobs:
-
-  build:
-    name: Build  # TODO remove (requires repo settings update)
+  changes:
     runs-on: ubuntu-latest
+    outputs:
+      go: ${{ steps.filter.outputs.go }}
+      src: ${{ steps.filter.outputs.src }}
     steps:
-
-      - name: Build
-        run: true
-
-  unit:
-    name: Unit tests  # TODO remove (requires repo settings update)
+      - uses: actions/checkout@v3
+      - uses: dorny/paths-filter@v2
+        if: ${{ !env.ACT }}
+        id: filter
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          filters: |
+            go:
+              - '**/*.go'
+              - 'go.mod'
+              - 'go.sum'
+            src:
+              - '!**.md'
+              - '!.github/*'
+  unit-tests:
+    name: Check unit tests
     runs-on: ubuntu-latest
+    needs:
+      - lint
     steps:
-
-      - name: Set up Go 1.x
-        uses: actions/setup-go@v2
+      - uses: actions/setup-go@v2
         with:
           go-version: ^1.16
-
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
       - uses: actions/cache@v2
+        if: ${{ !env.ACT }}
         with:
           path: |
             ~/.cache/go-build
             ~/go/pkg/mod
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
-
-      - name: Run units
-        run: make test
-
-  integration:
-    name: Integration tests  # remove (requires repo settings update)
+      - uses: haveyoudebuggedit/gotestfmt-action@v2
+      - name: Run tests
+        run: |
+          set -euo pipefail
+          # shellcheck disable=SC2046
+          go test -json -v $(go list ./... | grep -v '/integration_tests') 2>&1 | tee /tmp/gotest.log | gotestfmt
+  integration-tests:
+    if: needs.changes.outputs.src == 'true'
+    name: Integration tests
     runs-on: ubuntu-latest
+    needs:
+      - changes
     steps:
-
-      - name: Set up Go 1.x
-        uses: actions/setup-go@v2
+      - uses: actions/setup-go@v2
         with:
-          go-version: ^1.16
-
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
-
+          go-version: ^1.13
+      - uses: actions/checkout@v3
       - uses: actions/cache@v2
         with:
           path: |
@@ -80,42 +90,30 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
-
       - name: Run integration tests
-        run: bash integration_tests/run-all.sh
-
+        shell: bash
+        run: integration_tests/run-all.sh
   lint:
-    name: Lint  # TODO remove (requires repo settings update)
+    if: needs.changes.outputs.go == 'true'
+    name: Check linter issues with golangci-lint tool
     runs-on: ubuntu-latest
+    needs:
+      - changes
     steps:
-
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.43
           args: --timeout 5m0s
-
-  license:
-    name: License  # TODO remove (requires repo settings update)
+  check:
+    if: always()
+    needs:
+      - unit-tests
+      - integration-tests
+      - lint
     runs-on: ubuntu-latest
     steps:
-
-      - name: Set up Go 1.x
-        if: false  # TODO issue 99
-        uses: actions/setup-go@v2
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
         with:
-          go-version: ^1.16
-
-      - name: Get google/addlicense
-        if: false  # TODO issue 99
-        run: go get -u github.com/google/addlicense
-
-      - name: Check out code into the Go module directory
-        if: false  # TODO issue 99
-        uses: actions/checkout@v2
-
-      - name: Check license
-        if: false  # TODO issue 99
-        run: make license-check
+          jobs: ${{ toJSON(needs) }}

.golangci.yml

@@ -16,38 +16,33 @@
 linters:
   enable-all: true
   disable:
-    - golint
-    - unparam
+    - golint  # The linter 'golint' is deprecated (since v1.41.0) due to: The repository of the linter has been archived by the owner.  Replaced by revive.
     - gochecknoinits
     - gochecknoglobals
     - gomnd
-    - nolintlint
     - dupl
     - varnamelen
     - tagliatelle
     - wrapcheck
-    - thelper
     - testpackage
     - paralleltest
     - ireturn
-    - nlreturn
     - goerr113
     - exhaustivestruct
     - wsl
     - forcetypeassert
     - exhaustive
-    - scopelint
-    - revive
+    - scopelint  # The linter 'scopelint' is deprecated (since v1.39.0) due to: The repository of the linter has been deprecated by the owner.  Replaced by exportloopref.
     - lll
-    - interfacer
+    - interfacer  # The linter 'interfacer' is deprecated (since v1.38.0) due to: The repository of the linter has been archived by the owner.
     - gosec
     - funlen
-    - stylecheck
     - cyclop
     - forbidigo
     - gocognit
     - godox
     - gomoddirectives
-    - maligned
+    - maligned  # The linter 'maligned' is deprecated (since v1.38.0) due to: The repository of the linter has been archived by the owner.  Replaced by govet 'fieldalignment'.
     - gci
-    - whitespace
+    - containedctx
+    - maintidx

app/app.go

@@ -609,6 +609,7 @@ func (app *App) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.Res
 		panic(err)
 	}
 	app.UpgradeKeeper.SetModuleVersionMap(ctx, app.mm.GetVersionMap())
+
 	return app.mm.InitGenesis(ctx, app.appCodec, genesisState)
 }
 
@@ -676,6 +677,7 @@ func (app *App) GetMemKey(storeKey string) *sdk.MemoryStoreKey {
 // NOTE: This is solely to be used for testing purposes.
 func (app *App) GetSubspace(moduleName string) paramstypes.Subspace {
 	subspace, _ := app.ParamsKeeper.GetSubspace(moduleName)
+
 	return subspace
 }
 
@@ -718,6 +720,7 @@ func GetMaccPerms() map[string][]string {
 	for k, v := range maccPerms {
 		dupMaccPerms[k] = v
 	}
+
 	return dupMaccPerms
 }
 

app/export.go

@@ -37,6 +37,7 @@ func (app *App) ExportAppStateAndValidators(
 	if err != nil {
 		return servertypes.ExportedApp{}, err
 	}
+
 	return servertypes.ExportedApp{
 		AppState:        appState,
 		Validators:      validators,

cmd/dcld/cmd/genaccounts.go

@@ -99,7 +99,7 @@ the address will be looked up in the local Keybase.
 
 			ba := authtypes.NewBaseAccount(addr, pk, 0, 0)
 
-			var vendorID int32 = 0
+			var vendorID int32
 			if viper.GetString(FlagVID) != "" {
 				vendorID, err = cast.ToInt32E(viper.GetString(FlagVID))
 				if err != nil {
@@ -142,6 +142,7 @@ the address will be looked up in the local Keybase.
 			}
 
 			genDoc.AppState = appStateJSON
+
 			return dclgenutil.ExportGenesisFile(genDoc, genFile)
 		},
 	}

cmd/dcld/cmd/light.go

@@ -46,10 +46,10 @@ const (
 	FlagMaxConn          = "max-open-connections"
 	FlagTrustPeriod      = "trusting-period"
 	FlagStartTimeout     = "start-timeout"
-	FlagTlsCertFile      = "tls-cert-file"
-	FlagTlsCertFileShort = "c"
-	FlagTlsKeyFile       = "tls-key-file"
-	FlagTlsKeyFileShort  = "k"
+	FlagTLSCertFile      = "tls-cert-file"
+	FlagTLSCertFileShort = "c"
+	FlagTLSKeyFile       = "tls-key-file"
+	FlagTLSKeyFileShort  = "k"
 )
 
 // LightCmd represents the base command when called without any subcommands.
@@ -135,8 +135,8 @@ func init() {
 	LightCmd.Flags().Int64Var(&startTimeout, FlagStartTimeout, 0,
 		"How many seconds to wait before starting the light client proxy. Mostly for test purposes when light client is started at the same time as the pool.")
 
-	LightCmd.Flags().StringVarP(&tlsCertFile, FlagTlsCertFile, FlagTlsCertFileShort, "", "Path to the TLS certificate file")
-	LightCmd.Flags().StringVarP(&tlsKeyFile, FlagTlsKeyFile, FlagTlsKeyFileShort, "", "Path to the TLS key file")
+	LightCmd.Flags().StringVarP(&tlsCertFile, FlagTLSCertFile, FlagTLSCertFileShort, "", "Path to the TLS certificate file")
+	LightCmd.Flags().StringVarP(&tlsKeyFile, FlagTLSKeyFile, FlagTLSKeyFileShort, "", "Path to the TLS key file")
 }
 
 func runProxy(cmd *cobra.Command, args []string) error {
@@ -288,6 +288,7 @@ func checkForExistingProviders(db dbm.DB) (string, []string, error) {
 		return "", []string{""}, err
 	}
 	witnessesAddrs := strings.Split(string(witnessesBytes), ",")
+
 	return string(primaryBytes), witnessesAddrs, nil
 }
 
@@ -300,19 +301,20 @@ func saveProviders(db dbm.DB, primaryAddr, witnessesAddrs string) error {
 	if err != nil {
 		return fmt.Errorf("failed to save witness providers: %w", err)
 	}
+
 	return nil
 }
 
 func getTrustedHeightAndHash(primaryAddr string, witnessesAddrs []string) (int64, []byte, error) {
 	config := rpcserver.DefaultConfig()
 
 	// get height and hash from the primary
-	primaryRpcClient, err := rpchttp.NewWithTimeout(primaryAddr, "/websocket", uint(config.WriteTimeout.Seconds()))
+	primaryRPCClient, err := rpchttp.NewWithTimeout(primaryAddr, "/websocket", uint(config.WriteTimeout.Seconds()))
 	if err != nil {
 		return 0, []byte{}, fmt.Errorf("not able to obtain trusted height and hash: %w", err)
 	}
 
-	res, err := primaryRpcClient.Commit(context.Background(), nil)
+	res, err := primaryRPCClient.Commit(context.Background(), nil)
 	if err != nil {
 		return 0, []byte{}, fmt.Errorf("not able to obtain trusted height and hash: %w", err)
 	}
@@ -323,12 +325,12 @@ func getTrustedHeightAndHash(primaryAddr string, witnessesAddrs []string) (int64
 
 	// check that the hash for the given height is the same on all witnesses
 	for _, witnessesAddr := range witnessesAddrs {
-		witnessRpcClient, err := rpchttp.NewWithTimeout(witnessesAddr, "/websocket", uint(config.WriteTimeout.Seconds()))
+		witnessRPCClient, err := rpchttp.NewWithTimeout(witnessesAddr, "/websocket", uint(config.WriteTimeout.Seconds()))
 		if err != nil {
 			return 0, []byte{}, fmt.Errorf("not able to obtain trusted height and hash: %w", err)
 		}
 
-		res, err := witnessRpcClient.Commit(context.Background(), &primaryHeight)
+		res, err := witnessRPCClient.Commit(context.Background(), &primaryHeight)
 		if err != nil {
 			return 0, []byte{}, fmt.Errorf("not able to obtain trusted height and hash: %w", err)
 		}

cmd/dcld/cmd/root.go

@@ -54,6 +54,7 @@ type rootOptions struct {
 func newRootOptions(options ...Option) rootOptions {
 	opts := rootOptions{}
 	opts.apply(options...)
+
 	return opts
 }