Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add structured run output support #233

Merged
merged 2 commits into from
Jun 18, 2021
Merged

Add structured run output support #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d2a460
Add workspace support for structured run output
jgrumboe Jun 14, 2021
195c5c6
add feature to missing tests
jgrumboe Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 45 additions & 32 deletions workspace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,38 +96,39 @@ type WorkspaceList struct {

// Workspace represents a Terraform Enterprise workspace.
type Workspace struct {
ID string `jsonapi:"primary,workspaces"`
Actions *WorkspaceActions `jsonapi:"attr,actions"`
AgentPoolID string `jsonapi:"attr,agent-pool-id"`
AllowDestroyPlan bool `jsonapi:"attr,allow-destroy-plan"`
AutoApply bool `jsonapi:"attr,auto-apply"`
CanQueueDestroyPlan bool `jsonapi:"attr,can-queue-destroy-plan"`
CreatedAt time.Time `jsonapi:"attr,created-at,iso8601"`
Description string `jsonapi:"attr,description"`
Environment string `jsonapi:"attr,environment"`
ExecutionMode string `jsonapi:"attr,execution-mode"`
FileTriggersEnabled bool `jsonapi:"attr,file-triggers-enabled"`
GlobalRemoteState bool `jsonapi:"attr,global-remote-state"`
Locked bool `jsonapi:"attr,locked"`
MigrationEnvironment string `jsonapi:"attr,migration-environment"`
Name string `jsonapi:"attr,name"`
Operations bool `jsonapi:"attr,operations"`
Permissions *WorkspacePermissions `jsonapi:"attr,permissions"`
QueueAllRuns bool `jsonapi:"attr,queue-all-runs"`
SpeculativeEnabled bool `jsonapi:"attr,speculative-enabled"`
SourceName string `jsonapi:"attr,source-name"`
SourceURL string `jsonapi:"attr,source-url"`
TerraformVersion string `jsonapi:"attr,terraform-version"`
TriggerPrefixes []string `jsonapi:"attr,trigger-prefixes"`
VCSRepo *VCSRepo `jsonapi:"attr,vcs-repo"`
WorkingDirectory string `jsonapi:"attr,working-directory"`
UpdatedAt time.Time `jsonapi:"attr,updated-at,iso8601"`
ResourceCount int `jsonapi:"attr,resource-count"`
ApplyDurationAverage time.Duration `jsonapi:"attr,apply-duration-average"`
PlanDurationAverage time.Duration `jsonapi:"attr,plan-duration-average"`
PolicyCheckFailures int `jsonapi:"attr,policy-check-failures"`
RunFailures int `jsonapi:"attr,run-failures"`
RunsCount int `jsonapi:"attr,workspace-kpis-runs-count"`
ID string `jsonapi:"primary,workspaces"`
Actions *WorkspaceActions `jsonapi:"attr,actions"`
AgentPoolID string `jsonapi:"attr,agent-pool-id"`
AllowDestroyPlan bool `jsonapi:"attr,allow-destroy-plan"`
AutoApply bool `jsonapi:"attr,auto-apply"`
CanQueueDestroyPlan bool `jsonapi:"attr,can-queue-destroy-plan"`
CreatedAt time.Time `jsonapi:"attr,created-at,iso8601"`
Description string `jsonapi:"attr,description"`
Environment string `jsonapi:"attr,environment"`
ExecutionMode string `jsonapi:"attr,execution-mode"`
FileTriggersEnabled bool `jsonapi:"attr,file-triggers-enabled"`
GlobalRemoteState bool `jsonapi:"attr,global-remote-state"`
Locked bool `jsonapi:"attr,locked"`
MigrationEnvironment string `jsonapi:"attr,migration-environment"`
Name string `jsonapi:"attr,name"`
Operations bool `jsonapi:"attr,operations"`
Permissions *WorkspacePermissions `jsonapi:"attr,permissions"`
QueueAllRuns bool `jsonapi:"attr,queue-all-runs"`
SpeculativeEnabled bool `jsonapi:"attr,speculative-enabled"`
SourceName string `jsonapi:"attr,source-name"`
SourceURL string `jsonapi:"attr,source-url"`
StructuredRunOutputEnabled bool `jsonapi:"attr,structured-run-output-enabled"`
TerraformVersion string `jsonapi:"attr,terraform-version"`
TriggerPrefixes []string `jsonapi:"attr,trigger-prefixes"`
VCSRepo *VCSRepo `jsonapi:"attr,vcs-repo"`
WorkingDirectory string `jsonapi:"attr,working-directory"`
UpdatedAt time.Time `jsonapi:"attr,updated-at,iso8601"`
ResourceCount int `jsonapi:"attr,resource-count"`
ApplyDurationAverage time.Duration `jsonapi:"attr,apply-duration-average"`
PlanDurationAverage time.Duration `jsonapi:"attr,plan-duration-average"`
PolicyCheckFailures int `jsonapi:"attr,policy-check-failures"`
RunFailures int `jsonapi:"attr,run-failures"`
RunsCount int `jsonapi:"attr,workspace-kpis-runs-count"`

// Relations
AgentPool *AgentPool `jsonapi:"relation,agent-pool"`
Expand Down Expand Up @@ -285,6 +286,12 @@ type WorkspaceCreateOptions struct {
// documentation or other info about the client.
SourceURL *string `jsonapi:"attr,source-url,omitempty"`

// BETA. Enable the experimental advanced run user interface.
// This only applies to runs using Terraform version 0.15.2 or newer,
// and runs executed using older versions will see the classic experience
// regardless of this setting.
StructuredRunOutputEnabled *bool `jsonapi:"attr,structured-run-output-enabled,omitempty"`

// The version of Terraform to use for this workspace. Upon creating a
// workspace, the latest version is selected unless otherwise specified.
TerraformVersion *string `jsonapi:"attr,terraform-version,omitempty"`
Expand Down Expand Up @@ -499,6 +506,12 @@ type WorkspaceUpdateOptions struct {
// repository is public or includes untrusted contributors.
SpeculativeEnabled *bool `jsonapi:"attr,speculative-enabled,omitempty"`

// BETA. Enable the experimental advanced run user interface.
// This only applies to runs using Terraform version 0.15.2 or newer,
// and runs executed using older versions will see the classic experience
// regardless of this setting.
StructuredRunOutputEnabled *bool `jsonapi:"attr,structured-run-output-enabled,omitempty"`

// The version of Terraform to use for this workspace.
TerraformVersion *string `jsonapi:"attr,terraform-version,omitempty"`

Expand Down
76 changes: 41 additions & 35 deletions workspace_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,19 +105,20 @@ func TestWorkspacesCreate(t *testing.T) {

t.Run("with valid options", func(t *testing.T) {
options := WorkspaceCreateOptions{
Name: String("foo"),
AllowDestroyPlan: Bool(false),
AutoApply: Bool(true),
Description: String("qux"),
FileTriggersEnabled: Bool(true),
Operations: Bool(true),
QueueAllRuns: Bool(true),
SpeculativeEnabled: Bool(true),
SourceName: String("my-app"),
SourceURL: String("http://my-app-hostname.io"),
TerraformVersion: String("0.11.0"),
TriggerPrefixes: []string{"/modules", "/shared"},
WorkingDirectory: String("bar/"),
Name: String("foo"),
AllowDestroyPlan: Bool(false),
AutoApply: Bool(true),
Description: String("qux"),
FileTriggersEnabled: Bool(true),
Operations: Bool(true),
QueueAllRuns: Bool(true),
SpeculativeEnabled: Bool(true),
SourceName: String("my-app"),
SourceURL: String("http://my-app-hostname.io"),
StructuredRunOutputEnabled: Bool(true),
TerraformVersion: String("0.11.0"),
TriggerPrefixes: []string{"/modules", "/shared"},
WorkingDirectory: String("bar/"),
}

w, err := client.Workspaces.Create(ctx, orgTest.Name, options)
Expand All @@ -142,6 +143,7 @@ func TestWorkspacesCreate(t *testing.T) {
assert.Equal(t, *options.SpeculativeEnabled, item.SpeculativeEnabled)
assert.Equal(t, *options.SourceName, item.SourceName)
assert.Equal(t, *options.SourceURL, item.SourceURL)
assert.Equal(t, *options.StructuredRunOutputEnabled, item.StructuredRunOutputEnabled)
assert.Equal(t, *options.TerraformVersion, item.TerraformVersion)
assert.Equal(t, options.TriggerPrefixes, item.TriggerPrefixes)
assert.Equal(t, *options.WorkingDirectory, item.WorkingDirectory)
Expand Down Expand Up @@ -385,17 +387,18 @@ func TestWorkspacesUpdate(t *testing.T) {

t.Run("with valid options", func(t *testing.T) {
options := WorkspaceUpdateOptions{
Name: String(randomString(t)),
AllowDestroyPlan: Bool(true),
AutoApply: Bool(false),
FileTriggersEnabled: Bool(true),
Operations: Bool(false),
QueueAllRuns: Bool(false),
SpeculativeEnabled: Bool(true),
Description: String("updated description"),
TerraformVersion: String("0.11.1"),
TriggerPrefixes: []string{"/modules", "/shared"},
WorkingDirectory: String("baz/"),
Name: String(randomString(t)),
AllowDestroyPlan: Bool(true),
AutoApply: Bool(false),
FileTriggersEnabled: Bool(true),
Operations: Bool(false),
QueueAllRuns: Bool(false),
SpeculativeEnabled: Bool(true),
Description: String("updated description"),
StructuredRunOutputEnabled: Bool(true),
TerraformVersion: String("0.11.1"),
TriggerPrefixes: []string{"/modules", "/shared"},
WorkingDirectory: String("baz/"),
}

w, err := client.Workspaces.Update(ctx, orgTest.Name, wTest.Name, options)
Expand All @@ -417,6 +420,7 @@ func TestWorkspacesUpdate(t *testing.T) {
assert.Equal(t, *options.Operations, item.Operations)
assert.Equal(t, *options.QueueAllRuns, item.QueueAllRuns)
assert.Equal(t, *options.SpeculativeEnabled, item.SpeculativeEnabled)
assert.Equal(t, *options.StructuredRunOutputEnabled, item.StructuredRunOutputEnabled)
assert.Equal(t, *options.TerraformVersion, item.TerraformVersion)
assert.Equal(t, options.TriggerPrefixes, item.TriggerPrefixes)
assert.Equal(t, *options.WorkingDirectory, item.WorkingDirectory)
Expand Down Expand Up @@ -497,16 +501,17 @@ func TestWorkspacesUpdateByID(t *testing.T) {

t.Run("with valid options", func(t *testing.T) {
options := WorkspaceUpdateOptions{
Name: String(randomString(t)),
AllowDestroyPlan: Bool(true),
AutoApply: Bool(false),
FileTriggersEnabled: Bool(true),
Operations: Bool(false),
QueueAllRuns: Bool(false),
SpeculativeEnabled: Bool(true),
TerraformVersion: String("0.11.1"),
TriggerPrefixes: []string{"/modules", "/shared"},
WorkingDirectory: String("baz/"),
Name: String(randomString(t)),
AllowDestroyPlan: Bool(true),
AutoApply: Bool(false),
FileTriggersEnabled: Bool(true),
Operations: Bool(false),
QueueAllRuns: Bool(false),
SpeculativeEnabled: Bool(true),
StructuredRunOutputEnabled: Bool(true),
TerraformVersion: String("0.11.1"),
TriggerPrefixes: []string{"/modules", "/shared"},
WorkingDirectory: String("baz/"),
}

w, err := client.Workspaces.UpdateByID(ctx, wTest.ID, options)
Expand All @@ -527,6 +532,7 @@ func TestWorkspacesUpdateByID(t *testing.T) {
assert.Equal(t, *options.Operations, item.Operations)
assert.Equal(t, *options.QueueAllRuns, item.QueueAllRuns)
assert.Equal(t, *options.SpeculativeEnabled, item.SpeculativeEnabled)
assert.Equal(t, *options.StructuredRunOutputEnabled, item.StructuredRunOutputEnabled)
assert.Equal(t, *options.TerraformVersion, item.TerraformVersion)
assert.Equal(t, options.TriggerPrefixes, item.TriggerPrefixes)
assert.Equal(t, *options.WorkingDirectory, item.WorkingDirectory)
Expand Down Expand Up @@ -1051,7 +1057,7 @@ func TestWorkspace_Unmarshal(t *testing.T) {
require.NoError(t, err)

iso8601TimeFormat := "2006-01-02T15:04:05Z"
parsedTime, err := time.Parse(iso8601TimeFormat, "2020-07-15T23:38:43.821Z")
parsedTime, _ := time.Parse(iso8601TimeFormat, "2020-07-15T23:38:43.821Z")

assert.Equal(t, ws.ID, "ws-1234")
assert.Equal(t, ws.Name, "my-workspace")
Expand Down