package template import ( "context" "fmt" "io" "io/fs" "os" "path/filepath" "runtime" "strings" "testing" "text/template" "github.com/databricks/cli/cmd/root" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) func assertFileContent(t *testing.T, path string, content string) { b, err := os.ReadFile(path) require.NoError(t, err) assert.Equal(t, content, string(b)) } func assertFilePermissions(t *testing.T, path string, perm fs.FileMode) { info, err := os.Stat(path) require.NoError(t, err) assert.Equal(t, perm, info.Mode().Perm()) } func TestRendererWithAssociatedTemplateInLibrary(t *testing.T) { tmpDir := t.TempDir() ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/email/template", "./testdata/email/library", tmpDir) require.NoError(t, err) err = r.walk() require.NoError(t, err) err = r.persistToDisk() require.NoError(t, err) b, err := os.ReadFile(filepath.Join(tmpDir, "my_email")) require.NoError(t, err) assert.Equal(t, "shreyas.goenka@databricks.com", strings.Trim(string(b), "\n\r")) } func TestRendererExecuteTemplate(t *testing.T) { templateText := `"{{.count}} items are made of {{.Material}}". {{if eq .Animal "sheep" }} Sheep wool is the best! {{else}} {{.Animal}} wool is not too bad... {{end}} My email is {{template "email"}} ` r := renderer{ config: map[string]any{ "Material": "wool", "count": 1, "Animal": "sheep", }, baseTemplate: template.Must(template.New("base").Parse(`{{define "email"}}shreyas.goenka@databricks.com{{end}}`)), } statement, err := r.executeTemplate(templateText) require.NoError(t, err) assert.Contains(t, statement, `"1 items are made of wool"`) assert.NotContains(t, statement, `cat wool is not too bad.."`) assert.Contains(t, statement, "Sheep wool is the best!") assert.Contains(t, statement, `My email is shreyas.goenka@databricks.com`) r = renderer{ config: map[string]any{ "Material": "wool", "count": 1, "Animal": "cat", }, baseTemplate: template.Must(template.New("base").Parse(`{{define "email"}}hrithik.roshan@databricks.com{{end}}`)), } statement, err = r.executeTemplate(templateText) require.NoError(t, err) assert.Contains(t, statement, `"1 items are made of wool"`) assert.Contains(t, statement, `cat wool is not too bad...`) assert.NotContains(t, statement, "Sheep wool is the best!") assert.Contains(t, statement, `My email is hrithik.roshan@databricks.com`) } func TestRendererIsSkipped(t *testing.T) { skipPatterns := []string{"a*", "*yz", "def", "a/b/*"} // skipped paths match, err := isSkipped("abc", skipPatterns) require.NoError(t, err) assert.True(t, match) match, err = isSkipped("abcd", skipPatterns) require.NoError(t, err) assert.True(t, match) match, err = isSkipped("a", skipPatterns) require.NoError(t, err) assert.True(t, match) match, err = isSkipped("xxyz", skipPatterns) require.NoError(t, err) assert.True(t, match) match, err = isSkipped("yz", skipPatterns) require.NoError(t, err) assert.True(t, match) match, err = isSkipped("a/b/c", skipPatterns) require.NoError(t, err) assert.True(t, match) // NOT skipped paths match, err = isSkipped(".", skipPatterns) require.NoError(t, err) assert.False(t, match) match, err = isSkipped("y", skipPatterns) require.NoError(t, err) assert.False(t, match) match, err = isSkipped("z", skipPatterns) require.NoError(t, err) assert.False(t, match) match, err = isSkipped("defg", skipPatterns) require.NoError(t, err) assert.False(t, match) match, err = isSkipped("cat", skipPatterns) require.NoError(t, err) assert.False(t, match) match, err = isSkipped("a/b/c/d", skipPatterns) require.NoError(t, err) assert.False(t, match) } func TestRendererPersistToDisk(t *testing.T) { tmpDir := t.TempDir() ctx := context.Background() r := &renderer{ ctx: ctx, instanceRoot: tmpDir, skipPatterns: []string{"a/b/c", "mn*"}, files: []file{ &inMemoryFile{ dstPath: &destinationPath{ root: tmpDir, relPath: "a/b/c", }, perm: 0444, content: nil, }, &inMemoryFile{ dstPath: &destinationPath{ root: tmpDir, relPath: "mno", }, perm: 0444, content: nil, }, &inMemoryFile{ dstPath: &destinationPath{ root: tmpDir, relPath: "a/b/d", }, perm: 0444, content: []byte("123"), }, &inMemoryFile{ dstPath: &destinationPath{ root: tmpDir, relPath: "mmnn", }, perm: 0444, content: []byte("456"), }, }, } err := r.persistToDisk() require.NoError(t, err) assert.NoFileExists(t, filepath.Join(tmpDir, "a", "b", "c")) assert.NoFileExists(t, filepath.Join(tmpDir, "mno")) assertFileContent(t, filepath.Join(tmpDir, "a", "b", "d"), "123") assertFilePermissions(t, filepath.Join(tmpDir, "a", "b", "d"), 0444) assertFileContent(t, filepath.Join(tmpDir, "mmnn"), "456") assertFilePermissions(t, filepath.Join(tmpDir, "mmnn"), 0444) } func TestRendererWalk(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/walk/template", "./testdata/walk/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) getContent := func(r *renderer, path string) string { for _, f := range r.files { if f.DstPath().relPath != path { continue } switch v := f.(type) { case *inMemoryFile: return strings.Trim(string(v.content), "\r\n") case *copyFile: r, err := r.templateFiler.Read(context.Background(), v.srcPath) require.NoError(t, err) b, err := io.ReadAll(r) require.NoError(t, err) return strings.Trim(string(b), "\r\n") default: require.FailNow(t, "execution should not reach here") } } require.FailNow(t, "file is absent: "+path) return "" } assert.Len(t, r.files, 4) assert.Equal(t, "file one", getContent(r, "file1")) assert.Equal(t, "file two", getContent(r, "file2")) assert.Equal(t, "file three", getContent(r, "dir1/dir3/file3")) assert.Equal(t, "file four", getContent(r, "dir2/file4")) } func TestRendererFailFunction(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/fail/template", "./testdata/fail/library", tmpDir) require.NoError(t, err) err = r.walk() assert.Equal(t, "I am an error message", err.Error()) } func TestRendererSkipsDirsEagerly(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/skip-dir-eagerly/template", "./testdata/skip-dir-eagerly/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) assert.Len(t, r.files, 1) content := string(r.files[0].(*inMemoryFile).content) assert.Equal(t, "I should be the only file created", strings.Trim(content, "\r\n")) } func TestRendererSkipAllFilesInCurrentDirectory(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/skip-all-files-in-cwd/template", "./testdata/skip-all-files-in-cwd/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) // All 3 files are executed and have in memory representations require.Len(t, r.files, 3) err = r.persistToDisk() require.NoError(t, err) entries, err := os.ReadDir(tmpDir) require.NoError(t, err) // Assert none of the files are persisted to disk, because of {{skip "*"}} assert.Len(t, entries, 0) } func TestRendererSkipPatternsAreRelativeToFileDirectory(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/skip-is-relative/template", "./testdata/skip-is-relative/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) assert.Len(t, r.skipPatterns, 3) assert.Contains(t, r.skipPatterns, "a") assert.Contains(t, r.skipPatterns, "dir1/b") assert.Contains(t, r.skipPatterns, "dir1/dir2/c") } func TestRendererSkip(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/skip/template", "./testdata/skip/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) // All 6 files are computed, even though "dir2/*" is present as a skip pattern // This is because "dir2/*" matches the files in dir2, but not dir2 itself assert.Len(t, r.files, 6) err = r.persistToDisk() require.NoError(t, err) assert.FileExists(t, filepath.Join(tmpDir, "file1")) assert.FileExists(t, filepath.Join(tmpDir, "file2")) assert.FileExists(t, filepath.Join(tmpDir, "dir1/file5")) // These files have been skipped assert.NoFileExists(t, filepath.Join(tmpDir, "file3")) assert.NoFileExists(t, filepath.Join(tmpDir, "dir1/file4")) assert.NoDirExists(t, filepath.Join(tmpDir, "dir2")) assert.NoFileExists(t, filepath.Join(tmpDir, "dir2/file6")) } func TestRendererReadsPermissionsBits(t *testing.T) { if runtime.GOOS != "linux" && runtime.GOOS != "darwin" { t.SkipNow() } tmpDir := t.TempDir() ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/executable-bit-read/template", "./testdata/executable-bit-read/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) getPermissions := func(r *renderer, path string) fs.FileMode { for _, f := range r.files { if f.DstPath().relPath != path { continue } switch v := f.(type) { case *inMemoryFile: return v.perm case *copyFile: return v.perm default: require.FailNow(t, "execution should not reach here") } } require.FailNow(t, "file is absent: "+path) return 0 } assert.Len(t, r.files, 2) assert.Equal(t, getPermissions(r, "script.sh"), fs.FileMode(0755)) assert.Equal(t, getPermissions(r, "not-a-script"), fs.FileMode(0644)) } func TestRendererErrorOnConflictingFile(t *testing.T) { tmpDir := t.TempDir() f, err := os.Create(filepath.Join(tmpDir, "a")) require.NoError(t, err) err = f.Close() require.NoError(t, err) r := renderer{ skipPatterns: []string{}, files: []file{ &inMemoryFile{ dstPath: &destinationPath{ root: tmpDir, relPath: "a", }, perm: 0444, content: []byte("123"), }, }, } err = r.persistToDisk() assert.EqualError(t, err, fmt.Sprintf("failed to persist to disk, conflict with existing file: %s", filepath.Join(tmpDir, "a"))) } func TestRendererNoErrorOnConflictingFileIfSkipped(t *testing.T) { tmpDir := t.TempDir() ctx := context.Background() f, err := os.Create(filepath.Join(tmpDir, "a")) require.NoError(t, err) err = f.Close() require.NoError(t, err) r := renderer{ ctx: ctx, skipPatterns: []string{"a"}, files: []file{ &inMemoryFile{ dstPath: &destinationPath{ root: tmpDir, relPath: "a", }, perm: 0444, content: []byte("123"), }, }, } err = r.persistToDisk() // No error is returned even though a conflicting file exists. This is because // the generated file is being skipped assert.NoError(t, err) assert.Len(t, r.files, 1) } func TestRendererNonTemplatesAreCreatedAsCopyFiles(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/copy-file-walk/template", "./testdata/copy-file-walk/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) assert.Len(t, r.files, 1) 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")) } func TestRendererFileTreeRendering(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, map[string]any{ "dir_name": "my_directory", "file_name": "my_file", }, helpers, "./testdata/file-tree-rendering/template", "./testdata/file-tree-rendering/library", tmpDir) require.NoError(t, err) err = r.walk() assert.NoError(t, err) // Assert in memory representation is created. assert.Len(t, r.files, 1) assert.Equal(t, r.files[0].DstPath().absPath(), filepath.Join(tmpDir, "my_directory", "my_file")) err = r.persistToDisk() require.NoError(t, err) // Assert files and directories are correctly materialized. assert.DirExists(t, filepath.Join(tmpDir, "my_directory")) assert.FileExists(t, filepath.Join(tmpDir, "my_directory", "my_file")) } func TestRendererSubTemplateInPath(t *testing.T) { ctx := context.Background() ctx = root.SetWorkspaceClient(ctx, nil) tmpDir := t.TempDir() helpers := loadHelpers(ctx) r, err := newRenderer(ctx, nil, helpers, "./testdata/template-in-path/template", "./testdata/template-in-path/library", tmpDir) require.NoError(t, err) err = r.walk() require.NoError(t, err) assert.Equal(t, filepath.Join(tmpDir, "my_directory", "my_file"), r.files[0].DstPath().absPath()) assert.Equal(t, "my_directory/my_file", r.files[0].DstPath().relPath) }