Project improvements (#813)

* migrate CI to github actions * add binaries to gitignore * update linter configuration * update go version to 1.17 * create new useful commands and set default one on makefile * create working drand network on docker compose * update go version on generate CI workflow * set go and go grpc protobuf version on Makefile * update golangci-lint version * fix issues reported by linter * add build/test job to be run on PRs too
drand · Sep 27, 2021 · eeaae0a · eeaae0a
1 parent a2ba475
commit eeaae0a
Show file tree

Hide file tree

Showing 24 changed files with 436 additions and 142 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml
@@ -16,15 +16,16 @@ jobs:
       with:
         path: ~/go/pkg/mod
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+    - uses: actions/setup-go@v2
+      with:
+        go-version: '^1.17'
     - name: Fetch Dependencies
       run: go get ./...
-    -
-      name: Install Protoc
+    - name: Install Protoc
       uses: arduino/setup-protoc@v1.1.2
       with:
         version: '3.14.0'
-    -
-      name: Install Protoc-gen-go
+    - name: Install Protoc-gen-go
       run: |
         go get github.com/golang/protobuf/protoc-gen-go@v1.4.3
         go get google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1.0

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -20,5 +20,5 @@ jobs:
     - name: Run golangci-lint
       uses: golangci/golangci-lint-action@v2.3.0
       with:
-        version: v1.29
+        version: v1.41
         args: --timeout 5m
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -0,0 +1,35 @@
+name: "Publish image"
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  deploy:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.16'
+      - uses: actions/cache@v2
+        id: cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Build and push Docker image
+        run: |
+          docker build --build-arg version=`git describe --tags` --build-arg gitCommit=`git rev-parse HEAD` -t drandorg/go-drand:latest .
+          echo $DOCKER_PWD | docker login -u $DOCKER_LOGIN --password-stdin
+          docker push drandorg/go-drand:latest
+        env:
+          DOCKER_PWD: ${{ secrets.DOCKER_PWD }}
+          DOCKER_LOGIN: ${{ secrets.DOCKER_LOGIN }}
diff --git a/.github/workflows/publish_tagged.yaml b/.github/workflows/publish_tagged.yaml
@@ -0,0 +1,35 @@
+name: "Publish tagged image"
+
+on:
+  release:
+    types:
+      - created
+    tags:
+      - "v[0-9]+(\\.[0-9]+)*"
+
+jobs:
+  tagged-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.16'
+      - uses: actions/cache@v2
+        id: cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Build and push tagged Docker image
+        run: |
+          docker build --build-arg version=`git describe --tags` --build-arg gitCommit=`git rev-parse HEAD` -t drandorg/go-drand:`git describe --tags` .
+          echo $DOCKER_PWD | docker login -u $DOCKER_LOGIN --password-stdin
+          docker push drandorg/go-drand:`git describe --tags`
+        env:
+          DOCKER_PWD: ${{ secrets.DOCKER_PWD }}
+          DOCKER_LOGIN: ${{ secrets.DOCKER_LOGIN }}
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -0,0 +1,76 @@
+name: "Build/Tests"
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '^1.16'
+      - uses: actions/cache@v2
+        id: cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Build
+        run: |
+          export PATH=$PATH:$(go env GOPATH)/bin
+          make drand
+          make drand-client
+          make drand-relay-http
+          make drand-relay-gossip
+          make drand-relay-s3
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.16'
+      - uses: actions/cache@v2
+        id: cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - run: go get -v -t -d ./...
+      - name: Unit tests
+        run: make test-unit
+      - run: make test-integration
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.16'
+      - uses: actions/cache@v2
+        id: cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - run: go get -u github.com/ory/go-acc
+      - run: go get -v -t -d ./...
+      - run: go-acc ./...
+      - run: bash <(curl -s https://codecov.io/bash)
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,10 @@ gh-md-toc
 web/public/
 /drand
 cover*
+.idea
+drand
+drand-client
+drand-relay-gossip
+drand-relay-http
+drand-relay-s3
+docker/data*
diff --git a/.golangci.yml b/.golangci.yml
@@ -23,6 +23,7 @@ linters:
   # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
   disable-all: true
   enable:
+    - gocyclo
     - bodyclose
     - deadcode
     - depguard
@@ -36,20 +37,17 @@ linters:
     - gocyclo
     - gofmt
     - goimports
-    - golint
     - gomnd
     - goprintffuncname
     - gosec
     - gosimple
     - govet
     - ineffassign
-    - interfacer
     - lll
     - misspell
     - nakedret
     - nolintlint
     - rowserrcheck
-    - scopelint
     - staticcheck
     - structcheck
     - stylecheck

diff --git a/Makefile b/Makefile
@@ -1,5 +1,38 @@
 .PHONY: test test-unit test-integration demo deploy-local linter install build client drand relay-http relay-gossip relay-s3
 
+drand: build
+
+####################  Lint and fmt process ##################
+
+install_lint:
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.41.1
+
+lint:
+	golangci-lint --version
+	golangci-lint run -E gofmt -E gosec -E goconst -E gocritic --timeout 5m
+
+lint-todo:
+	golangci-lint run -E stylecheck -E gosec -E goconst -E godox -E gocritic
+
+fmt:
+	@echo "Checking (& upgrading) formatting of files. (if this fail, re-run until success)"
+	@{ \
+		files=$$( go fmt ./... ); \
+		if [ -n "$$files" ]; then \
+		echo "Files not properly formatted: $$files"; \
+		exit 1; \
+		fi; \
+	}
+
+check-modtidy:
+	go mod tidy
+	git diff --exit-code -- go.mod go.sum
+
+clean:
+	go clean
+
+############################################ Test ############################################
+
 test: test-unit test-integration
 
 test-unit:
@@ -26,6 +59,13 @@ demo:
 	cd demo && go build && ./demo -build
 	#cd demo && sudo ./run.sh
 
+############################################ Build ############################################
+
+build_proto:
+	go get -u github.com/golang/protobuf/protoc-gen-go@v1.4.3
+	go get -u google.golang.org/grpc/cmd/protoc-gen-go-grpc@1.1.0
+	cd protobuf && sh ./compile_proto.sh
+
 # create the "drand" binary and install it in $GOBIN
 install:
 	go install -ldflags "-X github.com/drand/drand/cmd/drand-cli.version=`git describe --tags` -X github.com/drand/drand/cmd/drand-cli.buildDate=`date -u +%d/%m/%Y@%H:%M:%S` -X github.com/drand/drand/cmd/drand-cli.gitCommit=`git rev-parse HEAD`"
@@ -34,8 +74,6 @@ install:
 build:
 	go build -o drand -mod=readonly -ldflags "-X github.com/drand/drand/cmd/drand-cli.version=`git describe --tags` -X github.com/drand/drand/cmd/drand-cli.buildDate=`date -u +%d/%m/%Y@%H:%M:%S` -X github.com/drand/drand/cmd/drand-cli.gitCommit=`git rev-parse HEAD`"
 
-drand: build
-
 # create the "drand-client" binary in the current folder
 client:
 	go build -o drand-client -mod=readonly -ldflags "-X main.version=`git describe --tags` -X main.buildDate=`date -u +%d/%m/%Y@%H:%M:%S` -X main.gitCommit=`git rev-parse HEAD`" ./cmd/client
@@ -55,3 +93,17 @@ drand-relay-gossip: relay-gossip
 relay-s3:
 	go build -o drand-relay-s3 -mod=readonly -ldflags "-X main.version=`git describe --tags` -X main.buildDate=`date -u +%d/%m/%Y@%H:%M:%S` -X main.gitCommit=`git rev-parse HEAD`" ./cmd/relay-s3
 drand-relay-s3: relay-s3
+
+build_all: drand drand-client drand-relay-http drand-relay-gossip drand-relay-s3
+
+############################################ Deps ############################################
+
+install_deps_linux:
+	PROTOC_ZIP=protoc-3.14.0-linux-x86_64.zip
+	curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.14.0/$PROTOC_ZIP
+	sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
+	sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
+	rm -f $PROTOC_ZIP
+
+install_deps_darwin:
+	brew install protobuf