|
| 1 | +package main |
| 2 | + |
| 3 | +import ( |
| 4 | + "bytes" |
| 5 | + "context" |
| 6 | + "encoding/json" |
| 7 | + "testing" |
| 8 | + "time" |
| 9 | + |
| 10 | + "github.com/go-logr/logr/testr" |
| 11 | + "github.com/stretchr/testify/assert" |
| 12 | + "github.com/stretchr/testify/require" |
| 13 | + corev1 "k8s.io/api/core/v1" |
| 14 | + apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" |
| 15 | + apierrors "k8s.io/apimachinery/pkg/api/errors" |
| 16 | + "k8s.io/apimachinery/pkg/api/meta" |
| 17 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 18 | + "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" |
| 19 | + "k8s.io/utils/ptr" |
| 20 | + ctrl "sigs.k8s.io/controller-runtime" |
| 21 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 22 | + |
| 23 | + ocv1 "github.com/operator-framework/operator-controller/api/v1" |
| 24 | + "github.com/operator-framework/operator-controller/internal/object-controller/scheme" |
| 25 | + "github.com/operator-framework/operator-controller/test" |
| 26 | +) |
| 27 | + |
| 28 | +func TestValidateMetricsFlags(t *testing.T) { |
| 29 | + for _, tc := range []struct { |
| 30 | + name string |
| 31 | + cfg config |
| 32 | + wantAddr string |
| 33 | + wantErr string |
| 34 | + }{ |
| 35 | + {name: "disabled"}, |
| 36 | + {name: "certificate without key", cfg: config{certFile: "cert"}, wantErr: "must be used together"}, |
| 37 | + {name: "key without certificate", cfg: config{keyFile: "key"}, wantErr: "must be used together"}, |
| 38 | + {name: "insecure metrics", cfg: config{metricsAddr: ":8443"}, wantErr: "requires tls-cert and tls-key"}, |
| 39 | + {name: "default address", cfg: config{certFile: "cert", keyFile: "key"}, wantAddr: ":8443"}, |
| 40 | + {name: "custom address", cfg: config{certFile: "cert", keyFile: "key", metricsAddr: ":9443"}, wantAddr: ":9443"}, |
| 41 | + } { |
| 42 | + t.Run(tc.name, func(t *testing.T) { |
| 43 | + err := tc.cfg.validate() |
| 44 | + if tc.wantErr != "" { |
| 45 | + require.ErrorContains(t, err, tc.wantErr) |
| 46 | + return |
| 47 | + } |
| 48 | + require.NoError(t, err) |
| 49 | + require.Equal(t, tc.wantAddr, tc.cfg.metricsAddr) |
| 50 | + }) |
| 51 | + } |
| 52 | +} |
| 53 | + |
| 54 | +func TestVersionWithoutCluster(t *testing.T) { |
| 55 | + cmd := newCommand() |
| 56 | + var output bytes.Buffer |
| 57 | + cmd.SetOut(&output) |
| 58 | + cmd.SetArgs([]string{"version"}) |
| 59 | + require.NoError(t, cmd.Execute()) |
| 60 | + require.NotEmpty(t, output.String()) |
| 61 | +} |
| 62 | + |
| 63 | +// Exercise the actual manager and revision engine with only the ClusterObjectSet CRD installed. |
| 64 | +func TestStandaloneController(t *testing.T) { |
| 65 | + ctrl.SetLogger(testr.New(t)) |
| 66 | + testEnv := test.NewEnv() |
| 67 | + testEnv.CRDDirectoryPaths = []string{"../../helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterobjectsets.yaml"} |
| 68 | + restConfig, err := testEnv.Start() |
| 69 | + require.NoError(t, err) |
| 70 | + t.Cleanup(func() { require.NoError(t, test.StopWithRetry(testEnv, time.Minute, time.Second)) }) |
| 71 | + |
| 72 | + cl, err := client.New(restConfig, client.Options{Scheme: scheme.Scheme}) |
| 73 | + require.NoError(t, err) |
| 74 | + ctx, cancel := context.WithCancel(t.Context()) |
| 75 | + defer cancel() |
| 76 | + require.True(t, apierrors.IsNotFound(cl.Get(ctx, client.ObjectKey{Name: "clusterextensions.olm.operatorframework.io"}, &apiextensionsv1.CustomResourceDefinition{}))) |
| 77 | + require.True(t, apierrors.IsNotFound(cl.Get(ctx, client.ObjectKey{Name: "clustercatalogs.olm.operatorframework.io"}, &apiextensionsv1.CustomResourceDefinition{}))) |
| 78 | + |
| 79 | + mgr, err := newManager(&config{probeAddr: "0", pprofAddr: "0"}, restConfig) |
| 80 | + require.NoError(t, err) |
| 81 | + done := make(chan error, 1) |
| 82 | + go func() { done <- mgr.Start(ctx) }() |
| 83 | + t.Cleanup(func() { |
| 84 | + cancel() |
| 85 | + select { |
| 86 | + case err := <-done: |
| 87 | + require.NoError(t, err) |
| 88 | + case <-time.After(30 * time.Second): |
| 89 | + t.Error("manager did not stop") |
| 90 | + } |
| 91 | + }) |
| 92 | + syncCtx, syncCancel := context.WithTimeout(ctx, 30*time.Second) |
| 93 | + defer syncCancel() |
| 94 | + require.True(t, mgr.GetCache().WaitForCacheSync(syncCtx), "manager cache did not synchronize") |
| 95 | + |
| 96 | + for _, name := range []string{"inline", "secret-ref"} { |
| 97 | + t.Run(name, func(t *testing.T) { |
| 98 | + ns := &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{GenerateName: "standalone-"}} |
| 99 | + require.NoError(t, cl.Create(ctx, ns)) |
| 100 | + manifest := unstructured.Unstructured{Object: map[string]any{ |
| 101 | + "apiVersion": "v1", "kind": "ConfigMap", |
| 102 | + "metadata": map[string]any{"name": name, "namespace": ns.Name}, |
| 103 | + "data": map[string]any{"hello": "world"}, |
| 104 | + }} |
| 105 | + obj := ocv1.ClusterObjectSetObject{Object: manifest} |
| 106 | + if name == "secret-ref" { |
| 107 | + data, err := json.Marshal(manifest.Object) |
| 108 | + require.NoError(t, err) |
| 109 | + secret := &corev1.Secret{ |
| 110 | + ObjectMeta: metav1.ObjectMeta{Name: "content", Namespace: ns.Name}, |
| 111 | + Immutable: ptr.To(true), Data: map[string][]byte{"object": data}, |
| 112 | + } |
| 113 | + require.NoError(t, cl.Create(ctx, secret)) |
| 114 | + obj = ocv1.ClusterObjectSetObject{Ref: ocv1.ObjectSourceRef{Name: secret.Name, Namespace: secret.Namespace, Key: "object"}} |
| 115 | + } |
| 116 | + cos := &ocv1.ClusterObjectSet{ |
| 117 | + ObjectMeta: metav1.ObjectMeta{Name: name}, |
| 118 | + Spec: ocv1.ClusterObjectSetSpec{ |
| 119 | + LifecycleState: ocv1.ClusterObjectSetLifecycleStateActive, Revision: 1, |
| 120 | + CollisionProtection: ocv1.CollisionProtectionPrevent, |
| 121 | + Phases: []ocv1.ClusterObjectSetPhase{{Name: "deploy", Objects: []ocv1.ClusterObjectSetObject{obj}}}, |
| 122 | + }, |
| 123 | + } |
| 124 | + require.NoError(t, cl.Create(ctx, cos)) |
| 125 | + require.EventuallyWithT(t, func(collect *assert.CollectT) { |
| 126 | + if !assert.NoError(collect, cl.Get(ctx, client.ObjectKeyFromObject(cos), cos)) { |
| 127 | + return |
| 128 | + } |
| 129 | + assert.True(collect, meta.IsStatusConditionTrue(cos.Status.Conditions, ocv1.ClusterObjectSetTypeSucceeded), "%v", cos.Status.Conditions) |
| 130 | + progressing := meta.FindStatusCondition(cos.Status.Conditions, ocv1.ClusterObjectSetTypeProgressing) |
| 131 | + if assert.NotNil(collect, progressing) { |
| 132 | + assert.Equal(collect, "Revision 1 has rolled out.", progressing.Message) |
| 133 | + } |
| 134 | + }, time.Minute, 100*time.Millisecond) |
| 135 | + cm := &corev1.ConfigMap{} |
| 136 | + require.NoError(t, cl.Get(ctx, client.ObjectKey{Name: name, Namespace: ns.Name}, cm)) |
| 137 | + require.Equal(t, "world", cm.Data["hello"]) |
| 138 | + require.NotNil(t, metav1.GetControllerOf(cm)) |
| 139 | + require.Equal(t, cos.UID, metav1.GetControllerOf(cm).UID) |
| 140 | + |
| 141 | + // Observe managed-object changes without updating the ClusterObjectSet. |
| 142 | + originalUID := cm.UID |
| 143 | + require.NoError(t, cl.Delete(ctx, cm)) |
| 144 | + require.EventuallyWithT(t, func(collect *assert.CollectT) { |
| 145 | + if !assert.NoError(collect, cl.Get(ctx, client.ObjectKeyFromObject(cm), cm)) { |
| 146 | + return |
| 147 | + } |
| 148 | + assert.NotEqual(collect, originalUID, cm.UID) |
| 149 | + assert.Equal(collect, "world", cm.Data["hello"]) |
| 150 | + if assert.NotNil(collect, metav1.GetControllerOf(cm)) { |
| 151 | + assert.Equal(collect, cos.UID, metav1.GetControllerOf(cm).UID) |
| 152 | + } |
| 153 | + }, time.Minute, 100*time.Millisecond) |
| 154 | + |
| 155 | + // The controller releases its finalizer independently of ClusterExtension. |
| 156 | + // The owner reference above lets Kubernetes garbage-collect the ConfigMap; |
| 157 | + // envtest does not run that garbage collector. |
| 158 | + require.NoError(t, cl.Delete(ctx, cos)) |
| 159 | + require.Eventually(t, func() bool { |
| 160 | + return apierrors.IsNotFound(cl.Get(ctx, client.ObjectKeyFromObject(cos), cos)) |
| 161 | + }, time.Minute, 100*time.Millisecond) |
| 162 | + }) |
| 163 | + } |
| 164 | +} |
0 commit comments