Merge pull request #106 from bdwyertech/output-map

Add support for nested objects in output

Makefile

@@ -11,7 +11,9 @@ PLATFORMS ?= linux_amd64 linux_arm64
 
 # Setup Go
 NPROCS ?= 1
-GOLANGCILINT_VERSION ?= 1.50.0
+# GOLANGCILINT_VERSION is inherited from build submodule by default.
+# Uncomment below if you need to override the version.
+# GOLANGCILINT_VERSION ?= 1.50.0
 GO_TEST_PARALLEL := $(shell echo $$(( $(NPROCS) / 2 )))
 GO_STATIC_PACKAGES = $(GO_PROJECT)/cmd/provider
 GO_LDFLAGS += -X $(GO_PROJECT)/pkg/version.Version=$(VERSION)
@@ -22,9 +24,10 @@ GO111MODULE = on
 # ====================================================================================
 # Setup Kubernetes tools
 
-KIND_VERSION = v0.15.0
-UP_VERSION = v0.14.0
-UP_CHANNEL = stable
+# Uncomment below to override the versions from the build module
+# KIND_VERSION = v0.15.0
+# UP_VERSION = v0.14.0
+# UP_CHANNEL = stable
 UPTEST_VERSION = v0.5.0
 -include build/makelib/k8s_tools.mk
 

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
       }

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.

examples/workspace-inline-aws.yaml

@@ -21,8 +21,11 @@ spec:
       output "vpc_id" {
         value       = aws_vpc.main.id
       }
-      output "subnet_id" {
-        value       = aws_subnet.main.id
+      output "subnet_data" {
+        value = {
+          "id" = aws_subnet.main.id
+          "arn" = aws_subnet.main.arn
+        }
       }
       variable "vpcName" {
         description = "VPC name"

go.mod

@@ -15,6 +15,7 @@ require (
 	golang.org/x/sync v0.1.0
 	gopkg.in/alecthomas/kingpin.v2 v2.2.6
 	k8s.io/api v0.26.3
+	k8s.io/apiextensions-apiserver v0.26.1
 	k8s.io/apimachinery v0.26.3
 	k8s.io/client-go v0.26.3
 	sigs.k8s.io/controller-runtime v0.14.6
@@ -126,7 +127,6 @@ require (
 	gopkg.in/square/go-jose.v2 v2.5.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	k8s.io/apiextensions-apiserver v0.26.1 // indirect
 	k8s.io/component-base v0.26.1 // indirect
 	k8s.io/klog/v2 v2.80.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20221012153701-172d655c2280 // indirect

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}
 			}
 		}
 	}

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"
@@ -852,7 +853,7 @@ func TestObserve(t *testing.T) {
 				},
 				wo: v1beta1.WorkspaceObservation{
 					Checksum: tfChecksum,
-					Outputs:  map[string]string{},
+					Outputs:  map[string]extensionsV1.JSON{},
 				},
 			},
 		},
@@ -882,7 +883,7 @@ func TestObserve(t *testing.T) {
 				},
 				wo: v1beta1.WorkspaceObservation{
 					Checksum: tfChecksum,
-					Outputs:  map[string]string{},
+					Outputs:  map[string]extensionsV1.JSON{},
 				},
 			},
 		},
@@ -958,7 +959,7 @@ func TestObserve(t *testing.T) {
 				},
 				wo: v1beta1.WorkspaceObservation{
 					Checksum: tfChecksum,
-					Outputs:  map[string]string{},
+					Outputs:  map[string]extensionsV1.JSON{},
 				},
 			},
 		},
@@ -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("null")},
 					},
 				},
 			},
@@ -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("null")},
 					},
 				},
 			},
@@ -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")},
 					},
 				},
 			},

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: