Add async handling and e2e tests for VPCLink resource (#29)

vijtrip2 · web-flow · commit 808d2e9f8d8c · 2022-03-02T16:23:12.000-08:00
Description of changes:

* Add async handling for VPCLink resource
* Add e2e tests for VPCLink resource
* Update the test-infra dependency in e2e tests
* Assert for ACK.ResourceSynced condition in all e2e tests
* I did not create a new Lambda function Bootstrapable Resource because there are multiple ways to input handler code inside a lambda function and I did not want to handle all the complexity as part of this PR.


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/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml
@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2022-03-02T21:33:14Z"
+  build_date: "2022-03-03T00:08:42Z"
   build_hash: ade2429bb444ab635916395ea5773d141ba135e1
   go_version: go1.17.5
   version: v0.17.2
 api_directory_checksum: b98cf468e3704663b922b51293db3aab00e16cbc
 api_version: v1alpha1
 aws_sdk_go_version: v1.42.0
 generator_config_info:
-  file_checksum: 851121fe11436e5c8584a366cb634e2dcdc7766a
+  file_checksum: 21136a68fd8323e233a0f579b52126998a12e378
   original_file_name: generator.yaml
 last_modification:
   reason: API generation
diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml
@@ -35,7 +35,15 @@ resources:
     hooks:
       sdk_update_post_build_request:
         template_path: hooks/stage/sdk_update_post_build_request.go.tpl
+  VpcLink:
+    hooks:
+      sdk_update_pre_build_request:
+        template_path: hooks/vpc_link/sdk_update_pre_build_request.go.tpl
+    synced:
+      when:
+        - path: Status.VPCLinkStatus
+          in:
+            - AVAILABLE
 operations:
   CreateApi:
     custom_implementation: customCreateApi
-
diff --git a/generator.yaml b/generator.yaml
@@ -35,7 +35,15 @@ resources:
     hooks:
       sdk_update_post_build_request:
         template_path: hooks/stage/sdk_update_post_build_request.go.tpl
+  VpcLink:
+    hooks:
+      sdk_update_pre_build_request:
+        template_path: hooks/vpc_link/sdk_update_pre_build_request.go.tpl
+    synced:
+      when:
+        - path: Status.VPCLinkStatus
+          in:
+            - AVAILABLE
 operations:
   CreateApi:
     custom_implementation: customCreateApi
-
diff --git a/olm/olmconfig.yaml b/olm/olmconfig.yaml
@@ -39,14 +39,8 @@ samples:
   spec: '{}'
 - kind: Deployment
   spec: '{}'
-- kind: IntegrationResponse
-  spec: '{}'
 - kind: Integration
   spec: '{}'
-- kind: Model
-  spec: '{}'
-- kind: RouteResponse
-  spec: '{}'
 - kind: Route
   spec: '{}'
 - kind: Stage
diff --git a/pkg/resource/vpc_link/hook.go b/pkg/resource/vpc_link/hook.go
@@ -0,0 +1,29 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file 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 vpc_link
+
+import (
+	"fmt"
+
+	ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue"
+	svcsdk "github.com/aws/aws-sdk-go/service/apigatewayv2"
+)
+
+var (
+	waitForAvailableRequeue = ackrequeue.NeededAfter(
+		fmt.Errorf("VPCLink not in '%s' state, cannot be modified",
+			svcsdk.VpcLinkStatusAvailable),
+		ackrequeue.DefaultRequeueAfterDuration,
+	)
+)
diff --git a/pkg/resource/vpc_link/manager.go b/pkg/resource/vpc_link/manager.go
diff --git a/pkg/resource/vpc_link/sdk.go b/pkg/resource/vpc_link/sdk.go
diff --git a/templates/hooks/vpc_link/sdk_update_pre_build_request.go.tpl b/templates/hooks/vpc_link/sdk_update_pre_build_request.go.tpl
@@ -0,0 +1,3 @@
+    if latest.ko.Status.VPCLinkStatus != nil && *latest.ko.Status.VPCLinkStatus != svcsdk.VpcLinkStatusAvailable {
+        return nil, waitForAvailableRequeue
+    }
diff --git a/test/e2e/bootstrap_resources.py b/test/e2e/bootstrap_resources.py
@@ -16,26 +16,24 @@
 """
 
 from dataclasses import dataclass
-from pathlib import Path
-from acktest.resources import read_bootstrap_config
+from acktest.bootstrapping import Resources
+from acktest.bootstrapping.iam import Role
+from acktest.bootstrapping.vpc import VPC
 from e2e import bootstrap_directory
 
 @dataclass
-class TestBootstrapResources:
-    AuthorizerRoleName: str
-    AuthorizerPolicyArn: str
-    AuthorizerRoleArn: str
-    AuthorizerFunctionName: str
-    AuthorizerFunctionArn: str
+class BootstrapResources(Resources):
+    AuthorizerRole: Role
+    VPC: VPC
+    AuthorizerFunctionName: str = ""
+    AuthorizerFunctionArn: str = ""
 
 
 _bootstrap_resources = None
 
 
-def get_bootstrap_resources(bootstrap_file_name: str = "bootstrap.yaml"):
+def get_bootstrap_resources(bootstrap_file_name: str = "bootstrap.pkl") -> BootstrapResources:
     global _bootstrap_resources
     if _bootstrap_resources is None:
-        _bootstrap_resources = TestBootstrapResources(
-            **read_bootstrap_config(bootstrap_directory, bootstrap_file_name=bootstrap_file_name),
-        )
+        _bootstrap_resources = BootstrapResources.deserialize(bootstrap_directory, bootstrap_file_name=bootstrap_file_name)
     return _bootstrap_resources
diff --git a/test/e2e/replacement_values.py b/test/e2e/replacement_values.py
@@ -31,5 +31,9 @@
     "INTEGRATION_ID": "integration_id",
     "AUTHORIZER_ID": "authorizer_id",
     "STAGE_NAME": "test",
-    "STAGE_DESCRIPTION": "ack-test-stage"
+    "STAGE_DESCRIPTION": "ack-test-stage",
+    "VPC_LINK_RES_NAME": "ack-test",
+    "VPC_LINK_NAME": "ack-test",
+    "SUBNET_ID_1": "subnet-id-1",
+    "SUBNET_ID_2": "subnet-id-2"
 }
diff --git a/test/e2e/requirements.txt b/test/e2e/requirements.txt
@@ -1 +1 @@
-acktest @ git+https://github.com/aws-controllers-k8s/test-infra.git@955d7831ee374a212250179e95a5f3b75e555fd9
+acktest @ git+https://github.com/aws-controllers-k8s/test-infra.git@381bc6cc9e74a200e8c24f1189c54d80b27242ce
diff --git a/test/e2e/resources/vpc-link.yaml b/test/e2e/resources/vpc-link.yaml
@@ -0,0 +1,9 @@
+apiVersion: apigatewayv2.services.k8s.aws/v1alpha1
+kind: VPCLink
+metadata:
+  name: $VPC_LINK_RES_NAME
+spec:
+  name: $VPC_LINK_NAME
+  subnetIDs:
+    - $SUBNET_ID_1
+    - $SUBNET_ID_2
diff --git a/test/e2e/service_bootstrap.py b/test/e2e/service_bootstrap.py
@@ -14,75 +14,51 @@
 """
 import logging
 import os
-from pathlib import Path
-import time
 from zipfile import ZipFile
-import random
-import string
 import tempfile
 
 import boto3
 
-from acktest import resources
+from acktest.bootstrapping import Resources, BootstrapFailureException
+from acktest.bootstrapping.iam import Role
+from acktest.bootstrapping.vpc import VPC
+from acktest.resources import random_suffix_name
 from acktest.aws.identity import get_region
 from e2e import bootstrap_directory
-from e2e.bootstrap_resources import TestBootstrapResources
+from e2e.bootstrap_resources import BootstrapResources
 
-RAND_TEST_SUFFIX = (''.join(random.choice(string.ascii_lowercase) for _ in range(6)))
-AUTHORIZER_IAM_ROLE_NAME = 'ack-apigwv2-authorizer-role-' + RAND_TEST_SUFFIX
-AUTHORIZER_ASSUME_ROLE_POLICY = '{"Version": "2012-10-17","Statement": [{ "Effect": "Allow", "Principal": {"Service": '\
-                                '"lambda.amazonaws.com"}, "Action": "sts:AssumeRole"}]} '
-AUTHORIZER_POLICY_ARN = 'arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole'
-AUTHORIZER_FUNCTION_NAME = 'ack-apigatewayv2-authorizer-' + RAND_TEST_SUFFIX
 
-
-def service_bootstrap() -> dict:
+def service_bootstrap() -> Resources:
     logging.getLogger().setLevel(logging.INFO)
-    authorizer_role_arn = create_authorizer_role()
-    time.sleep(15)
-    authorizer_function_arn = create_lambda_authorizer(authorizer_role_arn)
 
-    return TestBootstrapResources(
-        AUTHORIZER_IAM_ROLE_NAME,
-        AUTHORIZER_POLICY_ARN,
-        authorizer_role_arn,
-        AUTHORIZER_FUNCTION_NAME,
-        authorizer_function_arn
-    ).__dict__
+    # First create the AuthorizerRole and VPC.
+    # Then use the created AuthorizerRole.arn for
+    # creating Authorizer lambda function.
 
+    resources = BootstrapResources(
+        AuthorizerRole=Role("ack-apigwv2-authorizer-role",
+                            "lambda.amazonaws.com",
+                            managed_policies=["arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"]),
+        VPC=VPC(name_prefix="apigwv2-vpc-link")
+    )
 
-def create_authorizer_role() -> str:
-    region = get_region()
-    iam_client = boto3.client("iam", region_name=region)
+    try:
+        resources.bootstrap()
+    except BootstrapFailureException as ex:
+        exit(254)
 
-    logging.debug(f"Creating authorizer iam role {AUTHORIZER_IAM_ROLE_NAME}")
+    authorizer_function_name = random_suffix_name("ack-apigwv2-authorizer", 30)
+    authorizer_function_arn = create_lambda_authorizer(authorizer_function_name, resources.AuthorizerRole.arn)
 
-    try:
-        iam_client.get_role(RoleName=AUTHORIZER_IAM_ROLE_NAME)
-        raise RuntimeError(f"Expected {AUTHORIZER_IAM_ROLE_NAME} role to not exist."
-                           f" Did previous test cleanup successfully?")
-    except iam_client.exceptions.NoSuchEntityException:
-        pass
-
-    resp = iam_client.create_role(
-        RoleName=AUTHORIZER_IAM_ROLE_NAME,
-        AssumeRolePolicyDocument=AUTHORIZER_ASSUME_ROLE_POLICY
-    )
-    iam_client.attach_role_policy(RoleName=AUTHORIZER_IAM_ROLE_NAME, PolicyArn=AUTHORIZER_POLICY_ARN)
-    return resp['Role']['Arn']
+    resources.AuthorizerFunctionName = authorizer_function_name
+    resources.AuthorizerFunctionArn = authorizer_function_arn
+    return resources
 
 
-def create_lambda_authorizer(authorizer_role_arn : str) -> str:
+def create_lambda_authorizer(authorizer_function_name: str, authorizer_role_arn: str) -> str:
     region = get_region()
     lambda_client = boto3.client("lambda", region)
 
-    try:
-        lambda_client.get_function(FunctionName=AUTHORIZER_FUNCTION_NAME)
-        raise RuntimeError(f"Expected {AUTHORIZER_FUNCTION_NAME} function to not exist. Did previous test cleanup"
-                           f" successfully?")
-    except lambda_client.exceptions.ResourceNotFoundException:
-        pass
-
     with tempfile.TemporaryDirectory() as tempdir:
         current_directory = os.path.dirname(os.path.realpath(__file__))
         index_zip = ZipFile(f'{tempdir}/index.zip', 'w')
@@ -93,16 +69,17 @@ def create_lambda_authorizer(authorizer_role_arn : str) -> str:
             b64_encoded_zip_file = f.read()
 
         response = lambda_client.create_function(
-            FunctionName=AUTHORIZER_FUNCTION_NAME,
+            FunctionName=authorizer_function_name,
             Role=authorizer_role_arn,
             Handler='index.handler',
             Runtime='nodejs12.x',
             Code={'ZipFile': b64_encoded_zip_file}
         )
-    
+
     return response['FunctionArn']
 
+
 if __name__ == "__main__":
     config = service_bootstrap()
     # Write config to current directory by default
-    resources.write_bootstrap_config(config, bootstrap_directory)
+    config.serialize(bootstrap_directory)
diff --git a/test/e2e/service_cleanup.py b/test/e2e/service_cleanup.py
@@ -15,34 +15,20 @@
 """
 
 import boto3
-from acktest import resources
+import logging
+
+from acktest.bootstrapping import Resources
 from acktest.aws.identity import get_region
 
 from e2e import bootstrap_directory
-from e2e.bootstrap_resources import TestBootstrapResources
-
-
-def service_cleanup(config: dict):
-    resources = TestBootstrapResources(
-        **config
-    )
-    detach_policy_and_delete_role(iam_role_name=resources.AuthorizerRoleName, iam_policy_arn=resources.AuthorizerPolicyArn)
-    delete_authorizer_function(function_name=resources.AuthorizerFunctionName)
-
 
-def detach_policy_and_delete_role(iam_role_name: str, iam_policy_arn: str):
-    region = get_region()
-    iam_client = boto3.client("iam", region_name=region)
 
-    try:
-        iam_client.detach_role_policy(RoleName=iam_role_name, PolicyArn=iam_policy_arn)
-    except iam_client.exceptions.NoSuchEntityException:
-        pass
+def service_cleanup():
+    logging.getLogger().setLevel(logging.INFO)
 
-    try:
-        iam_client.delete_role(RoleName=iam_role_name)
-    except iam_client.exceptions.NoSuchEntityException:
-        pass
+    resources = Resources.deserialize(bootstrap_directory)
+    delete_authorizer_function(function_name=resources.AuthorizerFunctionName)
+    resources.cleanup()
 
 
 def delete_authorizer_function(function_name: str):
@@ -54,6 +40,6 @@ def delete_authorizer_function(function_name: str):
     except lambda_client.exceptions.ResourceNotFoundException:
         pass
 
-if __name__ == "__main__":   
-    bootstrap_config = resources.read_bootstrap_config(bootstrap_directory)
-    service_cleanup(bootstrap_config) 
+
+if __name__ == "__main__":
+    service_cleanup()
diff --git a/test/e2e/tests/helper.py b/test/e2e/tests/helper.py
diff --git a/test/e2e/tests/test_api.py b/test/e2e/tests/test_api.py
diff --git a/test/e2e/tests/test_vpc_link.py b/test/e2e/tests/test_vpc_link.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+ if latest.ko.Status.VPCLinkStatus != nil && *latest.ko.Status.VPCLinkStatus != svcsdk.VpcLinkStatusAvailable {`
	`2`	`+ return nil, waitForAvailableRequeue`
	`3`	`+ }`