@@ -22,8 +22,11 @@ package controller
2222import (
2323 "context"
2424 "encoding/json"
25+ "errors"
26+ "time"
2527
2628 metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
29+ ctrl "sigs.k8s.io/controller-runtime"
2730 k8client "sigs.k8s.io/controller-runtime/pkg/client"
2831 "sigs.k8s.io/controller-runtime/pkg/client/fake"
2932
@@ -37,14 +40,26 @@ import (
3740
3841type fakePluginClient struct {
3942 pluginClient.Client
40- setClusterStatus map [string ]string
43+ setClusterStatus map [string ]string
44+ setClusterStatusErr error
45+ setStatusInClusterCalled bool
46+ postReconcileResult pluginClient.ReconcilerHookResult
4147}
4248
4349func (f * fakePluginClient ) SetStatusInCluster (
4450 _ context.Context ,
4551 _ k8client.Object ,
4652) (map [string ]string , error ) {
47- return f .setClusterStatus , nil
53+ f .setStatusInClusterCalled = true
54+ return f .setClusterStatus , f .setClusterStatusErr
55+ }
56+
57+ func (f * fakePluginClient ) PostReconcile (
58+ _ context.Context ,
59+ _ k8client.Object ,
60+ _ k8client.Object ,
61+ ) pluginClient.ReconcilerHookResult {
62+ return f .postReconcileResult
4863}
4964
5065var _ = Describe ("setStatusPluginHook" , func () {
@@ -88,3 +103,127 @@ var _ = Describe("setStatusPluginHook", func() {
88103 Expect (cluster .Status .PluginStatus [0 ].Status ).To (BeEquivalentTo (string (content )))
89104 })
90105})
106+
107+ var _ = Describe ("finalizeReconciliation" , func () {
108+ const pluginName = "test1_plugin"
109+ const initialPhase = "InitialPhase"
110+
111+ var (
112+ cluster * apiv1.Cluster
113+ cli k8client.Client
114+ pluginCli * fakePluginClient
115+ reconciler * ClusterReconciler
116+ )
117+
118+ BeforeEach (func () {
119+ cluster = & apiv1.Cluster {
120+ ObjectMeta : metav1.ObjectMeta {
121+ Name : "test" ,
122+ Namespace : "test-suite" ,
123+ },
124+ Status : apiv1.ClusterStatus {
125+ Phase : initialPhase ,
126+ PluginStatus : []apiv1.PluginStatus {
127+ {Name : pluginName },
128+ },
129+ },
130+ }
131+ cli = fake .NewClientBuilder ().
132+ WithObjects (cluster ).
133+ WithScheme (scheme .BuildWithAllKnownScheme ()).
134+ WithStatusSubresource (& apiv1.Cluster {}).
135+ Build ()
136+
137+ pluginCli = & fakePluginClient {}
138+ reconciler = & ClusterReconciler {
139+ Client : cli ,
140+ }
141+ })
142+
143+ It ("registers PhaseHealthy when no plugin sets a status" , func (ctx SpecContext ) {
144+ res , err := reconciler .finalizeReconciliation (ctx , pluginCli , cluster )
145+
146+ Expect (err ).ToNot (HaveOccurred ())
147+ Expect (res .IsZero ()).To (BeTrue ())
148+
149+ var fresh apiv1.Cluster
150+ Expect (cli .Get (ctx , k8client .ObjectKeyFromObject (cluster ), & fresh )).To (Succeed ())
151+ Expect (fresh .Status .Phase ).To (Equal (apiv1 .PhaseHealthy ))
152+ })
153+
154+ It ("registers PhaseHealthy and propagates the requeue when plugins patch their statuses" , func (ctx SpecContext ) {
155+ // setStatusPluginHook returns RequeueAfter=5s on every successful
156+ // status patch. That requeue must NOT short-circuit the PhaseHealthy
157+ // registration: clusters with status-reporting plugins (e.g.
158+ // barman-cloud) requeue every 5s in steady state and would otherwise
159+ // never reach Healthy.
160+ content , err := json .Marshal (map [string ]string {"key" : "value" })
161+ Expect (err ).ToNot (HaveOccurred ())
162+ pluginCli .setClusterStatus = map [string ]string {pluginName : string (content )}
163+
164+ res , err := reconciler .finalizeReconciliation (ctx , pluginCli , cluster )
165+
166+ Expect (err ).ToNot (HaveOccurred ())
167+ Expect (res .RequeueAfter ).To (Equal (5 * time .Second ))
168+
169+ var fresh apiv1.Cluster
170+ Expect (cli .Get (ctx , k8client .ObjectKeyFromObject (cluster ), & fresh )).To (Succeed ())
171+ Expect (fresh .Status .Phase ).To (Equal (apiv1 .PhaseHealthy ))
172+ Expect (fresh .Status .PluginStatus [0 ].Status ).To (BeEquivalentTo (string (content )))
173+ })
174+
175+ It ("does not register PhaseHealthy when post-reconcile returns an error" , func (ctx SpecContext ) {
176+ // Regression test for #8582: when a post-reconcile plugin hook
177+ // returns an error, the loop must not also mark the cluster
178+ // Healthy. Otherwise the next reconciliation overwrites the
179+ // PhaseFailurePlugin set by Reconcile()'s error path and the
180+ // cluster oscillates between Healthy and FailurePlugin.
181+ expectedErr := errors .New ("plugin post-reconcile failure" )
182+ pluginCli .postReconcileResult = pluginClient.ReconcilerHookResult {Err : expectedErr }
183+
184+ _ , err := reconciler .finalizeReconciliation (ctx , pluginCli , cluster )
185+
186+ Expect (err ).To (MatchError (expectedErr ))
187+ // A post-reconcile error must short-circuit before the status sync.
188+ Expect (pluginCli .setStatusInClusterCalled ).To (BeFalse ())
189+
190+ var fresh apiv1.Cluster
191+ Expect (cli .Get (ctx , k8client .ObjectKeyFromObject (cluster ), & fresh )).To (Succeed ())
192+ Expect (fresh .Status .Phase ).To (Equal (initialPhase ))
193+ })
194+
195+ It ("registers PhaseHealthy when post-reconcile requests a requeue without error" , func (ctx SpecContext ) {
196+ // A plugin requesting a requeue (no error) from PostReconcile must
197+ // still transition the cluster to Healthy, and the status sync is
198+ // skipped because the requeue already short-circuits the loop.
199+ pluginCli .postReconcileResult = pluginClient.ReconcilerHookResult {
200+ Result : ctrl.Result {RequeueAfter : 30 * time .Second },
201+ }
202+
203+ res , err := reconciler .finalizeReconciliation (ctx , pluginCli , cluster )
204+
205+ Expect (err ).ToNot (HaveOccurred ())
206+ Expect (res .RequeueAfter ).To (Equal (30 * time .Second ))
207+ Expect (pluginCli .setStatusInClusterCalled ).To (BeFalse ())
208+
209+ var fresh apiv1.Cluster
210+ Expect (cli .Get (ctx , k8client .ObjectKeyFromObject (cluster ), & fresh )).To (Succeed ())
211+ Expect (fresh .Status .Phase ).To (Equal (apiv1 .PhaseHealthy ))
212+ })
213+
214+ It ("does not register PhaseHealthy when SetStatusInCluster returns an error" , func (ctx SpecContext ) {
215+ expectedErr := errors .New ("set status failure" )
216+ pluginCli .setClusterStatusErr = expectedErr
217+
218+ _ , err := reconciler .finalizeReconciliation (ctx , pluginCli , cluster )
219+
220+ // errors.Is to ensure the wrap chain is preserved (%w, not %v):
221+ // downstream callers depend on Unwrap to classify plugin errors via
222+ // cnpgiClient.ContainsPluginError.
223+ Expect (errors .Is (err , expectedErr )).To (BeTrue ())
224+
225+ var fresh apiv1.Cluster
226+ Expect (cli .Get (ctx , k8client .ObjectKeyFromObject (cluster ), & fresh )).To (Succeed ())
227+ Expect (fresh .Status .Phase ).To (Equal (initialPhase ))
228+ })
229+ })
0 commit comments