Support Function references in Alias resource (#53)

Vandita2020 · web-flow · commit abc7c87b0742 · 2022-09-16T11:04:05.000-07:00
Issue #, if available: 

Description of changes:
Adding functionality to the lambda controller to be able to reference a `Function` from an `Alias` 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/alias.go b/apis/v1alpha1/alias.go
diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml
@@ -62,6 +62,9 @@ resources:
         is_primary_key: true
       FunctionName:
         is_required: true
+        references:
+          resource: Function
+          path: Spec.Name 
       FunctionVersion:
         is_required: true
     tags:
diff --git a/config/crd/bases/lambda.services.k8s.aws_aliases.yaml b/config/crd/bases/lambda.services.k8s.aws_aliases.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: aliases.lambda.services.k8s.aws
 spec:
@@ -40,11 +39,24 @@ spec:
                 type: string
               functionName:
                 description: "The name of the Lambda function. \n Name formats \n
-                  \   * Function name - MyFunction. \n    * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
-                  \n    * Partial ARN - 123456789012:function:MyFunction. \n The length
+                  * Function name - MyFunction. \n * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
+                  \n * Partial ARN - 123456789012:function:MyFunction. \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
               functionVersion:
                 description: The function version that the alias invokes.
                 type: string
@@ -61,7 +73,6 @@ spec:
                     type: object
                 type: object
             required:
-            - functionName
             - functionVersion
             - name
             type: object
@@ -139,9 +150,3 @@ spec:
     storage: true
     subresources:
       status: {}
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []
diff --git a/generator.yaml b/generator.yaml
@@ -62,6 +62,9 @@ resources:
         is_primary_key: true
       FunctionName:
         is_required: true
+        references:
+          resource: Function
+          path: Spec.Name 
       FunctionVersion:
         is_required: true
     tags:
diff --git a/helm/crds/lambda.services.k8s.aws_aliases.yaml b/helm/crds/lambda.services.k8s.aws_aliases.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: aliases.lambda.services.k8s.aws
 spec:
@@ -40,11 +39,24 @@ spec:
                 type: string
               functionName:
                 description: "The name of the Lambda function. \n Name formats \n
-                  \   * Function name - MyFunction. \n    * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
-                  \n    * Partial ARN - 123456789012:function:MyFunction. \n The length
+                  * Function name - MyFunction. \n * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
+                  \n * Partial ARN - 123456789012:function:MyFunction. \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
               functionVersion:
                 description: The function version that the alias invokes.
                 type: string
@@ -61,7 +73,6 @@ spec:
                     type: object
                 type: object
             required:
-            - functionName
             - functionVersion
             - name
             type: object
@@ -139,9 +150,3 @@ spec:
     storage: true
     subresources:
       status: {}
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []
diff --git a/pkg/resource/alias/delta.go b/pkg/resource/alias/delta.go
diff --git a/pkg/resource/alias/references.go b/pkg/resource/alias/references.go
diff --git a/test/e2e/resources/alias-ref.yaml b/test/e2e/resources/alias-ref.yaml
@@ -0,0 +1,13 @@
+apiVersion: lambda.services.k8s.aws/v1alpha1
+kind: Alias
+metadata:
+  name: $ALIAS_NAME
+  annotations:
+    services.k8s.aws/region: $AWS_REGION
+spec:
+  name: $ALIAS_NAME
+  functionRef:
+    from:
+      name: $FUNCTION_REF_NAME
+  functionVersion: $FUNCTION_VERSION
+  description: alias created by ACK lambda-controller e2e tests
diff --git a/test/e2e/tests/test_alias.py b/test/e2e/tests/test_alias.py
@@ -136,3 +136,62 @@ def test_smoke(self, lambda_client, lambda_function):
 
         # Check alias doesn't exist
         assert not lambda_validator.alias_exists(resource_name, 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("lambda-alias", 24)
+
+        replacements = REPLACEMENT_VALUES.copy()
+        replacements["AWS_REGION"] = get_region()
+        replacements["ALIAS_NAME"] = resource_name
+        replacements["FUNCTION_REF_NAME"] = function_resource_name
+        replacements["FUNCTION_VERSION"] = "$LATEST"
+
+        # Load alias CR
+        resource_data = load_lambda_resource(
+            "alias-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)
+
+        lambda_validator = LambdaValidator(lambda_client)
+        # Check alias exists
+        assert lambda_validator.alias_exists(resource_name, function_resource_name)
+
+        cr = k8s.wait_resource_consumed_by_controller(ref)
+        
+        # Update cr
+        cr["spec"]["description"] = ""
+
+        # Patch k8s resource
+        k8s.patch_custom_resource(ref, cr)
+        time.sleep(UPDATE_WAIT_AFTER_SECONDS)
+
+        # Check alias description
+        alias = lambda_validator.get_alias(resource_name, function_resource_name)
+        assert alias is not None
+        assert alias["Description"] == ""
+
+        # Delete k8s resource
+        _, deleted = k8s.delete_custom_resource(ref)
+        assert deleted
+
+        time.sleep(DELETE_WAIT_AFTER_SECONDS)
+
+        # Check alias doesn't exist
+        assert not lambda_validator.alias_exists(resource_name, function_resource_name)
