Merge pull request #1119 from hashicorp/hw/custom-stack-config-upload

Added `SpeculativeEnabled` option to `CreateStackSourceOptions` for supporting speculative runs on manual stack uploads

Author: hwatkins05-hashicorp

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+## Enhancements
+
+* Adds BETA support for speculative runs with `Stacks` resources and removes VCS repo validity check on `Stack` creation, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1119](https://github.com/hashicorp/go-tfe/pull/1119)
+
 # v1.81.0
 
 ## Enhancements

examples/projects/main.go

@@ -28,23 +28,23 @@ func main() {
 
 	// Create a new project
 	p, err := client.Projects.Create(ctx, "org-test", tfe.ProjectCreateOptions{
-		Name:          "my-app-tst",
+		Name: "my-app-tst",
 	})
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	// Update the project auto destroy activity duration
 	p, err = client.Projects.Update(ctx, p.ID, tfe.ProjectUpdateOptions{
-		AutoDestroyActivityDuration:    jsonapi.NewNullableAttrWithValue("3d"),
+		AutoDestroyActivityDuration: jsonapi.NewNullableAttrWithValue("3d"),
 	})
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	// Disable auto destroy
 	p, err = client.Projects.Update(ctx, p.ID, tfe.ProjectUpdateOptions{
-		AutoDestroyActivityDuration:    jsonapi.NewNullNullableAttr[string](),
+		AutoDestroyActivityDuration: jsonapi.NewNullNullableAttr[string](),
 	})
 	if err != nil {
 		log.Fatal(err)

stack.go

@@ -331,14 +331,6 @@ func (s StackCreateOptions) valid() error {
 		return ErrRequiredProject
 	}
 
-	return s.VCSRepo.valid()
-}
-
-func (s StackVCSRepoOptions) valid() error {
-	if s.Identifier == "" {
-		return ErrRequiredVCSRepo
-	}
-
 	return nil
 }
 

stack_source.go

@@ -32,6 +32,7 @@ type StackSources interface {
 
 type CreateStackSourceOptions struct {
 	SelectedDeployments []string `jsonapi:"attr,selected-deployments,omitempty"`
+	SpeculativeEnabled  *bool    `jsonapi:"attr,speculative,omitempty"`
 }
 
 var _ StackSources = (*stackSources)(nil)

stack_source_integration_test.go

@@ -66,3 +66,63 @@ func TestStackSourceCreateUploadAndRead(t *testing.T) {
 		require.Fail(t, "timed out waiting for stack source to be processed")
 	}
 }
+
+func TestStackSourceSpeculatives(t *testing.T) {
+	skipUnlessBeta(t)
+
+	client := testClient(t)
+	ctx := context.Background()
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	oauthClient, cleanup := createOAuthClient(t, client, orgTest, nil)
+	t.Cleanup(cleanup)
+
+	stackVCS, err := client.Stacks.Create(ctx, StackCreateOptions{
+		Project: orgTest.DefaultProject,
+		Name:    "test-stack-vcs",
+		VCSRepo: &StackVCSRepoOptions{
+			Identifier:   "hashicorp-guides/pet-nulls-stack",
+			OAuthTokenID: oauthClient.OAuthTokens[0].ID,
+		},
+	})
+	require.NoError(t, err)
+
+	stack, err := client.Stacks.Create(ctx, StackCreateOptions{
+		Project: &Project{
+			ID: orgTest.DefaultProject.ID,
+		},
+		Name: "test-stack",
+	})
+	require.NoError(t, err)
+
+	t.Run("with speculative run enabled for VCS upload", func(t *testing.T) {
+		ss, err := client.StackSources.CreateAndUpload(ctx, stackVCS.ID, "test-fixtures/stack-source", &CreateStackSourceOptions{
+			SelectedDeployments: []string{"simple"},
+			SpeculativeEnabled:  Bool(true),
+		})
+		require.NoError(t, err)
+		require.NotNil(t, ss)
+		require.NotNil(t, ss.UploadURL)
+	})
+
+	t.Run("with speculative run disabled for manual upload", func(t *testing.T) {
+		ss, err := client.StackSources.CreateAndUpload(ctx, stack.ID, "test-fixtures/stack-source", &CreateStackSourceOptions{
+			SelectedDeployments: []string{"simple"},
+			SpeculativeEnabled:  Bool(false),
+		})
+		require.NoError(t, err)
+		require.NotNil(t, ss)
+		require.NotNil(t, ss.UploadURL)
+	})
+
+	t.Run("with invalid speculative run option for VCS upload", func(t *testing.T) {
+		ss, err := client.StackSources.CreateAndUpload(ctx, stackVCS.ID, "test-fixtures/stack-source", &CreateStackSourceOptions{
+			SelectedDeployments: []string{"simple"},
+			SpeculativeEnabled:  Bool(false),
+		})
+		require.Nil(t, ss)
+		require.Error(t, err)
+	})
+}