mirror of https://github.com/databricks/cli.git
Use filer for materializing template files
This commit is contained in:
parent
ca461bca57
commit
c71213ce56
|
@ -7,13 +7,22 @@ import (
|
||||||
"io/fs"
|
"io/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// WriteMode captures intent when writing a file.
|
||||||
|
//
|
||||||
|
// The first 9 bits are reserved for the [fs.FileMode] permission bits.
|
||||||
|
// These are used only by the local filer implementation and have
|
||||||
|
// no effect for the other implementations.
|
||||||
type WriteMode int
|
type WriteMode int
|
||||||
|
|
||||||
|
// writeModePerm is a mask to extract permission bits from a WriteMode.
|
||||||
|
const writeModePerm = WriteMode(fs.ModePerm)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
OverwriteIfExists WriteMode = 1 << iota
|
OverwriteIfExists WriteMode = writeModePerm + 1<<iota
|
||||||
CreateParentDirectories
|
CreateParentDirectories
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// DeleteMode captures intent when deleting a file.
|
||||||
type DeleteMode int
|
type DeleteMode int
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|
|
@ -0,0 +1,11 @@
|
||||||
|
package filer
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWriteMode(t *testing.T) {
|
||||||
|
assert.Equal(t, 512, int(OverwriteIfExists))
|
||||||
|
}
|
|
@ -28,6 +28,15 @@ func (w *LocalClient) Write(ctx context.Context, name string, reader io.Reader,
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Retrieve permission mask from the [WriteMode], if present.
|
||||||
|
perm := fs.FileMode(0644)
|
||||||
|
for _, m := range mode {
|
||||||
|
bits := m & writeModePerm
|
||||||
|
if bits != 0 {
|
||||||
|
perm = fs.FileMode(bits)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
flags := os.O_WRONLY | os.O_CREATE
|
flags := os.O_WRONLY | os.O_CREATE
|
||||||
if slices.Contains(mode, OverwriteIfExists) {
|
if slices.Contains(mode, OverwriteIfExists) {
|
||||||
flags |= os.O_TRUNC
|
flags |= os.O_TRUNC
|
||||||
|
@ -35,7 +44,7 @@ func (w *LocalClient) Write(ctx context.Context, name string, reader io.Reader,
|
||||||
flags |= os.O_EXCL
|
flags |= os.O_EXCL
|
||||||
}
|
}
|
||||||
|
|
||||||
f, err := os.OpenFile(absPath, flags, 0644)
|
f, err := os.OpenFile(absPath, flags, perm)
|
||||||
if errors.Is(err, fs.ErrNotExist) && slices.Contains(mode, CreateParentDirectories) {
|
if errors.Is(err, fs.ErrNotExist) && slices.Contains(mode, CreateParentDirectories) {
|
||||||
// Create parent directories if they don't exist.
|
// Create parent directories if they don't exist.
|
||||||
err = os.MkdirAll(filepath.Dir(absPath), 0755)
|
err = os.MkdirAll(filepath.Dir(absPath), 0755)
|
||||||
|
@ -43,7 +52,7 @@ func (w *LocalClient) Write(ctx context.Context, name string, reader io.Reader,
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
// Try again.
|
// Try again.
|
||||||
f, err = os.OpenFile(absPath, flags, 0644)
|
f, err = os.OpenFile(absPath, flags, perm)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -83,7 +83,7 @@ func TestTemplateConfigAssignValuesFromDefaultValues(t *testing.T) {
|
||||||
c, err := newConfig(ctx, os.DirFS(testDir), "schema.json")
|
c, err := newConfig(ctx, os.DirFS(testDir), "schema.json")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
r, err := newRenderer(ctx, nil, nil, os.DirFS("."), "./testdata/empty/template", "./testdata/empty/library", t.TempDir())
|
r, err := newRenderer(ctx, nil, nil, os.DirFS("."), "./testdata/empty/template", "./testdata/empty/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = c.assignDefaultValues(r)
|
err = c.assignDefaultValues(r)
|
||||||
|
@ -102,7 +102,7 @@ func TestTemplateConfigAssignValuesFromTemplatedDefaultValues(t *testing.T) {
|
||||||
c, err := newConfig(ctx, os.DirFS(testDir), "schema.json")
|
c, err := newConfig(ctx, os.DirFS(testDir), "schema.json")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
r, err := newRenderer(ctx, nil, nil, os.DirFS("."), path.Join(testDir, "template/template"), path.Join(testDir, "template/library"), t.TempDir())
|
r, err := newRenderer(ctx, nil, nil, os.DirFS("."), path.Join(testDir, "template/template"), path.Join(testDir, "template/library"))
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Note: only the string value is templated.
|
// Note: only the string value is templated.
|
||||||
|
|
|
@ -1,53 +1,36 @@
|
||||||
package template
|
package template
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"io"
|
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"slices"
|
"slices"
|
||||||
|
|
||||||
|
"github.com/databricks/cli/libs/filer"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Interface representing a file to be materialized from a template into a project
|
// Interface representing a file to be materialized from a template into a project
|
||||||
// instance
|
// instance
|
||||||
type file interface {
|
type file interface {
|
||||||
// Destination path for file. This is where the file will be created when
|
// Path of the file relative to the root of the instantiated template.
|
||||||
// PersistToDisk is called.
|
// This is where the file is written to when persisting the template to disk.
|
||||||
DstPath() *destinationPath
|
// Must be slash-separated.
|
||||||
|
RelPath() string
|
||||||
|
|
||||||
// Write file to disk at the destination path.
|
// Write file to disk at the destination path.
|
||||||
Write(ctx context.Context) error
|
Write(ctx context.Context, out filer.Filer) error
|
||||||
|
|
||||||
// contents returns the file contents as a byte slice.
|
// contents returns the file contents as a byte slice.
|
||||||
// This is used for testing purposes.
|
// This is used for testing purposes.
|
||||||
contents() ([]byte, error)
|
contents() ([]byte, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
type destinationPath struct {
|
|
||||||
// Root path for the project instance. This path uses the system's default
|
|
||||||
// file separator. For example /foo/bar on Unix and C:\foo\bar on windows
|
|
||||||
root string
|
|
||||||
|
|
||||||
// Unix like file path relative to the "root" of the instantiated project. Is used to
|
|
||||||
// evaluate whether the file should be skipped by comparing it to a list of
|
|
||||||
// skip glob patterns.
|
|
||||||
relPath string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Absolute path of the file, in the os native format. For example /foo/bar on
|
|
||||||
// Unix and C:\foo\bar on windows
|
|
||||||
func (f *destinationPath) absPath() string {
|
|
||||||
return filepath.Join(f.root, filepath.FromSlash(f.relPath))
|
|
||||||
}
|
|
||||||
|
|
||||||
type copyFile struct {
|
type copyFile struct {
|
||||||
ctx context.Context
|
|
||||||
|
|
||||||
// Permissions bits for the destination file
|
// Permissions bits for the destination file
|
||||||
perm fs.FileMode
|
perm fs.FileMode
|
||||||
|
|
||||||
dstPath *destinationPath
|
// Destination path for the file.
|
||||||
|
relPath string
|
||||||
|
|
||||||
// [fs.FS] rooted at template root. Used to read srcPath.
|
// [fs.FS] rooted at template root. Used to read srcPath.
|
||||||
srcFS fs.FS
|
srcFS fs.FS
|
||||||
|
@ -56,28 +39,17 @@ type copyFile struct {
|
||||||
srcPath string
|
srcPath string
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *copyFile) DstPath() *destinationPath {
|
func (f *copyFile) RelPath() string {
|
||||||
return f.dstPath
|
return f.relPath
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *copyFile) Write(ctx context.Context) error {
|
func (f *copyFile) Write(ctx context.Context, out filer.Filer) error {
|
||||||
path := f.DstPath().absPath()
|
src, err := f.srcFS.Open(f.srcPath)
|
||||||
err := os.MkdirAll(filepath.Dir(path), 0755)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
srcFile, err := f.srcFS.Open(f.srcPath)
|
defer src.Close()
|
||||||
if err != nil {
|
return out.Write(ctx, f.relPath, src, filer.CreateParentDirectories, filer.WriteMode(f.perm))
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer srcFile.Close()
|
|
||||||
dstFile, err := os.OpenFile(path, os.O_CREATE|os.O_EXCL|os.O_WRONLY, f.perm)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer dstFile.Close()
|
|
||||||
_, err = io.Copy(dstFile, srcFile)
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *copyFile) contents() ([]byte, error) {
|
func (f *copyFile) contents() ([]byte, error) {
|
||||||
|
@ -85,26 +57,22 @@ func (f *copyFile) contents() ([]byte, error) {
|
||||||
}
|
}
|
||||||
|
|
||||||
type inMemoryFile struct {
|
type inMemoryFile struct {
|
||||||
dstPath *destinationPath
|
|
||||||
|
|
||||||
content []byte
|
|
||||||
|
|
||||||
// Permissions bits for the destination file
|
// Permissions bits for the destination file
|
||||||
perm fs.FileMode
|
perm fs.FileMode
|
||||||
|
|
||||||
|
// Destination path for the file.
|
||||||
|
relPath string
|
||||||
|
|
||||||
|
// Contents of the file.
|
||||||
|
content []byte
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *inMemoryFile) DstPath() *destinationPath {
|
func (f *inMemoryFile) RelPath() string {
|
||||||
return f.dstPath
|
return f.relPath
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *inMemoryFile) Write(ctx context.Context) error {
|
func (f *inMemoryFile) Write(ctx context.Context, out filer.Filer) error {
|
||||||
path := f.DstPath().absPath()
|
return out.Write(ctx, f.relPath, bytes.NewReader(f.content), filer.CreateParentDirectories, filer.WriteMode(f.perm))
|
||||||
|
|
||||||
err := os.MkdirAll(filepath.Dir(path), 0755)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return os.WriteFile(path, f.content, f.perm)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *inMemoryFile) contents() ([]byte, error) {
|
func (f *inMemoryFile) contents() ([]byte, error) {
|
||||||
|
|
|
@ -8,6 +8,7 @@ import (
|
||||||
"runtime"
|
"runtime"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/databricks/cli/libs/filer"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
@ -16,14 +17,14 @@ func testInMemoryFile(t *testing.T, ctx context.Context, perm fs.FileMode) {
|
||||||
tmpDir := t.TempDir()
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
f := &inMemoryFile{
|
f := &inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "a/b/c",
|
|
||||||
},
|
|
||||||
perm: perm,
|
perm: perm,
|
||||||
|
relPath: "a/b/c",
|
||||||
content: []byte("123"),
|
content: []byte("123"),
|
||||||
}
|
}
|
||||||
err := f.Write(ctx)
|
|
||||||
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = f.Write(ctx, out)
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
|
|
||||||
assertFileContent(t, filepath.Join(tmpDir, "a/b/c"), "123")
|
assertFileContent(t, filepath.Join(tmpDir, "a/b/c"), "123")
|
||||||
|
@ -36,44 +37,21 @@ func testCopyFile(t *testing.T, ctx context.Context, perm fs.FileMode) {
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
f := ©File{
|
f := ©File{
|
||||||
ctx: context.Background(),
|
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "a/b/c",
|
|
||||||
},
|
|
||||||
perm: perm,
|
perm: perm,
|
||||||
srcPath: "source",
|
relPath: "a/b/c",
|
||||||
srcFS: os.DirFS(tmpDir),
|
srcFS: os.DirFS(tmpDir),
|
||||||
|
srcPath: "source",
|
||||||
}
|
}
|
||||||
err = f.Write(ctx)
|
|
||||||
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = f.Write(ctx, out)
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
|
|
||||||
assertFileContent(t, filepath.Join(tmpDir, "a/b/c"), "qwerty")
|
assertFileContent(t, filepath.Join(tmpDir, "a/b/c"), "qwerty")
|
||||||
assertFilePermissions(t, filepath.Join(tmpDir, "a/b/c"), perm)
|
assertFilePermissions(t, filepath.Join(tmpDir, "a/b/c"), perm)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTemplateFileDestinationPath(t *testing.T) {
|
|
||||||
if runtime.GOOS == "windows" {
|
|
||||||
t.SkipNow()
|
|
||||||
}
|
|
||||||
f := &destinationPath{
|
|
||||||
root: `a/b/c`,
|
|
||||||
relPath: "d/e",
|
|
||||||
}
|
|
||||||
assert.Equal(t, `a/b/c/d/e`, f.absPath())
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestTemplateFileDestinationPathForWindows(t *testing.T) {
|
|
||||||
if runtime.GOOS != "windows" {
|
|
||||||
t.SkipNow()
|
|
||||||
}
|
|
||||||
f := &destinationPath{
|
|
||||||
root: `c:\a\b\c`,
|
|
||||||
relPath: "d/e",
|
|
||||||
}
|
|
||||||
assert.Equal(t, `c:\a\b\c\d\e`, f.absPath())
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestTemplateInMemoryFilePersistToDisk(t *testing.T) {
|
func TestTemplateInMemoryFilePersistToDisk(t *testing.T) {
|
||||||
if runtime.GOOS == "windows" {
|
if runtime.GOOS == "windows" {
|
||||||
t.SkipNow()
|
t.SkipNow()
|
||||||
|
|
|
@ -18,11 +18,10 @@ import (
|
||||||
|
|
||||||
func TestTemplatePrintStringWithoutProcessing(t *testing.T) {
|
func TestTemplatePrintStringWithoutProcessing(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/print-without-processing/template", "./testdata/print-without-processing/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/print-without-processing/template", "./testdata/print-without-processing/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -35,11 +34,10 @@ func TestTemplatePrintStringWithoutProcessing(t *testing.T) {
|
||||||
|
|
||||||
func TestTemplateRegexpCompileFunction(t *testing.T) {
|
func TestTemplateRegexpCompileFunction(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/regexp-compile/template", "./testdata/regexp-compile/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/regexp-compile/template", "./testdata/regexp-compile/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -53,11 +51,10 @@ func TestTemplateRegexpCompileFunction(t *testing.T) {
|
||||||
|
|
||||||
func TestTemplateRandIntFunction(t *testing.T) {
|
func TestTemplateRandIntFunction(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/random-int/template", "./testdata/random-int/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/random-int/template", "./testdata/random-int/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -71,11 +68,10 @@ func TestTemplateRandIntFunction(t *testing.T) {
|
||||||
|
|
||||||
func TestTemplateUuidFunction(t *testing.T) {
|
func TestTemplateUuidFunction(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/uuid/template", "./testdata/uuid/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/uuid/template", "./testdata/uuid/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -88,11 +84,10 @@ func TestTemplateUuidFunction(t *testing.T) {
|
||||||
|
|
||||||
func TestTemplateUrlFunction(t *testing.T) {
|
func TestTemplateUrlFunction(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/urlparse-function/template", "./testdata/urlparse-function/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/urlparse-function/template", "./testdata/urlparse-function/library")
|
||||||
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
@ -105,11 +100,10 @@ func TestTemplateUrlFunction(t *testing.T) {
|
||||||
|
|
||||||
func TestTemplateMapPairFunction(t *testing.T) {
|
func TestTemplateMapPairFunction(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/map-pair/template", "./testdata/map-pair/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/map-pair/template", "./testdata/map-pair/library")
|
||||||
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
@ -122,7 +116,6 @@ func TestTemplateMapPairFunction(t *testing.T) {
|
||||||
|
|
||||||
func TestWorkspaceHost(t *testing.T) {
|
func TestWorkspaceHost(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
w := &databricks.WorkspaceClient{
|
w := &databricks.WorkspaceClient{
|
||||||
Config: &workspaceConfig.Config{
|
Config: &workspaceConfig.Config{
|
||||||
|
@ -132,7 +125,7 @@ func TestWorkspaceHost(t *testing.T) {
|
||||||
ctx = root.SetWorkspaceClient(ctx, w)
|
ctx = root.SetWorkspaceClient(ctx, w)
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/workspace-host/template", "./testdata/map-pair/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/workspace-host/template", "./testdata/map-pair/library")
|
||||||
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
@ -149,7 +142,6 @@ func TestWorkspaceHostNotConfigured(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
cmd := cmdio.NewIO(flags.OutputJSON, strings.NewReader(""), os.Stdout, os.Stderr, "", "template")
|
cmd := cmdio.NewIO(flags.OutputJSON, strings.NewReader(""), os.Stdout, os.Stderr, "", "template")
|
||||||
ctx = cmdio.InContext(ctx, cmd)
|
ctx = cmdio.InContext(ctx, cmd)
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
w := &databricks.WorkspaceClient{
|
w := &databricks.WorkspaceClient{
|
||||||
Config: &workspaceConfig.Config{},
|
Config: &workspaceConfig.Config{},
|
||||||
|
@ -157,7 +149,7 @@ func TestWorkspaceHostNotConfigured(t *testing.T) {
|
||||||
ctx = root.SetWorkspaceClient(ctx, w)
|
ctx = root.SetWorkspaceClient(ctx, w)
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/workspace-host/template", "./testdata/map-pair/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/workspace-host/template", "./testdata/map-pair/library")
|
||||||
|
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
|
|
||||||
|
|
|
@ -7,6 +7,7 @@ import (
|
||||||
"io/fs"
|
"io/fs"
|
||||||
|
|
||||||
"github.com/databricks/cli/libs/cmdio"
|
"github.com/databricks/cli/libs/cmdio"
|
||||||
|
"github.com/databricks/cli/libs/filer"
|
||||||
)
|
)
|
||||||
|
|
||||||
const libraryDirName = "library"
|
const libraryDirName = "library"
|
||||||
|
@ -40,7 +41,7 @@ func Materialize(ctx context.Context, configFilePath string, templateFS fs.FS, o
|
||||||
}
|
}
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, config.values, helpers, templateFS, templateDirName, libraryDirName, outputDir)
|
r, err := newRenderer(ctx, config.values, helpers, templateFS, templateDirName, libraryDirName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
@ -72,7 +73,12 @@ func Materialize(ctx context.Context, configFilePath string, templateFS fs.FS, o
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
err = r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(outputDir)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,7 +6,6 @@ import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
|
||||||
"path"
|
"path"
|
||||||
"regexp"
|
"regexp"
|
||||||
"slices"
|
"slices"
|
||||||
|
@ -14,6 +13,7 @@ import (
|
||||||
"strings"
|
"strings"
|
||||||
"text/template"
|
"text/template"
|
||||||
|
|
||||||
|
"github.com/databricks/cli/libs/filer"
|
||||||
"github.com/databricks/cli/libs/log"
|
"github.com/databricks/cli/libs/log"
|
||||||
"github.com/databricks/databricks-sdk-go/logger"
|
"github.com/databricks/databricks-sdk-go/logger"
|
||||||
)
|
)
|
||||||
|
@ -52,9 +52,6 @@ type renderer struct {
|
||||||
|
|
||||||
// [fs.FS] that holds the template's file tree.
|
// [fs.FS] that holds the template's file tree.
|
||||||
srcFS fs.FS
|
srcFS fs.FS
|
||||||
|
|
||||||
// Root directory for the project instantiated from the template
|
|
||||||
instanceRoot string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func newRenderer(
|
func newRenderer(
|
||||||
|
@ -64,7 +61,6 @@ func newRenderer(
|
||||||
templateFS fs.FS,
|
templateFS fs.FS,
|
||||||
templateDir string,
|
templateDir string,
|
||||||
libraryDir string,
|
libraryDir string,
|
||||||
instanceRoot string,
|
|
||||||
) (*renderer, error) {
|
) (*renderer, error) {
|
||||||
// Initialize new template, with helper functions loaded
|
// Initialize new template, with helper functions loaded
|
||||||
tmpl := template.New("").Funcs(helpers)
|
tmpl := template.New("").Funcs(helpers)
|
||||||
|
@ -99,7 +95,6 @@ func newRenderer(
|
||||||
files: make([]file, 0),
|
files: make([]file, 0),
|
||||||
skipPatterns: make([]string, 0),
|
skipPatterns: make([]string, 0),
|
||||||
srcFS: srcFS,
|
srcFS: srcFS,
|
||||||
instanceRoot: instanceRoot,
|
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -165,12 +160,8 @@ func (r *renderer) computeFile(relPathTemplate string) (file, error) {
|
||||||
// over as is, without treating it as a template
|
// over as is, without treating it as a template
|
||||||
if !strings.HasSuffix(relPathTemplate, templateExtension) {
|
if !strings.HasSuffix(relPathTemplate, templateExtension) {
|
||||||
return ©File{
|
return ©File{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: r.instanceRoot,
|
|
||||||
relPath: relPath,
|
|
||||||
},
|
|
||||||
perm: perm,
|
perm: perm,
|
||||||
ctx: r.ctx,
|
relPath: relPath,
|
||||||
srcFS: r.srcFS,
|
srcFS: r.srcFS,
|
||||||
srcPath: relPathTemplate,
|
srcPath: relPathTemplate,
|
||||||
}, nil
|
}, nil
|
||||||
|
@ -202,11 +193,8 @@ func (r *renderer) computeFile(relPathTemplate string) (file, error) {
|
||||||
}
|
}
|
||||||
|
|
||||||
return &inMemoryFile{
|
return &inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: r.instanceRoot,
|
|
||||||
relPath: relPath,
|
|
||||||
},
|
|
||||||
perm: perm,
|
perm: perm,
|
||||||
|
relPath: relPath,
|
||||||
content: []byte(content),
|
content: []byte(content),
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
@ -291,7 +279,7 @@ func (r *renderer) walk() error {
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
logger.Infof(r.ctx, "added file to list of possible project files: %s", f.DstPath().relPath)
|
logger.Infof(r.ctx, "added file to list of possible project files: %s", f.RelPath())
|
||||||
r.files = append(r.files, f)
|
r.files = append(r.files, f)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -299,17 +287,17 @@ func (r *renderer) walk() error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *renderer) persistToDisk(ctx context.Context) error {
|
func (r *renderer) persistToDisk(ctx context.Context, out filer.Filer) error {
|
||||||
// Accumulate files which we will persist, skipping files whose path matches
|
// Accumulate files which we will persist, skipping files whose path matches
|
||||||
// any of the skip patterns
|
// any of the skip patterns
|
||||||
filesToPersist := make([]file, 0)
|
filesToPersist := make([]file, 0)
|
||||||
for _, file := range r.files {
|
for _, file := range r.files {
|
||||||
match, err := isSkipped(file.DstPath().relPath, r.skipPatterns)
|
match, err := isSkipped(file.RelPath(), r.skipPatterns)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if match {
|
if match {
|
||||||
log.Infof(r.ctx, "skipping file: %s", file.DstPath())
|
log.Infof(r.ctx, "skipping file: %s", file.RelPath())
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
filesToPersist = append(filesToPersist, file)
|
filesToPersist = append(filesToPersist, file)
|
||||||
|
@ -317,8 +305,8 @@ func (r *renderer) persistToDisk(ctx context.Context) error {
|
||||||
|
|
||||||
// Assert no conflicting files exist
|
// Assert no conflicting files exist
|
||||||
for _, file := range filesToPersist {
|
for _, file := range filesToPersist {
|
||||||
path := file.DstPath().absPath()
|
path := file.RelPath()
|
||||||
_, err := os.Stat(path)
|
_, err := out.Stat(ctx, path)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
return fmt.Errorf("failed to initialize template, one or more files already exist: %s", path)
|
return fmt.Errorf("failed to initialize template, one or more files already exist: %s", path)
|
||||||
}
|
}
|
||||||
|
@ -329,7 +317,7 @@ func (r *renderer) persistToDisk(ctx context.Context) error {
|
||||||
|
|
||||||
// Persist files to disk
|
// Persist files to disk
|
||||||
for _, file := range filesToPersist {
|
for _, file := range filesToPersist {
|
||||||
err := file.Write(ctx)
|
err := file.Write(ctx, out)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
|
@ -18,6 +18,7 @@ import (
|
||||||
"github.com/databricks/cli/cmd/root"
|
"github.com/databricks/cli/cmd/root"
|
||||||
"github.com/databricks/cli/internal/testutil"
|
"github.com/databricks/cli/internal/testutil"
|
||||||
"github.com/databricks/cli/libs/diag"
|
"github.com/databricks/cli/libs/diag"
|
||||||
|
"github.com/databricks/cli/libs/filer"
|
||||||
"github.com/databricks/cli/libs/tags"
|
"github.com/databricks/cli/libs/tags"
|
||||||
"github.com/databricks/databricks-sdk-go"
|
"github.com/databricks/databricks-sdk-go"
|
||||||
workspaceConfig "github.com/databricks/databricks-sdk-go/config"
|
workspaceConfig "github.com/databricks/databricks-sdk-go/config"
|
||||||
|
@ -57,13 +58,15 @@ func assertBuiltinTemplateValid(t *testing.T, template string, settings map[stri
|
||||||
ctx = root.SetWorkspaceClient(ctx, w)
|
ctx = root.SetWorkspaceClient(ctx, w)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
|
|
||||||
renderer, err := newRenderer(ctx, settings, helpers, templateFS, templateDirName, libraryDirName, tempDir)
|
renderer, err := newRenderer(ctx, settings, helpers, templateFS, templateDirName, libraryDirName)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Evaluate template
|
// Evaluate template
|
||||||
err = renderer.walk()
|
err = renderer.walk()
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
err = renderer.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tempDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = renderer.persistToDisk(ctx, out)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
b, err := bundle.Load(ctx, filepath.Join(tempDir, "my_project"))
|
b, err := bundle.Load(ctx, filepath.Join(tempDir, "my_project"))
|
||||||
|
@ -181,13 +184,14 @@ func TestRendererWithAssociatedTemplateInLibrary(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/email/template", "./testdata/email/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/email/template", "./testdata/email/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
err = r.persistToDisk(ctx)
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
b, err := os.ReadFile(filepath.Join(tmpDir, "my_email"))
|
b, err := os.ReadFile(filepath.Join(tmpDir, "my_email"))
|
||||||
|
@ -312,45 +316,34 @@ func TestRendererPersistToDisk(t *testing.T) {
|
||||||
|
|
||||||
r := &renderer{
|
r := &renderer{
|
||||||
ctx: ctx,
|
ctx: ctx,
|
||||||
instanceRoot: tmpDir,
|
|
||||||
skipPatterns: []string{"a/b/c", "mn*"},
|
skipPatterns: []string{"a/b/c", "mn*"},
|
||||||
files: []file{
|
files: []file{
|
||||||
&inMemoryFile{
|
&inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "a/b/c",
|
|
||||||
},
|
|
||||||
perm: 0444,
|
perm: 0444,
|
||||||
|
relPath: "a/b/c",
|
||||||
content: nil,
|
content: nil,
|
||||||
},
|
},
|
||||||
&inMemoryFile{
|
&inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "mno",
|
|
||||||
},
|
|
||||||
perm: 0444,
|
perm: 0444,
|
||||||
|
relPath: "mno",
|
||||||
content: nil,
|
content: nil,
|
||||||
},
|
},
|
||||||
&inMemoryFile{
|
&inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "a/b/d",
|
|
||||||
},
|
|
||||||
perm: 0444,
|
perm: 0444,
|
||||||
|
relPath: "a/b/d",
|
||||||
content: []byte("123"),
|
content: []byte("123"),
|
||||||
},
|
},
|
||||||
&inMemoryFile{
|
&inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "mmnn",
|
|
||||||
},
|
|
||||||
perm: 0444,
|
perm: 0444,
|
||||||
|
relPath: "mmnn",
|
||||||
content: []byte("456"),
|
content: []byte("456"),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
err := r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
assert.NoFileExists(t, filepath.Join(tmpDir, "a", "b", "c"))
|
assert.NoFileExists(t, filepath.Join(tmpDir, "a", "b", "c"))
|
||||||
|
@ -365,10 +358,9 @@ func TestRendererPersistToDisk(t *testing.T) {
|
||||||
func TestRendererWalk(t *testing.T) {
|
func TestRendererWalk(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/walk/template", "./testdata/walk/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/walk/template", "./testdata/walk/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -376,7 +368,7 @@ func TestRendererWalk(t *testing.T) {
|
||||||
|
|
||||||
getContent := func(r *renderer, path string) string {
|
getContent := func(r *renderer, path string) string {
|
||||||
for _, f := range r.files {
|
for _, f := range r.files {
|
||||||
if f.DstPath().relPath != path {
|
if f.RelPath() != path {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
b, err := f.contents()
|
b, err := f.contents()
|
||||||
|
@ -397,10 +389,9 @@ func TestRendererWalk(t *testing.T) {
|
||||||
func TestRendererFailFunction(t *testing.T) {
|
func TestRendererFailFunction(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/fail/template", "./testdata/fail/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/fail/template", "./testdata/fail/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -410,10 +401,9 @@ func TestRendererFailFunction(t *testing.T) {
|
||||||
func TestRendererSkipsDirsEagerly(t *testing.T) {
|
func TestRendererSkipsDirsEagerly(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip-dir-eagerly/template", "./testdata/skip-dir-eagerly/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip-dir-eagerly/template", "./testdata/skip-dir-eagerly/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -430,7 +420,7 @@ func TestRendererSkipAllFilesInCurrentDirectory(t *testing.T) {
|
||||||
tmpDir := t.TempDir()
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip-all-files-in-cwd/template", "./testdata/skip-all-files-in-cwd/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip-all-files-in-cwd/template", "./testdata/skip-all-files-in-cwd/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -438,7 +428,9 @@ func TestRendererSkipAllFilesInCurrentDirectory(t *testing.T) {
|
||||||
// All 3 files are executed and have in memory representations
|
// All 3 files are executed and have in memory representations
|
||||||
require.Len(t, r.files, 3)
|
require.Len(t, r.files, 3)
|
||||||
|
|
||||||
err = r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
entries, err := os.ReadDir(tmpDir)
|
entries, err := os.ReadDir(tmpDir)
|
||||||
|
@ -450,10 +442,9 @@ func TestRendererSkipAllFilesInCurrentDirectory(t *testing.T) {
|
||||||
func TestRendererSkipPatternsAreRelativeToFileDirectory(t *testing.T) {
|
func TestRendererSkipPatternsAreRelativeToFileDirectory(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip-is-relative/template", "./testdata/skip-is-relative/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip-is-relative/template", "./testdata/skip-is-relative/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -471,7 +462,7 @@ func TestRendererSkip(t *testing.T) {
|
||||||
tmpDir := t.TempDir()
|
tmpDir := t.TempDir()
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip/template", "./testdata/skip/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/skip/template", "./testdata/skip/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -480,7 +471,9 @@ func TestRendererSkip(t *testing.T) {
|
||||||
// This is because "dir2/*" matches the files in dir2, but not dir2 itself
|
// This is because "dir2/*" matches the files in dir2, but not dir2 itself
|
||||||
assert.Len(t, r.files, 6)
|
assert.Len(t, r.files, 6)
|
||||||
|
|
||||||
err = r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
assert.FileExists(t, filepath.Join(tmpDir, "file1"))
|
assert.FileExists(t, filepath.Join(tmpDir, "file1"))
|
||||||
|
@ -498,12 +491,11 @@ func TestRendererReadsPermissionsBits(t *testing.T) {
|
||||||
if runtime.GOOS != "linux" && runtime.GOOS != "darwin" {
|
if runtime.GOOS != "linux" && runtime.GOOS != "darwin" {
|
||||||
t.SkipNow()
|
t.SkipNow()
|
||||||
}
|
}
|
||||||
tmpDir := t.TempDir()
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/executable-bit-read/template", "./testdata/executable-bit-read/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/executable-bit-read/template", "./testdata/executable-bit-read/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -511,7 +503,7 @@ func TestRendererReadsPermissionsBits(t *testing.T) {
|
||||||
|
|
||||||
getPermissions := func(r *renderer, path string) fs.FileMode {
|
getPermissions := func(r *renderer, path string) fs.FileMode {
|
||||||
for _, f := range r.files {
|
for _, f := range r.files {
|
||||||
if f.DstPath().relPath != path {
|
if f.RelPath() != path {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
switch v := f.(type) {
|
switch v := f.(type) {
|
||||||
|
@ -545,17 +537,16 @@ func TestRendererErrorOnConflictingFile(t *testing.T) {
|
||||||
skipPatterns: []string{},
|
skipPatterns: []string{},
|
||||||
files: []file{
|
files: []file{
|
||||||
&inMemoryFile{
|
&inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "a",
|
|
||||||
},
|
|
||||||
perm: 0444,
|
perm: 0444,
|
||||||
|
relPath: "a",
|
||||||
content: []byte("123"),
|
content: []byte("123"),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
err = r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
assert.EqualError(t, err, fmt.Sprintf("failed to initialize template, one or more files already exist: %s", filepath.Join(tmpDir, "a")))
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
|
assert.EqualError(t, err, fmt.Sprintf("failed to initialize template, one or more files already exist: %s", "a"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRendererNoErrorOnConflictingFileIfSkipped(t *testing.T) {
|
func TestRendererNoErrorOnConflictingFileIfSkipped(t *testing.T) {
|
||||||
|
@ -572,16 +563,15 @@ func TestRendererNoErrorOnConflictingFileIfSkipped(t *testing.T) {
|
||||||
skipPatterns: []string{"a"},
|
skipPatterns: []string{"a"},
|
||||||
files: []file{
|
files: []file{
|
||||||
&inMemoryFile{
|
&inMemoryFile{
|
||||||
dstPath: &destinationPath{
|
|
||||||
root: tmpDir,
|
|
||||||
relPath: "a",
|
|
||||||
},
|
|
||||||
perm: 0444,
|
perm: 0444,
|
||||||
|
relPath: "a",
|
||||||
content: []byte("123"),
|
content: []byte("123"),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
err = r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
// No error is returned even though a conflicting file exists. This is because
|
// No error is returned even though a conflicting file exists. This is because
|
||||||
// the generated file is being skipped
|
// the generated file is being skipped
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
|
@ -591,10 +581,9 @@ func TestRendererNoErrorOnConflictingFileIfSkipped(t *testing.T) {
|
||||||
func TestRendererNonTemplatesAreCreatedAsCopyFiles(t *testing.T) {
|
func TestRendererNonTemplatesAreCreatedAsCopyFiles(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = root.SetWorkspaceClient(ctx, nil)
|
ctx = root.SetWorkspaceClient(ctx, nil)
|
||||||
tmpDir := t.TempDir()
|
|
||||||
|
|
||||||
helpers := loadHelpers(ctx)
|
helpers := loadHelpers(ctx)
|
||||||
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/copy-file-walk/template", "./testdata/copy-file-walk/library", tmpDir)
|
r, err := newRenderer(ctx, nil, helpers, os.DirFS("."), "./testdata/copy-file-walk/template", "./testdata/copy-file-walk/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -602,7 +591,7 @@ func TestRendererNonTemplatesAreCreatedAsCopyFiles(t *testing.T) {
|
||||||
|
|
||||||
assert.Len(t, r.files, 1)
|
assert.Len(t, r.files, 1)
|
||||||
assert.Equal(t, r.files[0].(*copyFile).srcPath, "not-a-template")
|
assert.Equal(t, r.files[0].(*copyFile).srcPath, "not-a-template")
|
||||||
assert.Equal(t, r.files[0].DstPath().absPath(), filepath.Join(tmpDir, "not-a-template"))
|
assert.Equal(t, r.files[0].RelPath(), "not-a-template")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRendererFileTreeRendering(t *testing.T) {
|
func TestRendererFileTreeRendering(t *testing.T) {
|
||||||
|
@ -614,7 +603,7 @@ func TestRendererFileTreeRendering(t *testing.T) {
|
||||||
r, err := newRenderer(ctx, map[string]any{
|
r, err := newRenderer(ctx, map[string]any{
|
||||||
"dir_name": "my_directory",
|
"dir_name": "my_directory",
|
||||||
"file_name": "my_file",
|
"file_name": "my_file",
|
||||||
}, helpers, os.DirFS("."), "./testdata/file-tree-rendering/template", "./testdata/file-tree-rendering/library", tmpDir)
|
}, helpers, os.DirFS("."), "./testdata/file-tree-rendering/template", "./testdata/file-tree-rendering/library")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -622,9 +611,11 @@ func TestRendererFileTreeRendering(t *testing.T) {
|
||||||
|
|
||||||
// Assert in memory representation is created.
|
// Assert in memory representation is created.
|
||||||
assert.Len(t, r.files, 1)
|
assert.Len(t, r.files, 1)
|
||||||
assert.Equal(t, r.files[0].DstPath().absPath(), filepath.Join(tmpDir, "my_directory", "my_file"))
|
assert.Equal(t, r.files[0].RelPath(), "my_directory/my_file")
|
||||||
|
|
||||||
err = r.persistToDisk(ctx)
|
out, err := filer.NewLocalClient(tmpDir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = r.persistToDisk(ctx, out)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Assert files and directories are correctly materialized.
|
// Assert files and directories are correctly materialized.
|
||||||
|
@ -646,8 +637,7 @@ func TestRendererSubTemplateInPath(t *testing.T) {
|
||||||
// https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file.
|
// https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file.
|
||||||
testutil.Touch(t, filepath.Join(templateDir, "template/{{template `dir_name`}}/{{template `file_name`}}"))
|
testutil.Touch(t, filepath.Join(templateDir, "template/{{template `dir_name`}}/{{template `file_name`}}"))
|
||||||
|
|
||||||
tmpDir := t.TempDir()
|
r, err := newRenderer(ctx, nil, nil, os.DirFS(templateDir), "template", "library")
|
||||||
r, err := newRenderer(ctx, nil, nil, os.DirFS(templateDir), "template", "library", tmpDir)
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
err = r.walk()
|
err = r.walk()
|
||||||
|
@ -655,7 +645,6 @@ func TestRendererSubTemplateInPath(t *testing.T) {
|
||||||
|
|
||||||
if assert.Len(t, r.files, 2) {
|
if assert.Len(t, r.files, 2) {
|
||||||
f := r.files[1]
|
f := r.files[1]
|
||||||
assert.Equal(t, filepath.Join(tmpDir, "my_directory", "my_file"), f.DstPath().absPath())
|
assert.Equal(t, "my_directory/my_file", f.RelPath())
|
||||||
assert.Equal(t, "my_directory/my_file", f.DstPath().relPath)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue