Merge pull request #452 from hashicorp/brandonc/jsonstateoutputs

Optionally send json outputs when creating state versions

CHANGELOG.md

@@ -3,8 +3,8 @@
 ## Enhancements
 * Adds `RetryServerErrors` field to the `Config` object by @sebasslash [#439](https://github.com/hashicorp/go-tfe/pull/439)
 * Adds support for the GPG Keys API by @sebasslash [#429](https://github.com/hashicorp/go-tfe/pull/429)
-* [beta] Renames the optional StateVersion field `ExtState` to `JSONState` and changes to string for base64 encoding by @annawinkler [#444](https://github.com/hashicorp/go-tfe/pull/444)
 * Add support for new `WorkspaceLimit` Admin setting for organizations [#425](https://github.com/hashicorp/go-tfe/pull/425)
+* [beta] Renames the optional StateVersion field `ExtState` to `JSONStateOutputs` and changes the purpose and type by @annawinkler [#444](https://github.com/hashicorp/go-tfe/pull/444) and @brandoncroft [#452](https://github.com/hashicorp/go-tfe/pull/452)
 
 # v1.3.0
 

configuration_version_integration_test.go

@@ -7,10 +7,12 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
-	"github.com/hashicorp/go-slug"
+	"errors"
 	"testing"
 	"time"
 
+	"github.com/hashicorp/go-slug"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -155,22 +157,25 @@ func TestConfigurationVersionsReadWithOptions(t *testing.T) {
 	wTest, wTestCleanup := createWorkspaceWithVCS(t, client, orgTest, WorkspaceCreateOptions{QueueAllRuns: Bool(true)})
 	defer wTestCleanup()
 
-	// Hack: Wait for TFC to ingress the configuration and queue a run
-	time.Sleep(3 * time.Second)
+	w, err := retry(func() (interface{}, error) {
+		w, err := client.Workspaces.ReadByIDWithOptions(ctx, wTest.ID, &WorkspaceReadOptions{
+			Include: []WSIncludeOpt{WSCurrentRunConfigVer},
+		})
 
-	w, err := client.Workspaces.ReadByIDWithOptions(ctx, wTest.ID, &WorkspaceReadOptions{
-		Include: []WSIncludeOpt{WSCurrentRunConfigVer},
-	})
+		if err != nil {
+			return nil, err
+		}
 
-	if err != nil {
-		require.NoError(t, err)
-	}
+		if w.CurrentRun == nil {
+			return nil, errors.New("A run was expected to be found on this workspace as a test pre-condition")
+		}
 
-	if w.CurrentRun == nil {
-		t.Fatal("A run was expected to be found on this workspace as a test pre-condition")
-	}
+		return w, nil
+	})
+
+	require.NoError(t, err)
 
-	cv := w.CurrentRun.ConfigurationVersion
+	cv := w.(*Workspace).CurrentRun.ConfigurationVersion
 
 	t.Run("when the configuration version exists", func(t *testing.T) {
 		options := &ConfigurationVersionReadOptions{

oauth_client_integration_test.go

@@ -5,6 +5,7 @@ package tfe
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"testing"
 
@@ -247,8 +248,14 @@ func TestOAuthClientsDelete(t *testing.T) {
 		err := client.OAuthClients.Delete(ctx, ocTest.ID)
 		require.NoError(t, err)
 
-		// Try loading the OAuth client - it should fail.
-		_, err = client.OAuthClients.Read(ctx, ocTest.ID)
+		_, err = retry(func() (interface{}, error) {
+			c, err := client.OAuthClients.Read(ctx, ocTest.ID)
+			if err != ErrResourceNotFound {
+				return nil, fmt.Errorf("expected %s, but err was %s", ErrResourceNotFound, err)
+			}
+			return c, err
+		})
+
 		assert.Equal(t, err, ErrResourceNotFound)
 	})
 

state_version.go

@@ -139,13 +139,13 @@ type StateVersionCreateOptions struct {
 	// Optional: Specifies the run to associate the state with.
 	Run *Run `jsonapi:"relation,run,omitempty"`
 
-	// Optional: The external, json representation of state data, base64 encoded.
-	// https://www.terraform.io/internals/json-format#state-representation
-	// Supplying this state representation can provide more details to the platform
+	// Optional: The external, json representation of state outputs, base64 encoded. Supplying this field 
+	// will provide more detailed output type information to TFE.
+	// For more information on the contents of this field: https://www.terraform.io/internals/json-format#values-representation
 	// about the current terraform state.
 	//
 	// **Note**: This field is in BETA, subject to change and not widely available yet.
-	JSONState *string `jsonapi:"attr,json-state,omitempty"`
+	JSONStateOutputs *string `jsonapi:"attr,json-state-outputs,omitempty"`
 }
 
 // List all the state versions for a given workspace.

state_version_integration_test.go

@@ -121,7 +121,7 @@ func TestStateVersionsCreate(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	jsonState, err := ioutil.ReadFile("test-fixtures/ext-state-version/state.json")
+	jsonStateOutputs, err := ioutil.ReadFile("test-fixtures/json-state-outputs/everything.json")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -169,11 +169,11 @@ func TestStateVersionsCreate(t *testing.T) {
 		}
 
 		sv, err := client.StateVersions.Create(ctx, wTest.ID, StateVersionCreateOptions{
-			Lineage:   String("741c4949-60b9-5bb1-5bf8-b14f4bb14af3"),
-			MD5:       String(fmt.Sprintf("%x", md5.Sum(state))),
-			Serial:    Int64(1),
-			State:     String(base64.StdEncoding.EncodeToString(state)),
-			JSONState: String(base64.StdEncoding.EncodeToString(jsonState)),
+			Lineage:          String("741c4949-60b9-5bb1-5bf8-b14f4bb14af3"),
+			MD5:              String(fmt.Sprintf("%x", md5.Sum(state))),
+			Serial:           Int64(1),
+			State:            String(base64.StdEncoding.EncodeToString(state)),
+			JSONStateOutputs: String(base64.StdEncoding.EncodeToString(jsonStateOutputs)),
 		})
 		require.NoError(t, err)
 
@@ -186,6 +186,8 @@ func TestStateVersionsCreate(t *testing.T) {
 			t.Fatal(err)
 		}
 
+		// TODO: check state outputs for the ones we sent in JSONStateOutputs
+
 		for _, item := range []*StateVersion{
 			sv,
 			refreshed,