Support Function references in FunctionUrlConfig resource (#54)

Vandita2020 · web-flow · commit 753891a309d9 · 2022-09-20T19:11:09.000-07:00
Issue #, if available:

Description of changes:
Adding functionality to the lambda controller to be able to reference a Function from a FunctionUrlConfig resource using resource references.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
diff --git a/apis/v1alpha1/function_url_config.go b/apis/v1alpha1/function_url_config.go
diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml
@@ -96,4 +96,7 @@ resources:
       ignore: true
     fields:
       FunctionName:
+        references:
+          resource: Function
+          path: Spec.Name
         is_primary_key: true
diff --git a/config/crd/bases/lambda.services.k8s.aws_functionurlconfigs.yaml b/config/crd/bases/lambda.services.k8s.aws_functionurlconfigs.yaml
@@ -1,10 +1,9 @@
-
 ---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.9.2
   creationTimestamp: null
   name: functionurlconfigs.lambda.services.k8s.aws
 spec:
@@ -72,17 +71,29 @@ spec:
                 type: object
               functionName:
                 description: "The name of the Lambda function. \n Name formats \n
-                  \   * Function name - my-function. \n    * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
-                  \n    * Partial ARN - 123456789012:function:my-function. \n The
-                  length constraint applies only to the full ARN. If you specify only
-                  the function name, it is limited to 64 characters in length."
+                  * Function name - my-function. \n * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
+                  \n * Partial ARN - 123456789012:function:my-function. \n The length
+                  constraint applies only to the full ARN. If you specify only the
+                  function name, it is limited to 64 characters in length."
                 type: string
+              functionRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef: from: name: my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               qualifier:
                 description: The alias name.
                 type: string
             required:
             - authType
-            - functionName
             type: object
           status:
             description: FunctionURLConfigStatus defines the observed state of FunctionURLConfig
@@ -164,9 +175,3 @@ spec:
     storage: true
     subresources:
       status: {}
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []
diff --git a/generator.yaml b/generator.yaml
@@ -96,4 +96,7 @@ resources:
       ignore: true
     fields:
       FunctionName:
+        references:
+          resource: Function
+          path: Spec.Name
         is_primary_key: true
diff --git a/helm/crds/lambda.services.k8s.aws_functionurlconfigs.yaml b/helm/crds/lambda.services.k8s.aws_functionurlconfigs.yaml
@@ -1,10 +1,9 @@
-
 ---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.9.2
   creationTimestamp: null
   name: functionurlconfigs.lambda.services.k8s.aws
 spec:
@@ -72,17 +71,29 @@ spec:
                 type: object
               functionName:
                 description: "The name of the Lambda function. \n Name formats \n
-                  \   * Function name - my-function. \n    * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
-                  \n    * Partial ARN - 123456789012:function:my-function. \n The
-                  length constraint applies only to the full ARN. If you specify only
-                  the function name, it is limited to 64 characters in length."
+                  * Function name - my-function. \n * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
+                  \n * Partial ARN - 123456789012:function:my-function. \n The length
+                  constraint applies only to the full ARN. If you specify only the
+                  function name, it is limited to 64 characters in length."
                 type: string
+              functionRef:
+                description: 'AWSResourceReferenceWrapper provides a wrapper around
+                  *AWSResourceReference type to provide more user friendly syntax
+                  for references using ''from'' field Ex: APIIDRef: from: name: my-api'
+                properties:
+                  from:
+                    description: AWSResourceReference provides all the values necessary
+                      to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                    properties:
+                      name:
+                        type: string
+                    type: object
+                type: object
               qualifier:
                 description: The alias name.
                 type: string
             required:
             - authType
-            - functionName
             type: object
           status:
             description: FunctionURLConfigStatus defines the observed state of FunctionURLConfig
@@ -164,9 +175,3 @@ spec:
     storage: true
     subresources:
       status: {}
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []
diff --git a/pkg/resource/function_url_config/delta.go b/pkg/resource/function_url_config/delta.go
diff --git a/pkg/resource/function_url_config/references.go b/pkg/resource/function_url_config/references.go
diff --git a/test/e2e/resources/function_url_config_ref.yaml b/test/e2e/resources/function_url_config_ref.yaml
@@ -0,0 +1,12 @@
+apiVersion: lambda.services.k8s.aws/v1alpha1
+kind: FunctionURLConfig
+metadata:
+  name: $FUNCTION_URL_CONFIG_NAME
+  annotations:
+    services.k8s.aws/region: $AWS_REGION
+spec:
+  name: $FUNCTION_URL_CONFIG_NAME
+  functionRef:
+    from:
+      name: $FUNCTION_REF_NAME
+  authType: $AUTH_TYPE
diff --git a/test/e2e/tests/test_function_url_config.py b/test/e2e/tests/test_function_url_config.py
@@ -153,4 +153,72 @@ def test_smoke(self, lambda_client, lambda_function):
         time.sleep(DELETE_WAIT_AFTER_SECONDS)
 
         # Check FunctionURLConfig doesn't exist
-        assert not lambda_validator.function_url_config_exists(lambda_function_name)
+        assert not lambda_validator.function_url_config_exists(lambda_function_name)
+    
+    def test_smoke_ref(self, lambda_client, lambda_function):
+        (_, function_resource) = lambda_function
+        function_resource_name = function_resource["metadata"]["name"]
+
+        resource_name = random_suffix_name("functionurlconfig", 24)
+
+        replacements = REPLACEMENT_VALUES.copy()
+        replacements["AWS_REGION"] = get_region()
+        replacements["FUNCTION_URL_CONFIG_NAME"] = resource_name
+        replacements["FUNCTION_REF_NAME"] = function_resource_name
+        replacements["AUTH_TYPE"] = "NONE"
+
+        # Load FunctionURLConfig CR
+        resource_data = load_lambda_resource(
+            "function_url_config_ref",
+            additional_replacements=replacements,
+        )
+        logging.debug(resource_data)
+
+        # Create k8s resource
+        ref = k8s.CustomResourceReference(
+            CRD_GROUP, CRD_VERSION, RESOURCE_PLURAL,
+            resource_name, namespace="default",
+        )
+        k8s.create_custom_resource(ref, resource_data)
+        cr = k8s.wait_resource_consumed_by_controller(ref)
+
+        assert cr is not None
+        assert k8s.get_resource_exists(ref)
+
+        time.sleep(CREATE_WAIT_AFTER_SECONDS)
+
+        # Check FunctionURLConfig exists
+        lambda_validator = LambdaValidator(lambda_client)
+
+        # Check function url config exists
+        function_url_config = lambda_validator.get_function_url_config(function_resource_name)
+        assert function_url_config is not None
+        assert function_url_config["AuthType"] == "NONE"
+
+        cr = k8s.wait_resource_consumed_by_controller(ref)
+
+        # Update cr
+        cr["spec"]["cors"] = {
+            "maxAge": 10,
+            "allowOrigins": ["https://*"],
+        }
+
+        # Patch k8s resource
+        k8s.patch_custom_resource(ref, cr)
+        time.sleep(UPDATE_WAIT_AFTER_SECONDS)
+
+        # Check FunctionURLConfig MaxAge and AllowOrigins array
+        function_url_config = lambda_validator.get_function_url_config(function_resource_name)
+        assert function_url_config is not None
+        assert function_url_config["Cors"] is not None
+        assert function_url_config["Cors"]["MaxAge"] == 10
+        assert function_url_config["Cors"]["AllowOrigins"] == ["https://*"]
+
+        # Delete k8s resource
+        _, deleted = k8s.delete_custom_resource(ref)
+        assert deleted
+
+        time.sleep(DELETE_WAIT_AFTER_SECONDS)
+
+        # Check FunctionURLConfig doesn't exist
+        assert not lambda_validator.function_url_config_exists(function_resource_name)
