mirror of
https://github.com/mikefarah/yq.git
synced 2026-06-28 07:57:43 +00:00
249efaee46
When using --split-exp to split documents into per-file outputs, yq silently overwrites any pre-existing files at the target paths because os.Create truncates. For workflows that generate filenames from input data (e.g. '.metadata.name + ".yml"'), this can clobber unrelated files when two documents map to the same name, or when a target path collides with something already on disk. This change adds an opt-in --split-exp-no-overwrite flag (and a matching yqlib constructor NewMultiPrinterWriterWithOptions) that uses O_WRONLY|O_CREATE|O_EXCL so existing files are left untouched and yq exits with a clear error message instead. The default behaviour (overwrite) is unchanged; the original NewMultiPrinterWriter constructor still exists and now delegates to the new options-aware constructor with noOverwrite=false. Fixes #2028
97 lines
2.7 KiB
Go
97 lines
2.7 KiB
Go
package yqlib
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// helper to build an ExpressionNode that just yields a fixed string for the file name
|
|
func parseFilenameExp(t *testing.T, exp string) *ExpressionNode {
|
|
t.Helper()
|
|
InitExpressionParser()
|
|
node, err := ExpressionParser.ParseExpression(exp)
|
|
if err != nil {
|
|
t.Fatalf("failed to parse split-exp test expression %q: %v", exp, err)
|
|
}
|
|
return node
|
|
}
|
|
|
|
func TestMultiPrinterWriterOverwriteDefault(t *testing.T) {
|
|
dir := t.TempDir()
|
|
target := filepath.Join(dir, "out.yml")
|
|
if err := os.WriteFile(target, []byte("pre-existing\n"), 0600); err != nil {
|
|
t.Fatalf("setup: %v", err)
|
|
}
|
|
|
|
exp := parseFilenameExp(t, `"`+target+`"`)
|
|
pw := NewMultiPrinterWriter(exp, YamlFormat)
|
|
|
|
node := &CandidateNode{Kind: ScalarNode, Tag: "!!str", Value: "hello"}
|
|
w, err := pw.GetWriter(node)
|
|
if err != nil {
|
|
t.Fatalf("default behaviour should silently overwrite, got error: %v", err)
|
|
}
|
|
if w == nil {
|
|
t.Fatalf("expected a writer, got nil")
|
|
}
|
|
// confirm the file was truncated/recreated by os.Create
|
|
info, err := os.Stat(target)
|
|
if err != nil {
|
|
t.Fatalf("stat target: %v", err)
|
|
}
|
|
if info.Size() != 0 {
|
|
t.Fatalf("expected file to be truncated (size 0) before writes, got %d bytes", info.Size())
|
|
}
|
|
}
|
|
|
|
func TestMultiPrinterWriterNoOverwriteRefusesExisting(t *testing.T) {
|
|
dir := t.TempDir()
|
|
target := filepath.Join(dir, "out.yml")
|
|
if err := os.WriteFile(target, []byte("pre-existing\n"), 0600); err != nil {
|
|
t.Fatalf("setup: %v", err)
|
|
}
|
|
|
|
exp := parseFilenameExp(t, `"`+target+`"`)
|
|
pw := NewMultiPrinterWriterWithOptions(exp, YamlFormat, true)
|
|
|
|
node := &CandidateNode{Kind: ScalarNode, Tag: "!!str", Value: "hello"}
|
|
_, err := pw.GetWriter(node)
|
|
if err == nil {
|
|
t.Fatalf("expected error when --no-overwrite is set and target exists, got nil")
|
|
}
|
|
if !strings.Contains(err.Error(), "refusing to overwrite") {
|
|
t.Fatalf("expected refusing-to-overwrite error message, got: %v", err)
|
|
}
|
|
|
|
// file must be untouched
|
|
data, err := os.ReadFile(target)
|
|
if err != nil {
|
|
t.Fatalf("read target: %v", err)
|
|
}
|
|
if string(data) != "pre-existing\n" {
|
|
t.Fatalf("file should be untouched, contents = %q", string(data))
|
|
}
|
|
}
|
|
|
|
func TestMultiPrinterWriterNoOverwriteCreatesNew(t *testing.T) {
|
|
dir := t.TempDir()
|
|
target := filepath.Join(dir, "new.yml")
|
|
|
|
exp := parseFilenameExp(t, `"`+target+`"`)
|
|
pw := NewMultiPrinterWriterWithOptions(exp, YamlFormat, true)
|
|
|
|
node := &CandidateNode{Kind: ScalarNode, Tag: "!!str", Value: "hello"}
|
|
w, err := pw.GetWriter(node)
|
|
if err != nil {
|
|
t.Fatalf("no-overwrite should still create new files, got: %v", err)
|
|
}
|
|
if w == nil {
|
|
t.Fatalf("expected a writer, got nil")
|
|
}
|
|
if _, err := os.Stat(target); err != nil {
|
|
t.Fatalf("expected new file to exist, stat err: %v", err)
|
|
}
|
|
}
|