Skip to content

Linting fixes + validate NodeDrain better #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gezb merged 1 commit into from
Jan 29, 2026
Merged

Linting fixes + validate NodeDrain better #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ jobs:
go-version-file: go.mod

- name: Run linter
uses: golangci/golangci-lint-action@v6
uses: golangci/golangci-lint-action@v7
with:
version: v1.63.4
version: v2.8.0
63 changes: 36 additions & 27 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,15 @@
version: "2"
run:
timeout: 5m
allow-parallel-runners: true

issues:
# don't skip warning about doc comments
# don't exclude the default set of lint
exclude-use-default: false
# restore some of the defaults
# (fill in the rest as needed)
exclude-rules:
- path: "api/*"
linters:
- lll
- path: "internal/*"
linters:
- dupl
- lll
linters:
disable-all: true
default: none
enable:
- copyloopvar
- dupl
- errcheck
- copyloopvar
- ginkgolinter
- goconst
- gocyclo
- gofmt
- goimports
- gosimple
- govet
- ineffassign
- lll
Expand All @@ -36,14 +18,41 @@ linters:
- prealloc
- revive
- staticcheck
- typecheck
- unconvert
- unparam
- unused
settings:
lll:
line-length: 170
revive:
rules:
- name: comment-spacings
staticcheck:
dot-import-whitelist:
- "github.com/onsi/ginkgo/v2"
- "github.com/onsi/gomega"

linters-settings:
revive:
exclusions:
generated: lax
rules:
- name: comment-spacings
lll:
line-length: 170
- linters:
- lll
path: api/*
- linters:
- dupl
- lll
path: internal/*
paths:
- third_party$
- builtin$
- examples$
formatters:
enable:
- gofmt
- goimports
exclusions:
generated: lax
paths:
- third_party$
- builtin$
- examples$
39 changes: 28 additions & 11 deletions internal/controller/nodedrain_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,18 +79,18 @@ func (r *NodeDrainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
return ctrl.Result{}, err
}

if !controllerutil.ContainsFinalizer(nodeDrain, gezbcoukalphav1.NodeDrainFinalizer) && nodeDrain.ObjectMeta.DeletionTimestamp.IsZero() {
if !controllerutil.ContainsFinalizer(nodeDrain, gezbcoukalphav1.NodeDrainFinalizer) && nodeDrain.DeletionTimestamp.IsZero() {
// Add finalizer when object is created
controllerutil.AddFinalizer(nodeDrain, gezbcoukalphav1.NodeDrainFinalizer)

} else if controllerutil.ContainsFinalizer(nodeDrain, gezbcoukalphav1.NodeDrainFinalizer) && !nodeDrain.ObjectMeta.DeletionTimestamp.IsZero() {
} else if controllerutil.ContainsFinalizer(nodeDrain, gezbcoukalphav1.NodeDrainFinalizer) && !nodeDrain.DeletionTimestamp.IsZero() {
// The object is being deleted

// Do nothing special on deletion for now

// Remove finalizer
controllerutil.RemoveFinalizer(nodeDrain, gezbcoukalphav1.NodeDrainFinalizer)
if err := r.Client.Update(ctx, nodeDrain); err != nil {
if err := r.Update(ctx, nodeDrain); err != nil {
return r.onReconcileError(ctx, nil, nodeDrain, err)
}
return ctrl.Result{}, nil
Expand Down Expand Up @@ -154,7 +154,7 @@ func (r *NodeDrainReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
return r.Client.Status().Update(ctx, nodeDrain)
})
if updateErr != nil {
r.logger.Error(err, "Failed to update NodeDrain Status")
r.logger.Error(updateErr, "Failed to update NodeDrain Status")
return r.onReconcileError(ctx, drainer, nodeDrain, updateErr)
}
}
Expand All @@ -181,6 +181,23 @@ func (r *NodeDrainReconciler) reconcilePending(ctx context.Context, drainer *dra
}
}

if nodeDrain.Spec.NodeRole != node.Labels["role"] {
message := fmt.Sprintf("Node role mismatch: expected %s got %s", nodeDrain.Spec.NodeRole, node.Labels["role"])
r.logger.Info(message)
publishEvent(r.Recorder, nodeDrain, corev1.EventTypeWarning, events.EventReasonNodeNotFound, message)
setStatus(r.Recorder, nodeDrain, gezbcoukalphav1.NodeDrainPhaseFailed)
return true, nil
}

pattern := regexp.MustCompile(nodeDrain.Spec.VersionToDrainRegex)
if !pattern.MatchString(node.Status.NodeInfo.KubeletVersion) {
message := fmt.Sprintf("Node version mismatch: expected a value that satisfies %s got %s", nodeDrain.Spec.VersionToDrainRegex, node.Status.NodeInfo.KubeletVersion)
r.logger.Info(message)
publishEvent(r.Recorder, nodeDrain, corev1.EventTypeWarning, events.EventReasonNodeNotFound, message)
setStatus(r.Recorder, nodeDrain, gezbcoukalphav1.NodeDrainPhaseFailed)
return true, nil
}

if nodeDrain.Spec.DisableCordon {
r.logger.Info("NOT Cordoning node", "node", nodeName)
} else {
Expand Down Expand Up @@ -294,7 +311,7 @@ func (r *NodeDrainReconciler) reconcileWaitForPodsToRestart(ctx context.Context,

for _, nameAndNamespace := range nodeDrain.Status.PodsToBeEvicted {
pod := corev1.Pod{}
err := r.Client.Get(ctx, client.ObjectKey{Namespace: nameAndNamespace.Namespace, Name: nameAndNamespace.Name}, &pod)
err := r.Get(ctx, client.ObjectKey{Namespace: nameAndNamespace.Namespace, Name: nameAndNamespace.Name}, &pod)
if err != nil {
r.logger.Info(fmt.Sprintf("Failed to get pod %s in namespace %s", nameAndNamespace.Name, nameAndNamespace.Namespace))

Expand Down Expand Up @@ -322,7 +339,7 @@ func (r *NodeDrainReconciler) getBlockingPods(ctx context.Context, nodeDrain *ge
podsBlocking := []string{}
// get a list of drainChecks
drainCheckList := &gezbcoukalphav1.DrainCheckList{}
err := r.Client.List(ctx, drainCheckList, &client.ListOptions{})
err := r.List(ctx, drainCheckList, &client.ListOptions{})
if err != nil {
return podsBlocking, err
}
Expand Down Expand Up @@ -355,7 +372,7 @@ func (r *NodeDrainReconciler) fetchNode(ctx context.Context, drainer *drain.Help

func (r *NodeDrainReconciler) areAllNodesCordoned(ctx context.Context, nodeDrain *gezbcoukalphav1.NodeDrain) (bool, error) {
nodeList := &corev1.NodeList{}
err := r.Client.List(ctx, nodeList, &client.ListOptions{})
err := r.List(ctx, nodeList, &client.ListOptions{})
if err != nil {
return false, err
}
Expand Down Expand Up @@ -496,7 +513,7 @@ func createDrainer(ctx context.Context, mgrConfig *rest.Config) (*drain.Helper,
} else {
verbString = "Deleted"
}
msg := fmt.Sprintf("pod: %s:%s %s from node: %s", pod.ObjectMeta.Namespace, pod.ObjectMeta.Name, verbString, pod.Spec.NodeName)
msg := fmt.Sprintf("pod: %s:%s %s from node: %s", pod.Namespace, pod.Name, verbString, pod.Spec.NodeName)
klog.Info(msg)
}
return drainer, nil
Expand All @@ -505,7 +522,7 @@ func createDrainer(ctx context.Context, mgrConfig *rest.Config) (*drain.Helper,
// GetPodNameList returns a list of pod names from a pod list
func GetPodNameList(pods []corev1.Pod) (result []string) {
for _, pod := range pods {
result = append(result, pod.ObjectMeta.Name)
result = append(result, pod.Name)
}
return result
}
Expand All @@ -514,8 +531,8 @@ func GetPodNameList(pods []corev1.Pod) (result []string) {
func GetNameSpaceAndName(pods []corev1.Pod) (result []gezbcoukalphav1.NamespaceAndName) {
for _, pod := range pods {
result = append(result, gezbcoukalphav1.NamespaceAndName{
Name: pod.ObjectMeta.Name,
Namespace: pod.ObjectMeta.Namespace,
Name: pod.Name,
Namespace: pod.Namespace,
})
}
return result
Expand Down
93 changes: 92 additions & 1 deletion internal/controller/nodedrain_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,97 @@ var _ = Describe("Node Drain", func() {

})
})

When("NodeDrain CR for a node that does not match the role", func() {
BeforeEach(func() {
node := getTestNode("node1", false)
node.Labels["role"] = "not-test-role"
Expect(k8sClient.Create(ctx, node)).To(Succeed())
DeferCleanup(k8sClient.Delete, ctx, node)

pod1 := getTestPod("pod1")
Expect(k8sClient.Create(ctx, pod1)).To(Succeed())
pod2 := getTestPod("pod2")
Expect(k8sClient.Create(ctx, pod2)).To(Succeed())
pod3 := getTestPod("pod3")
Expect(k8sClient.Create(ctx, pod3)).To(Succeed())
DeferCleanup(k8sClient.Delete, ctx, pod1)
DeferCleanup(k8sClient.Delete, ctx, pod2)
DeferCleanup(k8sClient.Delete, ctx, pod3)

nodeDrainCR = getTestNodeDrain(false, false)
Expect(k8sClient.Create(ctx, nodeDrainCR)).To(Succeed())
DeferCleanup(k8sClient.Delete, ctx, nodeDrainCR)
})

It("should goto a failed state", func() {
nodeDrain := &gezbcoukalphav1.NodeDrain{}
Eventually(func(g Gomega) {
g.Expect(k8sClient.Get(ctx, client.ObjectKeyFromObject(nodeDrainCR), nodeDrain)).To(Succeed())
g.Expect(nodeDrain.Status.Phase).To(Equal(gezbcoukalphav1.NodeDrainPhaseFailed))
}, timeout, interval).Should(Succeed())

verifyStatusEvent(gezbcoukalphav1.NodeDrainPhasePending)
verifyStatusEvent(gezbcoukalphav1.NodeDrainPhaseFailed)

verifyEvent(events.EventReasonNodeNotFound, "Node role mismatch: expected test-role got not-test-role")

Expect(nodeDrain.Status.LastError).To(Equal(""))
Expect(nodeDrain.Status.TotalPods).To(Equal(0))
Expect(nodeDrain.Status.PendingPods).To(BeEmpty())
Expect(nodeDrain.Status.PodsToBeEvicted).To(BeEmpty())
Expect(nodeDrain.Status.EvictionPodCount).To(Equal(0))
Expect(nodeDrain.Status.DrainProgress).To(Equal(0))
Expect(nodeDrain.Status.PodsBlockingDrain).To(Equal(""))

})
})

When("NodeDrain CR for a node that has version does not match the regex", func() {
BeforeEach(func() {
node := getTestNode("node1", false)
Expect(k8sClient.Create(ctx, node)).To(Succeed())
DeferCleanup(k8sClient.Delete, ctx, node)

pod1 := getTestPod("pod1")
Expect(k8sClient.Create(ctx, pod1)).To(Succeed())
pod2 := getTestPod("pod2")
Expect(k8sClient.Create(ctx, pod2)).To(Succeed())
pod3 := getTestPod("pod3")
Expect(k8sClient.Create(ctx, pod3)).To(Succeed())
DeferCleanup(k8sClient.Delete, ctx, pod1)
DeferCleanup(k8sClient.Delete, ctx, pod2)
DeferCleanup(k8sClient.Delete, ctx, pod3)

nodeDrainCR = getTestNodeDrain(false, false)
nodeDrainCR.Spec.VersionToDrainRegex = "^1.34.*$"
Expect(k8sClient.Create(ctx, nodeDrainCR)).To(Succeed())
DeferCleanup(k8sClient.Delete, ctx, nodeDrainCR)
})

It("should goto a failed state", func() {
nodeDrain := &gezbcoukalphav1.NodeDrain{}
Eventually(func(g Gomega) {
g.Expect(k8sClient.Get(ctx, client.ObjectKeyFromObject(nodeDrainCR), nodeDrain)).To(Succeed())
g.Expect(nodeDrain.Status.Phase).To(Equal(gezbcoukalphav1.NodeDrainPhaseFailed))
}, timeout, interval).Should(Succeed())

verifyStatusEvent(gezbcoukalphav1.NodeDrainPhasePending)
verifyStatusEvent(gezbcoukalphav1.NodeDrainPhaseFailed)

verifyEvent(events.EventReasonNodeNotFound, "Node version mismatch: expected a value that satisfies ^1.34.*$ got 1.35.5-eks")

Expect(nodeDrain.Status.LastError).To(Equal(""))
Expect(nodeDrain.Status.TotalPods).To(Equal(0))
Expect(nodeDrain.Status.PendingPods).To(BeEmpty())
Expect(nodeDrain.Status.PodsToBeEvicted).To(BeEmpty())
Expect(nodeDrain.Status.EvictionPodCount).To(Equal(0))
Expect(nodeDrain.Status.DrainProgress).To(Equal(0))
Expect(nodeDrain.Status.PodsBlockingDrain).To(Equal(""))

})
})

})

func getTestPod(podName string) *corev1.Pod {
Expand Down Expand Up @@ -521,7 +612,7 @@ func getTestNodeDrain(disableCordon bool, waitForRestart bool) *gezbcoukalphav1.
},
Spec: gezbcoukalphav1.NodeDrainSpec{
NodeName: "node1",
VersionToDrainRegex: "1.35.*",
VersionToDrainRegex: "^1.35.*$",
NodeRole: "test-role",
DisableCordon: disableCordon,
WaitForPodsToRestart: waitForRestart,
Expand Down
5 changes: 2 additions & 3 deletions magefile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,12 @@ func TestE2E() error {
if err != nil {
return err
}
// make sure we delete the kind cluster
defer sh.RunWithV(env, "k3d", "cluster", "delete", CLUSTER_NAME)

err = sh.RunWithV(env, "go", "test", "./test/e2e/", "-v", "-ginkgo.v")
if err != nil {
return err
}

// make sure we delete the kind cluster
defer sh.RunWithV(env, "k3d", "cluster", "delete", CLUSTER_NAME)
return nil
}
Loading