Skip to content

fix: tar: do not archive .tfvars #11208

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 2 commits into from
Dec 15, 2023
Merged

fix: tar: do not archive .tfvars #11208

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
0db5aef
fix: do not archive .tfvars
mtojek Dec 14, 2023
9752402
Use logger.Debug
mtojek Dec 15, 2023
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
2 changes: 1 addition & 1 deletion cli/templatepush.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func (pf *templateUploadFlags) upload(inv *clibase.Invocation, client *codersdk.

pipeReader, pipeWriter := io.Pipe()
go func() {
err := provisionersdk.Tar(pipeWriter, pf.directory, provisionersdk.TemplateArchiveLimit)
err := provisionersdk.Tar(pipeWriter, inv.Logger, pf.directory, provisionersdk.TemplateArchiveLimit)
_ = pipeWriter.CloseWithError(err)
}()
defer pipeReader.Close()
Expand Down
11 changes: 10 additions & 1 deletion provisionersdk/archive.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@ package provisionersdk

import (
"archive/tar"
"context"
"io"
"os"
"path/filepath"
"strings"

"golang.org/x/xerrors"

"cdr.dev/slog"

"github.com/coder/coder/v2/coderd/util/xio"
)

Expand Down Expand Up @@ -39,7 +42,7 @@ func DirHasLockfile(dir string) (bool, error) {
}

// Tar archives a Terraform directory.
func Tar(w io.Writer, directory string, limit int64) error {
func Tar(w io.Writer, logger slog.Logger, directory string, limit int64) error {
// The total bytes written must be under the limit, so use -1
w = xio.NewLimitWriter(w, limit-1)
tarWriter := tar.NewWriter(w)
Expand Down Expand Up @@ -94,6 +97,12 @@ func Tar(w io.Writer, directory string, limit int64) error {
}
if strings.Contains(rel, ".tfstate") {
// Don't store tfstate!
logger.Debug(context.Background(), "skip state", slog.F("name", rel))
return nil
}
if rel == "terraform.tfvars" || rel == "terraform.tfvars.json" || strings.HasSuffix(rel, ".auto.tfvars") || strings.HasSuffix(rel, ".auto.tfvars.json") {
// Don't store .tfvars, as Coder uses their own variables file.
logger.Debug(context.Background(), "skip variable definitions", slog.F("name", rel))
return nil
}
// Use unix paths in the tar archive.
Expand Down
42 changes: 30 additions & 12 deletions provisionersdk/archive_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,16 @@ import (

"github.com/stretchr/testify/require"

"cdr.dev/slog/sloggers/slogtest"

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

func TestTar(t *testing.T) {
t.Parallel()

log := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true})

t.Run("NoFollowSymlink", func(t *testing.T) {
t.Parallel()
dir := t.TempDir()
Expand All @@ -28,7 +33,7 @@ func TestTar(t *testing.T) {
err = os.Symlink("no-exists", filepath.Join(dir, "link"))
require.NoError(t, err)

err = provisionersdk.Tar(io.Discard, dir, 1024*1024)
err = provisionersdk.Tar(io.Discard, log, dir, 1024*1024)
require.NoError(t, err)
})
t.Run("HeaderBreakLimit", func(t *testing.T) {
Expand All @@ -38,7 +43,7 @@ func TestTar(t *testing.T) {
require.NoError(t, err)
_ = file.Close()
// A header is 512 bytes
err = provisionersdk.Tar(io.Discard, dir, 100)
err = provisionersdk.Tar(io.Discard, log, dir, 100)
require.Error(t, err)
})
t.Run("HeaderAndContent", func(t *testing.T) {
Expand All @@ -49,11 +54,11 @@ func TestTar(t *testing.T) {
_, _ = file.Write(make([]byte, 100))
_ = file.Close()
// Pay + header is 1024 bytes (padding)
err = provisionersdk.Tar(io.Discard, dir, 1025)
err = provisionersdk.Tar(io.Discard, log, dir, 1025)
require.NoError(t, err)

// Limit is 1 byte too small (n == limit is a failure, must be under)
err = provisionersdk.Tar(io.Discard, dir, 1024)
err = provisionersdk.Tar(io.Discard, log, dir, 1024)
require.Error(t, err)
})

Expand All @@ -63,7 +68,7 @@ func TestTar(t *testing.T) {
file, err := os.CreateTemp(dir, "")
require.NoError(t, err)
_ = file.Close()
err = provisionersdk.Tar(io.Discard, dir, 1024)
err = provisionersdk.Tar(io.Discard, log, dir, 1024)
require.Error(t, err)
})
t.Run("Valid", func(t *testing.T) {
Expand All @@ -72,7 +77,7 @@ func TestTar(t *testing.T) {
file, err := os.CreateTemp(dir, "*.tf")
require.NoError(t, err)
_ = file.Close()
err = provisionersdk.Tar(io.Discard, dir, 1024)
err = provisionersdk.Tar(io.Discard, log, dir, 1024)
require.NoError(t, err)
})
t.Run("ValidJSON", func(t *testing.T) {
Expand All @@ -81,7 +86,7 @@ func TestTar(t *testing.T) {
file, err := os.CreateTemp(dir, "*.tf.json")
require.NoError(t, err)
_ = file.Close()
err = provisionersdk.Tar(io.Discard, dir, 1024)
err = provisionersdk.Tar(io.Discard, log, dir, 1024)
require.NoError(t, err)
})
t.Run("HiddenFiles", func(t *testing.T) {
Expand Down Expand Up @@ -122,6 +127,18 @@ func TestTar(t *testing.T) {
}, {
Name: "terraform.tfstate",
Archives: false,
}, {
Name: "terraform.tfvars",
Archives: false,
}, {
Name: "terraform.tfvars.json",
Archives: false,
}, {
Name: "*.auto.tfvars",
Archives: false,
}, {
Name: "*.auto.tfvars.json",
Archives: false,
},
}
for _, file := range files {
Expand Down Expand Up @@ -149,31 +166,32 @@ func TestTar(t *testing.T) {
}
archive := new(bytes.Buffer)
// Headers are chonky so raise the limit to something reasonable
err := provisionersdk.Tar(archive, dir, 1024<<2)
err := provisionersdk.Tar(archive, log, dir, 1024<<3)
require.NoError(t, err)
dir = t.TempDir()
err = provisionersdk.Untar(dir, archive)
require.NoError(t, err)
for _, file := range files {
_, err = os.Stat(filepath.Join(dir, file.Name))
t.Logf("stat %q %+v", file.Name, err)
if file.Archives {
require.NoError(t, err)
require.NoError(t, err, "stat %q, got error: %+v", file.Name, err)
} else {
require.ErrorIs(t, err, os.ErrNotExist)
require.ErrorIs(t, err, os.ErrNotExist, "stat %q, expected ErrNotExist, got: %+v", file.Name, err)
}
}
})
}

func TestUntar(t *testing.T) {
t.Parallel()
log := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true})

dir := t.TempDir()
file, err := os.CreateTemp(dir, "*.tf")
require.NoError(t, err)
_ = file.Close()
archive := new(bytes.Buffer)
err = provisionersdk.Tar(archive, dir, 1024)
err = provisionersdk.Tar(archive, log, dir, 1024)
require.NoError(t, err)
dir = t.TempDir()
err = provisionersdk.Untar(dir, archive)
Expand Down