|
| 1 | +/* |
| 2 | +Copyright 2026 The Tekton Authors |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package openshiftpipelinesascode |
| 18 | + |
| 19 | +import ( |
| 20 | + "testing" |
| 21 | + |
| 22 | + mf "github.com/manifestival/manifestival" |
| 23 | + "github.com/tektoncd/operator/pkg/apis/operator/v1alpha1" |
| 24 | + occommon "github.com/tektoncd/operator/pkg/reconciler/openshift/common" |
| 25 | + appsv1 "k8s.io/api/apps/v1" |
| 26 | + corev1 "k8s.io/api/core/v1" |
| 27 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 28 | + "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" |
| 29 | + "k8s.io/apimachinery/pkg/runtime" |
| 30 | +) |
| 31 | + |
| 32 | +// makePACDeployment returns an unstructured PAC Deployment for transformer tests. |
| 33 | +func makePACDeployment(t *testing.T, deploymentName, containerName string) unstructured.Unstructured { |
| 34 | + t.Helper() |
| 35 | + |
| 36 | + d := &appsv1.Deployment{ |
| 37 | + ObjectMeta: metav1.ObjectMeta{ |
| 38 | + Name: deploymentName, |
| 39 | + Namespace: "openshift-pipelines", |
| 40 | + }, |
| 41 | + Spec: appsv1.DeploymentSpec{ |
| 42 | + Template: corev1.PodTemplateSpec{ |
| 43 | + Spec: corev1.PodSpec{ |
| 44 | + Containers: []corev1.Container{ |
| 45 | + {Name: containerName}, |
| 46 | + }, |
| 47 | + }, |
| 48 | + }, |
| 49 | + }, |
| 50 | + } |
| 51 | + obj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(d) |
| 52 | + if err != nil { |
| 53 | + t.Fatalf("failed to convert deployment to unstructured: %v", err) |
| 54 | + } |
| 55 | + u := unstructured.Unstructured{Object: obj} |
| 56 | + u.SetKind("Deployment") |
| 57 | + u.SetAPIVersion("apps/v1") |
| 58 | + return u |
| 59 | +} |
| 60 | + |
| 61 | +func makePACWebhookDeployment(t *testing.T) unstructured.Unstructured { |
| 62 | + t.Helper() |
| 63 | + return makePACDeployment(t, pacWebhookDeployment, pacWebhookContainerName) |
| 64 | +} |
| 65 | + |
| 66 | +func TestPACTransformers_NoTLSConfig(t *testing.T) { |
| 67 | + ext := &openshiftExtension{ |
| 68 | + resolvedTLSConfig: nil, |
| 69 | + } |
| 70 | + |
| 71 | + transformers := ext.Transformers(&v1alpha1.OpenShiftPipelinesAsCode{}) |
| 72 | + |
| 73 | + u := makePACWebhookDeployment(t) |
| 74 | + manifest, err := mf.ManifestFrom(mf.Slice([]unstructured.Unstructured{u})) |
| 75 | + if err != nil { |
| 76 | + t.Fatalf("failed to build manifest: %v", err) |
| 77 | + } |
| 78 | + |
| 79 | + transformed, err := manifest.Transform(transformers...) |
| 80 | + if err != nil { |
| 81 | + t.Fatalf("transform failed: %v", err) |
| 82 | + } |
| 83 | + |
| 84 | + d := &appsv1.Deployment{} |
| 85 | + if err := runtime.DefaultUnstructuredConverter.FromUnstructured(transformed.Resources()[0].Object, d); err != nil { |
| 86 | + t.Fatalf("failed to convert back: %v", err) |
| 87 | + } |
| 88 | + for _, c := range d.Spec.Template.Spec.Containers { |
| 89 | + if c.Name != pacWebhookContainerName { |
| 90 | + continue |
| 91 | + } |
| 92 | + for _, e := range c.Env { |
| 93 | + if e.Name == occommon.WebhookEnvVarPrefix+occommon.TLSMinVersionEnvVar || |
| 94 | + e.Name == occommon.WebhookEnvVarPrefix+occommon.TLSCipherSuitesEnvVar { |
| 95 | + t.Errorf("unexpected TLS env var %s set when resolvedTLSConfig is nil", e.Name) |
| 96 | + } |
| 97 | + } |
| 98 | + } |
| 99 | +} |
| 100 | + |
| 101 | +func TestPACTransformers_WithTLSConfig_InjectsEnvVarsIntoWebhook(t *testing.T) { |
| 102 | + tlsConfig := &occommon.TLSEnvVars{ |
| 103 | + MinVersion: "1.2", |
| 104 | + CipherSuites: "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_AES_128_GCM_SHA256", |
| 105 | + } |
| 106 | + // pac-webhook uses the Knative webhook framework → reads WEBHOOK_TLS_* env vars. |
| 107 | + assertTLSInjected(t, &openshiftExtension{resolvedTLSConfig: tlsConfig}, pacWebhookDeployment, pacWebhookContainerName, occommon.WebhookEnvVarPrefix, tlsConfig) |
| 108 | +} |
| 109 | + |
| 110 | +// assertTLSInjected runs the Transformers against a single-resource manifest and |
| 111 | +// checks that TLS env vars are present in the named container. |
| 112 | +// envVarPrefix is prepended to the standard env var names (e.g. occommon.WebhookEnvVarPrefix |
| 113 | +// for deployments using the Knative webhook framework, "" for everything else). |
| 114 | +func assertTLSInjected(t *testing.T, ext *openshiftExtension, deploymentName, containerName, envVarPrefix string, tlsConfig *occommon.TLSEnvVars) { |
| 115 | + t.Helper() |
| 116 | + |
| 117 | + u := makePACDeployment(t, deploymentName, containerName) |
| 118 | + manifest, err := mf.ManifestFrom(mf.Slice([]unstructured.Unstructured{u})) |
| 119 | + if err != nil { |
| 120 | + t.Fatalf("failed to build manifest: %v", err) |
| 121 | + } |
| 122 | + |
| 123 | + transformed, err := manifest.Transform(ext.Transformers(&v1alpha1.OpenShiftPipelinesAsCode{})...) |
| 124 | + if err != nil { |
| 125 | + t.Fatalf("transform failed: %v", err) |
| 126 | + } |
| 127 | + |
| 128 | + d := &appsv1.Deployment{} |
| 129 | + if err := runtime.DefaultUnstructuredConverter.FromUnstructured(transformed.Resources()[0].Object, d); err != nil { |
| 130 | + t.Fatalf("failed to convert back: %v", err) |
| 131 | + } |
| 132 | + |
| 133 | + envMap := map[string]string{} |
| 134 | + for _, c := range d.Spec.Template.Spec.Containers { |
| 135 | + if c.Name != containerName { |
| 136 | + continue |
| 137 | + } |
| 138 | + for _, e := range c.Env { |
| 139 | + envMap[e.Name] = e.Value |
| 140 | + } |
| 141 | + } |
| 142 | + |
| 143 | + minVersionKey := envVarPrefix + occommon.TLSMinVersionEnvVar |
| 144 | + cipherSuitesKey := envVarPrefix + occommon.TLSCipherSuitesEnvVar |
| 145 | + |
| 146 | + if got := envMap[minVersionKey]; got != tlsConfig.MinVersion { |
| 147 | + t.Errorf("[%s/%s] %s = %q, want %q", deploymentName, containerName, minVersionKey, got, tlsConfig.MinVersion) |
| 148 | + } |
| 149 | + if got := envMap[cipherSuitesKey]; got != tlsConfig.CipherSuites { |
| 150 | + t.Errorf("[%s/%s] %s = %q, want %q", deploymentName, containerName, cipherSuitesKey, got, tlsConfig.CipherSuites) |
| 151 | + } |
| 152 | +} |
| 153 | + |
| 154 | +func TestPACTransformers_WithTLSConfig_InjectsEnvVarsIntoController(t *testing.T) { |
| 155 | + tlsConfig := &occommon.TLSEnvVars{ |
| 156 | + MinVersion: "1.2", |
| 157 | + CipherSuites: "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_AES_128_GCM_SHA256", |
| 158 | + } |
| 159 | + // pac-controller uses the Knative eventing adapter — no TLS version env var support; no prefix. |
| 160 | + assertTLSInjected(t, &openshiftExtension{resolvedTLSConfig: tlsConfig}, pacControllerDeployment, pacControllerContainerName, "", tlsConfig) |
| 161 | +} |
| 162 | + |
| 163 | +func TestPACTransformers_WithTLSConfig_DoesNotInjectIntoUnknownDeployment(t *testing.T) { |
| 164 | + tlsConfig := &occommon.TLSEnvVars{ |
| 165 | + MinVersion: "1.3", |
| 166 | + CipherSuites: "TLS_AES_128_GCM_SHA256", |
| 167 | + } |
| 168 | + ext := &openshiftExtension{resolvedTLSConfig: tlsConfig} |
| 169 | + transformers := ext.Transformers(&v1alpha1.OpenShiftPipelinesAsCode{}) |
| 170 | + |
| 171 | + // An unrelated deployment must not receive TLS env vars. |
| 172 | + u := makePACDeployment(t, "some-other-deployment", "some-container") |
| 173 | + manifest, err := mf.ManifestFrom(mf.Slice([]unstructured.Unstructured{u})) |
| 174 | + if err != nil { |
| 175 | + t.Fatalf("failed to build manifest: %v", err) |
| 176 | + } |
| 177 | + transformed, err := manifest.Transform(transformers...) |
| 178 | + if err != nil { |
| 179 | + t.Fatalf("transform failed: %v", err) |
| 180 | + } |
| 181 | + |
| 182 | + result := &appsv1.Deployment{} |
| 183 | + if err := runtime.DefaultUnstructuredConverter.FromUnstructured(transformed.Resources()[0].Object, result); err != nil { |
| 184 | + t.Fatalf("failed to convert back: %v", err) |
| 185 | + } |
| 186 | + for _, c := range result.Spec.Template.Spec.Containers { |
| 187 | + for _, e := range c.Env { |
| 188 | + if e.Name == occommon.TLSMinVersionEnvVar || e.Name == occommon.TLSCipherSuitesEnvVar || |
| 189 | + e.Name == occommon.WebhookEnvVarPrefix+occommon.TLSMinVersionEnvVar || |
| 190 | + e.Name == occommon.WebhookEnvVarPrefix+occommon.TLSCipherSuitesEnvVar { |
| 191 | + t.Errorf("unexpected TLS env var %s injected into unrelated deployment", e.Name) |
| 192 | + } |
| 193 | + } |
| 194 | + } |
| 195 | +} |
0 commit comments