🌱 Fix CI (PR verify) and avoid returning err+RequeueAfter. (#1591)

guettli · web-flow · commit 95b628c789d1 · 2025-04-24T14:22:30.000+02:00
diff --git a/.github/workflows/pr-verify.yml b/.github/workflows/pr-verify.yml
@@ -25,15 +25,15 @@ jobs:
             exit 1
           fi
 
-          if ! [[ "$TITLE" =~ ^($'\u26A0'|$'\u2728'|$'\U0001F41B'|$'\U0001F4D6'|$'\U0001F680'|$'\U0001F331') ]]; then
+          if ! [[ "$TITLE" =~ ^($'\u26A0'|:warning:|$'\u2728'|:sparkles:|$'\U0001F41B'|:bug:|$'\U0001F4D6'|:book:|$'\U0001F680'|:release:|$'\U0001F331'|:seedling:) ]]; then
             echo "Error: Invalid PR title format."
             echo "Your PR title must start with one of the following indicators:"
-            echo "- Breaking change: ⚠ (U+26A0)"
-            echo "- Non-breaking feature: ✨ (U+2728)"
-            echo "- Patch fix: 🐛 (U+1F41B)"
-            echo "- Docs: 📖 (U+1F4D6)"
-            echo "- Release: 🚀 (U+1F680)"
-            echo "- Infra/Tests/Other: 🌱 (U+1F331)"
+            echo "- Breaking change: ⚠ (U+26A0) or :warning:"
+            echo "- Non-breaking feature: ✨ (U+2728) or :sparkles:"
+            echo "- Patch fix: 🐛 (U+1F41B) or :bug:"
+            echo "- Docs: 📖 (U+1F4D6) or :book:"
+            echo "- Release: 🚀 (U+1F680) or :release:"
+            echo "- Infra/Tests/Other: 🌱 (U+1F331) or :seedling:"
             exit 1
           fi
 
diff --git a/controllers/hcloudmachine_controller.go b/controllers/hcloudmachine_controller.go
@@ -67,7 +67,7 @@ type HCloudMachineReconciler struct {
 //+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=hcloudmachines/finalizers,verbs=update
 
 // Reconcile manages the lifecycle of an HCloud machine object.
-func (r *HCloudMachineReconciler) Reconcile(ctx context.Context, req reconcile.Request) (_ reconcile.Result, reterr error) {
+func (r *HCloudMachineReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, reterr error) {
 	log := ctrl.LoggerFrom(ctx)
 
 	// Fetch the HCloudMachine instance.
@@ -154,6 +154,7 @@ func (r *HCloudMachineReconciler) Reconcile(ctx context.Context, req reconcile.R
 		}
 
 		if err := machineScope.Close(ctx); err != nil && reterr == nil {
+			res = reconcile.Result{}
 			reterr = err
 		}
 	}()
diff --git a/controllers/hcloudmachine_controller_test.go b/controllers/hcloudmachine_controller_test.go
@@ -318,7 +318,7 @@ var _ = Describe("HCloudMachineReconciler", func() {
 		Expect(testEnv.Cleanup(ctx, testNs, capiCluster, hetznerSecret, bootstrapSecret)).To(Succeed())
 	})
 
-	Context("Basic test", func() {
+	Context("Basic hcloudmachine test", func() {
 		Context("correct server", func() {
 			BeforeEach(func() {
 				// remove bootstrap infos
diff --git a/controllers/hcloudmachinetemplate_controller_test.go b/controllers/hcloudmachinetemplate_controller_test.go
@@ -53,7 +53,7 @@ var _ = Describe("HCloudMachineTemplateReconciler", func() {
 		Expect(testEnv.Cleanup(ctx, testNs, hetznerSecret)).To(Succeed())
 	})
 
-	Context("Basic test", func() {
+	Context("Basic hcloudmachinetemplate test", func() {
 		Context("ClusterClass test", func() {
 			var capiClusterClass *clusterv1.ClusterClass
 
diff --git a/controllers/hcloudremediation_controller.go b/controllers/hcloudremediation_controller.go
@@ -57,7 +57,7 @@ type HCloudRemediationReconciler struct {
 //+kubebuilder:rbac:groups=cluster.x-k8s.io,resources=machines;machines/status,verbs=get;update;patch
 
 // Reconcile reconciles the hetznerHCloudRemediation object.
-func (r *HCloudRemediationReconciler) Reconcile(ctx context.Context, req reconcile.Request) (_ reconcile.Result, reterr error) {
+func (r *HCloudRemediationReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, reterr error) {
 	log := ctrl.LoggerFrom(ctx)
 
 	hcloudRemediation := &infrav1.HCloudRemediation{}
@@ -165,6 +165,7 @@ func (r *HCloudRemediationReconciler) Reconcile(ctx context.Context, req reconci
 		patchOpts = append(patchOpts, patch.WithStatusObservedGeneration{})
 
 		if err := remediationScope.Close(ctx, patchOpts...); err != nil && reterr == nil {
+			res = reconcile.Result{}
 			reterr = err
 		}
 	}()
diff --git a/controllers/hcloudremediation_controller_test.go b/controllers/hcloudremediation_controller_test.go
@@ -186,7 +186,7 @@ var _ = Describe("HCloudRemediationReconciler", func() {
 			hetznerSecret, bootstrapSecret, hetznerCluster, capiMachine, capiCluster)).To(Succeed())
 	})
 
-	Context("Basic test", func() {
+	Context("Basic hcloudremediation test", func() {
 		It("creates the hcloudRemediation successfully", func() {
 			Expect(testEnv.Create(ctx, hcloudRemediation)).To(Succeed())
 
diff --git a/controllers/hetznerbaremetalhost_controller_test.go b/controllers/hetznerbaremetalhost_controller_test.go
@@ -192,7 +192,7 @@ var _ = Describe("HetznerBareMetalHostReconciler", func() {
 			hetznerSecret, rescueSSHSecret, osSSHSecret, bootstrapSecret)).To(Succeed())
 	})
 
-	Context("Basic test", func() {
+	Context("Basic hbmh test", func() {
 		BeforeEach(func() {
 			host = helpers.BareMetalHost(
 				hostName,
diff --git a/controllers/hetznerbaremetalmachine_controller.go b/controllers/hetznerbaremetalmachine_controller.go
@@ -60,7 +60,7 @@ type HetznerBareMetalMachineReconciler struct {
 //+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=hetznerbaremetalmachines/finalizers,verbs=update
 
 // Reconcile implements the reconcilement of HetznerBareMetalMachine objects.
-func (r *HetznerBareMetalMachineReconciler) Reconcile(ctx context.Context, req reconcile.Request) (_ reconcile.Result, reterr error) {
+func (r *HetznerBareMetalMachineReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, reterr error) {
 	log := ctrl.LoggerFrom(ctx)
 
 	// Fetch the Hetzner bare metal instance.
@@ -145,6 +145,7 @@ func (r *HetznerBareMetalMachineReconciler) Reconcile(ctx context.Context, req r
 		conditions.SetSummary(hbmMachine)
 
 		if err := machineScope.Close(ctx); err != nil && reterr == nil {
+			res = reconcile.Result{}
 			reterr = err
 		}
 	}()
diff --git a/controllers/hetznerbaremetalmachine_controller_test.go b/controllers/hetznerbaremetalmachine_controller_test.go
@@ -266,7 +266,7 @@ var _ = Describe("HetznerBareMetalMachineReconciler", func() {
 			})
 		})
 
-		Context("Basic test", func() {
+		Context("Basic hbmm test", func() {
 			var osSSHSecret *corev1.Secret
 
 			BeforeEach(func() {
diff --git a/controllers/hetznerbaremetalremediation_controller.go b/controllers/hetznerbaremetalremediation_controller.go
@@ -48,7 +48,7 @@ type HetznerBareMetalRemediationReconciler struct {
 //+kubebuilder:rbac:groups=cluster.x-k8s.io,resources=machines;machines/status,verbs=get;update;patch
 
 // Reconcile reconciles the hetznerBareMetalRemediation object.
-func (r *HetznerBareMetalRemediationReconciler) Reconcile(ctx context.Context, req reconcile.Request) (_ reconcile.Result, reterr error) {
+func (r *HetznerBareMetalRemediationReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, reterr error) {
 	log := ctrl.LoggerFrom(ctx)
 
 	// Fetch the Hetzner bare metal host instance.
@@ -140,6 +140,7 @@ func (r *HetznerBareMetalRemediationReconciler) Reconcile(ctx context.Context, r
 		patchOpts = append(patchOpts, patch.WithStatusObservedGeneration{})
 
 		if err := remediationScope.Close(ctx, patchOpts...); err != nil && reterr == nil {
+			res = reconcile.Result{}
 			reterr = err
 		}
 	}()
diff --git a/controllers/hetznerbaremetalremediation_controller_test.go b/controllers/hetznerbaremetalremediation_controller_test.go
@@ -232,7 +232,7 @@ var _ = Describe("HetznerBareMetalRemediationReconciler", func() {
 		Expect(testEnv.Cleanup(ctx, testNs, capiCluster, capiMachine, hetznerCluster)).To(Succeed())
 	})
 
-	Context("Basic test", func() {
+	Context("Basic hetznerbaremetalremediation test", func() {
 		Context("HetznerBareMetalHost will get provisioned", func() {
 			BeforeEach(func() {
 				hetznerSecret = getDefaultHetznerSecret(testNs.Name)
diff --git a/controllers/hetznercluster_controller.go b/controllers/hetznercluster_controller.go
@@ -86,7 +86,7 @@ type HetznerClusterReconciler struct {
 //+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=hetznerclusters/finalizers,verbs=update
 
 // Reconcile manages the lifecycle of a HetznerCluster object.
-func (r *HetznerClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (_ ctrl.Result, reterr error) {
+func (r *HetznerClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res ctrl.Result, reterr error) {
 	log := ctrl.LoggerFrom(ctx)
 
 	// Fetch the HetznerCluster instance
@@ -152,6 +152,7 @@ func (r *HetznerClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 		}
 
 		if err := clusterScope.Close(ctx); err != nil && reterr == nil {
+			res = reconcile.Result{}
 			reterr = err
 		}
 	}()
diff --git a/controllers/hetznercluster_controller_test.go b/controllers/hetznercluster_controller_test.go
@@ -625,15 +625,15 @@ var _ = Describe("Hetzner ClusterReconciler", func() {
 					return false
 				}, timeout, time.Second).Should(BeTrue())
 
-				By("deleting the cluster and load balancer and testing that owned label is gone")
+				By("deleting the cluster and load balancer and testing that owned label is gone (flaky)")
 
 				Expect(testEnv.Delete(ctx, instance))
 
 				Eventually(func() bool {
 					loadBalancers, err := hcloudClient.ListLoadBalancers(ctx, hcloud.LoadBalancerListOpts{Name: lbName})
 					// there should always be one load balancer, if not, then this is a problem where we can immediately return
 					Expect(err).To(BeNil())
-					Expect(loadBalancers).To(HaveLen(1))
+					Expect(loadBalancers).To(HaveLen(1)) // flaky
 
 					_, found := loadBalancers[0].Labels[instance.ClusterTagKey()]
 					return found

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ type HCloudMachineReconciler struct {`
`67`	`67`	`//+kubebuilder:rbac:groups=infrastructure.cluster.x-k8s.io,resources=hcloudmachines/finalizers,verbs=update`
`68`	`68`
`69`	`69`	`// Reconcile manages the lifecycle of an HCloud machine object.`
`70`		`-func (r *HCloudMachineReconciler) Reconcile(ctx context.Context, req reconcile.Request) (_ reconcile.Result, reterr error) {`
	`70`	`+func (r *HCloudMachineReconciler) Reconcile(ctx context.Context, req reconcile.Request) (res reconcile.Result, reterr error) {`
`71`	`71`	`log := ctrl.LoggerFrom(ctx)`
`72`	`72`
`73`	`73`	`// Fetch the HCloudMachine instance.`
`@@ -154,6 +154,7 @@ func (r *HCloudMachineReconciler) Reconcile(ctx context.Context, req reconcile.R`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`if err := machineScope.Close(ctx); err != nil && reterr == nil {`
	`157`	`+ res = reconcile.Result{}`
`157`	`158`	`reterr = err`
`158`	`159`	`}`
`159`	`160`	`}()`