Add auto-publish functionality for Function resources

This patch introduces the ability for CF Functions to be automatically
published after a successful create or update operation. It adds an
annotation `cloudfront.services.k8s.aws/auto-publish` to the `Function`
resource, which when set to `true`, will trigger the automatic
publishing of the Function after a create or update.

Signed-off-by: Amine Hilaly <[email protected]>

Author: a-hilaly

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2024-03-06T21:22:30Z"
-  build_hash: a5ba3c851434263128a1464a2c41e528779eeefa
-  go_version: go1.22.0
-  version: v0.32.1
-api_directory_checksum: 86a18c0bfcc849ad234f64249fd8951ce418dd14
+  build_date: "2024-03-23T14:14:11Z"
+  build_hash: d86061f5f579fe5d3a07528917d95e34e79c4dc0
+  go_version: go1.22.1
+  version: v0.32.1-1-gd86061f-dirty
+api_directory_checksum: 27fd205fbbd08711210430b8e19ed65ab91b5d32
 api_version: v1alpha1
 aws_sdk_go_version: v1.44.214
 generator_config_info:
-  file_checksum: 250151346bb9c7a0bcd8cdcdb77f482f2eee0d03
+  file_checksum: 9b125128dc96ab9b6c92fb4d368a0562a3f549fb
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/annotation.go

@@ -0,0 +1,24 @@
+// 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 v1alpha1
+
+import "fmt"
+
+var (
+	// AutoPublishAnnotation is the annotation key for the auto-publish annotation
+	// for CloudFront functions. This annotation is used to indicate whether a
+	// function should be automatically published after a successful update or create
+	// operation.
+	AutoPublishAnnotation = fmt.Sprintf("%s/auto-publish", GroupVersion.Group)
+)

apis/v1alpha1/generator.yaml

@@ -213,6 +213,10 @@ resources:
     hooks:
       sdk_read_one_post_set_output:
         template_path: hooks/function/sdk_read_one_post_set_output.go.tpl
+      sdk_create_post_set_output:
+        template_path: hooks/function/sdk_create_post_set_output.go.tpl
+      sdk_update_post_set_output:
+        template_path: hooks/function/sdk_update_post_set_output.go.tpl
   OriginRequestPolicy:
     tags:
       ignore: true

generator.yaml

@@ -213,6 +213,10 @@ resources:
     hooks:
       sdk_read_one_post_set_output:
         template_path: hooks/function/sdk_read_one_post_set_output.go.tpl
+      sdk_create_post_set_output:
+        template_path: hooks/function/sdk_create_post_set_output.go.tpl
+      sdk_update_post_set_output:
+        template_path: hooks/function/sdk_update_post_set_output.go.tpl
   OriginRequestPolicy:
     tags:
       ignore: true

pkg/resource/function/hooks.go

@@ -15,6 +15,7 @@ package function
 
 import (
 	"context"
+	"strconv"
 
 	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 	svcsdk "github.com/aws/aws-sdk-go/service/cloudfront"
@@ -57,3 +58,39 @@ func (rm *resourceManager) setFunctionCode(ctx context.Context, r *v1alpha1.Func
 	r.Spec.FunctionCode = []byte(output.FunctionCode)
 	return nil
 }
+
+// publishFunction publishes the a CloudFront function.
+func (rm *resourceManager) publishFunction(ctx context.Context, r *v1alpha1.Function) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.publishFunction")
+	defer func() { exit(err) }()
+
+	_, err = rm.sdkapi.PublishFunctionWithContext(
+		ctx,
+		&svcsdk.PublishFunctionInput{
+			Name:    r.Spec.Name,
+			IfMatch: r.Status.ETag,
+		},
+	)
+	rm.metrics.RecordAPICall("POST", "PublishFunction", err)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// functionAutoPublishEnabled returns true if the function should be
+// automatically published after a successful update or create operation.
+func functionAutoPublishEnabled(f *v1alpha1.Function) bool {
+	annotations := f.ObjectMeta.GetAnnotations()
+	if annotations == nil {
+		return false
+	}
+	autoPublish, ok := annotations[v1alpha1.AutoPublishAnnotation]
+	if ok {
+		return autoPublish == strconv.FormatBool(true)
+	}
+
+	// By default we do not auto-publish functions.
+	return false
+}

pkg/resource/function/sdk.go

@@ -0,0 +1,5 @@
+	if functionAutoPublishEnabled(ko) {
+		if err := rm.publishFunction(ctx, ko); err != nil {
+			return nil, err
+		}
+	}

templates/hooks/function/sdk_create_post_set_output.go.tpl

@@ -0,0 +1,5 @@
+	if functionAutoPublishEnabled(ko) {
+		if err := rm.publishFunction(ctx, ko); err != nil {
+			return nil, err
+		}
+	}

templates/hooks/function/sdk_update_post_set_output.go.tpl

@@ -2,9 +2,11 @@ apiVersion: cloudfront.services.k8s.aws/v1alpha1
 kind: Function
 metadata:
   name: $FUNCTION_NAME
+  annotations:
+    cloudfront.services.k8s.aws/auto-publish: $AUTO_PUBLISH
 spec:
   name: $FUNCTION_NAME
   functionCode: ZnVuY3Rpb24gaGFuZGxlcihldmVudCkgewogIHJldHVybiB7CiAgICBzdGF0dXNDb2RlOiAzMDIsCiAgICBzdGF0dXNEZXNjcmlwdGlvbjogJ0ZvdW5kJywKICAgIGhlYWRlcnM6IHsKICAgICAgbG9jYXRpb246IHsgdmFsdWU6ICdodHRwczovLy8nIH0KICAgIH0KICB9Cn0K
   functionConfig:
     comment: function to redirect to $DOMAIN_NAME
-    runtime: $FUNCTION_RUNTIME
+    runtime: $FUNCTION_RUNTIME

test/e2e/resources/function.yaml

@@ -16,15 +16,13 @@
 import time
 
 import pytest
-
+from acktest.aws import identity
 from acktest.k8s import condition
 from acktest.k8s import resource as k8s
-from acktest.aws import identity
 from acktest.resources import random_suffix_name
-from e2e import service_marker, CRD_GROUP, CRD_VERSION, load_resource
+from e2e import CRD_GROUP, CRD_VERSION, function, load_resource, service_marker
 from e2e.bootstrap_resources import get_bootstrap_resources
 from e2e.replacement_values import REPLACEMENT_VALUES
-from e2e import function
 
 FUNCTIONS_RESOURCE_PLURAL = "functions"
 DELETE_WAIT_AFTER_SECONDS = 10
@@ -33,7 +31,7 @@
 
 
 @pytest.fixture(scope="module")
-def simple_function():
+def simple_function(request):
     function_name = random_suffix_name("my-function", 24)
 
     # resources = get_bootstrap_resources()
@@ -46,6 +44,16 @@ def simple_function():
     replacements['FUNCTION_RUNTIME'] = "cloudfront-js-2.0"
     replacements['DOMAIN_NAME'] = "example.com"
 
+    auto_publish = "false"
+    marker = request.node.get_closest_marker("function_overrides")
+    if marker is not None:
+        data = marker.args[0]
+        if 'auto-publish' in data:
+            if data['auto-publish'] == "true":
+                auto_publish = "true"
+    
+    replacements['AUTO_PUBLISH'] = auto_publish
+
     resource_data = load_resource(
         "function",
         additional_replacements=replacements,
@@ -107,4 +115,39 @@ def test_crud(self, simple_function):
 
         latest = function.get(function_name)
         assert latest is not None
+        assert latest['Status'] == "UNPUBLISHED"
         assert latest['FunctionConfig']['Comment'] == "New comment"
+
+    @pytest.mark.function_overrides({
+        'auto-publish': True,
+    })
+    def test_auto_publish(self, simple_function):
+        ref, res, function_name = simple_function
+
+        time.sleep(CHECK_STATUS_WAIT_SECONDS)
+
+        # Check that function exists
+        cr = k8s.get_resource(ref)
+        assert cr is not None
+
+        condition.assert_synced(ref)
+
+        latest = function.get(function_name)
+        assert latest is not None
+        assert latest['Status'] == "PUBLISHED"
+
+        updates = {
+            "spec": {
+                "functionConfig": {
+                    "comment": "New comment"
+                }
+            },
+        }
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+
+        latest = function.get(function_name)
+        assert latest is not None
+        assert latest['FunctionConfig']['Comment'] == "New comment"
+        assert latest['Status'] == "PUBLISHED"
+