feat: optionally generate outputs for tf promise (#220)

Author: kirederik

cmd/add_container.go

@@ -348,15 +348,6 @@ func getContainerIdx(pipeline v1alpha1.Pipeline, containerName string) int {
 	return -1
 }
 
-func supportedLanguage(language string) bool {
-	for _, sl := range supportedLanguages {
-		if sl == language {
-			return true
-		}
-	}
-	return false
-}
-
 func getTemplates(containerFileDirectory, containerScriptsDirectory, language string) map[string]string {
 	pipelineScriptFilename := pipelineScriptFilename(language)
 	pipelineScriptTemplateFilepath := fmt.Sprintf("templates/workflows/%s/%s.tpl", language, pipelineScriptFilename)

cmd/init_tf_module_promise.go

@@ -57,16 +57,24 @@ To pull modules from private registries, ensure your system is logged in to the
   	--group syntasso.io \
 	--kind IAM \
 	--version v1alpha1`,
-		RunE: InitFromTerraformModule,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if err := InitFromTerraformModule(cmd, args); err != nil {
+				fmt.Printf("Error: %s\n", err)
+				return err
+			}
+			return nil
+		},
 		Args: cobra.ExactArgs(1),
 	}
 
 	moduleSource, moduleRegistryVersion string
 	moduleProviders                     []string
+	generateOutputs                     bool
 )
 
 func init() {
 	initCmd.AddCommand(terraformModuleCmd)
+	terraformModuleCmd.SilenceUsage = true
 	terraformModuleCmd.Flags().StringVarP(&moduleSource, "module-source", "s", "", "Source of the terraform module. \n"+
 		"This can be a Git URL, Terraform registry path, or a local directory path. \n"+
 		"It follows the same format as the `source` argument in the Terraform module block.",
@@ -77,33 +85,31 @@ func init() {
 	terraformModuleCmd.Flags().StringSliceVarP(&moduleProviders, "module-providers", "", []string{}, "(Optional) the names of any files containing Terraform provider block; "+
 		"defaults to versions.tf and providers.tf",
 	)
+	terraformModuleCmd.Flags().BoolVarP(&generateOutputs, "generate-outputs", "", false, "(Optional) generate Terraform 'output' blocks for the module")
 	terraformModuleCmd.MarkFlagRequired("module-source")
 }
 
 func InitFromTerraformModule(cmd *cobra.Command, args []string) error {
 	fmt.Println("Fetching terraform module variables, this might take up to a minute...")
 
 	if moduleRegistryVersion != "" && !internal.IsTerraformRegistrySource(moduleSource) {
-		fmt.Println("Error: --module-registry-version is only valid for Terraform registry sources like 'namespace/name/provider'. For git URLs (e.g., 'git::https://github.com/org/repo.git?ref=v1.0.0') or local paths, embed the ref directly in --module-source instead.")
+		return fmt.Errorf("--module-registry-version is only valid for Terraform registry sources like 'namespace/name/provider'. For git URLs (e.g., 'git::https://github.com/org/repo.git?ref=v1.0.0') or local paths, embed the ref directly in --module-source instead.")
 	}
 
 	moduleDir, err := internal.SetupModule(moduleSource, moduleRegistryVersion)
 	if err != nil {
-		fmt.Printf("Error: failed to setup module : %s\n", err)
-		return nil
+		return fmt.Errorf("failed to setup module: %w", err)
 	}
 	defer os.RemoveAll(moduleDir)
 
 	variables, err := internal.GetVariablesFromModule(moduleSource, moduleDir, moduleRegistryVersion)
 	if err != nil {
-		fmt.Printf("Error: failed to download and convert terraform module to CRD: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to download and convert terraform module to CRD: %w", err)
 	}
 
 	versionProviderFilepaths, err := internal.GetVersionsAndProvidersFromModule(moduleSource, moduleDir, moduleRegistryVersion, moduleProviders)
 	if err != nil {
-		fmt.Printf("Error: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to get versions and providers from module: %w", err)
 	}
 
 	crdSpecSchema, warnings := internal.VariablesToCRDSpecSchema(variables)
@@ -113,22 +119,27 @@ func InitFromTerraformModule(cmd *cobra.Command, args []string) error {
 
 	crdSchema, err := yaml.Marshal(crdSpecSchema)
 	if err != nil {
-		fmt.Printf("Error: failed to marshal CRD schema: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to marshal CRD schema: %w", err)
+	}
+
+	var moduleOutputNames []string
+	if generateOutputs {
+		moduleOutputNames, err = internal.GetOutputsFromModule(moduleDir)
+		if err != nil {
+			return fmt.Errorf("failed to extract module outputs: %w", err)
+		}
 	}
 
-	resourceConfigure, err := generateTerraformModuleResourceConfigurePipeline(moduleRegistryVersion)
+	resourceConfigure, err := generateTerraformModuleResourceConfigurePipeline(moduleRegistryVersion, generateOutputs, moduleOutputNames)
 	if err != nil {
-		fmt.Printf("Error: failed to generate promise pipelines: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to generate promise pipelines: %w", err)
 	}
 
 	var promiseConfigure string
 	if len(versionProviderFilepaths) > 1 {
 		promiseConfigure, err = generateTerraformModulePromiseConfigurePipeline()
 		if err != nil {
-			fmt.Printf("Error: failed to generate promise configure pipelines: %s\n", err)
-			return nil
+			return fmt.Errorf("failed to generate promise configure pipelines: %w", err)
 		}
 	}
 
@@ -137,10 +148,12 @@ func InitFromTerraformModule(cmd *cobra.Command, args []string) error {
 	if moduleRegistryVersion != "" {
 		extraFlags = fmt.Sprintf("%s --module-registry-version %s", extraFlags, moduleRegistryVersion)
 	}
+	if generateOutputs {
+		extraFlags = fmt.Sprintf("%s --generate-outputs", extraFlags)
+	}
 	templateValues, err := generateTemplateValues(promiseName, "tf-module-promise", extraFlags, resourceConfigure, promiseConfigure, string(crdSchema))
 	if err != nil {
-		fmt.Printf("Error: failed to generate template values: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to generate template values: %w", err)
 	}
 	templateValues.DestinationSelectors = "- matchLabels:\n    environment: terraform"
 
@@ -159,21 +172,19 @@ func InitFromTerraformModule(cmd *cobra.Command, args []string) error {
 
 	err = templateFiles(promiseTemplates, outputDir, templates, templateValues)
 	if err != nil {
-		fmt.Printf("Error: failed to template files: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to template files: %w", err)
 	}
 
 	err = writeDependencyFiles(versionProviderFilepaths)
 	if err != nil {
-		fmt.Printf("error writing promise dependencies: %s\n", err)
-		return nil
+		return fmt.Errorf("failed to write promise dependencies: %w", err)
 	}
 
 	fmt.Println("Promise generated successfully. It is set to schedule to Destinations with the label `environment: terraform` by default. To modify this behavior, update the `.spec.destinationSelectors` field in `promise.yaml`")
 	return nil
 }
 
-func generateTerraformModuleResourceConfigurePipeline(moduleRegistryVersion string) (string, error) {
+func generateTerraformModuleResourceConfigurePipeline(moduleRegistryVersion string, generateOutputs bool, moduleOutputNames []string) (string, error) {
 	envs := []corev1.EnvVar{
 		{
 			Name:  "MODULE_SOURCE",
@@ -188,6 +199,13 @@ func generateTerraformModuleResourceConfigurePipeline(moduleRegistryVersion stri
 		})
 	}
 
+	if generateOutputs && len(moduleOutputNames) > 0 {
+		envs = append(envs, corev1.EnvVar{
+			Name:  "MODULE_OUTPUT_NAMES",
+			Value: strings.Join(moduleOutputNames, ","),
+		})
+	}
+
 	pipelines := []unstructured.Unstructured{
 		{
 			Object: map[string]any{

cmd/platform_get_resources.go

@@ -47,8 +47,6 @@ var platformGetResourcesCmd = &cobra.Command{
 	},
 }
 
-var k8sQuerier Fetcher
-
 func init() {
 	platformGetCmd.AddCommand(platformGetResourcesCmd)
 }
@@ -98,7 +96,7 @@ func (q K8sQuerier) GetRequests(ctx context.Context, gvr *schema.GroupVersionRes
 	if selector != "" {
 		listOptions.LabelSelector = selector
 	}
-	promiseRequests, err := q.dynamicClient.Resource(*gvr).Namespace(v1.NamespaceAll).List(ctx, v1.ListOptions{})
+	promiseRequests, err := q.dynamicClient.Resource(*gvr).Namespace(v1.NamespaceAll).List(ctx, listOptions)
 	if err != nil {
 		return nil, fmt.Errorf("error listing requests for %q: %w", promiseName, err)
 	}
@@ -173,37 +171,6 @@ func clientsFromFlags(cf *genericclioptions.ConfigFlags) (K8sQuerier, error) {
 	}, nil
 }
 
-func listAllKratixGVRs(crdClient apiextensionsclient.Interface) ([]schema.GroupVersionResource, error) {
-	ctx := context.Background()
-	crds, err := crdClient.
-		ApiextensionsV1().
-		CustomResourceDefinitions().
-		List(ctx, v1.ListOptions{LabelSelector: v1alpha1.PromiseNameLabel})
-	if err != nil {
-		return nil, fmt.Errorf("error listing promise CRDs: %w", err)
-	}
-
-	var out []schema.GroupVersionResource
-	for _, crd := range crds.Items {
-		var storageVersion string
-		for _, v := range crd.Spec.Versions {
-			if v.Storage {
-				storageVersion = v.Name
-				break
-			}
-		}
-		if storageVersion == "" {
-			continue
-		}
-		out = append(out, schema.GroupVersionResource{
-			Group:    crd.Spec.Group,
-			Version:  storageVersion,
-			Resource: crd.Spec.Names.Plural,
-		})
-	}
-	return out, nil
-}
-
 func initialiseQuerier(args []Fetcher) (Fetcher, error) {
 	if len(args) == 0 {
 		k8sQuerier, err := clientsFromFlags(configFlags)
@@ -289,33 +256,6 @@ func RenderTree(promiseName string, fetcher ...Fetcher) error {
 	return nil
 }
 
-func gvrForPromise(ctx context.Context, k8sClient client.Client, mapper meta.RESTMapper, promiseName string) (*schema.GroupVersionResource, error) {
-	promise := &v1alpha1.Promise{}
-	err := k8sClient.Get(ctx, types.NamespacedName{Name: promiseName}, promise)
-
-	if errors.IsNotFound(err) {
-		return nil, fmt.Errorf("promise: %s not found", promiseName)
-	}
-	if client.IgnoreNotFound(err) != nil {
-		return nil, fmt.Errorf("error getting promise: %s with error %q", promiseName, err)
-	}
-
-	if !promise.ContainsAPI() {
-		return nil, fmt.Errorf("promise: %s contains no API", promiseName)
-	}
-
-	gvk, _, apiErr := promise.GetAPI()
-	if apiErr != nil {
-		return nil, fmt.Errorf("error generating GVK from promise: %s with error %q", promiseName, apiErr)
-	}
-
-	gvr, err := buildGVR(mapper, gvk.Group, gvk.Version, gvk.Kind)
-	if err != nil {
-		return nil, fmt.Errorf("error generating GroupVersionResource: %q", err)
-	}
-	return &gvr, nil
-}
-
 func buildGVR(mapper meta.RESTMapper, group, version, resource string) (schema.GroupVersionResource, error) {
 	return mapper.ResourceFor(schema.GroupVersionResource{
 		Group:    group,

go.mod

@@ -9,8 +9,8 @@ require (
 	github.com/go-logr/stdr v1.2.2
 	github.com/hashicorp/hcl/v2 v2.23.0
 	github.com/mittwald/go-helm-client v0.12.10
-	github.com/onsi/ginkgo/v2 v2.27.2
-	github.com/onsi/gomega v1.38.2
+	github.com/onsi/ginkgo/v2 v2.28.1
+	github.com/onsi/gomega v1.39.0
 	github.com/spf13/cobra v1.10.1
 	github.com/syntasso/kratix v0.125.1-0.20250923144917-71691d914142
 	github.com/zclconf/go-cty v1.13.0
@@ -68,15 +68,14 @@ require (
 	github.com/google/btree v1.1.3 // indirect
 	github.com/google/gnostic-models v0.6.9 // indirect
 	github.com/google/go-cmp v0.7.0 // indirect
-	github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 // indirect
+	github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 // indirect
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/gorilla/websocket v1.5.4-0.20250319132907-e064f32e3674 // indirect
 	github.com/gosuri/uitable v0.0.4 // indirect
 	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
-	github.com/hashicorp/hcl v1.0.1-vault-7 // indirect
 	github.com/huandu/xstrings v1.5.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/jmoiron/sqlx v1.4.0 // indirect
@@ -121,17 +120,17 @@ require (
 	github.com/xlab/treeprint v1.2.0 // indirect
 	go.yaml.in/yaml/v2 v2.4.2 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
-	golang.org/x/crypto v0.45.0 // indirect
+	golang.org/x/crypto v0.47.0 // indirect
 	golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa // indirect
-	golang.org/x/mod v0.29.0 // indirect
-	golang.org/x/net v0.47.0 // indirect
+	golang.org/x/mod v0.32.0 // indirect
+	golang.org/x/net v0.49.0 // indirect
 	golang.org/x/oauth2 v0.30.0 // indirect
-	golang.org/x/sync v0.18.0 // indirect
-	golang.org/x/sys v0.38.0 // indirect
-	golang.org/x/term v0.37.0 // indirect
-	golang.org/x/text v0.31.0 // indirect
+	golang.org/x/sync v0.19.0 // indirect
+	golang.org/x/sys v0.40.0 // indirect
+	golang.org/x/term v0.39.0 // indirect
+	golang.org/x/text v0.33.0 // indirect
 	golang.org/x/time v0.12.0 // indirect
-	golang.org/x/tools v0.38.0 // indirect
+	golang.org/x/tools v0.41.0 // indirect
 	gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576 // indirect
 	google.golang.org/grpc v1.68.1 // indirect