import code-lint workflow job (bfenetworks#1037)

Signed-off-by: kwanhur <[email protected]>

Author: kwanhur

.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         # Must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head of the pull request.

.github/workflows/code-lint.yml

@@ -0,0 +1,34 @@
+# Copyright 2022 The BFE Authors
+#
+# 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.
+#
+name: Code Lint
+
+on:
+  pull_request:
+    branches: [ develop ]
+    paths-ignore:
+      - 'docs/**'
+      - '**/*.md'
+
+jobs:
+  lint:
+    name: Code lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dominikh/[email protected]
+        with:
+          version: "2021.1.1"
+      - run: "go vet ./..."

.github/workflows/docs-lint.yml

@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 1
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
       - name: Use Node.js
         uses: actions/[email protected]
         with:

bfe_config/bfe_cluster_conf/cluster_conf/cluster_conf_load.go

@@ -75,7 +75,7 @@ type BackendCheck struct {
 	CheckInterval *int    // interval of health check, in ms
 }
 
-// FastCGI related configurations
+// FCGIConf are FastCGI related configurations
 type FCGIConf struct {
 	EnvVars map[string]string // the vars which will send to backend
 	Root    string            // the server root

bfe_fcgi/fcgi_client.go

@@ -180,7 +180,7 @@ func (rec *record) read(r io.Reader) (buf []byte, err error) {
 	if len(rec.rbuf) < n {
 		rec.rbuf = make([]byte, n)
 	}
-	if n, err = io.ReadFull(r, rec.rbuf[:n]); err != nil {
+	if _, err = io.ReadFull(r, rec.rbuf[:n]); err != nil {
 		return
 	}
 	buf = rec.rbuf[:int(rec.h.ContentLength)]

bfe_http/request.go

@@ -55,7 +55,7 @@ const (
 // is either not present in the request or not a file field.
 var ErrMissingFile = errors.New("http: no such file")
 
-// HTTP request parsing errors.
+// ProtocolError is the error found during HTTP request parsing.
 type ProtocolError struct {
 	ErrorString string
 }

bfe_http2/server.go

@@ -411,6 +411,7 @@ func (s *Server) ServeConn(c net.Conn, opts *ServeConnOpts) {
 			return
 		}
 
+		//lint:ignore SA9003 empty branch
 		if sc.tlsState.ServerName == "" {
 			// Client must use SNI, but we don't enforce that anymore,
 			// since it was causing problems when connecting to bare IP

bfe_modules/mod_auth_request/auth_request_rule_load.go

@@ -24,13 +24,11 @@ import (
 	"github.com/bfenetworks/bfe/bfe_util/json"
 )
 
-// rule loaded from file
 type AuthRequestRuleFile struct {
 	Version string
 	Config  ProductRuleRawList // product => raw rule list
 }
 
-// rule conf parsed from rule file
 type AuthRequestRuleConf struct {
 	Version string
 	Config  ProductRuleList // product => rule list

bfe_modules/mod_markdown/mod_markdown_test.go

@@ -131,6 +131,9 @@ func TestModuleMarkdown_renderMarkDownHandler(t *testing.T) {
 				t.Errorf("ModuleMarkdown.TestModuleMarkdown_renderMarkDownHandler() error = %v", err)
 			}
 			want, err := ioutil.ReadFile(targetPath)
+			if err != nil {
+				t.Errorf("ModuleMarkdown.TestModuleMarkdown_renderMarkDownHandler() error = %v", err)
+			}
 			if !reflect.DeepEqual(got, want) {
 				t.Errorf("ModuleMarkdown.TestModuleMarkdown_renderMarkDownHandler(), got[%s], want[%s]", string(got), string(want))
 			}

bfe_modules/mod_redirect/action.go

@@ -36,7 +36,6 @@ type Action struct {
 
 type ActionFileList []ActionFile
 
-// exclusive action set
 var EXCLUSIVE_ACTIONS = map[string]interface{}{
 	"SCHEME_SET":     nil,
 	"URL_SET":        nil,