IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2025-02-25 18:45:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

Unit tests to ensure renderer is appropriately called

Browse Source
This commit is contained in:
Sebastian Rivera 2023-04-11 16:48:36 -04:00 committed by Sebastian Rivera
parent b23cfaefe8
commit 5634ae3e18
4 changed files with 149 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
internal/cloud/backend_plan.go
View File

@ -460,7 +460,6 @@ func (b *Cloud) shouldRenderStructuredRunOutput(run *tfe.Run) (bool, error) {
// If the cloud backend is configured against TFC, we only require that
// the workspace has structured run output enabled.
if b.client.IsCloud() && run.Workspace.StructuredRunOutputEnabled {
fmt.Println("we should see this")
return true, nil
}
@ -475,8 +474,6 @@ func (b *Cloud) shouldRenderStructuredRunOutput(run *tfe.Run) (bool, error) {
return false, err
}
fmt.Println(releaseDate)
// Any release older than 202302-1 will not support enabling SRO for
// CLI-driven runs
if releaseDate < 202302 {

118
internal/cloud/backend_plan_test.go
View File

@ -2,6 +2,7 @@ package cloud
import (
"context"
"net/http"
"os"
"os/signal"
"strings"
@ -1250,3 +1251,120 @@ func TestCloud_planOtherError(t *testing.T) {
t.Fatalf("expected error message, got: %s", err.Error())
}
}
func TestCloud_planShouldRenderSRO(t *testing.T) {
t.Run("when instance is TFC", func(t *testing.T) {
handlers := map[string]func(http.ResponseWriter, *http.Request){
"/api/v2/ping": func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("TFP-API-Version", "2.5")
w.Header().Set("TFP-AppName", "Terraform Cloud")
},
}
b, bCleanup := testBackendWithHandlers(t, handlers)
t.Cleanup(bCleanup)
b.renderer = &jsonformat.Renderer{}
t.Run("and SRO is enabled", func(t *testing.T) {
r := &tfe.Run{
Workspace: &tfe.Workspace{
StructuredRunOutputEnabled: true,
},
}
assertSRORendered(t, b, r, true)
})
t.Run("and SRO is not enabled", func(t *testing.T) {
r := &tfe.Run{
Workspace: &tfe.Workspace{
StructuredRunOutputEnabled: false,
},
}
assertSRORendered(t, b, r, false)
})
})
t.Run("when instance is TFE and version supports CLI SRO", func(t *testing.T) {
handlers := map[string]func(http.ResponseWriter, *http.Request){
"/api/v2/ping": func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("TFP-API-Version", "2.5")
w.Header().Set("TFP-AppName", "Terraform Enterprise")
w.Header().Set("X-TFE-Version", "v202303-1")
},
}
b, bCleanup := testBackendWithHandlers(t, handlers)
t.Cleanup(bCleanup)
b.renderer = &jsonformat.Renderer{}
t.Run("and SRO is enabled", func(t *testing.T) {
r := &tfe.Run{
Workspace: &tfe.Workspace{
StructuredRunOutputEnabled: true,
},
}
assertSRORendered(t, b, r, true)
})
t.Run("and SRO is not enabled", func(t *testing.T) {
r := &tfe.Run{
Workspace: &tfe.Workspace{
StructuredRunOutputEnabled: false,
},
}
assertSRORendered(t, b, r, false)
})
})
t.Run("when instance is a known unsupported TFE release", func(t *testing.T) {
handlers := map[string]func(http.ResponseWriter, *http.Request){
"/api/v2/ping": func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("TFP-API-Version", "2.5")
w.Header().Set("TFP-AppName", "Terraform Enterprise")
w.Header().Set("X-TFE-Version", "v202208-1")
},
}
b, bCleanup := testBackendWithHandlers(t, handlers)
t.Cleanup(bCleanup)
b.renderer = &jsonformat.Renderer{}
r := &tfe.Run{
Workspace: &tfe.Workspace{
StructuredRunOutputEnabled: true,
},
}
assertSRORendered(t, b, r, false)
})
t.Run("when instance is an unknown TFE release", func(t *testing.T) {
handlers := map[string]func(http.ResponseWriter, *http.Request){
"/api/v2/ping": func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("TFP-API-Version", "2.5")
},
}
b, bCleanup := testBackendWithHandlers(t, handlers)
t.Cleanup(bCleanup)
b.renderer = &jsonformat.Renderer{}
r := &tfe.Run{
Workspace: &tfe.Workspace{
StructuredRunOutputEnabled: true,
},
}
assertSRORendered(t, b, r, false)
})
}
func assertSRORendered(t *testing.T, b *Cloud, r *tfe.Run, shouldRender bool) {
got, err := b.shouldRenderStructuredRunOutput(r)
if err != nil {
t.Fatalf("expected no error: %v", err)
}
if shouldRender != got {
t.Fatalf("expected SRO to be rendered: %t, got %t", shouldRender, got)
}
}

2
internal/cloud/backend_test.go
View File

@ -647,7 +647,7 @@ func TestCloud_setUnavailableTerraformVersion(t *testing.T) {
}),
})
b, bCleanup := testBackend(t, config)
b, bCleanup := testBackend(t, config, nil)
defer bCleanup()
// Make sure the workspace doesn't exist yet -- otherwise, we can't test what

35
internal/cloud/testing.go
View File

@ -43,6 +43,13 @@ var (
tfeHost: {"token": testCred},
})
testBackendSingleWorkspaceName = "app-prod"
defaultTFCPing = map[string]func(http.ResponseWriter, *http.Request){
"/api/v2/ping": func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.Header().Set("TFP-API-Version", "2.5")
w.Header().Set("TFP-AppName", "Terraform Cloud")
},
}
)
// mockInput is a mock implementation of terraform.UIInput.
@ -79,7 +86,7 @@ func testBackendWithName(t *testing.T) (*Cloud, func()) {
"tags": cty.NullVal(cty.Set(cty.String)),
}),
})
return testBackend(t, obj)
return testBackend(t, obj, defaultTFCPing)
}
func testBackendWithTags(t *testing.T) (*Cloud, func()) {
@ -96,7 +103,7 @@ func testBackendWithTags(t *testing.T) (*Cloud, func()) {
),
}),
})
return testBackend(t, obj)
return testBackend(t, obj, nil)
}
func testBackendNoOperations(t *testing.T) (*Cloud, func()) {
@ -109,7 +116,20 @@ func testBackendNoOperations(t *testing.T) (*Cloud, func()) {
"tags": cty.NullVal(cty.Set(cty.String)),
}),
})
return testBackend(t, obj)
return testBackend(t, obj, nil)
}
func testBackendWithHandlers(t *testing.T, handlers map[string]func(http.ResponseWriter, *http.Request)) (*Cloud, func()) {
obj := cty.ObjectVal(map[string]cty.Value{
"hostname": cty.NullVal(cty.String),
"organization": cty.StringVal("hashicorp"),
"token": cty.NullVal(cty.String),
"workspaces": cty.ObjectVal(map[string]cty.Value{
"name": cty.StringVal(testBackendSingleWorkspaceName),
"tags": cty.NullVal(cty.Set(cty.String)),
}),
})
return testBackend(t, obj, handlers)
}
func testCloudState(t *testing.T) *State {
@ -186,8 +206,13 @@ func testBackendWithOutputs(t *testing.T) (*Cloud, func()) {
return b, cleanup
}
func testBackend(t *testing.T, obj cty.Value) (*Cloud, func()) {
s := testServer(t)
func testBackend(t *testing.T, obj cty.Value, handlers map[string]func(http.ResponseWriter, *http.Request)) (*Cloud, func()) {
var s *httptest.Server
if handlers != nil {
s = testServerWithHandlers(handlers)
} else {
s = testServer(t)
}
b := New(testDisco(s))
// Configure the backend so the client is created.