Add support for nested objects in output

Signed-off-by: Brian Dwyer <brian.dwyer@broadridge.com>
upbound · May 10, 2023 · 4c76309 · 4c76309
1 parent b73df0b
commit 4c76309
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ spec:
     source: Inline
     module: |
       // All outputs are written to the connection secret.  Non-sensitive outputs
-      // are stored as string values in the status.atProvider.outputs object.
+      // are stored in the status.atProvider.outputs object.
       output "url" {
         value       = google_storage_bucket.example.self_link
       }

diff --git a/apis/v1beta1/workspace_types.go b/apis/v1beta1/workspace_types.go
@@ -18,6 +18,7 @@ package v1beta1
 
 import (
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
+	extensionsV1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	runtime "k8s.io/apimachinery/pkg/runtime"
 )
@@ -134,8 +135,8 @@ type WorkspaceParameters struct {
 
 // WorkspaceObservation are the observable fields of a Workspace.
 type WorkspaceObservation struct {
-	Checksum string            `json:"checksum,omitempty"`
-	Outputs  map[string]string `json:"outputs,omitempty"`
+	Checksum string                       `json:"checksum,omitempty"`
+	Outputs  map[string]extensionsV1.JSON `json:"outputs,omitempty"`
 }
 
 // A WorkspaceSpec defines the desired state of a Workspace.

diff --git a/apis/v1beta1/zz_generated.deepcopy.go b/apis/v1beta1/zz_generated.deepcopy.go
diff --git a/internal/controller/workspace/workspace.go b/internal/controller/workspace/workspace.go
@@ -28,6 +28,7 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/afero"
 	corev1 "k8s.io/api/core/v1"
+	extensionsV1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/types"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -474,14 +475,12 @@ func op2cd(o []terraform.Output) managed.ConnectionDetails {
 // workspace_type.Workspace.
 func generateWorkspaceObservation(op []terraform.Output) v1beta1.WorkspaceObservation {
 	wo := v1beta1.WorkspaceObservation{
-		Outputs: make(map[string]string, len(op)),
+		Outputs: make(map[string]extensionsV1.JSON, len(op)),
 	}
 	for _, o := range op {
 		if !o.Sensitive {
-			if o.Type == terraform.OutputTypeString {
-				wo.Outputs[o.Name] = o.StringValue()
-			} else if j, err := o.JSONValue(); err == nil {
-				wo.Outputs[o.Name] = string(j)
+			if j, err := o.JSONValue(); err == nil {
+				wo.Outputs[o.Name] = extensionsV1.JSON{Raw: j}
 			}
 		}
 	}

diff --git a/internal/controller/workspace/workspace_test.go b/internal/controller/workspace/workspace_test.go
@@ -27,6 +27,7 @@ import (
 	"github.com/pkg/errors"
 	"github.com/spf13/afero"
 	corev1 "k8s.io/api/core/v1"
+	extensionsV1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	runtime "k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
@@ -999,8 +1000,8 @@ func TestObserve(t *testing.T) {
 				},
 				wo: v1beta1.WorkspaceObservation{
 					Checksum: tfChecksum,
-					Outputs: map[string]string{
-						"string": "",
+					Outputs: map[string]extensionsV1.JSON{
+						"string": {Raw: []byte("")},
 					},
 				},
 			},
@@ -1042,8 +1043,8 @@ func TestObserve(t *testing.T) {
 				},
 				wo: v1beta1.WorkspaceObservation{
 					Checksum: tfChecksum,
-					Outputs: map[string]string{
-						"string": "",
+					Outputs: map[string]extensionsV1.JSON{
+						"string": {Raw: []byte("")},
 					},
 				},
 			},
@@ -1265,8 +1266,8 @@ func TestCreate(t *testing.T) {
 					},
 				},
 				wo: v1beta1.WorkspaceObservation{
-					Outputs: map[string]string{
-						"object": "null",
+					Outputs: map[string]extensionsV1.JSON{
+						"object": {Raw: []byte("null")},
 					},
 				},
 			},

diff --git a/package/crds/tf.upbound.io_workspaces.yaml b/package/crds/tf.upbound.io_workspaces.yaml
@@ -365,7 +365,7 @@ spec:
                     type: string
                   outputs:
                     additionalProperties:
-                      type: string
+                      x-kubernetes-preserve-unknown-fields: true
                     type: object
                 type: object
               conditions: