mirror of
https://github.com/coder/coder.git
synced 2025-07-08 11:39:50 +00:00
c2f74f3cc2
* chore: golangci: add linter rule to report usage of t.FailNow inside goroutines * chore: avoid t.FailNow in goroutines to appease the race detector
561 lines
13 KiB
Go
561 lines
13 KiB
Go
//go:build linux
|
|
|
|
package terraform_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"os"
|
|
"path/filepath"
|
|
"sort"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"cdr.dev/slog"
|
|
"cdr.dev/slog/sloggers/slogtest"
|
|
|
|
"github.com/coder/coder/provisioner/terraform"
|
|
"github.com/coder/coder/provisionersdk"
|
|
"github.com/coder/coder/provisionersdk/proto"
|
|
)
|
|
|
|
func TestProvision(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
provider := `
|
|
terraform {
|
|
required_providers {
|
|
coder = {
|
|
source = "coder/coder"
|
|
version = "0.3.4"
|
|
}
|
|
}
|
|
}
|
|
|
|
provider "coder" {
|
|
}
|
|
`
|
|
t.Log(provider)
|
|
|
|
client, server := provisionersdk.TransportPipe()
|
|
ctx, cancelFunc := context.WithCancel(context.Background())
|
|
t.Cleanup(func() {
|
|
_ = client.Close()
|
|
_ = server.Close()
|
|
cancelFunc()
|
|
})
|
|
go func() {
|
|
err := terraform.Serve(ctx, &terraform.ServeOptions{
|
|
ServeOptions: &provisionersdk.ServeOptions{
|
|
Listener: server,
|
|
},
|
|
Logger: slogtest.Make(t, nil).Leveled(slog.LevelDebug),
|
|
})
|
|
assert.NoError(t, err)
|
|
}()
|
|
api := proto.NewDRPCProvisionerClient(provisionersdk.Conn(client))
|
|
|
|
for _, testCase := range []struct {
|
|
Name string
|
|
Files map[string]string
|
|
Request *proto.Provision_Request
|
|
Response *proto.Provision_Response
|
|
Error bool
|
|
}{{
|
|
Name: "single-variable",
|
|
Files: map[string]string{
|
|
"main.tf": `variable "A" {
|
|
description = "Testing!"
|
|
}`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
ParameterValues: []*proto.ParameterValue{{
|
|
DestinationScheme: proto.ParameterDestination_PROVISIONER_VARIABLE,
|
|
Name: "A",
|
|
Value: "example",
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "missing-variable",
|
|
Files: map[string]string{
|
|
"main.tf": `variable "A" {
|
|
}`,
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Error: "exit status 1",
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "single-resource",
|
|
Files: map[string]string{
|
|
"main.tf": `resource "null_resource" "A" {}`,
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "invalid-sourcecode",
|
|
Files: map[string]string{
|
|
"main.tf": `a`,
|
|
},
|
|
Error: true,
|
|
}, {
|
|
Name: "dryrun-single-resource",
|
|
Files: map[string]string{
|
|
"main.tf": `resource "null_resource" "A" {}`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
DryRun: true,
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "dryrun-conditional-single-resource",
|
|
Files: map[string]string{
|
|
"main.tf": `
|
|
variable "test" {
|
|
default = "no"
|
|
}
|
|
resource "null_resource" "A" {
|
|
count = var.test == "yes" ? 1 : 0
|
|
}`,
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: nil,
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "resource-associated-with-agent",
|
|
Files: map[string]string{
|
|
"main.tf": provider + `
|
|
resource "coder_agent" "A" {
|
|
os = "windows"
|
|
arch = "arm64"
|
|
dir = "C:\\System32"
|
|
}
|
|
resource "null_resource" "A" {
|
|
depends_on = [
|
|
coder_agent.A
|
|
]
|
|
}`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
Metadata: &proto.Provision_Metadata{},
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
Agents: []*proto.Agent{{
|
|
Name: "A",
|
|
OperatingSystem: "windows",
|
|
Architecture: "arm64",
|
|
Directory: "C:\\System32",
|
|
Auth: &proto.Agent_Token{
|
|
Token: "",
|
|
},
|
|
}},
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "dryrun-resource-associated-with-agent",
|
|
Files: map[string]string{
|
|
"main.tf": provider + `
|
|
resource "coder_agent" "A" {
|
|
count = 1
|
|
os = "linux"
|
|
arch = "amd64"
|
|
env = {
|
|
test: "example"
|
|
}
|
|
startup_script = "code-server"
|
|
}
|
|
resource "null_resource" "A" {
|
|
count = length(coder_agent.A)
|
|
}`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
DryRun: true,
|
|
Metadata: &proto.Provision_Metadata{},
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
Agents: []*proto.Agent{{
|
|
Name: "A",
|
|
OperatingSystem: "linux",
|
|
Architecture: "amd64",
|
|
Auth: &proto.Agent_Token{},
|
|
Env: map[string]string{
|
|
"test": "example",
|
|
},
|
|
StartupScript: "code-server",
|
|
}},
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "resource-manually-associated-with-agent",
|
|
Files: map[string]string{
|
|
"main.tf": provider + `
|
|
resource "coder_agent" "A" {
|
|
os = "darwin"
|
|
arch = "amd64"
|
|
}
|
|
resource "null_resource" "A" {
|
|
depends_on = [
|
|
coder_agent.A
|
|
]
|
|
}
|
|
resource "coder_agent_instance" "A" {
|
|
agent_id = coder_agent.A.id
|
|
instance_id = "bananas"
|
|
}
|
|
`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
Metadata: &proto.Provision_Metadata{},
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
Agents: []*proto.Agent{{
|
|
Name: "A",
|
|
OperatingSystem: "darwin",
|
|
Architecture: "amd64",
|
|
Auth: &proto.Agent_InstanceId{
|
|
InstanceId: "bananas",
|
|
},
|
|
}},
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "resource-manually-associated-with-multiple-agents",
|
|
Files: map[string]string{
|
|
"main.tf": provider + `
|
|
resource "coder_agent" "A" {
|
|
os = "darwin"
|
|
arch = "amd64"
|
|
}
|
|
resource "coder_agent" "B" {
|
|
os = "linux"
|
|
arch = "amd64"
|
|
}
|
|
resource "null_resource" "A" {
|
|
depends_on = [
|
|
coder_agent.A,
|
|
coder_agent.B
|
|
]
|
|
}
|
|
resource "coder_agent_instance" "A" {
|
|
agent_id = coder_agent.A.id
|
|
instance_id = "bananas"
|
|
}
|
|
`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
Metadata: &proto.Provision_Metadata{},
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
Agents: []*proto.Agent{{
|
|
Name: "A",
|
|
OperatingSystem: "darwin",
|
|
Architecture: "amd64",
|
|
Auth: &proto.Agent_InstanceId{
|
|
InstanceId: "bananas",
|
|
},
|
|
}, {
|
|
Name: "B",
|
|
OperatingSystem: "linux",
|
|
Architecture: "amd64",
|
|
Auth: &proto.Agent_Token{
|
|
Token: "",
|
|
},
|
|
}},
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "dryrun-resource-separated-from-agent",
|
|
Files: map[string]string{
|
|
"main.tf": provider + `
|
|
resource "coder_agent" "A" {
|
|
os = "darwin"
|
|
arch = "amd64"
|
|
}
|
|
data "null_data_source" "values" {
|
|
inputs = {
|
|
script = coder_agent.A.init_script
|
|
}
|
|
}
|
|
resource "null_resource" "A" {
|
|
depends_on = [
|
|
data.null_data_source.values
|
|
]
|
|
}
|
|
`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
Metadata: &proto.Provision_Metadata{},
|
|
DryRun: true,
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
Agents: []*proto.Agent{{
|
|
Name: "A",
|
|
OperatingSystem: "darwin",
|
|
Architecture: "amd64",
|
|
Auth: &proto.Agent_Token{},
|
|
}},
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}, {
|
|
Name: "resource-separated-from-agent",
|
|
Files: map[string]string{
|
|
"main.tf": provider + `
|
|
resource "coder_agent" "A" {
|
|
os = "darwin"
|
|
arch = "amd64"
|
|
}
|
|
data "null_data_source" "values" {
|
|
inputs = {
|
|
script = coder_agent.A.init_script
|
|
}
|
|
}
|
|
resource "null_resource" "A" {
|
|
depends_on = [
|
|
data.null_data_source.values
|
|
]
|
|
}
|
|
`,
|
|
},
|
|
Request: &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
Metadata: &proto.Provision_Metadata{},
|
|
},
|
|
},
|
|
},
|
|
Response: &proto.Provision_Response{
|
|
Type: &proto.Provision_Response_Complete{
|
|
Complete: &proto.Provision_Complete{
|
|
Resources: []*proto.Resource{{
|
|
Name: "A",
|
|
Type: "null_resource",
|
|
Agents: []*proto.Agent{{
|
|
Name: "A",
|
|
OperatingSystem: "darwin",
|
|
Architecture: "amd64",
|
|
Auth: &proto.Agent_Token{},
|
|
}},
|
|
}},
|
|
},
|
|
},
|
|
},
|
|
}} {
|
|
testCase := testCase
|
|
t.Run(testCase.Name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
directory := t.TempDir()
|
|
for path, content := range testCase.Files {
|
|
err := os.WriteFile(filepath.Join(directory, path), []byte(content), 0600)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
request := &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
Directory: directory,
|
|
},
|
|
},
|
|
}
|
|
if testCase.Request != nil {
|
|
request.GetStart().ParameterValues = testCase.Request.GetStart().ParameterValues
|
|
request.GetStart().State = testCase.Request.GetStart().State
|
|
request.GetStart().DryRun = testCase.Request.GetStart().DryRun
|
|
request.GetStart().Metadata = testCase.Request.GetStart().Metadata
|
|
}
|
|
if request.GetStart().Metadata == nil {
|
|
request.GetStart().Metadata = &proto.Provision_Metadata{}
|
|
}
|
|
response, err := api.Provision(ctx)
|
|
require.NoError(t, err)
|
|
err = response.Send(request)
|
|
require.NoError(t, err)
|
|
for {
|
|
msg, err := response.Recv()
|
|
if msg != nil && msg.GetLog() != nil {
|
|
t.Logf("log: [%s] %s", msg.GetLog().Level, msg.GetLog().Output)
|
|
continue
|
|
}
|
|
if testCase.Error {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
|
|
if msg.GetComplete() == nil {
|
|
continue
|
|
}
|
|
|
|
require.NoError(t, err)
|
|
|
|
// Remove randomly generated data.
|
|
for _, resource := range msg.GetComplete().Resources {
|
|
sort.Slice(resource.Agents, func(i, j int) bool {
|
|
return resource.Agents[i].Name < resource.Agents[j].Name
|
|
})
|
|
|
|
for _, agent := range resource.Agents {
|
|
agent.Id = ""
|
|
if agent.GetToken() == "" {
|
|
continue
|
|
}
|
|
agent.Auth = &proto.Agent_Token{}
|
|
}
|
|
}
|
|
|
|
resourcesGot, err := json.Marshal(msg.GetComplete().Resources)
|
|
require.NoError(t, err)
|
|
|
|
resourcesWant, err := json.Marshal(testCase.Response.GetComplete().Resources)
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, testCase.Response.GetComplete().Error, msg.GetComplete().Error)
|
|
|
|
require.Equal(t, string(resourcesWant), string(resourcesGot))
|
|
break
|
|
}
|
|
})
|
|
}
|
|
|
|
t.Run("DestroyNoState", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const template = `resource "null_resource" "A" {}`
|
|
|
|
directory := t.TempDir()
|
|
err := os.WriteFile(filepath.Join(directory, "main.tf"), []byte(template), 0600)
|
|
require.NoError(t, err)
|
|
|
|
request := &proto.Provision_Request{
|
|
Type: &proto.Provision_Request_Start{
|
|
Start: &proto.Provision_Start{
|
|
State: nil,
|
|
Directory: directory,
|
|
Metadata: &proto.Provision_Metadata{
|
|
WorkspaceTransition: proto.WorkspaceTransition_DESTROY,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
response, err := api.Provision(ctx)
|
|
require.NoError(t, err)
|
|
err = response.Send(request)
|
|
require.NoError(t, err)
|
|
|
|
gotLog := false
|
|
for {
|
|
msg, err := response.Recv()
|
|
require.NoError(t, err)
|
|
require.NotNil(t, msg)
|
|
|
|
if msg.GetLog() != nil && strings.Contains(msg.GetLog().Output, "nothing to do") {
|
|
gotLog = true
|
|
continue
|
|
}
|
|
if msg.GetComplete() == nil {
|
|
continue
|
|
}
|
|
|
|
require.Empty(t, msg.GetComplete().Error)
|
|
require.True(t, gotLog, "never received 'nothing to do' log")
|
|
break
|
|
}
|
|
})
|
|
}
|