Add a build script with more code quality checks (#2)

yoink00 · web-flow · commit de9370df3c39 · 2020-07-28T08:48:45.000+01:00
* Add a build script with more code quality checks
* Fix false go mod tidy check error
* Download modules before checks
diff --git a/.travis.yml b/.travis.yml
@@ -11,4 +11,4 @@ go:
 env:
   - CGO_ENABLED=0
 
-script: travis_wait 20 go test ./... -v -parallel 1 -timeout 60m
+script: travis_wait 20 ./scripts/build.sh
diff --git a/go.mod b/go.mod
@@ -5,5 +5,7 @@ go 1.14
 require (
 	github.com/blang/semver v3.5.1+incompatible
 	github.com/hashicorp/go-cleanhttp v0.5.1
+	github.com/kr/pretty v0.1.0 // indirect
 	github.com/stretchr/testify v1.6.1
+	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
 )
diff --git a/go.sum b/go.sum
@@ -1,15 +1,21 @@
-github.com/blang/semver v1.1.0 h1:ol1rO7QQB5uy7umSNV7VAmLugfLRD+17sYJujRNYPhg=
 github.com/blang/semver v3.5.1+incompatible h1:cQNTCjp13qL8KC3Nbxr/y2Bqb63oX6wdnnjpJbkM4JQ=
 github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/hashicorp/go-cleanhttp v0.5.1 h1:dH3aiDG9Jvb5r5+bYHsikaOUIpcM0xvgMXVoDkXMzJM=
 github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
+github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
+gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+#
+# Stop build script if there are any errors
+#
+set -x
+set -e
+
+PROJECT_HOME=$(git rev-parse --show-toplevel)
+if [[ -z "$GOBIN" ]]; then
+  GOBIN="$(go env GOPATH)/bin"
+fi
+
+# Get build dependencies
+pushd /tmp
+if [[ ! -e $GOBIN/staticcheck ]]; then
+  go get honnef.co/go/tools/cmd/staticcheck
+fi
+if [[ ! -e $GOBIN/goimports ]]; then
+  go get golang.org/x/tools/cmd/goimports
+fi
+popd
+
+# Go Mod Download
+go mod download
+
+# Check format of Go files
+$PROJECT_HOME/scripts/check-gofmt.sh .
+
+# Check format of Imports
+$PROJECT_HOME/scripts/check-goimports.sh .
+
+# Check module tidiness
+#$PROJECT_HOME/scripts/check-gomodtidy.sh
+
+# Check for common problems
+go vet ./...
+
+# Lint
+staticcheck ./...
+
+# Run tests
+go test ./... -v -parallel 1 -timeout 60m
+
diff --git a/scripts/check-gofmt.sh b/scripts/check-gofmt.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+DIR="."
+if [[ ! -z "$1" ]]; then
+  DIR="$1"
+fi
+
+go_files=$(gofmt -l -s $(find . -type f -name \*.go))
+if [[ ! -z "$go_files" ]]; then
+  echo "The following files need formatting:"
+  echo $go_files
+  exit 1
+fi
+
diff --git a/scripts/check-goimports.sh b/scripts/check-goimports.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+DIR="."
+if [[ ! -z "$1" ]]; then
+  DIR="$1"
+fi
+
+go_files=$(goimports -l $(find . -type f -name \*.go))
+if [[ ! -z "$go_files" ]]; then
+  echo "The following files need imports fixed:"
+  for f in $go_files; do
+    echo $f
+  done
+  exit 1
+fi
+
diff --git a/scripts/check-gomodtidy.sh b/scripts/check-gomodtidy.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+go_files=$(go mod tidy -v 2>&1)
+if [[ ! -z "$go_files" ]]; then
+  echo "The following modules need tidied."
+  echo $go_files
+  echo "If run locally they will have been tidied for you."
+  exit 1
+fi
+
diff --git a/upcloud/account_test.go b/upcloud/account_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalAccount tests that Account objects unmarshal correctly
diff --git a/upcloud/firewall_test.go b/upcloud/firewall_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalFirewallRules tests the FirewallRules and FirewallRule are unmarshaled correctly
diff --git a/upcloud/ip_address_test.go b/upcloud/ip_address_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalIPAddresses tests that IPAddresses and IPAddress structs are unmarshaled correctly
diff --git a/upcloud/plan_test.go b/upcloud/plan_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalPlans tests that Plans and Plan objects unmarshal correctly
diff --git a/upcloud/price_test.go b/upcloud/price_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUmarshalPriceZones tests that PrizeZones, PriceZone and Price are unmarshaled correctly
diff --git a/upcloud/request/firewall.go b/upcloud/request/firewall.go
@@ -3,6 +3,7 @@ package request
 import (
 	"encoding/xml"
 	"fmt"
+
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 )
 
diff --git a/upcloud/request/firewall_test.go b/upcloud/request/firewall_test.go
@@ -2,9 +2,10 @@ package request
 
 import (
 	"encoding/xml"
+	"testing"
+
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 // TestGetFirewallRulesRequest tests that GetFirewallRulesRequest behaves correctly
diff --git a/upcloud/request/ip_address_test.go b/upcloud/request/ip_address_test.go
@@ -2,9 +2,10 @@ package request
 
 import (
 	"encoding/xml"
+	"testing"
+
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 // TestGetIPAddressDetailsRequest tests that GetIPAddressDetailsRequest behaves correctly
diff --git a/upcloud/request/storage.go b/upcloud/request/storage.go
@@ -3,8 +3,9 @@ package request
 import (
 	"encoding/xml"
 	"fmt"
-	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"time"
+
+	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 )
 
 // GetStoragesRequest represents a request for retrieving all or some storages
diff --git a/upcloud/request/storage_test.go b/upcloud/request/storage_test.go
@@ -2,9 +2,10 @@ package request
 
 import (
 	"encoding/xml"
+	"testing"
+
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 // TestGetStoragesRequest tests that GetStoragesRequest objects behave correctly
diff --git a/upcloud/request/tag.go b/upcloud/request/tag.go
@@ -3,6 +3,7 @@ package request
 import (
 	"encoding/xml"
 	"fmt"
+
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 )
 
diff --git a/upcloud/request/tag_test.go b/upcloud/request/tag_test.go
@@ -2,9 +2,10 @@ package request
 
 import (
 	"encoding/xml"
+	"testing"
+
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 // TestCreateTagRequest tests that CreateTagRequest behaves correctly
diff --git a/upcloud/server_test.go b/upcloud/server_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalServerConfiguratons tests that ServerConfigurations and ServerConfiguration are unmarshaled correctly
diff --git a/upcloud/service/service.go b/upcloud/service/service.go
@@ -179,7 +179,7 @@ func (s *Service) WaitForServerState(r *request.WaitForServerStateRequest) (*upc
 		}
 
 		if time.Duration(attempts)*sleepDuration >= r.Timeout {
-			return nil, fmt.Errorf("Timeout reached while waiting for server to enter state \"%s\"", r.DesiredState)
+			return nil, fmt.Errorf("timeout reached while waiting for server to enter state \"%s\"", r.DesiredState)
 		}
 	}
 }
@@ -503,7 +503,7 @@ func (s *Service) WaitForStorageState(r *request.WaitForStorageStateRequest) (*u
 		time.Sleep(sleepDuration)
 
 		if time.Duration(attempts)*sleepDuration >= r.Timeout {
-			return nil, fmt.Errorf("Timeout reached while waiting for storage to enter state \"%s\"", r.DesiredState)
+			return nil, fmt.Errorf("timeout reached while waiting for storage to enter state \"%s\"", r.DesiredState)
 		}
 	}
 }
diff --git a/upcloud/service/service_test.go b/upcloud/service/service_test.go
@@ -325,7 +325,7 @@ func TestAttachDetachStorage(t *testing.T) {
 	// Detach the storage
 	t.Logf("Detaching storage %s", storageDetails.UUID)
 
-	serverDetails, err = svc.DetachStorage(&request.DetachStorageRequest{
+	_, err = svc.DetachStorage(&request.DetachStorageRequest{
 		ServerUUID: serverDetails.UUID,
 		Address:    "scsi:0:0",
 	})
@@ -442,7 +442,7 @@ func TestLoadEjectCDROM(t *testing.T) {
 
 	// Attach CD-ROM device
 	t.Logf("Attaching CD-ROM device to server with UUID %s", serverDetails.UUID)
-	serverDetails, err := svc.AttachStorage(&request.AttachStorageRequest{
+	_, err := svc.AttachStorage(&request.AttachStorageRequest{
 		ServerUUID: serverDetails.UUID,
 		Type:       upcloud.StorageTypeCDROM,
 	})
@@ -452,7 +452,7 @@ func TestLoadEjectCDROM(t *testing.T) {
 
 	// Load the CD-ROM
 	t.Log("Loading CD-ROM into CD-ROM device")
-	serverDetails, err = svc.LoadCDROM(&request.LoadCDROMRequest{
+	_, err = svc.LoadCDROM(&request.LoadCDROMRequest{
 		ServerUUID:  serverDetails.UUID,
 		StorageUUID: "01000000-0000-4000-8000-000030060101",
 	})
@@ -462,7 +462,7 @@ func TestLoadEjectCDROM(t *testing.T) {
 
 	// Eject the CD-ROM
 	t.Log("Ejecting CD-ROM from CD-ROM device")
-	serverDetails, err = svc.EjectCDROM(&request.EjectCDROMRequest{
+	_, err = svc.EjectCDROM(&request.EjectCDROMRequest{
 		ServerUUID: serverDetails.UUID,
 	})
 
@@ -595,7 +595,7 @@ func TestFirewallRules(t *testing.T) {
 
 	// Create firewall rule
 	t.Logf("Creating firewall rule #1 for server with UUID %s ...", serverDetails.UUID)
-	firewallRule, err := svc.CreateFirewallRule(&request.CreateFirewallRuleRequest{
+	_, err := svc.CreateFirewallRule(&request.CreateFirewallRuleRequest{
 		ServerUUID: serverDetails.UUID,
 		FirewallRule: upcloud.FirewallRule{
 			Direction: upcloud.FirewallRuleDirectionIn,
@@ -611,7 +611,7 @@ func TestFirewallRules(t *testing.T) {
 
 	// Get details about the rule
 	t.Log("Getting details about firewall rule #1 ...")
-	firewallRule, err = svc.GetFirewallRuleDetails(&request.GetFirewallRuleDetailsRequest{
+	firewallRule, err := svc.GetFirewallRuleDetails(&request.GetFirewallRuleDetailsRequest{
 		ServerUUID: serverDetails.UUID,
 		Position:   1,
 	})
@@ -775,7 +775,7 @@ func stopServer(uuid string) {
 
 	handleError(err)
 
-	serverDetails, err = svc.WaitForServerState(&request.WaitForServerStateRequest{
+	_, err = svc.WaitForServerState(&request.WaitForServerStateRequest{
 		UUID:         serverDetails.UUID,
 		DesiredState: upcloud.ServerStateStopped,
 		Timeout:      time.Minute * 15,
diff --git a/upcloud/tag_test.go b/upcloud/tag_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalTag tests that Tag structs are unmarshaled correctly
diff --git a/upcloud/timezone_test.go b/upcloud/timezone_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalTimeZone tests that the TimeZones struct is correctly marshaled
diff --git a/upcloud/zone_test.go b/upcloud/zone_test.go
@@ -2,8 +2,9 @@ package upcloud
 
 import (
 	"encoding/xml"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 // TestUnmarshalZones tests that the Zone and Zones structs are correctly marshaled

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,7 @@ go 1.14`
`5`	`5`	`require (`
`6`	`6`	`github.com/blang/semver v3.5.1+incompatible`
`7`	`7`	`github.com/hashicorp/go-cleanhttp v0.5.1`
	`8`	`+ github.com/kr/pretty v0.1.0 // indirect`
`8`	`9`	`github.com/stretchr/testify v1.6.1`
	`10`	`+ gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect`
`9`	`11`	`)`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,9 @@ package upcloud`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"encoding/xml"`
`5`		`- "github.com/stretchr/testify/assert"`
`6`	`5`	`"testing"`
	`6`	`+`
	`7`	`+ "github.com/stretchr/testify/assert"`
`7`	`8`	`)`
`8`	`9`
`9`	`10`	`// TestUnmarshalAccount tests that Account objects unmarshal correctly`