Unify common code by amartyasinha · Pull Request #1130 · openstack-k8s-operators/nova-operator

amartyasinha · 2026-06-18T08:33:09Z

Introduce internal/common for shared nova/placement
controller code: reconciler base, ensure helpers,
config generation, watch mappers, Kolla constants,
and static errors. Nova and placement controllers
call these helpers; nova-only logic stays in
internal/controller/nova/common.go.

This is a move-first refactor: logic, comments, and
naming are preserved where possible. Only
unavoidable mechanical changes are included (e.g.
exported names for cross-package use, import
updates, r.Client.Update because Client is a named
field on ReconcilerBase).

Co-authored-by: Cursor cursoragent@cursor.com

openshift-ci · 2026-06-18T08:33:13Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

openshift-ci · 2026-06-18T08:33:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amartyasinha

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [amartyasinha]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

SeanMooney · 2026-06-22T11:50:24Z

-}
-
 // ReconcilerBase provides a common set of clients scheme and loggers for all reconcilers.
 type ReconcilerBase struct {


so ReconcilerBase is intened to be the thing that hold the common code

so you shoudl be moving this as well if your going to do this.

the orginal inte was for this to become the common bas for the nova placment and evnetully cyborg contolers.

Thanks @SeanMooney! Sure, I'll be moving ReconcilerBase soon to common code. I had it in the initial draft, but removed it because it was getting overwhelming for me to self-review. Once I believe the current code I'm moving are well-placed, I'll move ReconcilerBase as well.

I've tried moving ReconcilerBase and other related func to internal/common. PTAL.

mrkisaolamb · 2026-06-23T09:31:30Z

 		h.GetClient(),
-		&instance.Status.Conditions)
+		&instance.Status.Conditions,
+		time.Second*10,


I think thanks to unifying ReconcilerBase, we can use r.RequeueTimeout

mrkisaolamb · 2026-06-23T10:12:51Z

+	// networks to attach to
+	nadList := []networkv1.NetworkAttachmentDefinition{}
+	for _, netAtt := range networkAttachments {
+		nad, err := nad.GetNADWithName(ctx, h, netAtt, h.GetBeforeObject().GetNamespace())


maybe nadObject (nad is a name of package already)

Done. Thanks!

mrkisaolamb · 2026-06-23T10:26:38Z

+var (
+	// ErrACSecretNotFound indicates that the ApplicationCredential secret was not found.
+	ErrACSecretNotFound = errors.New("ApplicationCredential secret not found")
+	// ErrACSecretMissingKeys indicates that the ApplicationCredential secret is missing required keys.


I think we missed a few errors, like errUnexpectedObjectType or ErrInvalidObjectType (of course, assuming we want to deduplicate all similar errors in the future, e.g., all errors like errExpectedNovaObject)

moved all remaining errors here.

Cool thanks, now when we have all errors in one place they can be unified like ErrInvalidObjectType and ErrUnexpectedObjectType probably can be one error in code. Maybe similar thing can be with more specific one eg ErrExpectedNovaAPIObject

mrkisaolamb

Something else we can try: unifying FindObjectsForSrcByField and findObjectsWithAppSelectorLabelInNamespace

mrkisaolamb · 2026-06-23T13:40:17Z

I think this can be fix Log := r.GetLogger(ctx)

mrkisaolamb · 2026-06-23T13:43:10Z

can we fix all this kind of timeouts using r.RequeueTimeout?

mrkisaolamb · 2026-06-23T13:45:53Z

+var (
+	// ErrACSecretNotFound indicates that the ApplicationCredential secret was not found.
+	ErrACSecretNotFound = errors.New("ApplicationCredential secret not found")
+	// ErrACSecretMissingKeys indicates that the ApplicationCredential secret is missing required keys.


Cool thanks, now when we have all errors in one place they can be unified like ErrInvalidObjectType and ErrUnexpectedObjectType probably can be one error in code. Maybe similar thing can be with more specific one eg ErrExpectedNovaAPIObject

mrkisaolamb · 2026-06-24T07:47:27Z

 		return result, nil
 	}

 	err = r.generateServiceConfigMaps(ctx, h, instance, secret, &configMapVars, db)


Do you think we can generalize the existing nova generateConfigsGeneric and use it here?

Yes, we can do that. Though it won't be a clean move of nova's generateConfigsGeneric to internal/common, and there will be a few changes, thus will required some tests. I'll try to do it tomorrow, or if you want, we can have it in a follow up PR too, whatever you prefer.

added a new commit for this. PTAL

…et names Move shared Kolla volume and secret name helpers out of internal/nova so nova and placement deployments can reuse them.

Move shared static errors into internal/common/errors.go and update webhook and controller call sites to reference the shared definitions.

Extract ReconcilerBase, Manageable, Reconciler, NewReconcilerBase, SetRequeueTimeout, Reconcilers, Setup, and OverrideRequeueTimeout into internal/common. Wire nova, placement, and main to use the shared base.

Move EnsureSecret, EnsureNetworkAttachments, EnsureTopology, and ConditionUpdater into internal/common. Switch nova and placement controllers to use the shared helpers.

Remove the duplicate allSubConditionIsTrue helper from nova common; logic matches condition.Conditions.AllSubConditionIsTrue() from lib-common.

Add unit tests for internal/common.EnsureSecret and extend placement functional coverage for missing and incomplete input secrets.

Replace duplicated controller watch map functions with generic helpers in internal/common/watch.go.

Share config secret generation between nova and placement controllers. Nova passes service-specific templates via NovaAdditionalTemplates in nova/common.go; placement uses GenerateConfigsWithScripts in generateServiceConfigMaps. Co-authored-by: Cursor <cursoragent@cursor.com>

mrkisaolamb · 2026-06-24T12:22:34Z

+// Static errors shared across operator services.
+var (
+	// ErrACSecretNotFound indicates that the ApplicationCredential secret was not found.
+	ErrACSecretNotFound = errors.New("ApplicationCredential secret not found")


question: wdyt about removing this error and use in placement similar condition+log+nil error like in nova controllers?

mrkisaolamb · 2026-06-29T07:38:00Z

-		cmLabels, additionalTemplates, commonTemplates, templateDir, true,
-	)
+// NovaAdditionalTemplates are the default extra config templates for nova services.
+var NovaAdditionalTemplates = map[string]string{


I don't think this should be global, as it can be mutated by any caller during execution. It's better to scope this locally inside the functions

mrkisaolamb · 2026-06-29T07:39:25Z

+
+// EnsureNetworkAttachments - checks the requested network attachments exists and
+// returns the annotation to be set on the deployment objects.
+func EnsureNetworkAttachments(


can we add some tests for this?

mrkisaolamb · 2026-06-29T07:39:54Z

+// EnsureTopology - when a Topology CR is referenced, remove the
+// finalizer from a previous referenced Topology (if any), and retrieve the
+// newly referenced topology object
+func EnsureTopology(


pls add some unit tests

openshift-ci Bot added the do-not-merge/work-in-progress label Jun 18, 2026

openshift-ci Bot added the approved label Jun 18, 2026

amartyasinha mentioned this pull request Jun 19, 2026

[WIP] Unify code common 2 #1132

Closed

amartyasinha force-pushed the unify_code branch 10 times, most recently from 6aab9a1 to 1ef05f9 Compare June 22, 2026 10:20

SeanMooney reviewed Jun 22, 2026

View reviewed changes

amartyasinha force-pushed the unify_code branch from 1ef05f9 to c95289d Compare June 23, 2026 06:48

mrkisaolamb requested changes Jun 23, 2026

View reviewed changes

openshift-ci Bot assigned mrkisaolamb Jun 23, 2026

amartyasinha force-pushed the unify_code branch 2 times, most recently from fc8d155 to 7d82edc Compare June 23, 2026 11:34

amartyasinha requested a review from mrkisaolamb June 23, 2026 11:38

mrkisaolamb requested changes Jun 24, 2026

View reviewed changes

amartyasinha force-pushed the unify_code branch 5 times, most recently from 2444cca to 3a8b6c6 Compare June 24, 2026 15:22

amartyasinha requested review from SeanMooney and mrkisaolamb June 24, 2026 15:34

amartyasinha marked this pull request as ready for review June 29, 2026 03:38

openshift-ci Bot requested a review from amoralej June 29, 2026 03:38

amartyasinha changed the title ~~[WIP] Unify common code~~ Unify common code Jun 29, 2026

openshift-ci Bot removed the do-not-merge/work-in-progress label Jun 29, 2026

amartyasinha and others added 8 commits June 29, 2026 09:43

Add internal/common kolla helpers for shared Kolla constants and secr…

4a376a4

…et names Move shared Kolla volume and secret name helpers out of internal/nova so nova and placement deployments can reuse them.

Consolidate operator static errors in internal/common

606970a

Move shared static errors into internal/common/errors.go and update webhook and controller call sites to reference the shared definitions.

Move shared reconciler infrastructure to internal/common

68e44bb

Extract ReconcilerBase, Manageable, Reconciler, NewReconcilerBase, SetRequeueTimeout, Reconcilers, Setup, and OverrideRequeueTimeout into internal/common. Wire nova, placement, and main to use the shared base.

Extract shared ensure helpers into internal/common

2d669f5

Move EnsureSecret, EnsureNetworkAttachments, EnsureTopology, and ConditionUpdater into internal/common. Switch nova and placement controllers to use the shared helpers.

Use lib-common AllSubConditionIsTrue in nova controllers

71344e2

Remove the duplicate allSubConditionIsTrue helper from nova common; logic matches condition.Conditions.AllSubConditionIsTrue() from lib-common.

Add tests for shared EnsureSecret in placement

50d0b2f

Add unit tests for internal/common.EnsureSecret and extend placement functional coverage for missing and incomplete input secrets.

Extract shared watch map helpers into internal/common

07d944a

Replace duplicated controller watch map functions with generic helpers in internal/common/watch.go.

amartyasinha force-pushed the unify_code branch from 3a8b6c6 to 9000f33 Compare June 29, 2026 04:13

mrkisaolamb requested changes Jun 29, 2026

View reviewed changes

Uh oh!

Conversation

amartyasinha commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci Bot commented Jun 18, 2026

Uh oh!

openshift-ci Bot commented Jun 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrkisaolamb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

amartyasinha commented Jun 18, 2026 •

edited

Loading