Skip to content

🌱 Make target namespaces optional #1945

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.

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
merged 1 commit into from
Apr 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ func (c Converter) Convert(rv1 render.RegistryV1, installNamespace string, targe
return nil, fmt.Errorf("webhookDefinitions are not supported")
}

objs, err := c.BundleRenderer.Render(rv1, installNamespace, targetNamespaces)
objs, err := c.BundleRenderer.Render(rv1, installNamespace, render.WithTargetNamespaces(targetNamespaces...))
if err != nil {
return nil, err
}
Expand Down
21 changes: 18 additions & 3 deletions internal/operator-controller/rukpak/render/render.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"errors"

apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/client"

Expand Down Expand Up @@ -69,27 +70,41 @@ type Options struct {

func (o *Options) apply(opts ...Option) *Options {
for _, opt := range opts {
opt(o)
if opt != nil {
opt(o)
}
}
return o
}

type Option func(*Options)

func WithTargetNamespaces(namespaces ...string) Option {
return func(o *Options) {
o.TargetNamespaces = namespaces
}
}

func WithUniqueNameGenerator(generator UniqueNameGenerator) Option {
return func(o *Options) {
o.UniqueNameGenerator = generator
}
}

type BundleRenderer struct {
BundleValidator BundleValidator
ResourceGenerators []ResourceGenerator
}

func (r BundleRenderer) Render(rv1 RegistryV1, installNamespace string, watchNamespaces []string, opts ...Option) ([]client.Object, error) {
func (r BundleRenderer) Render(rv1 RegistryV1, installNamespace string, opts ...Option) ([]client.Object, error) {
// validate bundle
if err := r.BundleValidator.Validate(&rv1); err != nil {
return nil, err
}

genOpts := (&Options{
InstallNamespace: installNamespace,
TargetNamespaces: watchNamespaces,
TargetNamespaces: []string{metav1.NamespaceAll},
UniqueNameGenerator: DefaultUniqueNameGenerator,
}).apply(opts...)

Expand Down
37 changes: 32 additions & 5 deletions internal/operator-controller/rukpak/render/render_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ func Test_BundleRenderer_ValidatesBundle(t *testing.T) {
},
},
}
objs, err := renderer.Render(render.RegistryV1{}, "", nil)
objs, err := renderer.Render(render.RegistryV1{}, "")
require.Nil(t, objs)
require.Error(t, err)
require.Contains(t, err.Error(), "this bundle is invalid")
}

func Test_BundleRenderer_CreatesCorrectDefaultOptions(t *testing.T) {
expectedInstallNamespace := "install-namespace"
expectedTargetNamespaces := []string{"ns-one", "ns-two"}
expectedTargetNamespaces := []string{""}
expectedUniqueNameGenerator := render.DefaultUniqueNameGenerator

renderer := render.BundleRenderer{
Expand All @@ -51,7 +51,34 @@ func Test_BundleRenderer_CreatesCorrectDefaultOptions(t *testing.T) {
},
}

_, _ = renderer.Render(render.RegistryV1{}, expectedInstallNamespace, expectedTargetNamespaces)
_, _ = renderer.Render(render.RegistryV1{}, expectedInstallNamespace)
}

func Test_BundleRenderer_AppliesUserOptions(t *testing.T) {
isOptionApplied := false
_, _ = render.BundleRenderer{}.Render(render.RegistryV1{}, "install-namespace", func(options *render.Options) {
isOptionApplied = true
})
require.True(t, isOptionApplied)
}

func Test_WithTargetNamespaces(t *testing.T) {
opts := &render.Options{
TargetNamespaces: []string{"target-namespace"},
}
render.WithTargetNamespaces("a", "b", "c")(opts)
require.Equal(t, []string{"a", "b", "c"}, opts.TargetNamespaces)
}

func Test_WithUniqueNameGenerator(t *testing.T) {
opts := &render.Options{
UniqueNameGenerator: render.DefaultUniqueNameGenerator,
}
render.WithUniqueNameGenerator(func(s string, i interface{}) (string, error) {
return "a man needs a name", nil
})(opts)
generatedName, _ := opts.UniqueNameGenerator("", nil)
require.Equal(t, "a man needs a name", generatedName)
}

func Test_BundleRenderer_CallsResourceGenerators(t *testing.T) {
Expand All @@ -65,7 +92,7 @@ func Test_BundleRenderer_CallsResourceGenerators(t *testing.T) {
},
},
}
objs, err := renderer.Render(render.RegistryV1{}, "", nil)
objs, err := renderer.Render(render.RegistryV1{}, "")
require.NoError(t, err)
require.Equal(t, []client.Object{&corev1.Namespace{}, &corev1.Service{}, &appsv1.Deployment{}}, objs)
}
Expand All @@ -81,7 +108,7 @@ func Test_BundleRenderer_ReturnsResourceGeneratorErrors(t *testing.T) {
},
},
}
objs, err := renderer.Render(render.RegistryV1{}, "", nil)
objs, err := renderer.Render(render.RegistryV1{}, "")
require.Nil(t, objs)
require.Error(t, err)
require.Contains(t, err.Error(), "generator error")
Expand Down
Loading