Create set-name-prefix function (#925)

Author: justinsb

functions/go/set-gcp-resource-ids/pkg/kpt/packagecontext.go

@@ -1,4 +1,4 @@
-package common
+package kpt
 
 import (
 	"fmt"

functions/go/set-gcp-resource-ids/pkg/kpt/resourcegroup.go

@@ -1,4 +1,4 @@
-package common
+package kpt
 
 import (
 	"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"

functions/go/set-name-prefix/Makefile

@@ -0,0 +1,11 @@
+# GCP project to use for development
+export GCP_PROJECT_ID ?= $(shell gcloud config get-value project)
+export IMAGE_REPO ?= gcr.io/$(GCP_PROJECT_ID)
+export IMAGE_TAG ?= latest
+
+build:
+	KO_DOCKER_REPO=ko.local ko build -B --tags=${IMAGE_TAG} .
+
+push:
+	KO_DOCKER_REPO=${IMAGE_REPO} ko build -B --tags=${IMAGE_TAG} .
+

functions/go/set-name-prefix/setnameprefix.go

@@ -0,0 +1,100 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/bind/pkg/rename"
+	"github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/set-gcp-resource-ids/pkg/kpt"
+	"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+func main() {
+	// TODO: fn.AsMain should support an "easy mode" where it runs against a directory
+	if err := fn.AsMain(fn.ResourceListProcessorFunc(Run)); err != nil {
+		os.Exit(1)
+	}
+}
+
+type SetNamePrefix struct {
+	Prefix    string `json:"prefix,omitempty"`
+	OldPrefix string `json:"oldPrefix,omitempty"`
+}
+
+func Run(rl *fn.ResourceList) (bool, error) {
+	f := SetNamePrefix{
+		OldPrefix: "packagename",
+	}
+
+	packageContext, err := kpt.FindPackageContext(rl.Items)
+	if err != nil {
+		return false, err
+	}
+	f.Prefix = packageContext.Name
+
+	if err := f.LoadConfig(rl.FunctionConfig); err != nil {
+		rl.Results = append(rl.Results, fn.ErrorConfigObjectResult(fmt.Errorf("functionConfig error: %w", err), rl.FunctionConfig))
+		return true, nil
+	}
+
+	if f.Prefix == "" {
+		return false, fmt.Errorf("`data.prefix` should not be empty")
+	}
+
+	if err := f.Transform(rl.Items); err != nil {
+		rl.Results = append(rl.Results, fn.ErrorResult(err))
+	}
+	return true, nil
+}
+
+func (f *SetNamePrefix) LoadConfig(fnConfig *fn.KubeObject) error {
+	if fnConfig != nil {
+		switch { //TODO: fnConfig.GroupVersionKind()
+		case fnConfig.IsGVK("", "v1", "ConfigMap"):
+			data := fnConfig.UpsertMap("data") // TODO: Why does GetMap fail?
+			if s, ok, _ := data.NestedString("prefix"); ok {
+				f.Prefix = s
+			}
+			if s, ok, _ := data.NestedString("oldPrefix"); ok {
+				f.OldPrefix = s
+			}
+
+		default:
+			gvk := schema.GroupVersionKind{}
+			return fmt.Errorf("unknown functionConfig Kind %v", gvk) //TODO: fnConfig.GroupVersionKind())
+		}
+	}
+
+	return nil
+}
+
+func (f *SetNamePrefix) Transform(objects fn.KubeObjects) error {
+	for _, object := range objects {
+		if object.IsLocalConfig() {
+			continue
+		}
+		if kpt.IsResourceGroup(object) {
+			continue // Should ResourceGroup be marked as local config?
+		}
+		oldName := object.GetName()
+		newNamespace := object.GetNamespace() // do not change namespace
+		if oldName != "" {
+			if oldName == f.OldPrefix {
+				newName := f.Prefix
+				if err := rename.Rename(object, newName, newNamespace, objects); err != nil {
+					return err
+				}
+			} else if strings.HasPrefix(oldName, f.OldPrefix+"-") {
+				suffix := strings.TrimPrefix(oldName, f.OldPrefix+"-")
+				newName := f.Prefix + "-" + suffix
+				if err := rename.Rename(object, newName, newNamespace, objects); err != nil {
+					return err
+				}
+			}
+		}
+	}
+
+	return nil
+}

scripts/verify-docs.py

@@ -37,7 +37,7 @@
 functions_directory = 'functions'
 lang_dirs = ['go', 'ts']
 examples_directories_to_skip = ['_template']
-fn_directories_to_skip = ['bind', 'inflate-helm-chart', 'set-gcp-resource-ids']
+fn_directories_to_skip = ['bind', 'inflate-helm-chart', 'set-gcp-resource-ids', 'set-name-prefix']
 required_fields = ['image', 'description', 'tags', 'sourceURL', 'examplePackageURLs', 'emails', 'license']
 kpt_team_email = '[email protected]'
 disallowed_kpt_commands = ['kpt fn run', 'kpt cfg', 'kpt pkg cat']