feat(cli): include status conditions in output of render command

Signed-off-by: Jared Watts <[email protected]>

Author: jbw976

cmd/crank/render/cmd.go

@@ -44,14 +44,15 @@ type Cmd struct {
 	Functions         string `arg:"" help:"A YAML file or directory of YAML files specifying the Composition Functions to use to render the XR." type:"path"`
 
 	// Flags. Keep them in alphabetical order.
-	ContextFiles           map[string]string `help:"Comma-separated context key-value pairs to pass to the Function pipeline. Values must be files containing JSON."                           mapsep:""`
-	ContextValues          map[string]string `help:"Comma-separated context key-value pairs to pass to the Function pipeline. Values must be JSON. Keys take precedence over --context-files." mapsep:""`
-	IncludeFunctionResults bool              `help:"Include informational and warning messages from Functions in the rendered output as resources of kind: Result."                            short:"r"`
-	IncludeFullXR          bool              `help:"Include a direct copy of the input XR's spec and metadata fields in the rendered output."                                                  short:"x"`
-	ObservedResources      string            `help:"A YAML file or directory of YAML files specifying the observed state of composed resources."                                               placeholder:"PATH" short:"o"   type:"path"`
-	ExtraResources         string            `help:"A YAML file or directory of YAML files specifying extra resources to pass to the Function pipeline."                                       placeholder:"PATH" short:"e"   type:"path"`
-	IncludeContext         bool              `help:"Include the context in the rendered output as a resource of kind: Context."                                                                short:"c"`
-	FunctionCredentials    string            `help:"A YAML file or directory of YAML files specifying credentials to use for Functions to render the XR."                                      placeholder:"PATH" type:"path"`
+	ContextFiles            map[string]string `help:"Comma-separated context key-value pairs to pass to the Function pipeline. Values must be files containing JSON."                           mapsep:""`
+	ContextValues           map[string]string `help:"Comma-separated context key-value pairs to pass to the Function pipeline. Values must be JSON. Keys take precedence over --context-files." mapsep:""`
+	IncludeFunctionResults  bool              `help:"Include informational and warning messages from Functions in the rendered output as resources of kind: Result."                            short:"r"`
+	IncludeFullXR           bool              `help:"Include a direct copy of the input XR's spec and metadata fields in the rendered output."                                                  short:"x"`
+	IncludeStatusConditions bool              `help:"Include the status conditions in the rendered output as a resource of kind: Condition."                                                    short:"s"`
+	ObservedResources       string            `help:"A YAML file or directory of YAML files specifying the observed state of composed resources."                                               placeholder:"PATH" short:"o"   type:"path"`
+	ExtraResources          string            `help:"A YAML file or directory of YAML files specifying extra resources to pass to the Function pipeline."                                       placeholder:"PATH" short:"e"   type:"path"`
+	IncludeContext          bool              `help:"Include the context in the rendered output as a resource of kind: Context."                                                                short:"c"`
+	FunctionCredentials     string            `help:"A YAML file or directory of YAML files specifying credentials to use for Functions to render the XR."                                      placeholder:"PATH" type:"path"`
 
 	Timeout time.Duration `default:"1m" help:"How long to run before timing out."`
 
@@ -270,6 +271,15 @@ func (c *Cmd) Run(k *kong.Context, log logging.Logger) error { //nolint:gocognit
 		}
 	}
 
+	if c.IncludeStatusConditions {
+		for i := range out.Conditions {
+			_, _ = fmt.Fprintln(k.Stdout, "---")
+			if err := s.Encode(&out.Conditions[i], os.Stdout); err != nil {
+				return errors.Wrap(err, "cannot marshal condition to YAML")
+			}
+		}
+	}
+
 	if c.IncludeContext {
 		_, _ = fmt.Fprintln(k.Stdout, "---")
 		if err := s.Encode(out.Context, k.Stdout); err != nil {

cmd/crank/render/render.go

@@ -85,6 +85,7 @@ type Outputs struct {
 	ComposedResources []composed.Unstructured
 	Results           []unstructured.Unstructured
 	Context           *unstructured.Unstructured
+	Conditions        []unstructured.Unstructured
 
 	// TODO(negz): Allow returning desired XR connection details. Maybe as a
 	// Secret? Should we honor writeConnectionSecretToRef? What if secret stores
@@ -99,6 +100,15 @@ type RuntimeFunctionRunner struct {
 	mx       sync.Mutex
 }
 
+// A CompositionTarget is the target of a composition event or condition.
+type CompositionTarget string
+
+// Composition event and condition targets.
+const (
+	CompositionTargetComposite         CompositionTarget = "Composite"
+	CompositionTargetCompositeAndClaim CompositionTarget = "CompositeAndClaim"
+)
+
 // NewRuntimeFunctionRunner returns a FunctionRunner that runs functions
 // locally, using the runtime configured in their annotations (e.g. Docker). It
 // starts all the functions and creates gRPC connections when called.
@@ -207,6 +217,7 @@ func Render(ctx context.Context, log logging.Logger, in Inputs) (Outputs, error)
 	d := &fnv1.State{}
 
 	results := make([]unstructured.Unstructured, 0)
+	conditions := make([]unstructured.Unstructured, 0)
 
 	// The Function context starts empty.
 	fctx := &structpb.Struct{Fields: map[string]*structpb.Value{}}
@@ -271,6 +282,29 @@ func Render(ctx context.Context, log logging.Logger, in Inputs) (Outputs, error)
 		// We intentionally discard/ignore this after the last Function runs.
 		fctx = rsp.GetContext()
 
+		for _, c := range rsp.GetConditions() {
+			var status corev1.ConditionStatus
+			switch c.GetStatus() {
+			case fnv1.Status_STATUS_CONDITION_TRUE:
+				status = corev1.ConditionTrue
+			case fnv1.Status_STATUS_CONDITION_FALSE:
+				status = corev1.ConditionFalse
+			case fnv1.Status_STATUS_CONDITION_UNKNOWN, fnv1.Status_STATUS_CONDITION_UNSPECIFIED:
+				status = corev1.ConditionUnknown
+			}
+
+			conditions = append(conditions, unstructured.Unstructured{Object: map[string]any{
+				"apiVersion":         "render.crossplane.io/v1beta1",
+				"kind":               "Condition",
+				"type":               c.GetType(),
+				"status":             status,
+				"lastTransitionTime": metav1.Now(),
+				"reason":             xpv1.ConditionReason(c.GetReason()),
+				"message":            c.GetMessage(),
+				"target":             convertTarget(c.GetTarget()),
+			}})
+		}
+
 		// Results of fatal severity stop the Composition process.
 		for _, rs := range rsp.GetResults() {
 			switch rs.GetSeverity() { //nolint:exhaustive // We intentionally have a broad default case.
@@ -340,7 +374,7 @@ func Render(ctx context.Context, log logging.Logger, in Inputs) (Outputs, error)
 	xrCond.LastTransitionTime = metav1.NewTime(time.Date(2024, time.January, 1, 0, 0, 0, 0, time.UTC))
 	xr.SetConditions(xrCond)
 
-	out := Outputs{CompositeResource: xr, ComposedResources: desired, Results: results}
+	out := Outputs{CompositeResource: xr, ComposedResources: desired, Results: results, Conditions: conditions}
 	if fctx != nil {
 		out.Context = &unstructured.Unstructured{Object: map[string]any{
 			"apiVersion": "render.crossplane.io/v1beta1",
@@ -414,3 +448,10 @@ func (f *FilteringFetcher) Fetch(_ context.Context, rs *fnv1.ResourceSelector) (
 
 	return out, nil
 }
+
+func convertTarget(t fnv1.Target) CompositionTarget {
+	if t == fnv1.Target_TARGET_COMPOSITE_AND_CLAIM {
+		return CompositionTargetCompositeAndClaim
+	}
+	return CompositionTargetComposite
+}

cmd/crank/render/render_test.go

@@ -21,6 +21,7 @@ import (
 	"io"
 	"net"
 	"testing"
+	"time"
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
@@ -32,7 +33,9 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/utils/ptr"
 
+	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
 	"github.com/crossplane/crossplane-runtime/pkg/logging"
 	"github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/composed"
 	ucomposite "github.com/crossplane/crossplane-runtime/pkg/resource/unstructured/composite"
@@ -249,6 +252,15 @@ func TestRender(t *testing.T) {
 										},
 									},
 								},
+								Conditions: []*fnv1.Condition{
+									{
+										Type:    "ProvisioningSuccess",
+										Status:  fnv1.Status_STATUS_CONDITION_TRUE,
+										Reason:  "Provisioned",
+										Message: ptr.To("Provisioned successfully"),
+										Target:  fnv1.Target_TARGET_COMPOSITE_AND_CLAIM.Enum(),
+									},
+								},
 							})
 							listeners = append(listeners, lis)
 
@@ -349,6 +361,20 @@ func TestRender(t *testing.T) {
 							},
 						},
 					},
+					Conditions: []unstructured.Unstructured{
+						{
+							Object: map[string]any{
+								"apiVersion":         "render.crossplane.io/v1beta1",
+								"kind":               "Condition",
+								"type":               "ProvisioningSuccess",
+								"status":             corev1.ConditionTrue,
+								"reason":             xpv1.ConditionReason("Provisioned"),
+								"message":            "Provisioned successfully",
+								"target":             CompositionTargetCompositeAndClaim,
+								"lastTransitionTime": metav1.Now(),
+							},
+						},
+					},
 				},
 			},
 		},
@@ -745,7 +771,7 @@ func TestRender(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			out, err := Render(tc.args.ctx, logging.NewNopLogger(), tc.args.in)
 
-			if diff := cmp.Diff(tc.want.out, out, cmpopts.EquateEmpty()); diff != "" {
+			if diff := cmp.Diff(tc.want.out, out, cmpopts.EquateEmpty(), cmpopts.EquateApproxTime(time.Second)); diff != "" {
 				t.Errorf("%s\nRender(...): -want, +got:\n%s", tc.reason, diff)
 			}
 			if diff := cmp.Diff(tc.want.err, err, cmpopts.EquateErrors()); diff != "" {