Skip to content

chore(testutil): extract testutil.CreateZip and testutil.CreateTar helpers #15540

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 6 commits into from
Nov 18, 2024
Merged

chore(testutil): extract testutil.CreateZip and testutil.CreateTar helpers #15540

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b09fe9a
feat(testutil): extract testutil.Create(Zip|Tar) helpers
johnstcn Nov 15, 2024
a81b561
found another one
johnstcn Nov 15, 2024
482b9b9
rm commented code
johnstcn Nov 18, 2024
fcfd5bc
Merge remote-tracking branch 'origin/main' into cj/testutil-createtar
johnstcn Nov 18, 2024
a2969b8
add directories to archive
johnstcn Nov 18, 2024
abecc98
post-merge fixup
johnstcn Nov 18, 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
3 changes: 2 additions & 1 deletion provisioner/terraform/parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/provisionersdk/proto"
"github.com/coder/coder/v2/testutil"
)

func TestParse(t *testing.T) {
Expand Down Expand Up @@ -380,7 +381,7 @@ func TestParse(t *testing.T) {
t.Parallel()

session := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, testCase.Files),
TemplateSourceArchive: testutil.CreateTar(t, testCase.Files),
})

err := session.Send(&proto.Request{Type: &proto.Request_Parse{Parse: &proto.ParseRequest{}}})
Expand Down
51 changes: 25 additions & 26 deletions provisioner/terraform/provision_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
package terraform_test

import (
"archive/tar"
"bytes"
"context"
"encoding/json"
"errors"
Expand All @@ -28,6 +26,7 @@ import (
"github.com/coder/coder/v2/provisioner/terraform"
"github.com/coder/coder/v2/provisionersdk"
"github.com/coder/coder/v2/provisionersdk/proto"
"github.com/coder/coder/v2/testutil"
)

type provisionerServeOptions struct {
Expand Down Expand Up @@ -78,24 +77,24 @@ func setupProvisioner(t *testing.T, opts *provisionerServeOptions) (context.Cont
return ctx, api
}

func makeTar(t *testing.T, files map[string]string) []byte {
t.Helper()
var buffer bytes.Buffer
writer := tar.NewWriter(&buffer)
for name, content := range files {
err := writer.WriteHeader(&tar.Header{
Name: name,
Size: int64(len(content)),
Mode: 0o644,
})
require.NoError(t, err)
_, err = writer.Write([]byte(content))
require.NoError(t, err)
}
err := writer.Flush()
require.NoError(t, err)
return buffer.Bytes()
}
// func testutil.CreateTar(t *testing.T, files map[string]string) []byte {
// t.Helper()
// var buffer bytes.Buffer
// writer := tar.NewWriter(&buffer)
// for name, content := range files {
// err := writer.WriteHeader(&tar.Header{
// Name: name,
// Size: int64(len(content)),
// Mode: 0o644,
// })
// require.NoError(t, err)
// _, err = writer.Write([]byte(content))
// require.NoError(t, err)
// }
// err := writer.Flush()
// require.NoError(t, err)
// return buffer.Bytes()
// }

func configure(ctx context.Context, t *testing.T, client proto.DRPCProvisionerClient, config *proto.Config) proto.DRPCProvisioner_SessionClient {
t.Helper()
Expand Down Expand Up @@ -186,7 +185,7 @@ func TestProvision_Cancel(t *testing.T) {
binaryPath: binPath,
})
sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, nil),
TemplateSourceArchive: testutil.CreateTar(t, nil),
})

err = sendPlan(sess, proto.WorkspaceTransition_START)
Expand Down Expand Up @@ -257,7 +256,7 @@ func TestProvision_CancelTimeout(t *testing.T) {
})

sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, nil),
TemplateSourceArchive: testutil.CreateTar(t, nil),
})

// provisioner requires plan before apply, so test cancel with plan.
Expand Down Expand Up @@ -346,7 +345,7 @@ func TestProvision_TextFileBusy(t *testing.T) {
})

sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, nil),
TemplateSourceArchive: testutil.CreateTar(t, nil),
})

err = sendPlan(sess, proto.WorkspaceTransition_START)
Expand Down Expand Up @@ -758,7 +757,7 @@ func TestProvision(t *testing.T) {

ctx, api := setupProvisioner(t, nil)
sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, testCase.Files),
TemplateSourceArchive: testutil.CreateTar(t, testCase.Files),
})

planRequest := &proto.Request{Type: &proto.Request_Plan{Plan: &proto.PlanRequest{
Expand Down Expand Up @@ -863,7 +862,7 @@ func TestProvision_ExtraEnv(t *testing.T) {

ctx, api := setupProvisioner(t, nil)
sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, map[string]string{"main.tf": `resource "null_resource" "A" {}`}),
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{"main.tf": `resource "null_resource" "A" {}`}),
})

err := sendPlan(sess, proto.WorkspaceTransition_START)
Expand Down Expand Up @@ -913,7 +912,7 @@ func TestProvision_SafeEnv(t *testing.T) {

ctx, api := setupProvisioner(t, nil)
sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, map[string]string{"main.tf": echoResource}),
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{"main.tf": echoResource}),
})

err := sendPlan(sess, proto.WorkspaceTransition_START)
Expand Down
41 changes: 4 additions & 37 deletions provisioner/terraform/tfparse/tfparse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package tfparse_test

import (
"archive/tar"
"bytes"
"context"
"io"
"log"
Expand All @@ -11,7 +9,6 @@ import (
"cdr.dev/slog"
"cdr.dev/slog/sloggers/sloghuman"
"cdr.dev/slog/sloggers/slogtest"
"github.com/coder/coder/v2/archive"
"github.com/coder/coder/v2/provisioner/terraform/tfparse"
"github.com/coder/coder/v2/testutil"

Expand Down Expand Up @@ -363,7 +360,7 @@ func Test_WorkspaceTagDefaultsFromFile(t *testing.T) {
t.Run(tc.name+"/tar", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
tar := createTar(t, tc.files)
tar := testutil.CreateTar(t, tc.files)
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
tmpDir := t.TempDir()
tfparse.WriteArchive(tar, "application/x-tar", tmpDir)
Expand All @@ -381,7 +378,7 @@ func Test_WorkspaceTagDefaultsFromFile(t *testing.T) {
t.Run(tc.name+"/zip", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
zip := createZip(t, tc.files)
zip := testutil.CreateZip(t, tc.files)
logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
tmpDir := t.TempDir()
tfparse.WriteArchive(zip, "application/zip", tmpDir)
Expand All @@ -399,36 +396,6 @@ func Test_WorkspaceTagDefaultsFromFile(t *testing.T) {
}
}

func createTar(t testing.TB, files map[string]string) []byte {
var buffer bytes.Buffer
writer := tar.NewWriter(&buffer)
for path, content := range files {
err := writer.WriteHeader(&tar.Header{
Name: path,
Size: int64(len(content)),
Uid: 65534, // nobody
Gid: 65534, // nogroup
Mode: 0o666, // -rw-rw-rw-
})
require.NoError(t, err)

_, err = writer.Write([]byte(content))
require.NoError(t, err)
}

err := writer.Flush()
require.NoError(t, err)
return buffer.Bytes()
}

func createZip(t testing.TB, files map[string]string) []byte {
ta := createTar(t, files)
tr := tar.NewReader(bytes.NewReader(ta))
za, err := archive.CreateZipFromTar(tr, int64(len(ta)))
require.NoError(t, err)
return za
}

// Last run results:
// goos: linux
// goarch: amd64
Expand Down Expand Up @@ -460,8 +427,8 @@ func BenchmarkWorkspaceTagDefaultsFromFile(b *testing.B) {
}
}`,
}
tarFile := createTar(b, files)
zipFile := createZip(b, files)
tarFile := testutil.CreateTar(b, files)
zipFile := testutil.CreateZip(b, files)
logger := discardLogger(b)
b.ResetTimer()
b.Run("Tar", func(b *testing.B) {
Expand Down
2 changes: 1 addition & 1 deletion provisioner/terraform/timings_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestTimingsFromProvision(t *testing.T) {
binaryPath: fakeBin,
})
sess := configure(ctx, t, api, &proto.Config{
TemplateSourceArchive: makeTar(t, nil),
TemplateSourceArchive: testutil.CreateTar(t, nil),
})

ctx, cancel := context.WithTimeout(ctx, testutil.WaitLong)
Expand Down
48 changes: 13 additions & 35 deletions provisionerd/provisionerd_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package provisionerd_test

import (
"archive/tar"
"bytes"
"context"
"fmt"
"io"
Expand Down Expand Up @@ -97,7 +95,7 @@ func TestProvisionerd(t *testing.T) {
err := stream.Send(&proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_TemplateImport_{
Expand Down Expand Up @@ -150,7 +148,7 @@ func TestProvisionerd(t *testing.T) {
acq = newAcquireOne(t, &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"../../../etc/passwd": "content",
}),
Type: &proto.AcquiredJob_TemplateImport_{
Expand Down Expand Up @@ -194,7 +192,7 @@ func TestProvisionerd(t *testing.T) {
err := stream.Send(&proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_TemplateImport_{
Expand Down Expand Up @@ -243,7 +241,7 @@ func TestProvisionerd(t *testing.T) {
acq = newAcquireOne(t, &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
provisionersdk.ReadmeFile: "# A cool template 😎\n",
}),
Expand Down Expand Up @@ -325,7 +323,7 @@ func TestProvisionerd(t *testing.T) {
acq = newAcquireOne(t, &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_TemplateDryRun_{
Expand Down Expand Up @@ -396,7 +394,7 @@ func TestProvisionerd(t *testing.T) {
acq = newAcquireOne(t, &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -459,7 +457,7 @@ func TestProvisionerd(t *testing.T) {
acq = newAcquireOne(t, &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -549,7 +547,7 @@ func TestProvisionerd(t *testing.T) {
acq = newAcquireOne(t, &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -645,7 +643,7 @@ func TestProvisionerd(t *testing.T) {
err := stream.Send(&proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -725,7 +723,7 @@ func TestProvisionerd(t *testing.T) {
err := stream.Send(&proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -819,7 +817,7 @@ func TestProvisionerd(t *testing.T) {
job := &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -916,7 +914,7 @@ func TestProvisionerd(t *testing.T) {
job := &proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -1010,7 +1008,7 @@ func TestProvisionerd(t *testing.T) {
err := stream.Send(&proto.AcquiredJob{
JobId: "test",
Provisioner: "someprovisioner",
TemplateSourceArchive: createTar(t, map[string]string{
TemplateSourceArchive: testutil.CreateTar(t, map[string]string{
"test.txt": "content",
}),
Type: &proto.AcquiredJob_WorkspaceBuild_{
Expand Down Expand Up @@ -1078,26 +1076,6 @@ func TestProvisionerd(t *testing.T) {
})
}

// Creates an in-memory tar of the files provided.
func createTar(t *testing.T, files map[string]string) []byte {
var buffer bytes.Buffer
writer := tar.NewWriter(&buffer)
for path, content := range files {
err := writer.WriteHeader(&tar.Header{
Name: path,
Size: int64(len(content)),
})
require.NoError(t, err)

_, err = writer.Write([]byte(content))
require.NoError(t, err)
}

err := writer.Flush()
require.NoError(t, err)
return buffer.Bytes()
}

// Creates a provisionerd implementation with the provided dialer and provisioners.
func createProvisionerd(t *testing.T, dialer provisionerd.Dialer, connector provisionerd.LocalProvisioners) *provisionerd.Server {
server := provisionerd.New(dialer, &provisionerd.Options{
Expand Down
Loading
Loading