-
Notifications
You must be signed in to change notification settings - Fork 69
fix: fall back to canonical backup auth secret name on restore #1614
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
base: main
Are you sure you want to change the base?
Changes from all commits
c9f7339
39879ba
7bd062d
1073608
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| // | ||
| // Copyright (c) 2019-2026 Red Hat, Inc. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| package secrets_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
|
|
||
| dwv2 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" | ||
| controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| k8sErrors "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/fake" | ||
| "sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
|
|
||
| "github.com/devfile/devworkspace-operator/pkg/constants" | ||
| "github.com/devfile/devworkspace-operator/pkg/secrets" | ||
| ) | ||
|
|
||
| func TestSecrets(t *testing.T) { | ||
| RegisterFailHandler(Fail) | ||
| RunSpecs(t, "Secrets Suite") | ||
| } | ||
|
|
||
| // buildScheme returns a minimal runtime.Scheme for tests: core v1 and the DWO API types. | ||
| func buildScheme() *runtime.Scheme { | ||
| scheme := runtime.NewScheme() | ||
| Expect(corev1.AddToScheme(scheme)).To(Succeed()) | ||
| Expect(dwv2.AddToScheme(scheme)).To(Succeed()) | ||
| Expect(controllerv1alpha1.AddToScheme(scheme)).To(Succeed()) | ||
| return scheme | ||
| } | ||
|
|
||
| // makeWorkspace returns a minimal DevWorkspace in the given namespace. | ||
| func makeWorkspace(namespace string) *dwv2.DevWorkspace { | ||
| return &dwv2.DevWorkspace{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-workspace", | ||
| Namespace: namespace, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // makeConfig returns an OperatorConfiguration with BackupCronJob configured to use the given auth secret name. | ||
| func makeConfig(authSecretName string) *controllerv1alpha1.OperatorConfiguration { | ||
| return &controllerv1alpha1.OperatorConfiguration{ | ||
| Workspace: &controllerv1alpha1.WorkspaceConfig{ | ||
| BackupCronJob: &controllerv1alpha1.BackupCronJobConfig{ | ||
| Registry: &controllerv1alpha1.RegistryConfig{ | ||
| Path: "example.registry.io/org", | ||
| AuthSecret: authSecretName, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // makeSecret returns a corev1.Secret with the given name and namespace. | ||
| func makeSecret(name, namespace string) *corev1.Secret { | ||
| return &corev1.Secret{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: name, | ||
| Namespace: namespace, | ||
| }, | ||
| Data: map[string][]byte{"auth": []byte("dXNlcjpwYXNz")}, | ||
| Type: corev1.SecretTypeDockerConfigJson, | ||
| } | ||
|
Comment on lines
+79
to
+87
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Verify dockerconfigjson fixtures and key usage across Go tests.
# Expected: SecretTypeDockerConfigJson fixtures should use the ".dockerconfigjson" key.
rg -nP --type=go -C3 'SecretTypeDockerConfigJson|map\[string\]\[\]byte\{'Repository: devfile/devworkspace-operator Length of output: 6697 Change the secret fixture to use For 🤖 Prompt for AI Agents |
||
| } | ||
|
|
||
| var _ = Describe("HandleRegistryAuthSecret (restore path: operatorConfigNamespace='')", func() { | ||
| const workspaceNS = "user-namespace" | ||
|
|
||
| var ( | ||
| ctx context.Context | ||
| scheme *runtime.Scheme | ||
| log = zap.New(zap.UseDevMode(true)).WithName("SecretsTest") | ||
| ) | ||
|
|
||
| BeforeEach(func() { | ||
| ctx = context.Background() | ||
| scheme = buildScheme() | ||
| }) | ||
|
|
||
| It("returns the predefined secret when it exists in the workspace namespace", func() { | ||
| By("creating the predefined DevWorkspaceBackupAuthSecretName secret in the workspace namespace") | ||
| predefinedSecret := makeSecret(constants.DevWorkspaceBackupAuthSecretName, workspaceNS) | ||
|
|
||
| fakeClient := fake.NewClientBuilder().WithScheme(scheme).WithObjects(predefinedSecret).Build() | ||
| workspace := makeWorkspace(workspaceNS) | ||
| config := makeConfig("quay-backup-auth") | ||
|
|
||
| result, err := secrets.HandleRegistryAuthSecret(ctx, fakeClient, workspace, config, "", scheme, log) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(result).NotTo(BeNil()) | ||
| Expect(result.Name).To(Equal(constants.DevWorkspaceBackupAuthSecretName)) | ||
| }) | ||
|
|
||
| It("returns nil when the predefined secret does not exist in the workspace namespace", func() { | ||
| By("using a fake client with no secrets") | ||
| fakeClient := fake.NewClientBuilder().WithScheme(scheme).Build() | ||
| workspace := makeWorkspace(workspaceNS) | ||
| config := makeConfig("quay-backup-auth") | ||
|
|
||
| result, err := secrets.HandleRegistryAuthSecret(ctx, fakeClient, workspace, config, "", scheme, log) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(result).To(BeNil()) | ||
| }) | ||
|
|
||
| It("propagates a non-NotFound error from the workspace namespace lookup", func() { | ||
| By("wrapping a fake client so that the predefined name lookup returns a server error") | ||
| errClient := &errorOnNameClient{ | ||
| Client: fake.NewClientBuilder().WithScheme(scheme).Build(), | ||
| failName: constants.DevWorkspaceBackupAuthSecretName, | ||
| failErr: k8sErrors.NewInternalError(errors.New("simulated etcd timeout")), | ||
| } | ||
| workspace := makeWorkspace(workspaceNS) | ||
| config := makeConfig("quay-backup-auth") | ||
|
|
||
| result, err := secrets.HandleRegistryAuthSecret(ctx, errClient, workspace, config, "", scheme, log) | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(result).To(BeNil()) | ||
| Expect(err.Error()).To(ContainSubstring("simulated etcd timeout")) | ||
| }) | ||
|
Comment on lines
+104
to
+143
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add restore-path coverage for configured-name-first behavior. These cases only validate predefined-name lookup. To match the fallback requirement, add cases where:
🤖 Prompt for AI Agents |
||
| }) | ||
|
|
||
| // errorOnNameClient is a thin client wrapper that injects an error for a specific secret name. | ||
| type errorOnNameClient struct { | ||
| client.Client | ||
| failName string | ||
| failErr error | ||
| } | ||
|
|
||
| func (e *errorOnNameClient) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error { | ||
| if secret, ok := obj.(*corev1.Secret); ok { | ||
| _ = secret | ||
| if key.Name == e.failName { | ||
| return e.failErr | ||
| } | ||
| } | ||
| return e.Client.Get(ctx, key, obj, opts...) | ||
| } | ||
|
|
||
| // Ensure errorOnNameClient satisfies client.Client at compile time. | ||
| var _ client.Client = &errorOnNameClient{} | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move all project-local imports into the third import block.
github.com/devfile/devworkspace-operator/apis/controller/v1alpha1is project-local but is currently grouped with third-party/Kubernetes imports.As per coding guidelines "Organize imports into three groups separated by blank lines: (1) standard library, (2) third-party + Kubernetes, (3) project-local."
🤖 Prompt for AI Agents