feat/export-tool: adding export CLI

Feat: Export tool

Author: gergely-szabo-sap

Makefile

@@ -33,7 +33,7 @@ NPROCS ?= 1
 GO_TEST_PARALLEL := $(shell echo $$(( $(NPROCS) / 2 )))
 
 GO_REQUIRED_VERSION ?= 1.23
-GO_STATIC_PACKAGES = $(GO_PROJECT)/cmd/provider
+GO_STATIC_PACKAGES = $(GO_PROJECT)/cmd/provider $(GO_PROJECT)/cmd/exporter
 GO_LDFLAGS += -X $(GO_PROJECT)/internal/version.Version=$(VERSION)
 GO_SUBDIRS += cmd internal apis
 GO111MODULE = on

README.md

@@ -69,7 +69,7 @@ kind delete cluster <cluster-name>
 
 ### Upgrade Tests
 
-The provider comes with a set of upgrade tests that can be run locally. To learn more about it : [Upgrade Tests README](./test/upgrade/README.md). 
+The provider comes with a set of upgrade tests that can be run locally. To learn more about it : [Upgrade Tests README](./test/upgrade/README.md).
 
 #### Required Configuration
 In order for the tests to perform successfully some configuration need to be present as environment variables:
@@ -92,9 +92,15 @@ Contains the CF server URL, for example:
 https://api.cf.eu12.hana.ondemand.com
 ```
 
+## Export CLI
+
+The provider includes an export CLI tool that generates managed resource definitions from the existing resource configurations of a Cloud Foundry cluster.
+
+For more details, refer to the [user guide](cmd/exporter/docs/USERGUIDE.md).
+
 ## 👐 Support, Feedback, Contributing
 
-If you have a question always feel free to reach out on our official crossplane slack channel: 
+If you have a question always feel free to reach out on our official crossplane slack channel:
 
 :rocket: [**#provider-sap-cloudfoundry**](https://crossplane.slack.com/archives/C08NBTJ1J05).
 

cmd/exporter/cf/cache/guid.go

@@ -0,0 +1,49 @@
+package cache
+
+import (
+	"iter"
+	"maps"
+	"slices"
+)
+
+type CacheWithGUID[T ResourceWithGuid] interface {
+	GetByGUID(guid string) T
+	GetGUIDs() []string
+	Len() int
+	StoreWithGUID(resources ...T)
+	AllByGUIDs() iter.Seq2[string, T]
+}
+
+type cacheWithGUID[T ResourceWithGuid] struct {
+	guidIndex map[string]T
+}
+
+var _ CacheWithGUID[dummyResourceWithGuid] = &cacheWithGUID[dummyResourceWithGuid]{}
+
+func NewWithGUID[T ResourceWithGuid]() CacheWithGUID[T] {
+	return &cacheWithGUID[T]{
+		guidIndex: make(map[string]T),
+	}
+}
+
+func (c *cacheWithGUID[T]) StoreWithGUID(resources ...T) {
+	for _, resource := range resources {
+		c.guidIndex[resource.GetGUID()] = resource
+	}
+}
+
+func (c *cacheWithGUID[T]) GetByGUID(guid string) T {
+	return c.guidIndex[guid]
+}
+
+func (c *cacheWithGUID[T]) GetGUIDs() []string {
+	return slices.Sorted(maps.Keys(c.guidIndex))
+}
+
+func (c *cacheWithGUID[T]) Len() int {
+	return len(c.guidIndex)
+}
+
+func (c *cacheWithGUID[T]) AllByGUIDs() iter.Seq2[string, T] {
+	return maps.All(c.guidIndex)
+}

cmd/exporter/cf/cache/guidname.go

@@ -0,0 +1,38 @@
+package cache
+
+type CacheWithGUIDAndName[T ResourceWithGUIDAndName] interface {
+	CacheWithGUID[T]
+	CacheWithName[T]
+	StoreWithGUIDAndName(resources ...T)
+}
+
+type cacheWithGUIDAndName[T ResourceWithGUIDAndName] struct {
+	CacheWithGUID[T]
+	CacheWithName[T]
+}
+
+var _ CacheWithGUIDAndName[dummyResourceWithGUIDAndName] = &cacheWithGUIDAndName[dummyResourceWithGUIDAndName]{}
+
+func NewWithGUIDAndName[T ResourceWithGUIDAndName]() CacheWithGUIDAndName[T] {
+	return &cacheWithGUIDAndName[T]{
+		CacheWithGUID: NewWithGUID[T](),
+		CacheWithName: NewWithName[T](),
+	}
+}
+
+func (c *cacheWithGUIDAndName[T]) Len() int {
+	return c.CacheWithGUID.Len()
+}
+
+func (c *cacheWithGUIDAndName[T]) StoreWithGUIDAndName(resources ...T) {
+	c.CacheWithGUID.StoreWithGUID(resources...)
+	c.CacheWithName.StoreWithName(resources...)
+}
+
+func (c *cacheWithGUIDAndName[T]) StoreWithName(_ ...T) {
+	panic("StoreWithName shall not be used here")
+}
+
+func (c *cacheWithGUIDAndName[T]) StoreWithGUID(_ ...T) {
+	panic("StoreWithGUID shall not be used here")
+}

cmd/exporter/cf/cache/name.go

@@ -0,0 +1,50 @@
+package cache
+
+import (
+	"iter"
+	"maps"
+	"slices"
+)
+
+type CacheWithName[T ResourceWithName] interface {
+	GetByName(name string) []T
+	GetNames() []string
+	StoreWithName(resources ...T)
+	Len() int
+	AllByNames() iter.Seq2[string, []T]
+}
+
+type cacheWithName[T ResourceWithName] struct {
+	nameIndex map[string][]T
+}
+
+var _ CacheWithName[dummyResourceWithName] = &cacheWithName[dummyResourceWithName]{}
+
+func NewWithName[T ResourceWithName]() CacheWithName[T] {
+	return &cacheWithName[T]{
+		nameIndex: make(map[string][]T),
+	}
+}
+
+func (c *cacheWithName[T]) StoreWithName(resources ...T) {
+	for _, resource := range resources {
+		name := resource.GetName()
+		c.nameIndex[name] = append(c.nameIndex[name], resource)
+	}
+}
+
+func (c *cacheWithName[T]) GetByName(name string) []T {
+	return c.nameIndex[name]
+}
+
+func (c *cacheWithName[T]) GetNames() []string {
+	return slices.Sorted(maps.Keys(c.nameIndex))
+}
+
+func (c *cacheWithName[T]) Len() int {
+	return len(c.nameIndex)
+}
+
+func (c *cacheWithName[T]) AllByNames() iter.Seq2[string, []T] {
+	return maps.All(c.nameIndex)
+}

cmd/exporter/cf/cache/resource.go

@@ -0,0 +1,43 @@
+package cache
+
+import (
+	"github.com/SAP/xp-clifford/yaml"
+)
+
+type ResourceWithGuid interface {
+	GetGUID() string
+}
+
+type dummyResourceWithGuid struct{}
+
+var _ ResourceWithGuid = dummyResourceWithGuid{}
+
+func (r dummyResourceWithGuid) GetGUID() string {
+	return "dummyGUID"
+}
+
+type ResourceWithName interface {
+	GetName() string
+}
+
+type dummyResourceWithName struct{}
+
+var _ ResourceWithName = dummyResourceWithName{}
+
+func (r dummyResourceWithName) GetName() string {
+	return "dummyName"
+}
+
+type ResourceWithGUIDAndName interface {
+	ResourceWithGuid
+	ResourceWithName
+	yaml.CommentedYAML
+}
+
+type dummyResourceWithGUIDAndName struct {
+	dummyResourceWithGuid
+	dummyResourceWithName
+	*yaml.ResourceWithComment
+}
+
+var _ ResourceWithGUIDAndName = dummyResourceWithGUIDAndName{}

cmd/exporter/cf/config/config.go

@@ -0,0 +1,32 @@
+package config
+
+import (
+	"context"
+	"log/slog"
+
+	"github.com/SAP/xp-clifford/cli/configparam"
+
+	"github.com/cloudfoundry/go-cfclient/v3/config"
+)
+
+func Get(ctx context.Context, useCfLoginMethod *configparam.BoolParam, apiUrlParam, usernameParam, passwordParam *configparam.StringParam) (*config.Config, error) {
+	if useCfLoginMethod.Value() {
+		slog.Debug("log in to CF using the CF login method")
+		return config.NewFromCFHome()
+	} else {
+		apiUrl, err := apiUrlParam.ValueOrAsk(ctx)
+		if err != nil {
+			return nil, err
+		}
+		username, err := usernameParam.ValueOrAsk(ctx)
+		if err != nil {
+			return nil, err
+		}
+		password, err := passwordParam.ValueOrAsk(ctx)
+		if err != nil {
+			return nil, err
+		}
+		slog.Debug("log in to CF using credentials", "url", apiUrl, "username", username)
+		return config.New(apiUrl, config.UserPassword(username, password))
+	}
+}

cmd/exporter/cf/guidname/guidname.go

@@ -0,0 +1,56 @@
+package guidname
+
+import (
+	"fmt"
+	"regexp"
+
+	"github.com/SAP/xp-clifford/erratt"
+)
+
+type Name struct {
+	Name string
+	GUID string
+}
+
+func NewName(guid, name string) *Name {
+	return &Name{
+		Name: name,
+		GUID: guid,
+	}
+}
+
+func (n *Name) String() string {
+	return fmt.Sprintf("%s - [%s]", n.Name, n.GUID)
+}
+
+var nameRx = regexp.MustCompile(`(.*) - \[(.*)\]`)
+
+func ParseName(s string) (*Name, error) {
+	parsed := nameRx.FindStringSubmatch(s)
+	switch len(parsed) {
+	case 0:
+		return &Name{
+			Name: fmt.Sprintf("^%s$", s),
+			GUID: s,
+		}, nil
+	case 3:
+		return &Name{
+			Name: fmt.Sprintf("^%s$", parsed[1]),
+			GUID: parsed[2],
+		}, nil
+	default:
+		return nil, erratt.New("guidname cannot be be parsed", "name", s, "len", len(parsed))
+	}
+}
+
+func CollectNames(guidNames []string) ([]string, error) {
+	names := make([]string, len(guidNames))
+	for i, guidName := range guidNames {
+		name, err := ParseName(guidName)
+		if err != nil {
+			return nil, err
+		}
+		names[i] = name.Name
+	}
+	return names, nil
+}

cmd/exporter/cf/org/convert.go

@@ -0,0 +1,43 @@
+package org
+
+import (
+	"log/slog"
+
+	"github.com/SAP/crossplane-provider-cloudfoundry/apis/resources/v1alpha1"
+
+	"github.com/SAP/xp-clifford/yaml"
+	v1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func convertOrgResource(org *res) *yaml.ResourceWithComment {
+	slog.Debug("converting org", "name", org.GetName())
+	o := yaml.NewResourceWithComment(
+		&v1alpha1.Organization{
+			TypeMeta: metav1.TypeMeta{
+				Kind:       v1alpha1.Org_Kind,
+				APIVersion: v1alpha1.CRDGroupVersion.String(),
+			},
+			ObjectMeta: metav1.ObjectMeta{
+				Name: org.GetName(),
+				Annotations: map[string]string{
+					"crossplane.io/external-name": org.GetGUID(),
+				},
+			},
+			Spec: v1alpha1.OrgSpec{
+				ResourceSpec: v1.ResourceSpec{
+					ManagementPolicies: []v1.ManagementAction{
+						v1.ManagementActionObserve,
+					},
+				},
+				ForProvider: v1alpha1.OrgParameters{
+					Annotations: org.Metadata.Annotations,
+					Labels:      org.Metadata.Labels,
+					Name:        org.Name,
+					Suspended:   &org.Suspended,
+				},
+			},
+		})
+	o.CloneComment(org)
+	return o
+}