Merge pull request #553 from ulucinar/prep-release-1.11

[Backport release-1.11] PR#533 PR#534 PR#538 PR#549 PR#551

Author: ulucinar

OWNERS.md

@@ -12,10 +12,10 @@ repository maintainers in their own `OWNERS.md` file.
 
 ## Maintainers
 
-* Alper Ulucinar <alper@upbound.com> ([ulucinar](https://github.com/ulucinar))
-* Sergen Yalcin <sergen@upbound.com> ([sergenyalcin](https://github.com/sergenyalcin))
-* Jean du Plessis <jean@upbound.com> ([jeanduplessis](https://github.com/jeanduplessis))
-* Erhan Cagirici <erhan@upbound.com> ([erhancagirici](https://github.com/erhancagirici))
-* Cem Mergenci <cem@upbound.com> ([mergenci](https://github.com/mergenci))
+* Alper Ulucinar <alper@upbound.io> ([ulucinar](https://github.com/ulucinar))
+* Sergen Yalcin <sergen@upbound.io> ([sergenyalcin](https://github.com/sergenyalcin))
+* Jean du Plessis <jean@upbound.io> ([jeanduplessis](https://github.com/jeanduplessis))
+* Erhan Cagirici <erhan@upbound.io> ([erhancagirici](https://github.com/erhancagirici))
+* Cem Mergenci <cem@upbound.io> ([mergenci](https://github.com/mergenci))
 
 See [CODEOWNERS](./CODEOWNERS) for automatic PR assignment.

pkg/config/externalname.go

@@ -7,6 +7,7 @@ package config
 import (
 	"bytes"
 	"context"
+	"fmt"
 	"regexp"
 	"strings"
 	"text/template"
@@ -210,6 +211,35 @@ func GetExternalNameFromTemplated(tmpl, val string) (string, error) { //nolint:g
 	return "", errors.Errorf("unhandled case with template %s and value %s", tmpl, val)
 }
 
+// FrameworkResourceWithComputedIdentifier returns an ExternalName
+// configuration for a Terraform plugin framework resource with the specified
+// computed identifier attribute and the specified placeholder identifier for
+// the initial external read calls.
+func FrameworkResourceWithComputedIdentifier(identifier, placeholder string) ExternalName {
+	en := NewExternalNameFrom(IdentifierFromProvider,
+		WithSetIdentifierArgumentsFn(func(fn SetIdentifierArgumentsFn, base map[string]any, externalName string) {
+			if id, ok := base[identifier]; !ok || id == placeholder {
+				if externalName == "" {
+					base[identifier] = placeholder
+				} else {
+					base[identifier] = externalName
+				}
+			}
+		}),
+		WithGetExternalNameFn(func(fn GetExternalNameFn, tfState map[string]any) (string, error) {
+			if id, ok := tfState[identifier]; ok {
+				idStr := fmt.Sprintf("%v", id)
+				if len(idStr) > 0 {
+					return idStr, nil
+				}
+			}
+			return "", errors.Errorf("cannot find attribute %q in tfstate", identifier)
+		}),
+	)
+	en.TFPluginFrameworkOptions.ComputedIdentifierAttributes = []string{identifier}
+	return en
+}
+
 // ExternalNameFrom is an ExternalName configuration which uses a parent
 // configuration as its base and modifies any of the GetIDFn,
 // GetExternalNameFn or SetIdentifierArgumentsFn. This enables us to reuse
@@ -276,7 +306,9 @@ func WithSetIdentifierArgumentsFn(fn func(fn SetIdentifierArgumentsFn, base map[
 //		return fn(ctx, externalName, parameters, terraformProviderConfig)
 //	}))
 func NewExternalNameFrom(parent ExternalName, opts ...ExternalNameFromOption) ExternalName {
-	ec := &ExternalNameFrom{}
+	ec := &ExternalNameFrom{
+		ExternalName: parent,
+	}
 	for _, o := range opts {
 		o(ec)
 	}

pkg/config/provider.go

@@ -52,7 +52,11 @@ func (cc ResourceConfiguratorChain) Configure(r *Resource) {
 type BasePackages struct {
 	APIVersion []string
 	// Deprecated: Use ControllerMap instead.
-	Controller    []string
+	Controller []string
+	// ControllerMap is a map from:
+	// <API group name>/<resource name> to <provider package name>.
+	// An example is "azure/resourcegroup: config", where "config" represents
+	// the config package (provider family package).
 	ControllerMap map[string]string
 }
 

pkg/config/resource.go

@@ -165,6 +165,20 @@ type ExternalName struct {
 	// management policy is including the Observe Only, different from other
 	// (required) fields.
 	IdentifierFields []string
+
+	// TFPluginFrameworkOptions represents options related to Terraform plugin
+	// framework resources.
+	TFPluginFrameworkOptions TFPluginFrameworkOptions
+}
+
+// TFPluginFrameworkOptions are external-name configuration options that
+// are specific to Terraform plugin framework resources.
+type TFPluginFrameworkOptions struct {
+	// ComputedIdentifierAttributes is the list of computed Terraform identifier
+	// attribute names for a framework resource. When set,
+	// these computed identifier attributes will be ignored from the desired
+	// state when calculating the drifts between the desired and actual states.
+	ComputedIdentifierAttributes []string
 }
 
 // References represents reference resolver configurations for the fields of a

pkg/controller/external_tfpluginfw.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"maps"
 	"math"
 	"math/big"
 	"strings"
@@ -18,7 +19,6 @@ import (
 	"github.com/crossplane/crossplane-runtime/pkg/meta"
 	"github.com/crossplane/crossplane-runtime/pkg/reconciler/managed"
 	xpresource "github.com/crossplane/crossplane-runtime/pkg/resource"
-	fwdiag "github.com/hashicorp/terraform-plugin-framework/diag"
 	fwprovider "github.com/hashicorp/terraform-plugin-framework/provider"
 	"github.com/hashicorp/terraform-plugin-framework/providerserver"
 	fwresource "github.com/hashicorp/terraform-plugin-framework/resource"
@@ -35,6 +35,7 @@ import (
 	"github.com/crossplane/upjet/pkg/resource"
 	upjson "github.com/crossplane/upjet/pkg/resource/json"
 	"github.com/crossplane/upjet/pkg/terraform"
+	tferrors "github.com/crossplane/upjet/pkg/terraform/errors"
 )
 
 // TerraformPluginFrameworkConnector is an external client, with credentials and
@@ -189,8 +190,7 @@ func (c *TerraformPluginFrameworkConnector) getResourceSchema(ctx context.Contex
 	schemaResp := &fwresource.SchemaResponse{}
 	res.Schema(ctx, fwresource.SchemaRequest{}, schemaResp)
 	if schemaResp.Diagnostics.HasError() {
-		fwErrors := frameworkDiagnosticsToString(schemaResp.Diagnostics)
-		return rschema.Schema{}, errors.Errorf("could not retrieve resource schema: %s", fwErrors)
+		return rschema.Schema{}, tferrors.FrameworkDiagnosticsError("could not retrieve resource schema", schemaResp.Diagnostics)
 	}
 
 	return schemaResp.Schema, nil
@@ -209,8 +209,7 @@ func (c *TerraformPluginFrameworkConnector) configureProvider(ctx context.Contex
 	var schemaResp fwprovider.SchemaResponse
 	ts.FrameworkProvider.Schema(ctx, fwprovider.SchemaRequest{}, &schemaResp)
 	if schemaResp.Diagnostics.HasError() {
-		fwDiags := frameworkDiagnosticsToString(schemaResp.Diagnostics)
-		return nil, fmt.Errorf("cannot retrieve provider schema: %s", fwDiags)
+		return nil, tferrors.FrameworkDiagnosticsError("cannot retrieve provider schema", schemaResp.Diagnostics)
 	}
 	providerServer := providerserver.NewProtocol5(ts.FrameworkProvider)()
 
@@ -254,15 +253,20 @@ func (n *terraformPluginFrameworkExternalClient) filteredDiffExists(rawDiff []tf
 // If plan response contains non-empty RequiresReplace (i.e. the resource needs
 // to be recreated) an error is returned as Crossplane Resource Model (XRM)
 // prohibits resource re-creations and rejects this plan.
-func (n *terraformPluginFrameworkExternalClient) getDiffPlanResponse(ctx context.Context,
-	tfStateValue tftypes.Value) (*tfprotov5.PlanResourceChangeResponse, bool, error) {
-	tfConfigDynamicVal, err := protov5DynamicValueFromMap(n.params, n.resourceValueTerraformType)
+func (n *terraformPluginFrameworkExternalClient) getDiffPlanResponse(ctx context.Context, tfStateValue tftypes.Value) (*tfprotov5.PlanResourceChangeResponse, bool, error) {
+	params := maps.Clone(n.params)
+	// if some computed identifiers have been configured,
+	// remove them from config.
+	for _, id := range n.config.ExternalName.TFPluginFrameworkOptions.ComputedIdentifierAttributes {
+		delete(params, id)
+	}
+	tfConfigDynamicVal, err := protov5DynamicValueFromMap(params, n.resourceValueTerraformType)
 	if err != nil {
 		return nil, false, errors.Wrap(err, "cannot construct dynamic value for TF Config")
 	}
 
 	//
-	tfPlannedStateDynamicVal, err := protov5DynamicValueFromMap(n.params, n.resourceValueTerraformType)
+	tfPlannedStateDynamicVal, err := protov5DynamicValueFromMap(params, n.resourceValueTerraformType)
 	if err != nil {
 		return nil, false, errors.Wrap(err, "cannot construct dynamic value for TF Planned State")
 	}
@@ -708,18 +712,6 @@ func getFatalDiagnostics(diags []*tfprotov5.Diagnostic) error {
 	return errs
 }
 
-// frameworkDiagnosticsToString constructs an error string from the provided
-// Plugin Framework diagnostics instance. Only Error severity diagnostics are
-// included.
-func frameworkDiagnosticsToString(fwdiags fwdiag.Diagnostics) string {
-	frameworkErrorDiags := fwdiags.Errors()
-	diagErrors := make([]string, 0, len(frameworkErrorDiags))
-	for _, tfdiag := range frameworkErrorDiags {
-		diagErrors = append(diagErrors, fmt.Sprintf("%s: %s", tfdiag.Summary(), tfdiag.Detail()))
-	}
-	return strings.Join(diagErrors, "\n")
-}
-
 // protov5DynamicValueFromMap constructs a protov5 DynamicValue given the
 // map[string]any using the terraform type as reference.
 func protov5DynamicValueFromMap(data map[string]any, terraformType tftypes.Type) (*tfprotov5.DynamicValue, error) {

pkg/examples/conversion/example_conversions.go

@@ -23,12 +23,12 @@ import (
 	"github.com/crossplane/upjet/pkg/config/conversion"
 )
 
-// ConvertSingletonListToEmbeddedObject generates the example manifests for
-// the APIs with converted singleton lists in their new API versions with the
-// embedded objects. All manifests under `startPath` are scanned and the
+// ApplyAPIConverters applies the registered converters to generated
+// example manifests under the given root directory.
+// All (generated) manifests under the `startPath` are scanned and the
 // header at the specified path `licenseHeaderPath` is used for the converted
 // example manifests.
-func ConvertSingletonListToEmbeddedObject(pc *config.Provider, startPath, licenseHeaderPath string) error {
+func ApplyAPIConverters(pc *config.Provider, startPath, licenseHeaderPath string) error {
 	resourceRegistry := prepareResourceRegistry(pc)
 
 	var license string
@@ -64,15 +64,15 @@ func ConvertSingletonListToEmbeddedObject(pc *config.Provider, startPath, licens
 				return nil
 			}
 
-			newPath := strings.ReplaceAll(path, examples[0].GroupVersionKind().Version, rootResource.Version)
-			if path == newPath {
-				return nil
-			}
 			annotationValue := strings.ToLower(fmt.Sprintf("%s/%s/%s", rootResource.ShortGroup, rootResource.Version, rootResource.Kind))
 			for _, e := range examples {
 				if resource, ok := resourceRegistry[fmt.Sprintf("%s/%s", e.GroupVersionKind().Kind, e.GroupVersionKind().Group)]; ok {
 					conversionPaths := resource.CRDListConversionPaths()
-					if conversionPaths != nil && e.GroupVersionKind().Version != resource.Version {
+					// if the latest version has conversions, run the conversions on the
+					// example manifest.
+					// Please note that only the version being generated (latest version)
+					// is processed.
+					if conversionPaths != nil && e.GroupVersionKind().Version == resource.Version {
 						for i, cp := range conversionPaths {
 							// Here, for the manifests to be converted, only `forProvider
 							// is converted, assuming the `initProvider` field is empty in the
@@ -100,7 +100,7 @@ func ConvertSingletonListToEmbeddedObject(pc *config.Provider, startPath, licens
 				}
 			}
 			convertedFileContent = license + "\n\n"
-			if err := writeExampleContent(path, convertedFileContent, examples, newPath); err != nil {
+			if err := writeExampleContent(path, convertedFileContent, examples, path); err != nil {
 				return errors.Wrap(err, "failed to write example content")
 			}
 		}

pkg/pipeline/run.go

@@ -102,6 +102,7 @@ func Run(pc *config.Provider, rootDir string) { //nolint:gocyclo
 				panic(errors.Wrapf(err, "cannot insert type definitions from the previous versions into the package scope for group %q", group))
 			}
 
+			modulePathControllers := filepath.Join(pc.ModulePath, "internal", "controller")
 			for _, name := range sortedResources(resources) {
 				paramTypeName, err := crdGen.Generate(resources[name])
 				if err != nil {
@@ -125,7 +126,11 @@ func Run(pc *config.Provider, rootDir string) { //nolint:gocyclo
 					panic(errors.Wrapf(err, "cannot generate controller for resource %s", name))
 				}
 				controllerPkgMap[shortGroup] = append(controllerPkgMap[shortGroup], ctrlPkgPath)
-				controllerPkgMap[config.PackageNameMonolith] = append(controllerPkgMap[config.PackageNameMonolith], ctrlPkgPath)
+				// if the controller is not already added as a base package controller
+				// to the monolith provider.
+				if len(pc.BasePackages.ControllerMap[strings.TrimPrefix(ctrlPkgPath, strings.TrimSuffix(modulePathControllers, "/")+"/")]) == 0 {
+					controllerPkgMap[config.PackageNameMonolith] = append(controllerPkgMap[config.PackageNameMonolith], ctrlPkgPath)
+				}
 				if err := exampleGen.Generate(group, version, resources[name]); err != nil {
 					panic(errors.Wrapf(err, "cannot generate example manifest for resource %s", name))
 				}

pkg/terraform/errors/fw_diag.go

@@ -0,0 +1,51 @@
+// SPDX-FileCopyrightText: 2025 The Crossplane Authors <https://crossplane.io>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package errors
+
+import (
+	"strings"
+
+	"github.com/crossplane/crossplane-runtime/pkg/errors"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+)
+
+// FrameworkDiagnosticsError returns an error representing
+// the collected diagnostics at SeverityError level.
+func FrameworkDiagnosticsError(parentMessage string, diags diag.Diagnostics) error {
+	eds := diags.Errors()
+	if len(eds) == 0 {
+		return nil
+	}
+
+	errs := make([]error, 0, len(eds)+1)
+	errs = append(errs, errors.New(parentMessage))
+	for _, d := range eds {
+		errs = append(errs, errors.New(frameworkDiagnosticString(d)))
+	}
+	return errors.Join(errs...)
+}
+
+// frameworkDiagnosticString formats the given framework Diagnostic
+// as a string <summary>[: <detail>][: <path>].
+func frameworkDiagnosticString(d diag.Diagnostic) string {
+	var msg strings.Builder
+	msg.WriteString(strings.TrimSpace(d.Summary()))
+
+	detail := strings.TrimSpace(d.Detail())
+	if detail != "" {
+		msg.WriteString(": ")
+		msg.WriteString(detail)
+	}
+
+	if p, ok := d.(diag.DiagnosticWithPath); ok {
+		wp := strings.TrimSpace(p.Path().String())
+		if wp != "" {
+			msg.WriteString(": ")
+			msg.WriteString(wp)
+		}
+	}
+
+	return msg.String()
+}