Add extension normalization command

This commit is contained in:
Rogee
2025-10-30 10:31:53 +08:00
parent f66c59fd57
commit 6a353b5086
35 changed files with 2306 additions and 2 deletions

View File

@@ -0,0 +1,137 @@
package contract
import (
"bytes"
"context"
"errors"
"os"
"path/filepath"
"strings"
"testing"
"github.com/rogeecn/renamer/internal/extension"
"github.com/rogeecn/renamer/internal/listing"
)
func TestExtensionPreviewAndApply(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
writeTestFile(t, filepath.Join(tmp, "photo.jpeg"))
writeTestFile(t, filepath.Join(tmp, "banner.JPG"))
writeTestFile(t, filepath.Join(tmp, "logo.jpg"))
writeTestFile(t, filepath.Join(tmp, "notes.txt"))
scope := &listing.ListingRequest{
WorkingDir: tmp,
IncludeDirectories: false,
Recursive: false,
IncludeHidden: false,
Extensions: nil,
Format: listing.FormatTable,
}
if err := scope.Validate(); err != nil {
t.Fatalf("validate scope: %v", err)
}
req := extension.NewRequest(scope)
req.SetExecutionMode(true, false)
sources := []string{".jpeg", ".JPG", ".jpg"}
canonical, display, duplicates := extension.NormalizeSourceExtensions(sources)
target := extension.NormalizeTargetExtension(".jpg")
targetCanonical := extension.CanonicalExtension(target)
filteredCanonical := make([]string, 0, len(canonical))
filteredDisplay := make([]string, 0, len(display))
noOps := make([]string, 0)
for i, canon := range canonical {
if canon == targetCanonical {
noOps = append(noOps, display[i])
continue
}
filteredCanonical = append(filteredCanonical, canon)
filteredDisplay = append(filteredDisplay, display[i])
}
if len(filteredCanonical) == 0 {
t.Fatalf("expected canonical sources after filtering")
}
req.SetExtensions(filteredCanonical, filteredDisplay, target)
req.SetWarnings(duplicates, noOps)
var buf bytes.Buffer
summary, planned, err := extension.Preview(context.Background(), req, &buf)
if err != nil {
t.Fatalf("Preview error: %v", err)
}
if summary.TotalCandidates != 3 {
t.Fatalf("expected 3 candidates, got %d", summary.TotalCandidates)
}
if summary.TotalChanged != 2 {
t.Fatalf("expected 2 changed entries, got %d", summary.TotalChanged)
}
if summary.NoChange != 1 {
t.Fatalf("expected 1 no-change entry, got %d", summary.NoChange)
}
if len(planned) != 2 {
t.Fatalf("expected 2 planned renames, got %d", len(planned))
}
output := buf.String()
if !strings.Contains(output, "photo.jpeg -> photo.jpg") {
t.Fatalf("expected preview to include photo rename, output: %s", output)
}
if !strings.Contains(output, "banner.JPG -> banner.jpg") {
t.Fatalf("expected preview to include banner rename, output: %s", output)
}
if !strings.Contains(output, "logo.jpg (no change)") {
t.Fatalf("expected preview to mark logo as no change, output: %s", output)
}
if !strings.Contains(output, "Summary: 3 candidates, 2 will change, 1 already target extension") {
t.Fatalf("expected summary line, output: %s", output)
}
if len(summary.Warnings) == 0 {
t.Fatalf("expected warnings for duplicates/no-ops")
}
req.SetExecutionMode(false, true)
entry, err := extension.Apply(context.Background(), req, planned, summary)
if err != nil {
t.Fatalf("Apply error: %v", err)
}
if len(entry.Operations) != len(planned) {
t.Fatalf("expected %d ledger operations, got %d", len(planned), len(entry.Operations))
}
if _, err := os.Stat(filepath.Join(tmp, "photo.jpg")); err != nil {
t.Fatalf("expected photo.jpg after apply: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "banner.jpg")); err != nil {
t.Fatalf("expected banner.jpg after apply: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "logo.jpg")); err != nil {
t.Fatalf("expected logo.jpg to remain: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "photo.jpeg")); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("expected photo.jpeg to be renamed, err=%v", err)
}
ledger := filepath.Join(tmp, ".renamer")
if _, err := os.Stat(ledger); err != nil {
t.Fatalf("expected ledger file to be created: %v", err)
}
}
func writeTestFile(t *testing.T, path string) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
t.Fatalf("mkdir %s: %v", path, err)
}
if err := os.WriteFile(path, []byte("test"), 0o644); err != nil {
t.Fatalf("write file %s: %v", path, err)
}
}

View File

@@ -0,0 +1,167 @@
package contract
import (
"bytes"
"context"
"errors"
"os"
"path/filepath"
"strings"
"testing"
renamercmd "github.com/rogeecn/renamer/cmd"
"github.com/rogeecn/renamer/internal/extension"
"github.com/rogeecn/renamer/internal/listing"
)
func TestExtensionApplyMetadataCaptured(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
writeTestFile(t, filepath.Join(tmp, "clip.jpeg"))
writeTestFile(t, filepath.Join(tmp, "poster.JPG"))
writeTestFile(t, filepath.Join(tmp, "flyer.jpg"))
scope := &listing.ListingRequest{
WorkingDir: tmp,
IncludeDirectories: false,
Recursive: false,
IncludeHidden: false,
Extensions: nil,
Format: listing.FormatTable,
}
if err := scope.Validate(); err != nil {
t.Fatalf("validate scope: %v", err)
}
req := extension.NewRequest(scope)
req.SetExecutionMode(true, false)
sources := []string{".jpeg", ".JPG", ".jpg"}
canonical, display, duplicates := extension.NormalizeSourceExtensions(sources)
target := extension.NormalizeTargetExtension(".jpg")
targetCanonical := extension.CanonicalExtension(target)
filteredCanonical := make([]string, 0, len(canonical))
filteredDisplay := make([]string, 0, len(display))
noOps := make([]string, 0)
for i, canon := range canonical {
if canon == targetCanonical {
noOps = append(noOps, display[i])
continue
}
filteredCanonical = append(filteredCanonical, canon)
filteredDisplay = append(filteredDisplay, display[i])
}
req.SetExtensions(filteredCanonical, filteredDisplay, target)
req.SetWarnings(duplicates, noOps)
summary, planned, err := extension.Preview(context.Background(), req, nil)
if err != nil {
t.Fatalf("preview error: %v", err)
}
req.SetExecutionMode(false, true)
entry, err := extension.Apply(context.Background(), req, planned, summary)
if err != nil {
t.Fatalf("apply error: %v", err)
}
if entry.Metadata == nil {
t.Fatalf("expected metadata to be recorded")
}
sourcesMeta, ok := entry.Metadata["sourceExtensions"].([]string)
if !ok || len(sourcesMeta) != len(filteredDisplay) {
t.Fatalf("sourceExtensions metadata mismatch: %#v", entry.Metadata["sourceExtensions"])
}
if sourcesMeta[0] != ".jpeg" {
t.Fatalf("expected .jpeg in source metadata, got %v", sourcesMeta)
}
targetMeta, ok := entry.Metadata["targetExtension"].(string)
if !ok || targetMeta != target {
t.Fatalf("targetExtension metadata mismatch: %v", targetMeta)
}
if changed, ok := entry.Metadata["totalChanged"].(int); !ok || changed != summary.TotalChanged {
t.Fatalf("totalChanged metadata mismatch: %v", entry.Metadata["totalChanged"])
}
if noChange, ok := entry.Metadata["noChange"].(int); !ok || noChange != summary.NoChange {
t.Fatalf("noChange metadata mismatch: %v", entry.Metadata["noChange"])
}
counts, ok := entry.Metadata["perExtensionCounts"].(map[string]int)
if !ok {
t.Fatalf("perExtensionCounts metadata missing: %#v", entry.Metadata["perExtensionCounts"])
}
if counts[".jpeg"] == 0 || counts[".jpg"] == 0 {
t.Fatalf("expected counts for .jpeg and .jpg, got %#v", counts)
}
scopeMeta, ok := entry.Metadata["scope"].(map[string]any)
if !ok {
t.Fatalf("scope metadata missing: %#v", entry.Metadata["scope"])
}
if includeHidden, _ := scopeMeta["includeHidden"].(bool); includeHidden {
t.Fatalf("includeHidden should be false, got %v", includeHidden)
}
warnings, ok := entry.Metadata["warnings"].([]string)
if !ok || len(warnings) == 0 {
t.Fatalf("warnings metadata missing: %#v", entry.Metadata["warnings"])
}
joined := strings.Join(warnings, " ")
if !strings.Contains(joined, "duplicate source extension") {
t.Fatalf("expected duplicate warning in metadata: %v", warnings)
}
ledger := filepath.Join(tmp, ".renamer")
if _, err := os.Stat(ledger); err != nil {
t.Fatalf("ledger not created: %v", err)
}
if err := os.Remove(ledger); err != nil {
t.Fatalf("cleanup ledger: %v", err)
}
}
func TestExtensionCommandExitCodes(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
var out bytes.Buffer
cmd := renamercmd.NewRootCommand()
cmd.SetOut(&out)
cmd.SetErr(&out)
cmd.SetArgs([]string{"extension", ".jpeg", ".jpg", "--dry-run", "--path", tmp})
if err := cmd.Execute(); err != nil {
t.Fatalf("expected dry-run to exit successfully, err=%v output=%s", err, out.String())
}
if !strings.Contains(out.String(), "No candidates found.") {
t.Fatalf("expected no candidates notice, output=%s", out.String())
}
writeTestFile(t, filepath.Join(tmp, "clip.jpeg"))
out.Reset()
cmd = renamercmd.NewRootCommand()
cmd.SetOut(&out)
cmd.SetErr(&out)
cmd.SetArgs([]string{"extension", ".jpeg", ".jpg", "--yes", "--path", tmp})
if err := cmd.Execute(); err != nil {
t.Fatalf("expected apply to exit successfully, err=%v output=%s", err, out.String())
}
if _, err := os.Stat(filepath.Join(tmp, "clip.jpg")); err != nil {
t.Fatalf("expected clip.jpg after apply: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "clip.jpeg")); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("expected clip.jpeg to be renamed, err=%v", err)
}
}

View File

@@ -0,0 +1,102 @@
package contract
import (
"context"
"errors"
"path/filepath"
"testing"
"github.com/rogeecn/renamer/internal/extension"
"github.com/rogeecn/renamer/internal/listing"
)
func TestParseArgsValidation(t *testing.T) {
cases := []struct {
name string
args []string
}{
{"tooFew", []string{".jpg"}},
{"emptySource", []string{" ", ".jpg"}},
{"missingDotSource", []string{"jpg", ".png"}},
{"missingDotTarget", []string{".jpg", "png"}},
}
for _, tc := range cases {
_, err := extension.ParseArgs(tc.args)
if err == nil {
t.Fatalf("expected error for case %s", tc.name)
}
}
_, err := extension.ParseArgs([]string{".jpg", ".JPG"})
if err == nil {
t.Fatalf("expected error when all sources match target")
}
parsed, err := extension.ParseArgs([]string{".jpeg", ".JPG", ".jpg"})
if err != nil {
t.Fatalf("unexpected error for valid args: %v", err)
}
if len(parsed.SourcesCanonical) != 1 || parsed.SourcesCanonical[0] != ".jpeg" {
t.Fatalf("expected canonical list to contain .jpeg only, got %#v", parsed.SourcesCanonical)
}
if len(parsed.NoOps) != 1 {
t.Fatalf("expected .jpg to be treated as no-op")
}
}
func TestPreviewDetectsConflicts(t *testing.T) {
tmp := t.TempDir()
writeTestFile(t, filepath.Join(tmp, "report.jpeg"))
writeTestFile(t, filepath.Join(tmp, "report.jpg"))
scope := &listing.ListingRequest{
WorkingDir: tmp,
IncludeDirectories: false,
Recursive: false,
IncludeHidden: false,
Format: listing.FormatTable,
}
if err := scope.Validate(); err != nil {
t.Fatalf("validate scope: %v", err)
}
req := extension.NewRequest(scope)
parsed, err := extension.ParseArgs([]string{".jpeg", ".jpg"})
if err != nil {
t.Fatalf("parse error: %v", err)
}
req.SetExtensions(parsed.SourcesCanonical, parsed.SourcesDisplay, parsed.Target)
req.SetWarnings(parsed.Duplicates, parsed.NoOps)
summary, planned, err := extension.Preview(context.Background(), req, nil)
if err != nil {
t.Fatalf("preview error: %v", err)
}
if !summary.HasConflicts() {
t.Fatalf("expected conflict when target already exists")
}
if len(planned) != 0 {
t.Fatalf("expected no operations due to conflict, got %d", len(planned))
}
if len(summary.Warnings) == 0 {
t.Fatalf("expected warning recorded for conflict")
}
// Apply should be skipped by caller; invoking directly without operations should no-op.
req.SetExecutionMode(false, true)
entry, err := extension.Apply(context.Background(), req, planned, summary)
if err != nil {
t.Fatalf("apply error: %v", err)
}
if len(entry.Operations) != 0 {
t.Fatalf("expected zero operations recorded when conflicts present")
}
if _, err := extension.ParseArgs([]string{".jpeg", ".jpg"}); err != nil {
// ensure previous parse errors do not leak state
if !errors.Is(err, nil) {
// unreachable, but keeps staticcheck happy
}
}
}

View File

@@ -0,0 +1,78 @@
package integration
import (
"bytes"
"os"
"path/filepath"
"strings"
"testing"
renamercmd "github.com/rogeecn/renamer/cmd"
)
func TestExtensionCommandFlow(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
createFile(t, filepath.Join(tmp, "image.jpeg"))
createFile(t, filepath.Join(tmp, "poster.JPG"))
createFile(t, filepath.Join(tmp, "logo.jpg"))
var previewOut bytes.Buffer
preview := renamercmd.NewRootCommand()
preview.SetOut(&previewOut)
preview.SetErr(&previewOut)
preview.SetArgs([]string{"extension", ".jpeg", ".JPG", ".jpg", "--dry-run", "--path", tmp})
if err := preview.Execute(); err != nil {
t.Fatalf("preview command failed: %v\noutput: %s", err, previewOut.String())
}
output := previewOut.String()
if !strings.Contains(output, "image.jpeg -> image.jpg") {
t.Fatalf("expected preview output to include image rename, got:\n%s", output)
}
if !strings.Contains(output, "poster.JPG -> poster.jpg") {
t.Fatalf("expected preview output to include poster rename, got:\n%s", output)
}
if !strings.Contains(output, "logo.jpg (no change)") {
t.Fatalf("expected preview output to include no-change row for logo, got:\n%s", output)
}
var applyOut bytes.Buffer
apply := renamercmd.NewRootCommand()
apply.SetOut(&applyOut)
apply.SetErr(&applyOut)
apply.SetArgs([]string{"extension", ".jpeg", ".JPG", ".jpg", "--yes", "--path", tmp})
if err := apply.Execute(); err != nil {
t.Fatalf("apply command failed: %v\noutput: %s", err, applyOut.String())
}
if _, err := os.Stat(filepath.Join(tmp, "image.jpg")); err != nil {
t.Fatalf("expected image.jpg after apply: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "poster.jpg")); err != nil {
t.Fatalf("expected poster.jpg after apply: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "logo.jpg")); err != nil {
t.Fatalf("expected logo.jpg to remain: %v", err)
}
var undoOut bytes.Buffer
undo := renamercmd.NewRootCommand()
undo.SetOut(&undoOut)
undo.SetErr(&undoOut)
undo.SetArgs([]string{"undo", "--path", tmp})
if err := undo.Execute(); err != nil {
t.Fatalf("undo command failed: %v\noutput: %s", err, undoOut.String())
}
if _, err := os.Stat(filepath.Join(tmp, "image.jpeg")); err != nil {
t.Fatalf("expected image.jpeg after undo: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "poster.JPG")); err != nil {
t.Fatalf("expected poster.JPG after undo: %v", err)
}
}

View File

@@ -0,0 +1,52 @@
package integration
import (
"bytes"
"os"
"path/filepath"
"testing"
renamercmd "github.com/rogeecn/renamer/cmd"
)
func TestExtensionAutomationUndo(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
createFile(t, filepath.Join(tmp, "config.yaml"))
createFile(t, filepath.Join(tmp, "notes.yml"))
var applyOut bytes.Buffer
apply := renamercmd.NewRootCommand()
apply.SetOut(&applyOut)
apply.SetErr(&applyOut)
apply.SetArgs([]string{"extension", ".yaml", ".yml", ".yml", "--yes", "--path", tmp})
if err := apply.Execute(); err != nil {
t.Fatalf("automation apply failed: %v\noutput: %s", err, applyOut.String())
}
if _, err := os.Stat(filepath.Join(tmp, "config.yml")); err != nil {
t.Fatalf("expected config.yml after apply: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "config.yaml")); !os.IsNotExist(err) {
t.Fatalf("expected config.yaml renamed, err=%v", err)
}
var undoOut bytes.Buffer
undo := renamercmd.NewRootCommand()
undo.SetOut(&undoOut)
undo.SetErr(&undoOut)
undo.SetArgs([]string{"undo", "--path", tmp})
if err := undo.Execute(); err != nil {
t.Fatalf("undo failed: %v\noutput: %s", err, undoOut.String())
}
if _, err := os.Stat(filepath.Join(tmp, "config.yaml")); err != nil {
t.Fatalf("expected config.yaml after undo: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "config.yml")); !os.IsNotExist(err) {
t.Fatalf("expected config.yml removed after undo, err=%v", err)
}
}

View File

@@ -0,0 +1,42 @@
package integration
import (
"bytes"
"os"
"path/filepath"
"strings"
"testing"
renamercmd "github.com/rogeecn/renamer/cmd"
)
func TestExtensionCommandBlocksConflicts(t *testing.T) {
t.Parallel()
tmp := t.TempDir()
createFile(t, filepath.Join(tmp, "doc.jpeg"))
createFile(t, filepath.Join(tmp, "doc.jpg"))
var out bytes.Buffer
cmd := renamercmd.NewRootCommand()
cmd.SetOut(&out)
cmd.SetErr(&out)
cmd.SetArgs([]string{"extension", ".jpeg", ".jpg", ".jpg", "--yes", "--path", tmp})
err := cmd.Execute()
if err == nil {
t.Fatalf("expected conflict to produce an error")
}
if !strings.Contains(out.String(), "existing") && !strings.Contains(out.String(), "conflict") {
t.Fatalf("expected conflict messaging in output, got: %s", out.String())
}
// Ensure files unchanged after failed apply.
if _, err := os.Stat(filepath.Join(tmp, "doc.jpeg")); err != nil {
t.Fatalf("expected doc.jpeg to remain: %v", err)
}
if _, err := os.Stat(filepath.Join(tmp, "doc.jpg")); err != nil {
t.Fatalf("expected doc.jpg to remain: %v", err)
}
}