[testing] - add more coverage (#194)

* add tests for filter and version

* exclude mock package from coverage since it's autogenerated

* add helpers test

* exclude autogenerated deepcopy from coverage

Author: AshleyDumaine

.gitignore

@@ -2,7 +2,7 @@
 .idea
 bin/*
 kind-logs-*
-cover.out
+cover.out*
 kubeconfig*
 .devbox/*
 docs/book

Makefile

@@ -140,7 +140,9 @@ docs:
 
 .PHONY: test
 test: generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(CACHE_BIN) -p path)" go test -race -timeout 60s ./... -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(CACHE_BIN) -p path)" go test -race -timeout 60s `go list ./... | grep -v ./mock`  -coverprofile cover.out.tmp
+	grep -v "zz_generated.deepcopy.go" cover.out.tmp > cover.out
+	rm cover.out.tmp
 
 .PHONY: e2etest
 e2etest: generate local-deploy chainsaw

cloud/services/loadbalancers.go

@@ -31,7 +31,11 @@ func CreateNodeBalancer(ctx context.Context, clusterScope *scope.ClusterScope, l
 		Label: NBLabel,
 		Tags:  tags,
 	}
-	linodeNBs, err := clusterScope.LinodeClient.ListNodeBalancers(ctx, linodego.NewListOptions(1, listFilter.String()))
+	filter, err := listFilter.String()
+	if err != nil {
+		return nil, err
+	}
+	linodeNBs, err := clusterScope.LinodeClient.ListNodeBalancers(ctx, linodego.NewListOptions(1, filter))
 	if err != nil {
 		logger.Info("Failed to list NodeBalancers", "error", err.Error())
 

controller/linodemachine_controller.go

@@ -248,7 +248,11 @@ func (r *LinodeMachineReconciler) reconcileCreate(
 		Label: machineScope.LinodeMachine.Name,
 		Tags:  tags,
 	}
-	linodeInstances, err := machineScope.LinodeClient.ListInstances(ctx, linodego.NewListOptions(1, listFilter.String()))
+	filter, err := listFilter.String()
+	if err != nil {
+		return nil, err
+	}
+	linodeInstances, err := machineScope.LinodeClient.ListInstances(ctx, linodego.NewListOptions(1, filter))
 	if err != nil {
 		logger.Error(err, "Failed to list Linode machine instances")
 

controller/linodevpc_controller_helpers.go

@@ -46,7 +46,11 @@ func (r *LinodeVPCReconciler) reconcileVPC(ctx context.Context, vpcScope *scope.
 		Label: createConfig.Label,
 		Tags:  nil,
 	}
-	if vpcs, err := vpcScope.LinodeClient.ListVPCs(ctx, linodego.NewListOptions(1, listFilter.String())); err != nil {
+	filter, err := listFilter.String()
+	if err != nil {
+		return err
+	}
+	if vpcs, err := vpcScope.LinodeClient.ListVPCs(ctx, linodego.NewListOptions(1, filter)); err != nil {
 		logger.Error(err, "Failed to list VPCs")
 
 		return err

util/filter.go

@@ -35,11 +35,11 @@ func (f Filter) MarshalJSON() ([]byte, error) {
 
 // String returns the string representation of the encoded value from
 // [Filter.MarshalJSON].
-func (f Filter) String() string {
+func (f Filter) String() (string, error) {
 	p, err := f.MarshalJSON()
 	if err != nil {
-		panic("this should not have failed")
+		return "", err
 	}
 
-	return string(p)
+	return string(p), nil
 }

util/filter_test.go

@@ -0,0 +1,54 @@
+package util
+
+import "testing"
+
+func TestString(t *testing.T) {
+	t.Parallel()
+	tests := []struct {
+		name      string
+		filter    Filter
+		expectErr bool
+	}{{
+		name: "success ID",
+		filter: Filter{
+			ID:    Pointer(123),
+			Label: "",
+			Tags:  nil,
+		},
+		expectErr: false,
+	}, {
+		name: "success label",
+		filter: Filter{
+			ID:    nil,
+			Label: "test",
+			Tags:  nil,
+		},
+		expectErr: false,
+	}, {
+		name: "success tags",
+		filter: Filter{
+			ID:    nil,
+			Label: "",
+			Tags:  []string{"testtag"},
+		},
+		expectErr: false,
+	}, {
+		name: "failure unmarshal",
+		filter: Filter{
+			ID:    nil,
+			Label: "",
+			Tags:  []string{},
+		},
+		expectErr: true,
+	}}
+	for _, tt := range tests {
+		testcase := tt
+		t.Run(testcase.name, func(t *testing.T) {
+			t.Parallel()
+			_, err := testcase.filter.String()
+			if testcase.expectErr && err != nil {
+				t.Error("expected err but got nil")
+			}
+		})
+	}
+}

util/helpers_test.go

@@ -0,0 +1,51 @@
+package util
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/linode/linodego"
+)
+
+func TestIgnoreLinodeAPIError(t *testing.T) {
+	t.Parallel()
+	tests := []struct {
+		name         string
+		err          error
+		code         int
+		shouldFilter bool
+	}{{
+		name:         "Not Linode API error",
+		err:          errors.New("foo"),
+		code:         0,
+		shouldFilter: false,
+	}, {
+		name: "Ignore not found Linode API error",
+		err: linodego.Error{
+			Response: nil,
+			Code:     400,
+			Message:  "not found",
+		},
+		code:         400,
+		shouldFilter: true,
+	}, {
+		name: "Don't ignore not found Linode API error",
+		err: linodego.Error{
+			Response: nil,
+			Code:     400,
+			Message:  "not found",
+		},
+		code:         500,
+		shouldFilter: false,
+	}}
+	for _, tt := range tests {
+		testcase := tt
+		t.Run(testcase.name, func(t *testing.T) {
+			t.Parallel()
+			err := IgnoreLinodeAPIError(testcase.err, testcase.code)
+			if testcase.shouldFilter && err != nil {
+				t.Error("expected err but got nil")
+			}
+		})
+	}
+}

version/version_test.go

@@ -0,0 +1,11 @@
+package version
+
+import "testing"
+
+func TestVersion(t *testing.T) {
+	t.Parallel()
+	vers := GetVersion()
+	if vers != "dev" {
+		t.Errorf("unset version should be dev, got %s", vers)
+	}
+}