feat(exporter): add Cloud Foundry App resource export support by gergely-szabo-sap · Pull Request #232 · SAP/crossplane-provider-cloudfoundry

gergely-szabo-sap · 2026-03-23T14:28:12Z

Summary

This PR adds support for exporting Cloud Foundry applications to Crossplane App resources. It enables users to migrate
existing CF apps to Crossplane-managed infrastructure.

Changes

feat(exporter): adding App resource (8e47b3e)
- Implement cmd/exporter/cf/app/ package with full App export functionality
- app.go: Core export logic with org/space filtering and name pattern matching
- convert.go: CF App manifest to Crossplane App CR conversion
- manifest.go: CF API manifest fetching and parsing
- secret.go: Docker credential secret generation
- Register app export in cmd/exporter/main.go
test(exporter): add unit tests for convertAppResource helpers (32e611b)
- TestConvertDockerField: Docker config conversion with/without credentials
- TestConvertProcessesField: Process configuration conversion (nil, empty, single, multiple)
- TestGenerateDockerCredentialSecret: Secret generation validation
docs(exporter): add documentation comments to app export package (6a413f1)
- Package-level documentation
- Function documentation for all exported and internal functions
chore(clifford): bumping xp-clifford dependency (80ee652)
- Update github.com/SAP/xp-clifford to latest version

Technical Details

The App exporter:

Fetches apps from CF API filtered by org/space GUIDs
Supports regex pattern matching for app names
Converts CF app manifests to Crossplane App resources
Handles Docker lifecycle apps with credential secrets
Supports process configuration (web, worker, etc.)
Includes health check configuration conversion
Resolves space references when resolveReferences is enabled

Testing

Unit tests added for conversion helper functions
All tests pass: make reviewable ✅

ikhandamirov

Looks good. Just a few remarks. Please feel free to overrule.

ikhandamirov · 2026-03-23T16:54:06Z

+				},
+			},
+			ForProvider: v1alpha1.AppParameters{
+				Name:      app.GetName(),


Is this correct to sanitize the name? Or should it be the original one from CF?

The CF name may not conform to the Kubernetes naming requirements. That's why it needs to be sanitized, IMO.

But it is not a name of a Kubernetes resource, is it? Isn't it just a forProvider field unrelated to k8s?

you're right, it is being fixed

ikhandamirov · 2026-03-23T16:57:23Z

+				appWithComment.AddComment(err.Error())
+			}
+		}
+		managedApp.Spec.ForProvider.NoRoute = appManifest.NoRoute


appManifest could be nil, as getAppManifest returns nil, nil in some cases.

You're right, this needs to be treated.

ikhandamirov · 2026-03-23T17:00:31Z

+	"context"
+	"log/slog"
+
+	// kyaml "sigs.k8s.io/yaml"


Minor: is this comment needed / intentional? Are you sure you don't want to use this package?

Thank you, it's a leftover comment.

ikhandamirov · 2026-03-23T17:00:44Z

+// type docker struct {
+// 	Image string `json:"image"`
+// 	Username *string `json:"username,omitempty"`
+// }
+
+// type application struct {
+// 	Name string `json:"name"`
+// 	Docker *docker `json:"docker,omitempty"`
+// }
+
+// type manifest struct {
+// 	Applications []application `json:"applications"`
+// }


Minor: is this comment needed?

Thank you, it's a leftover comment.

ikhandamirov · 2026-03-23T17:07:26Z

+			Command:   &process.Command,
+			DiskQuota: &process.DiskQuota,
+			Instances: process.Instances,
+			Memory:    &process.Memory,
+			Timeout:   &process.Timeout,
+			HealthCheckConfiguration: v1alpha1.HealthCheckConfiguration{
+				HealthCheckType:              (*string)(&process.HealthCheckType),
+				HealthCheckHTTPEndpoint:      &process.HealthCheckHTTPEndpoint,
+				HealthCheckInterval:          &process.HealthCheckInterval,
+				HealthCheckInvocationTimeout: &process.HealthCheckInvocationTimeout,


Command: &process.Command, DiskQuota: &process.DiskQuota, Memory: &process.Memory, Timeout: &process.Timeout, HealthCheckHTTPEndpoint: &process.HealthCheckHTTPEndpoint, HealthCheckInterval: &process.HealthCheckInterval, HealthCheckInvocationTimeout: &process.HealthCheckInvocationTimeout,

They will always be non-nil in the output even when the CF API returned no value (empty string, zero). This differs from the CRD field definitions which are Optional and pointer-typed precisely so they can be omitted. Downstream, the controller will see these as explicitly set and may send unnecessary update calls.

ikhandamirov · 2026-03-23T17:10:28Z

+			ReadinessHealthCheckType:              &appManifest.ReadinessHealthCheckType,
+			ReadinessHealthCheckHTTPEndpoint:      &appManifest.ReadinessHealthCheckHttpEndpoint,
+			ReadinessHealthCheckInterval:          &appManifest.ReadinessHealthCheckInterval,
+			ReadinessHealthCheckInvocationTimeout: &appManifest.ReadinessHealthInvocationTimeout,


Same as above. They will always be non-nil in the output even when the CF API returned no value (empty string, zero). This differs from the CRD field definitions which are Optional and pointer-typed precisely so they can be omitted. Downstream, the controller will see these as explicitly set and may send unnecessary update calls.

ikhandamirov · 2026-03-23T17:19:39Z

+					t.Errorf("expected comment to be added to secret")
+				}
+			},
+		},


Minor: would it make sense to test edge cases like empty secret or user name?

… documentation Add convertProcessConfiguration function to handle individual process conversion from CF manifest to Crossplane ProcessConfiguration. This extracts the process conversion logic into a separate, testable function. Changes: - convert.go: Add convertProcessConfiguration() helper, refactor convertProcessesField() to use the new helper, add documentation comments to convertProcessConfiguration and convertReadinessHealthCheckConfiguration - convert_test.go: Add TestConvertProcessConfiguration with test cases: * process_with_all_fields_set * process_with_only_required_fields * process_with_partial_fields * Also includes TestConvertReadinessHealthCheckConfiguration tests - manifest.go: Clean up commented code The new helper conditionally sets fields only when they have non-zero values, using nil pointers for omitted fields.

Add test cases covering empty username, empty secret name, and both empty to improve coverage of the docker credential secret generation.

Update version and vendorHash in config.nix.

Replace `app.GetName()` with `app.Name` in `convertAppResource`.

Modified-by: gergely-szabo-sap <gergely.szabo@sap.com>

gergely-szabo-sap temporarily deployed to pr-e2e-approval March 23, 2026 14:28 — with GitHub Actions Inactive

gergely-szabo-sap marked this pull request as ready for review March 23, 2026 15:03

gergely-szabo-sap self-assigned this Mar 23, 2026

gergely-szabo-sap requested a review from ikhandamirov March 23, 2026 15:51

gergely-szabo-sap had a problem deploying to pr-e2e-approval March 23, 2026 15:58 — with GitHub Actions Failure

ikhandamirov reviewed Mar 23, 2026

View reviewed changes

gergely-szabo-sap force-pushed the feat/export-apps branch from 68c3812 to db4fc7e Compare March 24, 2026 11:36

gergely-szabo-sap temporarily deployed to pr-e2e-approval March 24, 2026 11:36 — with GitHub Actions Inactive

gergely-szabo-sap requested a review from ikhandamirov March 27, 2026 09:24

gergely-szabo-sap force-pushed the feat/export-apps branch from db4fc7e to 84c52f4 Compare March 30, 2026 09:30

gergely-szabo-sap temporarily deployed to pr-e2e-approval March 30, 2026 09:30 — with GitHub Actions Inactive

gergely-szabo-sap temporarily deployed to pr-e2e-approval March 30, 2026 10:30 — with GitHub Actions Inactive

gergely-szabo-sap linked an issue Mar 30, 2026 that may be closed by this pull request

[FEATURE] Extend the CF export tool that it supports all resource types #120

Closed

gergely-szabo-sap force-pushed the feat/export-apps branch from a8155ac to 64de474 Compare April 27, 2026 12:28

gergely-szabo-sap requested a deployment to pr-e2e-approval April 27, 2026 12:28 — with GitHub Actions Waiting

gergely-szabo-sap requested a deployment to pr-e2e-approval April 27, 2026 12:35 — with GitHub Actions Waiting

gergely-szabo-sap requested a deployment to pr-e2e-approval April 27, 2026 14:08 — with GitHub Actions Waiting

gergely-szabo-sap requested a deployment to pr-e2e-approval April 27, 2026 14:54 — with GitHub Actions Waiting

gergely-szabo-sap requested a deployment to pr-e2e-approval April 27, 2026 15:09 — with GitHub Actions Waiting

gergely-szabo-sap requested a deployment to pr-e2e-approval April 27, 2026 15:23 — with GitHub Actions Waiting

gergely-szabo-sap added 10 commits April 27, 2026 17:41

feat(exporter): adding App resource

8375cf8

chore(clifford): bumping xp-clifford dependency

6e3be73

test(exporter): add unit tests for convertAppResource helpers

215b604

docs(exporter): add documentation comments to app export package

a85899e

doc(export): Update USERGUIDE with App resource

3304d88

test: add edge cases for GenerateDockerCredentialSecret

f680ebf

Add test cases covering empty username, empty secret name, and both empty to improve coverage of the docker credential secret generation.

build(xpcf): bump exporter-cli to 0.0.1-alpha2

557cbde

Update version and vendorHash in config.nix.

refactor(cf): use direct struct field for app name

9d7855a

Replace `app.GetName()` with `app.Name` in `convertAppResource`.

(build): updating nix flakes

6e7545d

Modified-by: gergely-szabo-sap <gergely.szabo@sap.com>

gergely-szabo-sap added 4 commits April 27, 2026 17:41

build: update vendor hash for export CLI

17fcf0a

ci: fix submodule-path of docs testing workflow

4717d05

fix: invalid doc references

9344dcd

fix: invalid doc references

a68cc3f

gergely-szabo-sap force-pushed the feat/export-apps branch from 69192b5 to a68cc3f Compare April 27, 2026 15:42

gergely-szabo-sap deployed to pr-e2e-approval April 27, 2026 15:42 — with GitHub Actions Active

gergely-szabo-sap merged commit 31b654f into main Apr 27, 2026
14 checks passed

gergely-szabo-sap deleted the feat/export-apps branch April 27, 2026 16:13

Conversation

gergely-szabo-sap commented Mar 23, 2026

Summary

Changes

Technical Details

Testing

Uh oh!

ikhandamirov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants