Add Adoption by annotation tests (#139)

michaelhtm · web-flow · commit dbbf635b94c8 · 2024-12-03T17:36:08.000Z
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,8 +1,8 @@
 ack_generate_info:
-  build_date: "2024-10-10T04:12:55Z"
-  build_hash: 36c2d234498c2bc4f60773ab8df632af4067f43b
+  build_date: "2024-12-02T23:36:35Z"
+  build_hash: ce8a66e1fd3d15afacc33069bb788795863a4245
   go_version: go1.23.2
-  version: v0.39.1
+  version: v0.39.1-6-gce8a66e
 api_directory_checksum: 82bfc8d45e816b2a02a83a4b7cedd72056accddd
 api_version: v1alpha1
 aws_sdk_go_version: v1.44.93
diff --git a/config/controller/deployment.yaml b/config/controller/deployment.yaml
@@ -41,6 +41,8 @@ spec:
         - "$(LEADER_ELECTION_NAMESPACE)"
         - --reconcile-default-max-concurrent-syncs
         - "$(RECONCILE_DEFAULT_MAX_CONCURRENT_SYNCS)"
+        - --feature-gates
+        - "$(FEATURE_GATES)"
         image: controller:latest
         name: controller
         ports:
@@ -76,6 +78,8 @@ spec:
           value: "ack-system"
         - name: "RECONCILE_DEFAULT_MAX_CONCURRENT_SYNCS"
           value: "1"
+        - name: "FEATURE_GATES"
+          value: ""
         securityContext:
           allowPrivilegeEscalation: false
           privileged: false
diff --git a/go.mod b/go.mod
@@ -5,7 +5,7 @@ go 1.22.0
 toolchain go1.22.5
 
 require (
-	github.com/aws-controllers-k8s/runtime v0.39.0
+	github.com/aws-controllers-k8s/runtime v0.39.1-0.20241202082353-a6b0014a8130
 	github.com/aws/aws-sdk-go v1.49.0
 	github.com/go-logr/logr v1.4.2
 	github.com/pkg/errors v0.9.1
diff --git a/go.sum b/go.sum
@@ -1,5 +1,5 @@
-github.com/aws-controllers-k8s/runtime v0.39.0 h1:IgOXluSzvb4UcDr9eU7SPw5MJnL7kt5R6DuF5Qu9zVQ=
-github.com/aws-controllers-k8s/runtime v0.39.0/go.mod h1:G07g26y1cxyZO6Ngp+LwXf03CqFyLNL7os4Py4IdyGY=
+github.com/aws-controllers-k8s/runtime v0.39.1-0.20241202082353-a6b0014a8130 h1:EoXYRrpBX2hi5B1IawKr2LJTsVsreHsJdxULLlMNO9U=
+github.com/aws-controllers-k8s/runtime v0.39.1-0.20241202082353-a6b0014a8130/go.mod h1:G07g26y1cxyZO6Ngp+LwXf03CqFyLNL7os4Py4IdyGY=
 github.com/aws/aws-sdk-go v1.49.0 h1:g9BkW1fo9GqKfwg2+zCD+TW/D36Ux+vtfJ8guF4AYmY=
 github.com/aws/aws-sdk-go v1.49.0/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
diff --git a/helm/templates/caches-role-binding.yaml b/helm/templates/caches-role-binding.yaml
@@ -8,7 +8,7 @@ roleRef:
   name: ack-namespaces-cache-s3-controller
 subjects:
 - kind: ServiceAccount
-  name: ack-s3-controller
+  name: {{ include "ack-s3-controller.service-account.name" . }}
   namespace: {{ .Release.Namespace }}
 ---
 apiVersion: rbac.authorization.k8s.io/v1
@@ -22,5 +22,5 @@ roleRef:
   name: ack-configmaps-cache-s3-controller
 subjects:
 - kind: ServiceAccount
-  name: ack-s3-controller
-  namespace: {{ .Release.Namespace }}
+  name: {{ include "ack-s3-controller.service-account.name" . }}
+  namespace: {{ .Release.Namespace }}
diff --git a/pkg/resource/bucket/descriptor.go b/pkg/resource/bucket/descriptor.go
diff --git a/pkg/resource/bucket/resource.go b/pkg/resource/bucket/resource.go
diff --git a/test/e2e/bootstrap_resources.py b/test/e2e/bootstrap_resources.py
@@ -25,6 +25,7 @@
 @dataclass
 class BootstrapResources(Resources):
     ReplicationBucket: Bucket
+    AdoptionBucket: Bucket
     ReplicationRole: Role
     NotificationTopic: Topic
 
diff --git a/test/e2e/replacement_values.py b/test/e2e/replacement_values.py
@@ -18,6 +18,7 @@
 
 REPLACEMENT_VALUES = {
     "REPLICATION_ROLE_ARN": get_bootstrap_resources().ReplicationRole.arn,
+    "ADOPTION_BUCKET_NAME": get_bootstrap_resources().AdoptionBucket.name,
     "REPLICATION_BUCKET_NAME": get_bootstrap_resources().ReplicationBucket.name,
     "NOTIFICATION_TOPIC_ARN": get_bootstrap_resources().NotificationTopic.arn,
 }
diff --git a/test/e2e/resources/bucket_adoption_policy.yaml b/test/e2e/resources/bucket_adoption_policy.yaml
@@ -0,0 +1,8 @@
+apiVersion: s3.services.k8s.aws/v1alpha1
+kind: Bucket
+metadata:
+  name: $ADOPTION_BUCKET_NAME
+  annotations:
+    services.k8s.aws/adoption-policy: $ADOPTION_POLICY
+    services.k8s.aws/adoption-fields: "$ADOPTION_FIELDS"
+    services.k8s.aws/deletion-policy: retain
diff --git a/test/e2e/service_bootstrap.py b/test/e2e/service_bootstrap.py
@@ -64,6 +64,7 @@ def service_bootstrap() -> Resources:
 
     resources = BootstrapResources(
         ReplicationBucket=Bucket("ack-s3-replication", enable_versioning=True),
+        AdoptionBucket=Bucket("ack-s3-annotation-adoption", enable_versioning=True),
         ReplicationRole=Role("ack-s3-replication-role", "s3.amazonaws.com",
             user_policies=UserPolicies("ack-s3-replication-policy", [replication_policy])
         ),
diff --git a/test/e2e/tests/test_bucket_adoption_policy.py b/test/e2e/tests/test_bucket_adoption_policy.py
@@ -0,0 +1,104 @@
+# 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.
+
+"""Integration tests for the deletion policy annotation on Bucket.
+"""
+
+from enum import Enum
+import pytest
+import time
+import logging
+
+from acktest.resources import random_suffix_name
+from acktest.k8s import resource as k8s
+from acktest import adoption as adoption
+from acktest import tags as tags
+from e2e import service_marker, CRD_GROUP, CRD_VERSION, load_s3_resource
+from e2e.tests.test_bucket import bucket_exists, get_bucket
+from e2e.replacement_values import REPLACEMENT_VALUES
+
+CREATE_WAIT_AFTER_SECONDS = 10
+MODIFY_WAIT_AFTER_SECONDS = 10
+DELETE_WAIT_AFTER_SECONDS = 10
+
+class AdoptionPolicy(str, Enum):
+    NONE = ""
+    ADOPT = "adopt"
+    ADOPT_OR_CREATE = "adopt-or-create"
+
+
+@pytest.fixture(scope="module")
+def adoption_policy_adopt_bucket(s3_client):
+    replacements = REPLACEMENT_VALUES.copy()
+    bucket_name = replacements["ADOPTION_BUCKET_NAME"]
+    replacements["ADOPTION_POLICY"] = AdoptionPolicy.ADOPT
+    replacements["ADOPTION_FIELDS"] = f'{{\\\"name\\\": \\\"{bucket_name}\\\"}}'
+
+    resource_data = load_s3_resource(
+        "bucket_adoption_policy",
+        additional_replacements=replacements,
+    )
+
+    # Create k8s resource
+    ref = k8s.CustomResourceReference(
+        CRD_GROUP, CRD_VERSION, "buckets",
+        bucket_name, namespace="default")
+    k8s.create_custom_resource(ref, resource_data)
+
+    time.sleep(CREATE_WAIT_AFTER_SECONDS)
+    cr = k8s.wait_resource_consumed_by_controller(ref)
+
+    assert cr is not None
+    assert k8s.get_resource_exists(ref)
+
+    yield (ref, cr)
+
+    _, deleted = k8s.delete_custom_resource(ref, DELETE_WAIT_AFTER_SECONDS)
+    assert deleted
+
+@service_marker
+@pytest.mark.canary
+class TestAdoptionPolicyBucket:
+    def test_adoption_policy(
+        self, s3_client, adoption_policy_adopt_bucket, s3_resource
+    ):
+        (ref, cr) = adoption_policy_adopt_bucket
+
+        # Spec will be added by controller
+        assert 'spec' in cr
+        assert 'name' in cr['spec']
+        bucket_name = cr['spec']['name']
+
+        updates = {
+            "spec": {
+                "versioning": {
+                    "status": "Suspended"
+                },
+            }
+        }
+
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+
+        cr = k8s.wait_resource_consumed_by_controller(ref)
+        assert cr is not None
+        assert 'spec' in cr
+        assert 'versioning' in cr['spec']
+        assert 'status' in cr['spec']['versioning']
+        status = cr['spec']['versioning']['status']
+        latest = get_bucket(s3_resource, bucket_name)
+        assert latest is not None
+        versioning = latest.Versioning()
+        assert versioning.status == status
+
+

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`
`19`	`19`	`REPLACEMENT_VALUES = {`
`20`	`20`	`"REPLICATION_ROLE_ARN": get_bootstrap_resources().ReplicationRole.arn,`
	`21`	`+ "ADOPTION_BUCKET_NAME": get_bootstrap_resources().AdoptionBucket.name,`
`21`	`22`	`"REPLICATION_BUCKET_NAME": get_bootstrap_resources().ReplicationBucket.name,`
`22`	`23`	`"NOTIFICATION_TOPIC_ARN": get_bootstrap_resources().NotificationTopic.arn,`
`23`	`24`	`}`