Fix linter issues, add Makefile targets, add CI jobs (#1)

Signed-off-by: Antonin Bas <[email protected]>

.github/workflows/go.yml

@@ -0,0 +1,44 @@
+name: Go
+on:
+  pull_request:
+    branches:
+    - main
+  push:
+    branches:
+    - main
+
+jobs:
+  # test:
+  #   runs-on: [ubuntu-latest]
+  #   steps:
+  #   - name: Set up Go 1.15
+  #     uses: actions/setup-go@v1
+  #     with:
+  #       go-version: 1.15
+  #   - name: Check-out code
+  #     uses: actions/checkout@v2
+  #   - name: Run unit tests
+  #     run: |
+  #       make test
+
+  tidy:
+    runs-on: [ubuntu-latest]
+    steps:
+    - name: Set up Go 1.15
+      uses: actions/setup-go@v1
+      with:
+        go-version: 1.15
+    - name: Check-out code
+      uses: actions/checkout@v2
+    - name: Check tidiness
+      run: |
+        ./ci/check-tidy.sh
+
+  golangci:
+    runs-on: [ubuntu-latest]
+    steps:
+    - name: Check-out code
+      uses: actions/checkout@v2
+    - name: Run code linters
+      run: |
+        make golangci

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'VERSION'
+
+jobs:
+  release:
+    runs-on: [ubuntu-latest]
+    steps:
+    - name: Check-out code
+      uses: actions/checkout@v2
+    - name: Read version
+      run: |
+        echo "version=$(head VERSION)" >> $GITHUB_ENV
+    - name: Create release
+      uses: ncipollo/release-action@v1
+      with:
+        omitBody: true
+        token: "${{ secrets.GITHUB_TOKEN }}"
+        tag: "${{ env.version }}"
+        commit: "${{ env.GITHUB_SHA }}"

.gitignore

@@ -1,3 +1,13 @@
-# vagrant
-.vagrant
-cscope*
+.cache
+.golangci-bin
+
+.DS_Store
+
+# VIM
+.*.swp
+
+# Emacs
+*~
+
+.idea/
+.vscode/

.golangci.yml

@@ -0,0 +1,24 @@
+run:
+  tests: true
+  timeout: 5m
+  skip-files:
+    - ".*\\.pb\\.go"
+  skip-dirs-use-default: true
+
+linters-settings:
+  goimports:
+    local-prefixes: antrea.io/ofnet
+
+linters:
+  disable-all: true
+  enable: # see https://golangci-lint.run/usage/linters/
+    - deadcode
+    - staticcheck
+    - govet
+    - gofmt
+    - goimports
+    - gosec
+    - misspell
+
+run:
+  deadline: 5m

Makefile

@@ -1 +1,22 @@
-# TODO
+GO                 ?= go
+
+all: test
+
+.PHONY: test
+test:
+	$(GO) test -v ./...
+
+# code linting
+.golangci-bin:
+	@echo "===> Installing Golangci-lint <==="
+	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $@ v1.41.1
+
+.PHONY: golangci
+golangci: .golangci-bin
+	@echo "===> Running golangci <==="
+	@GOOS=linux .golangci-bin/golangci-lint run -c .golangci.yml
+
+.PHONY: golangci-fix
+golangci-fix: .golangci-bin
+	@echo "===> Running golangci-fix <==="
+	@GOOS=linux .golangci-bin/golangci-lint run -c .golangci.yml --fix

VERSION

@@ -0,0 +1 @@
+v0.1.0

ci/check-tidy.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+set -e
+
+: "${GO:=go}"
+
+goversion=$($GO version)
+
+$GO mod tidy
+
+rc=0
+diff=$(git diff --exit-code -- go.mod go.sum) || rc=$?
+
+if [ $rc -ne 0 ]; then
+    echo "Found some differences when running 'go mod tidy'"
+    echo "**********"
+    echo "$diff"
+    echo "**********"
+    echo "Please ensure you are using the correct version of go ($goversion), run 'go mod tidy', and commit the changes"
+fi
+
+exit $rc

ofctrl/fgraphFlow.go

@@ -21,11 +21,11 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"antrea.io/libOpenflow/util"
 	"net"
 	"sync"
 
 	"antrea.io/libOpenflow/openflow13"
+	"antrea.io/libOpenflow/util"
 	log "github.com/sirupsen/logrus"
 )
 

ofctrl/ofErrors.go

@@ -2,6 +2,7 @@ package ofctrl
 
 import (
 	"fmt"
+
 	"antrea.io/libOpenflow/openflow13"
 	"antrea.io/libOpenflow/util"
 )

ofctrl/ofMatchFields.go

@@ -4,9 +4,10 @@ import (
 	"encoding/binary"
 	"errors"
 	"fmt"
+	"net"
+
 	"antrea.io/libOpenflow/openflow13"
 	"antrea.io/libOpenflow/util"
-	"net"
 )
 
 type Uint32WithMask struct {
@@ -749,7 +750,7 @@ func GetUint32ValueWithRangeFromBytes(data []byte, rng *openflow13.NXRange) (uin
 	}
 	startByte := int(rng.GetOfs() / 8)
 	startDiff := startByte * 8
-	endByte := int(rng.GetNbits() + 7/8)
+	endByte := int((rng.GetNbits() + 7) / 8)
 	if endByte > len(data) {
 		return 0, errors.New("range is larger than data length")
 	}
@@ -765,7 +766,7 @@ func GetUint64ValueWithRangeFromBytes(data []byte, rng *openflow13.NXRange) (uin
 	}
 	startByte := int(rng.GetOfs() / 8)
 	startDiff := startByte * 8
-	endByte := int(rng.GetNbits() + 7/8)
+	endByte := int((rng.GetNbits() + 7) / 8)
 	if endByte > len(data) {
 		return 0, errors.New("range is larger than data length")
 	}

ofctrl/ofPacket.go

@@ -1,3 +1,4 @@
+// #nosec G404: random number generator not used for security purposes
 package ofctrl
 
 import (
@@ -103,12 +104,12 @@ func GenerateTCPPacket(srcMAC, dstMAC net.HardwareAddr, srcIP, dstIP net.IP, dst
 	var pktOut *PacketOut
 	if srcIP.To4() == nil {
 		ipv6Header := &protocol.IPv6{
-			Version:        6,
-			Length:         tcpHeader.Len(),
-			HopLimit:       64,
-			NextHeader:     protocol.Type_TCP,
-			NWSrc:          srcIP,
-			NWDst:          dstIP,
+			Version:    6,
+			Length:     tcpHeader.Len(),
+			HopLimit:   64,
+			NextHeader: protocol.Type_TCP,
+			NWSrc:      srcIP,
+			NWDst:      dstIP,
 		}
 		pktOut = &PacketOut{
 			SrcMAC:     srcMAC,

ofctrl/ofctrl.go

@@ -12,6 +12,7 @@ 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.
 */
+
 package ofctrl
 
 // This library implements a simple openflow 1.3 controller
@@ -91,7 +92,7 @@ type Controller struct {
 func NewController(app AppInterface) *Controller {
 	c := new(Controller)
 	c.connectMode = ServerMode
-	c.id = uint16(rand.Uint32())
+	c.id = uint16(rand.Uint32()) // #nosec G404: random number generator not used for security purposes
 
 	// for debug logs
 	// log.SetLevel(log.DebugLevel)
@@ -261,7 +262,7 @@ func (c *Controller) handleConnection(conn net.Conn) {
 			switch m := msg.(type) {
 			// A Hello message of the appropriate type
 			// completes version negotiation. If version
-			// types are incompatable, it is possible the
+			// types are incompatible, it is possible the
 			// connection may be servered without error.
 			case *common.Hello:
 				if m.Version == openflow13.VERSION {