Skip to content

ci: run integration test #240

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

Merged
merged 5 commits into from
Jun 10, 2024
Merged

ci: run integration test #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6cb4f4a
chore(integration): ensure presence of image
johnstcn Jun 7, 2024
f829eea
ci: run integration test
johnstcn Jun 7, 2024
772f4c7
move to build stage
johnstcn Jun 7, 2024
a4aae83
disable cgo in build
johnstcn Jun 7, 2024
7a6bb17
name container properly
johnstcn Jun 7, 2024
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
10 changes: 10 additions & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,19 @@ jobs:
go mod download

- name: Build
env:
CGO_ENABLED: "0"
Comment on lines +36 to +37
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: this is required because coder/coder is based on alpine and it will otherwise look for libc

run: |
go build -v .

- name: Run integration test
timeout-minutes: 10
env:
CODER_IMAGE: "ghcr.io/coder/coder"
CODER_VERSION: "latest"
run: |
go test -v ./integration

# run acceptance tests in a matrix with Terraform core versions
test:
name: Matrix Test
Expand Down
37 changes: 23 additions & 14 deletions integration/integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"context"
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"
"runtime"
Expand All @@ -15,6 +16,7 @@ import (

"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/container"
"github.com/docker/docker/api/types/image"
"github.com/docker/docker/client"
"github.com/docker/docker/pkg/stdcopy"
"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -44,17 +46,14 @@ func TestIntegration(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Duration(timeoutMins)*time.Minute)
t.Cleanup(cancel)

// Given: we have an existing Coder deployment running locally
ctrID := setup(ctx, t)

for _, tt := range []struct {
// Name of the folder under `integration/` containing a test template
templateName string
name string
// map of string to regex to be passed to assertOutput()
expectedOutput map[string]string
}{
{
templateName: "test-data-source",
name: "test-data-source",
expectedOutput: map[string]string{
"provisioner.arch": runtime.GOARCH,
"provisioner.id": `[a-zA-Z0-9-]+`,
Expand Down Expand Up @@ -82,20 +81,22 @@ func TestIntegration(t *testing.T) {
"workspace_owner.name": `testing`,
"workspace_owner.oidc_access_token": `^$`, // TODO: test OIDC integration
"workspace_owner.session_token": `.+`,
"workspace_owner.ssh_private_key": `^$`, // Depends on coder/coder#13366
"workspace_owner.ssh_public_key": `^$`, // Depends on coder/coder#13366
"workspace_owner.ssh_private_key": `(?s)^.+?BEGIN OPENSSH PRIVATE KEY.+?END OPENSSH PRIVATE KEY.+?$`,
"workspace_owner.ssh_public_key": `(?s)^ssh-ed25519.+$`,
},
},
} {
t.Run(tt.templateName, func(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
// Given: we have an existing Coder deployment running locally
ctrID := setup(ctx, t, tt.name)
// Import named template
_, rc := execContainer(ctx, t, ctrID, fmt.Sprintf(`coder templates push %s --directory /src/integration/%s --var output_path=/tmp/%s.json --yes`, tt.templateName, tt.templateName, tt.templateName))
_, rc := execContainer(ctx, t, ctrID, fmt.Sprintf(`coder templates push %s --directory /src/integration/%s --var output_path=/tmp/%s.json --yes`, tt.name, tt.name, tt.name))
require.Equal(t, 0, rc)
// Create a workspace
_, rc = execContainer(ctx, t, ctrID, fmt.Sprintf(`coder create %s -t %s --yes`, tt.templateName, tt.templateName))
_, rc = execContainer(ctx, t, ctrID, fmt.Sprintf(`coder create %s -t %s --yes`, tt.name, tt.name))
require.Equal(t, 0, rc)
// Fetch the output created by the template
out, rc := execContainer(ctx, t, ctrID, fmt.Sprintf(`cat /tmp/%s.json`, tt.templateName))
out, rc := execContainer(ctx, t, ctrID, fmt.Sprintf(`cat /tmp/%s.json`, tt.name))
require.Equal(t, 0, rc)
actual := make(map[string]string)
require.NoError(t, json.NewDecoder(strings.NewReader(out)).Decode(&actual))
Expand All @@ -104,7 +105,7 @@ func TestIntegration(t *testing.T) {
}
}

func setup(ctx context.Context, t *testing.T) string {
func setup(ctx context.Context, t *testing.T, name string) string {
var (
// For this test to work, we pass in a custom terraformrc to use
// the locally built version of the provider.
Expand Down Expand Up @@ -148,9 +149,17 @@ func setup(ctx context.Context, t *testing.T) string {
require.NoError(t, err, "get abs path of parent")
t.Logf("src path is %s\n", srcPath)

// Ensure the image is available locally.
refStr := coderImg + ":" + coderVersion
t.Logf("ensuring image %q", refStr)
resp, err := cli.ImagePull(ctx, refStr, image.PullOptions{})
require.NoError(t, err)
_, err = io.ReadAll(resp)
require.NoError(t, err)

// Stand up a temporary Coder instance
ctr, err := cli.ContainerCreate(ctx, &container.Config{
Image: coderImg + ":" + coderVersion,
Image: refStr,
Env: []string{
"CODER_ACCESS_URL=" + localURL, // Set explicitly to avoid creating try.coder.app URLs.
"CODER_IN_MEMORY=true", // We don't necessarily care about real persistence here.
Expand All @@ -163,7 +172,7 @@ func setup(ctx context.Context, t *testing.T) string {
tfrcPath + ":/tmp/integration.tfrc", // Custom tfrc from above.
srcPath + ":/src", // Bind-mount in the repo with the built binary and templates.
},
}, nil, nil, "")
}, nil, nil, "terraform-provider-coder-integration-"+name)
require.NoError(t, err, "create test deployment")

t.Logf("created container %s\n", ctr.ID)
Expand Down
Loading