|
| 1 | +/* |
| 2 | +Copyright 2024 The Kubernetes 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 cilium |
| 18 | + |
| 19 | +import ( |
| 20 | + "testing" |
| 21 | + |
| 22 | + "github.com/google/go-cmp/cmp" |
| 23 | + "github.com/kubernetes-sigs/ingress2gateway/pkg/i2gw/intermediate" |
| 24 | + "github.com/kubernetes-sigs/ingress2gateway/pkg/i2gw/providers/common" |
| 25 | + "k8s.io/apimachinery/pkg/types" |
| 26 | + "k8s.io/apimachinery/pkg/util/validation/field" |
| 27 | + "k8s.io/utils/ptr" |
| 28 | + |
| 29 | + networkingv1 "k8s.io/api/networking/v1" |
| 30 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 31 | + gatewayv1 "sigs.k8s.io/gateway-api/apis/v1" |
| 32 | +) |
| 33 | + |
| 34 | +func Test_forceHTTPSFeature(t *testing.T) { |
| 35 | + testCases := []struct { |
| 36 | + name string |
| 37 | + ingress networkingv1.Ingress |
| 38 | + initialHTTPRoute *gatewayv1.HTTPRoute |
| 39 | + expectedHTTPRoute *gatewayv1.HTTPRoute |
| 40 | + expectedError field.ErrorList |
| 41 | + }{ |
| 42 | + { |
| 43 | + name: "force-https annontation present and set to enabled", |
| 44 | + ingress: networkingv1.Ingress{ |
| 45 | + ObjectMeta: metav1.ObjectMeta{ |
| 46 | + Name: "test-ingress", |
| 47 | + Namespace: "default", |
| 48 | + Annotations: map[string]string{ |
| 49 | + "ingress.cilium.io/force-https": "enabled", |
| 50 | + }, |
| 51 | + }, |
| 52 | + Spec: networkingv1.IngressSpec{ |
| 53 | + Rules: []networkingv1.IngressRule{ |
| 54 | + { |
| 55 | + Host: "foo.com", |
| 56 | + }, |
| 57 | + }, |
| 58 | + }, |
| 59 | + }, |
| 60 | + initialHTTPRoute: &gatewayv1.HTTPRoute{ |
| 61 | + ObjectMeta: metav1.ObjectMeta{ |
| 62 | + Name: "test-ingress-foo-com", |
| 63 | + Namespace: "default", |
| 64 | + }, |
| 65 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 66 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 67 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 68 | + { |
| 69 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 70 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 71 | + }, |
| 72 | + }, |
| 73 | + }, |
| 74 | + }, |
| 75 | + }, |
| 76 | + expectedHTTPRoute: &gatewayv1.HTTPRoute{ |
| 77 | + ObjectMeta: metav1.ObjectMeta{ |
| 78 | + Name: "test-ingress-foo-com", |
| 79 | + Namespace: "default", |
| 80 | + }, |
| 81 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 82 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 83 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 84 | + { |
| 85 | + Filters: []gatewayv1.HTTPRouteFilter{ |
| 86 | + { |
| 87 | + Type: gatewayv1.HTTPRouteFilterRequestRedirect, |
| 88 | + RequestRedirect: &gatewayv1.HTTPRequestRedirectFilter{ |
| 89 | + Scheme: ptr.To("https"), |
| 90 | + StatusCode: ptr.To(int(301)), |
| 91 | + }, |
| 92 | + }, |
| 93 | + }, |
| 94 | + }, |
| 95 | + }, |
| 96 | + }, |
| 97 | + }, |
| 98 | + expectedError: field.ErrorList{}, |
| 99 | + }, |
| 100 | + { |
| 101 | + name: "force-https annontation present and set to disabled", |
| 102 | + ingress: networkingv1.Ingress{ |
| 103 | + ObjectMeta: metav1.ObjectMeta{ |
| 104 | + Name: "test-ingress", |
| 105 | + Namespace: "default", |
| 106 | + Annotations: map[string]string{ |
| 107 | + "ingress.cilium.io/force-https": "disabled", |
| 108 | + }, |
| 109 | + }, |
| 110 | + Spec: networkingv1.IngressSpec{ |
| 111 | + Rules: []networkingv1.IngressRule{ |
| 112 | + { |
| 113 | + Host: "foo.com", |
| 114 | + }, |
| 115 | + }, |
| 116 | + }, |
| 117 | + }, |
| 118 | + initialHTTPRoute: &gatewayv1.HTTPRoute{ |
| 119 | + ObjectMeta: metav1.ObjectMeta{ |
| 120 | + Name: "test-ingress-foo-com", |
| 121 | + Namespace: "default", |
| 122 | + }, |
| 123 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 124 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 125 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 126 | + { |
| 127 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 128 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 129 | + }, |
| 130 | + }, |
| 131 | + }, |
| 132 | + }, |
| 133 | + }, |
| 134 | + expectedHTTPRoute: &gatewayv1.HTTPRoute{ |
| 135 | + ObjectMeta: metav1.ObjectMeta{ |
| 136 | + Name: "test-ingress-foo-com", |
| 137 | + Namespace: "default", |
| 138 | + }, |
| 139 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 140 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 141 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 142 | + { |
| 143 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 144 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 145 | + }, |
| 146 | + }, |
| 147 | + }, |
| 148 | + }, |
| 149 | + }, |
| 150 | + }, |
| 151 | + { |
| 152 | + name: "force-https annontation present and set to true", |
| 153 | + ingress: networkingv1.Ingress{ |
| 154 | + ObjectMeta: metav1.ObjectMeta{ |
| 155 | + Name: "test-ingress", |
| 156 | + Namespace: "default", |
| 157 | + Annotations: map[string]string{ |
| 158 | + "ingress.cilium.io/force-https": "true", |
| 159 | + }, |
| 160 | + }, |
| 161 | + Spec: networkingv1.IngressSpec{ |
| 162 | + Rules: []networkingv1.IngressRule{ |
| 163 | + { |
| 164 | + Host: "foo.com", |
| 165 | + }, |
| 166 | + }, |
| 167 | + }, |
| 168 | + }, |
| 169 | + initialHTTPRoute: &gatewayv1.HTTPRoute{ |
| 170 | + ObjectMeta: metav1.ObjectMeta{ |
| 171 | + Name: "test-ingress-foo-com", |
| 172 | + Namespace: "default", |
| 173 | + }, |
| 174 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 175 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 176 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 177 | + { |
| 178 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 179 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 180 | + }, |
| 181 | + }, |
| 182 | + }, |
| 183 | + }, |
| 184 | + }, |
| 185 | + expectedHTTPRoute: &gatewayv1.HTTPRoute{ |
| 186 | + ObjectMeta: metav1.ObjectMeta{ |
| 187 | + Name: "test-ingress-foo-com", |
| 188 | + Namespace: "default", |
| 189 | + }, |
| 190 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 191 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 192 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 193 | + { |
| 194 | + Filters: []gatewayv1.HTTPRouteFilter{ |
| 195 | + { |
| 196 | + Type: gatewayv1.HTTPRouteFilterRequestRedirect, |
| 197 | + RequestRedirect: &gatewayv1.HTTPRequestRedirectFilter{ |
| 198 | + Scheme: ptr.To("https"), |
| 199 | + StatusCode: ptr.To(int(301)), |
| 200 | + }, |
| 201 | + }, |
| 202 | + }, |
| 203 | + }, |
| 204 | + }, |
| 205 | + }, |
| 206 | + }, |
| 207 | + expectedError: field.ErrorList{}, |
| 208 | + }, |
| 209 | + { |
| 210 | + name: "force-https annontation present and set to false", |
| 211 | + ingress: networkingv1.Ingress{ |
| 212 | + ObjectMeta: metav1.ObjectMeta{ |
| 213 | + Name: "test-ingress", |
| 214 | + Namespace: "default", |
| 215 | + Annotations: map[string]string{ |
| 216 | + "ingress.cilium.io/force-https": "false", |
| 217 | + }, |
| 218 | + }, |
| 219 | + Spec: networkingv1.IngressSpec{ |
| 220 | + Rules: []networkingv1.IngressRule{ |
| 221 | + { |
| 222 | + Host: "foo.com", |
| 223 | + }, |
| 224 | + }, |
| 225 | + }, |
| 226 | + }, |
| 227 | + initialHTTPRoute: &gatewayv1.HTTPRoute{ |
| 228 | + ObjectMeta: metav1.ObjectMeta{ |
| 229 | + Name: "test-ingress-foo-com", |
| 230 | + Namespace: "default", |
| 231 | + }, |
| 232 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 233 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 234 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 235 | + { |
| 236 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 237 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 238 | + }, |
| 239 | + }, |
| 240 | + }, |
| 241 | + }, |
| 242 | + }, |
| 243 | + expectedHTTPRoute: &gatewayv1.HTTPRoute{ |
| 244 | + ObjectMeta: metav1.ObjectMeta{ |
| 245 | + Name: "test-ingress-foo-com", |
| 246 | + Namespace: "default", |
| 247 | + }, |
| 248 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 249 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 250 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 251 | + { |
| 252 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 253 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 254 | + }, |
| 255 | + }, |
| 256 | + }, |
| 257 | + }, |
| 258 | + }, |
| 259 | + expectedError: field.ErrorList{}, |
| 260 | + }, |
| 261 | + { |
| 262 | + name: "force-https annotation not present", |
| 263 | + ingress: networkingv1.Ingress{ |
| 264 | + ObjectMeta: metav1.ObjectMeta{ |
| 265 | + Name: "test-ingress", |
| 266 | + Namespace: "default", |
| 267 | + }, |
| 268 | + Spec: networkingv1.IngressSpec{ |
| 269 | + Rules: []networkingv1.IngressRule{ |
| 270 | + { |
| 271 | + Host: "foo.com", |
| 272 | + }, |
| 273 | + }, |
| 274 | + }, |
| 275 | + }, |
| 276 | + initialHTTPRoute: &gatewayv1.HTTPRoute{ |
| 277 | + ObjectMeta: metav1.ObjectMeta{ |
| 278 | + Name: "test-ingress-foo-com", |
| 279 | + Namespace: "default", |
| 280 | + }, |
| 281 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 282 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 283 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 284 | + { |
| 285 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 286 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 287 | + }, |
| 288 | + }, |
| 289 | + }, |
| 290 | + }, |
| 291 | + }, |
| 292 | + expectedHTTPRoute: &gatewayv1.HTTPRoute{ |
| 293 | + ObjectMeta: metav1.ObjectMeta{ |
| 294 | + Name: "test-ingress-foo-com", |
| 295 | + Namespace: "default", |
| 296 | + }, |
| 297 | + Spec: gatewayv1.HTTPRouteSpec{ |
| 298 | + Hostnames: []gatewayv1.Hostname{"foo.com"}, |
| 299 | + Rules: []gatewayv1.HTTPRouteRule{ |
| 300 | + { |
| 301 | + BackendRefs: []gatewayv1.HTTPBackendRef{ |
| 302 | + {BackendRef: gatewayv1.BackendRef{BackendObjectReference: gatewayv1.BackendObjectReference{Name: "foo", Port: ptr.To(gatewayv1.PortNumber(3000))}}}, |
| 303 | + }, |
| 304 | + }, |
| 305 | + }, |
| 306 | + }, |
| 307 | + }, |
| 308 | + expectedError: field.ErrorList{}, |
| 309 | + }, |
| 310 | + } |
| 311 | + |
| 312 | + for _, tc := range testCases { |
| 313 | + t.Run(tc.name, func(t *testing.T) { |
| 314 | + ingresses := []networkingv1.Ingress{tc.ingress} |
| 315 | + ir := &intermediate.IR{ |
| 316 | + HTTPRoutes: map[types.NamespacedName]intermediate.HTTPRouteContext{ |
| 317 | + {Name: tc.expectedHTTPRoute.Name, Namespace: tc.expectedHTTPRoute.Namespace}: { |
| 318 | + HTTPRoute: *tc.initialHTTPRoute, |
| 319 | + }, |
| 320 | + }, |
| 321 | + } |
| 322 | + |
| 323 | + errs := forceHTTPSFeature(ingresses, ir) |
| 324 | + |
| 325 | + if len(errs) != len(tc.expectedError) { |
| 326 | + t.Errorf("expected %d errors, got %d", len(tc.expectedError), len(errs)) |
| 327 | + } |
| 328 | + |
| 329 | + key := types.NamespacedName{Namespace: tc.ingress.Namespace, Name: common.RouteName(tc.ingress.Name, tc.ingress.Spec.Rules[0].Host)} |
| 330 | + |
| 331 | + actualHTTPRouteContext, ok := ir.HTTPRoutes[key] |
| 332 | + if !ok { |
| 333 | + t.Errorf("HTTPRoute not found: %v", key) |
| 334 | + } |
| 335 | + |
| 336 | + if diff := cmp.Diff(*tc.expectedHTTPRoute, actualHTTPRouteContext.HTTPRoute); diff != "" { |
| 337 | + t.Errorf("Unexpected HTTPRoute resource found, \n want: %+v\n got: %+v\n diff (-want +got):\n%s", *tc.expectedHTTPRoute, actualHTTPRouteContext.HTTPRoute, diff) |
| 338 | + } |
| 339 | + }) |
| 340 | + } |
| 341 | +} |
0 commit comments