Skip to content

Cyclomatic complexity: globalize fetch dependency helper #621

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
mandre merged 2 commits into from
Jan 7, 2026
Merged

Cyclomatic complexity: globalize fetch dependency helper #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a57831b
globalize get dependency helper
eshulman2 Dec 24, 2025
153dba0
refactor actuators to use global FetchDependency helper
eshulman2 Jan 4, 2026
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
34 changes: 11 additions & 23 deletions cmd/scaffold-controller/data/controller/actuator.go.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ import (

"{{ .GophercloudModule }}"
corev1 "k8s.io/api/core/v1"
{{- if len .ImportDependencies }}
apierrors "k8s.io/apimachinery/pkg/api/errors"
{{- end }}
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand All @@ -37,6 +34,9 @@ import (
"github.com/k-orc/openstack-resource-controller/v2/internal/controllers/generic/progress"
"github.com/k-orc/openstack-resource-controller/v2/internal/logging"
"github.com/k-orc/openstack-resource-controller/v2/internal/osclients"
{{- if len .ImportDependencies }}
"github.com/k-orc/openstack-resource-controller/v2/internal/util/dependency"
{{- end }}
orcerrors "github.com/k-orc/openstack-resource-controller/v2/internal/util/errors"
)

Expand Down Expand Up @@ -106,24 +106,12 @@ func (actuator {{ .PackageName }}Actuator) ListOSResourcesForImport(ctx context.
var reconcileStatus progress.ReconcileStatus
{{- range .ImportDependencies }}
{{ $depNameCamelCase := . | camelCase }}
{{ $depNameCamelCase }} := &orcv1alpha1.{{ . }}{}
if filter.{{ . }}Ref != nil {
{{ $depNameCamelCase }}Key := client.ObjectKey{Name: string(*filter.{{ . }}Ref), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, {{ $depNameCamelCase }}Key, {{ $depNameCamelCase }}); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("{{ . }}", {{ $depNameCamelCase }}Key.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching {{ $depNameCamelCase }} %s: %w", {{ $depNameCamelCase }}Key.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable({{ $depNameCamelCase }}) || {{ $depNameCamelCase }}.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("{{ . }}", {{ $depNameCamelCase }}Key.Name, progress.WaitingOnReady))
}
}
}
{{ $depNameCamelCase }}, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace,
filter.{{ . }}Ref, "{{ . }}",
func(dep *orcv1alpha1.{{ . }}) bool { return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil },
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)
{{- end }}

if needsReschedule, _ := reconcileStatus.NeedsReschedule(); needsReschedule {
Expand All @@ -135,12 +123,12 @@ func (actuator {{ .PackageName }}Actuator) ListOSResourcesForImport(ctx context.
Name: string(ptr.Deref(filter.Name, "")),
Description: string(ptr.Deref(filter.Description, "")),
{{- range .ImportDependencies }}
{{ . }}: ptr.Deref({{ . | camelCase }}.Status.ID, ""),
{{ . }}ID: ptr.Deref({{ . | camelCase }}.Status.ID, ""),
{{- end }}
// TODO(scaffolding): Add more import filters
}

return actuator.osClient.List{{ .Kind }}s(ctx, listOpts), nil
return actuator.osClient.List{{ .Kind }}s(ctx, listOpts), {{ if len .ImportDependencies }}reconcileStatus{{ else }}nil{{ end }}
}

func (actuator {{ .PackageName }}Actuator) CreateResource(ctx context.Context, obj orcObjectPT) (*osResourceT, progress.ReconcileStatus) {
Expand Down
82 changes: 24 additions & 58 deletions internal/controllers/floatingip/actuator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package floatingip

import (
"context"
"fmt"
"iter"

"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/layer3/floatingips"
Expand All @@ -27,10 +26,10 @@ import (
"github.com/k-orc/openstack-resource-controller/v2/internal/controllers/generic/progress"
"github.com/k-orc/openstack-resource-controller/v2/internal/logging"
osclients "github.com/k-orc/openstack-resource-controller/v2/internal/osclients"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/dependency"
orcerrors "github.com/k-orc/openstack-resource-controller/v2/internal/util/errors"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/tags"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -89,62 +88,29 @@ func (actuator floatingipActuator) ListOSResourcesForAdoption(ctx context.Contex
func (actuator floatingipCreateActuator) ListOSResourcesForImport(ctx context.Context, obj orcObjectPT, filter filterT) (iter.Seq2[*osResourceT, error], progress.ReconcileStatus) {
var reconcileStatus progress.ReconcileStatus

network := &orcv1alpha1.Network{}
if filter.FloatingNetworkRef != nil {
networkKey := client.ObjectKey{Name: string(ptr.Deref(filter.FloatingNetworkRef, "")), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, networkKey, network); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Network", networkKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching network %s: %w", networkKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(network) || network.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Network", networkKey.Name, progress.WaitingOnReady))
}
}
}

port := &orcv1alpha1.Port{}
if filter.PortRef != nil {
portKey := client.ObjectKey{Name: string(ptr.Deref(filter.PortRef, "")), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, portKey, port); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Port", portKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching port %s: %w", portKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(port) || port.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Port", portKey.Name, progress.WaitingOnReady))
}
}
}

project := &orcv1alpha1.Project{}
if filter.ProjectRef != nil {
projectKey := client.ObjectKey{Name: string(*filter.ProjectRef), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, projectKey, project); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Project", projectKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching project %s: %w", projectKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(project) || project.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Project", projectKey.Name, progress.WaitingOnReady))
}
}
}
network, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, filter.FloatingNetworkRef, "Network",
func(dep *orcv1alpha1.Network) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

port, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, filter.PortRef, "Port",
func(dep *orcv1alpha1.Port) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

project, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, filter.ProjectRef, "Project",
func(dep *orcv1alpha1.Project) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

if needsReschedule, _ := reconcileStatus.NeedsReschedule(); needsReschedule {
return nil, reconcileStatus
Expand Down
28 changes: 8 additions & 20 deletions internal/controllers/group/actuator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,10 @@ package group

import (
"context"
"fmt"
"iter"

"github.com/gophercloud/gophercloud/v2/openstack/identity/v3/groups"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand All @@ -33,6 +31,7 @@ import (
"github.com/k-orc/openstack-resource-controller/v2/internal/controllers/generic/progress"
"github.com/k-orc/openstack-resource-controller/v2/internal/logging"
"github.com/k-orc/openstack-resource-controller/v2/internal/osclients"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/dependency"
orcerrors "github.com/k-orc/openstack-resource-controller/v2/internal/util/errors"
)

Expand Down Expand Up @@ -83,24 +82,13 @@ func (actuator groupActuator) ListOSResourcesForImport(ctx context.Context, obj

var reconcileStatus progress.ReconcileStatus

domain := &orcv1alpha1.Domain{}
if filter.DomainRef != nil {
domainKey := client.ObjectKey{Name: string(*filter.DomainRef), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, domainKey, domain); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Domain", domainKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching domain %s: %w", domainKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(domain) || domain.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Domain", domainKey.Name, progress.WaitingOnReady))
}
}
}
domain, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, filter.DomainRef, "Domain",
func(dep *orcv1alpha1.Domain) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

if needsReschedule, _ := reconcileStatus.NeedsReschedule(); needsReschedule {
return nil, reconcileStatus
Expand Down
28 changes: 8 additions & 20 deletions internal/controllers/network/actuator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package network

import (
"context"
"fmt"
"iter"

"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/dns"
Expand All @@ -27,7 +26,6 @@ import (
"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/portsecurity"
"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/networks"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand All @@ -37,6 +35,7 @@ import (
"github.com/k-orc/openstack-resource-controller/v2/internal/controllers/generic/progress"
"github.com/k-orc/openstack-resource-controller/v2/internal/logging"
"github.com/k-orc/openstack-resource-controller/v2/internal/osclients"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/dependency"
orcerrors "github.com/k-orc/openstack-resource-controller/v2/internal/util/errors"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/tags"
)
Expand Down Expand Up @@ -84,24 +83,13 @@ func (actuator networkActuator) ListOSResourcesForAdoption(ctx context.Context,
func (actuator networkActuator) ListOSResourcesForImport(ctx context.Context, obj orcObjectPT, filter filterT) (iter.Seq2[*osResourceT, error], progress.ReconcileStatus) {
var reconcileStatus progress.ReconcileStatus

project := &orcv1alpha1.Project{}
if filter.ProjectRef != nil {
projectKey := client.ObjectKey{Name: string(*filter.ProjectRef), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, projectKey, project); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Project", projectKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching project %s: %w", projectKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(project) || project.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Project", projectKey.Name, progress.WaitingOnReady))
}
}
}
project, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, filter.ProjectRef, "Project",
func(dep *orcv1alpha1.Project) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

if needsReschedule, _ := reconcileStatus.NeedsReschedule(); needsReschedule {
return nil, reconcileStatus
Expand Down
52 changes: 15 additions & 37 deletions internal/controllers/port/actuator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import (
"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/portsecurity"
"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/ports"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand All @@ -37,6 +36,7 @@ import (
"github.com/k-orc/openstack-resource-controller/v2/internal/controllers/generic/progress"
"github.com/k-orc/openstack-resource-controller/v2/internal/logging"
osclients "github.com/k-orc/openstack-resource-controller/v2/internal/osclients"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/dependency"
orcerrors "github.com/k-orc/openstack-resource-controller/v2/internal/util/errors"
"github.com/k-orc/openstack-resource-controller/v2/internal/util/tags"
)
Expand Down Expand Up @@ -89,43 +89,21 @@ func (actuator portActuator) ListOSResourcesForAdoption(ctx context.Context, obj
func (actuator portActuator) ListOSResourcesForImport(ctx context.Context, obj orcObjectPT, filter filterT) (iter.Seq2[*osResourceT, error], progress.ReconcileStatus) {
var reconcileStatus progress.ReconcileStatus

network := &orcv1alpha1.Network{}
if filter.NetworkRef != "" {
networkKey := client.ObjectKey{Name: string(filter.NetworkRef), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, networkKey, network); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Network", networkKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching network %s: %w", networkKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(network) || network.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Network", networkKey.Name, progress.WaitingOnReady))
}
}
}
network, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, &filter.NetworkRef, "Network",
func(dep *orcv1alpha1.Network) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

project := &orcv1alpha1.Project{}
if filter.ProjectRef != nil {
projectKey := client.ObjectKey{Name: string(*filter.ProjectRef), Namespace: obj.Namespace}
if err := actuator.k8sClient.Get(ctx, projectKey, project); err != nil {
if apierrors.IsNotFound(err) {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Project", projectKey.Name, progress.WaitingOnCreation))
} else {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WrapError(fmt.Errorf("fetching project %s: %w", projectKey.Name, err)))
}
} else {
if !orcv1alpha1.IsAvailable(project) || project.Status.ID == nil {
reconcileStatus = reconcileStatus.WithReconcileStatus(
progress.WaitingOnObject("Project", projectKey.Name, progress.WaitingOnReady))
}
}
}
project, rs := dependency.FetchDependency(
ctx, actuator.k8sClient, obj.Namespace, filter.ProjectRef, "Project",
func(dep *orcv1alpha1.Project) bool {
return orcv1alpha1.IsAvailable(dep) && dep.Status.ID != nil
},
)
reconcileStatus = reconcileStatus.WithReconcileStatus(rs)

if needsReschedule, _ := reconcileStatus.NeedsReschedule(); needsReschedule {
return nil, reconcileStatus
Expand Down
Loading