Merge pull request #46 from x1unix/feat/gh-action-lint

x1unix · web-flow · commit 4e87948acdbb · 2020-08-20T01:29:03.000+03:00
Add PR check and coverage submit workflows
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -0,0 +1,35 @@
+#
+# Code coverage report
+#
+# Reports tests code coverage to coveralls.
+# Uses COVERALLS_TOKEN env var from GitHub repo secrets.
+#
+# see: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+#
+
+name: Submit code coverage
+on:
+  push:
+    branches:
+      - master
+env:
+  GO111MODULE: on
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '^1.14.4'
+      - uses: actions/checkout@v2
+      - run: go version
+      - name: install
+        run: |
+          go get golang.org/x/tools/cmd/cover
+      - name: Test
+        run: cat tools/cover.txt | xargs go test -v -covermode=count -coverprofile=coverage.out
+      - name: Send coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: coverage.out
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -0,0 +1,25 @@
+#
+# Pull request check workflow
+#
+# Runs linter and tests on source branch to check code quality.
+#
+# see: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+#
+
+name: Check Pull Request
+on: [pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v1
+        with:
+          version: v1.27
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '^1.14.4'
+      - run: go version
+      - run: go test ./...
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,5 @@
+run:
+  tests: false
+  skip-dirs:
+    - pkg/worker
+    - cmd/webworker
diff --git a/cmd/playground/main.go b/cmd/playground/main.go
@@ -52,7 +52,7 @@ func main() {
 
 	flag.Parse()
 	l := getLogger(args.debug)
-	defer l.Sync()
+	defer l.Sync() //nolint:errcheck
 	if err := start(goRoot, args); err != nil {
 		l.Sugar().Fatal(err)
 	}
@@ -143,7 +143,6 @@ func startHttpServer(ctx context.Context, wg *sync.WaitGroup, server *http.Serve
 		if err := server.Shutdown(shutdownCtx); err != nil {
 			logger.Errorf("Could not gracefully shutdown the server: %v\n", err)
 		}
-		return
 	}()
 
 	wg.Add(1)
diff --git a/cmd/webworker/webworker.go b/cmd/webworker/webworker.go
@@ -1,3 +1,5 @@
+// +build js
+
 package main
 
 import (
diff --git a/pkg/analyzer/package_test.go b/pkg/analyzer/package_test.go
@@ -29,8 +29,8 @@ func TestPackage_SymbolByChar(t *testing.T) {
 	pkg := Package{
 		Synopsis: "test doc",
 		PackageSummary: PackageSummary{
-			Functions: newSymbolIndex(allFuncs),
-			Values:    newSymbolIndex(allSyms),
+			Functions: NewSymbolIndex(allFuncs),
+			Values:    NewSymbolIndex(allSyms),
 		},
 	}
 
diff --git a/pkg/analyzer/scanner_test.go b/pkg/analyzer/scanner_test.go
@@ -10,7 +10,7 @@ import (
 
 // should be in sync with "testdata/src" !!!
 var examplePackageSummary = PackageSummary{
-	Functions: newSymbolIndex([]*CompletionItem{
+	Functions: NewSymbolIndex([]*CompletionItem{
 		{
 			Label:           "SomeFunc",
 			Kind:            Function,
@@ -71,7 +71,7 @@ var examplePackageSummary = PackageSummary{
 			Documentation:   NewMarkdownString("FuncUnnamedParams is function with unnamed params\n\n"),
 		},
 	}),
-	Values: newSymbolIndex([]*CompletionItem{
+	Values: NewSymbolIndex([]*CompletionItem{
 		{
 			Label:         "SomeConst",
 			Kind:          Constant,
diff --git a/pkg/analyzer/sym_index.go b/pkg/analyzer/sym_index.go
@@ -20,7 +20,8 @@ func emptySymbolIndex() SymbolIndex {
 	}
 }
 
-func newSymbolIndex(items []*CompletionItem) SymbolIndex {
+// NewSymbolIndex creates a new symbol index from completion items
+func NewSymbolIndex(items []*CompletionItem) SymbolIndex {
 	idx := SymbolIndex{
 		Symbols: items,
 		nameMap: make(map[string]*CompletionItem, len(items)),
diff --git a/pkg/analyzer/sym_index_test.go b/pkg/analyzer/sym_index_test.go
@@ -13,7 +13,7 @@ func TestSymbolIndex(t *testing.T) {
 		{Label: "baz"},
 	}
 
-	index := newSymbolIndex(syms)
+	index := NewSymbolIndex(syms)
 	require.Equal(t, syms, index.Symbols)
 	require.Equal(t, len(syms), index.Len())
 
diff --git a/pkg/compiler/storage/local.go b/pkg/compiler/storage/local.go
@@ -96,7 +96,7 @@ func (s LocalStorage) getOutputLocation(id ArtifactID) string {
 // HasItem implements storage interface
 func (s LocalStorage) HasItem(id ArtifactID) (bool, error) {
 	s.useLock.Lock()
-	s.useLock.Unlock()
+	defer s.useLock.Unlock()
 	fPath := s.getOutputLocation(id)
 	_, err := os.Stat(fPath)
 	if err != nil {
diff --git a/pkg/langserver/request.go b/pkg/langserver/request.go
@@ -114,8 +114,7 @@ func WriteJSON(w http.ResponseWriter, i interface{}) {
 
 	w.Header().Add("Content-Type", "application/json")
 	w.WriteHeader(http.StatusOK)
-	w.Write(data)
-	return
+	_, _ = w.Write(data)
 }
 
 func shouldFormatCode(r *http.Request) (bool, error) {
diff --git a/pkg/testutil/errors.go b/pkg/testutil/errors.go
@@ -15,5 +15,4 @@ func ContainsError(t *testing.T, err error, msg string) {
 	if emsg := err.Error(); !strings.Contains(emsg, msg) {
 		t.Fatalf("error %q should include %q", emsg, msg)
 	}
-	return
 }
diff --git a/pkg/worker/args.go b/pkg/worker/args.go
@@ -1,3 +1,5 @@
+// +build js
+
 package worker
 
 import (
diff --git a/pkg/worker/callback.go b/pkg/worker/callback.go
@@ -1,3 +1,5 @@
+// +build js
+
 package worker
 
 import "syscall/js"
diff --git a/pkg/worker/worker.go b/pkg/worker/worker.go
@@ -1,3 +1,5 @@
+// +build js
+
 // Package worker contains Go web-worker WASM module bridge methods
 package worker
 

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ func main() {`
`52`	`52`
`53`	`53`	`flag.Parse()`
`54`	`54`	`l := getLogger(args.debug)`
`55`		`- defer l.Sync()`
	`55`	`+ defer l.Sync() //nolint:errcheck`
`56`	`56`	`if err := start(goRoot, args); err != nil {`
`57`	`57`	`l.Sugar().Fatal(err)`
`58`	`58`	`}`
`@@ -143,7 +143,6 @@ func startHttpServer(ctx context.Context, wg sync.WaitGroup, server http.Serve`
`143`	`143`	`if err := server.Shutdown(shutdownCtx); err != nil {`
`144`	`144`	`logger.Errorf("Could not gracefully shutdown the server: %v\n", err)`
`145`	`145`	`}`
`146`		`- return`
`147`	`146`	`}()`
`148`	`147`
`149`	`148`	`wg.Add(1)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// +build js`
	`2`	`+`
`1`	`3`	`package main`
`2`	`4`
`3`	`5`	`import (`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ func emptySymbolIndex() SymbolIndex {`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`
`23`		`-func newSymbolIndex(items []*CompletionItem) SymbolIndex {`
	`23`	`+// NewSymbolIndex creates a new symbol index from completion items`
	`24`	`+func NewSymbolIndex(items []*CompletionItem) SymbolIndex {`
`24`	`25`	`idx := SymbolIndex{`
`25`	`26`	`Symbols: items,`
`26`	`27`	`nameMap: make(map[string]*CompletionItem, len(items)),`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ func TestSymbolIndex(t *testing.T) {`
`13`	`13`	`{Label: "baz"},`
`14`	`14`	`}`
`15`	`15`
`16`		`- index := newSymbolIndex(syms)`
	`16`	`+ index := NewSymbolIndex(syms)`
`17`	`17`	`require.Equal(t, syms, index.Symbols)`
`18`	`18`	`require.Equal(t, len(syms), index.Len())`
`19`	`19`