Refactor Build for Go

.github/workflows/go.yml

@@ -43,5 +43,5 @@ jobs:
       - uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c
         with:
           go-version-file: go.mod
-      - run: just proxy-init-test-unit
+      - run: just go-test
 

.gitignore

@@ -1,4 +1,6 @@
 **/.idea
 *.iml
 **/*.swp
+*-test.json
+*-cover.out
 target/

go.just

@@ -0,0 +1,39 @@
+
+# go-build all packages into target binaries
+go-build: \
+    (go-build-pkg "linkerd2-cni-plugin" "cni-plugin") \
+    (go-build-pkg "linkerd2-proxy-init" "proxy-init")
+
+# go-fmt-check the root directory for all fmt errors printing the result;
+# and exiting non-zero if formatting issues exist.
+go-fmt-check:
+    out=$(gofmt -e -d .) ; [ -z "$out" ] || (echo "$out" ; exit 1)
+
+# go-lint all packages
+go-lint *flags: \
+    (go-lint-pkg "cni-plugin" flags) \
+    (go-lint-pkg "pkg" flags) \
+    (go-lint-pkg "proxy-init" flags)
+
+# go-test all packages w/ gotestsum and write results to ${pkg}-test.json
+#
+# cni-plugin is not tested here as it only include integration tests
+go-test: \
+    (go-test-pkg "pkg") \
+    (go-test-pkg "proxy-init")
+
+# go-build runs go build against a specific package outputting to a specific
+# target binary (no optional flags)
+go-build-pkg out pkg:
+    go build -o target/{{ out }} ./{{ pkg }}
+
+# go-lint-pkg runs go lint against a specific package with optional flags
+go-lint-pkg pkg *flags:
+    golangci-lint run ./{{ pkg }}/... {{ flags }}
+
+# go-test runs gotestsum against a specific package with optional flags writing
+# the output/result to ${pkg}-test.json and coverage detail to ${pkg}-cover.out
+go-test-pkg pkg *flags:
+    gotestsum --jsonfile {{ pkg }}-test.json -- \
+        -coverprofile {{ pkg }}-cover.out \
+        -race -v -mod=readonly -v ./{{ pkg }}/... {{ flags }}

justfile

@@ -1,3 +1,4 @@
+import "go.just"
 #
 # Config
 #
@@ -15,13 +16,7 @@ default: lint test
 
 lint: sh-lint md-lint rs-clippy action-lint action-dev-check
 
-go-lint *flags: (proxy-init-lint flags) (cni-plugin-lint flags)
-
-test: rs-test proxy-init-test-unit proxy-init-test-integration cni-repair-controller-integration
-
-# Check whether the Go code is formatted.
-go-fmt-check:
-    out=$(gofmt -d .) ; [ -z "$out" ] || (echo "$out" ; exit 1)
+test: rs-test go-test proxy-init-test-integration cni-repair-controller-integration
 
 ##
 ## rust
@@ -92,24 +87,10 @@ cni-repair-controller-integration: build-cni-plugin-image
 ## cni-plugin
 ##
 
-cni-plugin-lint *flags:
-    golangci-lint run ./cni-plugin/... {{ flags }}
-
 ##
 ## proxy-init
 ##
 
-proxy-init-build:
-    go build -o target/linkerd2-proxy-init ./proxy-init
-
-proxy-init-lint *flags:
-    golangci-lint run ./proxy-init/... {{ flags }}
-
-# Run proxy-init unit tests
-proxy-init-test-unit:
-    go test -v ./proxy-init/...
-    go test -v ./pkg/...
-
 # Run proxy-init integration tests after preparing dependencies
 proxy-init-test-integration: proxy-init-test-integration-deps proxy-init-test-integration-run
 
@@ -136,12 +117,6 @@ build-proxy-init-test-image *args='--load':
 ## cni-plugin
 ##
 
-cni-plugin-build:
-    go build -o target/linkerd2-cni-plugin ./cni-plugin
-
-cni-plugin-test-unit:
-    go test -v ./cni-plugin/...
-
 # Build docker image for cni-plugin (Development)
 build-cni-plugin-image *args='--load':
     docker buildx build . \

pkg/iptables/iptables.go

@@ -274,7 +274,7 @@ func (fc FirewallConfiguration) addRulesForIgnoredSubnets(chainName string, comm
 func makeMultiportDestinations(portsToIgnore []string) [][]string {
 	destinationSlices := make([][]string, 0)
 	destinationPortCount := 0
-	if portsToIgnore == nil || len(portsToIgnore) < 1 {
+	if len(portsToIgnore) < 1 {
 		return destinationSlices
 	}
 	destinations := make([]string, 0)
@@ -422,9 +422,9 @@ func (fc FirewallConfiguration) makeRedirectChainToPortBasedOnDestinationPort(ch
 		"--comment", formatComment(comment))
 }
 
-func (fc FirewallConfiguration) makeJumpFromChainToAnotherForAllProtocols(chainName string, targetChain string, comment string, delete bool) *exec.Cmd {
+func (fc FirewallConfiguration) makeJumpFromChainToAnotherForAllProtocols(chainName string, targetChain string, comment string, deleteChain bool) *exec.Cmd {
 	action := "-A"
-	if delete {
+	if deleteChain {
 		action = "-D"
 	}
 

pkg/iptables/iptables_test.go

@@ -7,6 +7,7 @@ import (
 )
 
 func TestMakeMultiportDestinations(t *testing.T) {
+	assertEqual(t, makeMultiportDestinations(nil), [][]string{})
 	assertEqual(t, makeMultiportDestinations([]string{}), [][]string{})
 	assertEqual(t, makeMultiportDestinations([]string{"22", "25-27", "33"}), [][]string{{"22", "25:27", "33"}})
 	assertEqual(t, makeMultiportDestinations([]string{"22-22", "25-27", "33"}), [][]string{{"22", "25:27", "33"}})

pkg/util/portrange_test.go

@@ -48,7 +48,10 @@ func TestParsePortRange(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.input, func(t *testing.T) {
 			check, _ := ParsePortRange(tt.input)
-			reflect.DeepEqual(tt.expected, check)
+			if !reflect.DeepEqual(tt.expected, check) {
+				t.Fatalf("expected port range does not match check '%v'<>'%v'",
+					tt.expected, check)
+			}
 		})
 	}
 }