mire
Code Issues

fix: make miro testdir resolution explicit based on config

Browse Source
This commit is contained in:
ruinivist
2026-03-18 12:48:09 +00:00
parent 3949ee98bc
commit 666219edbf
8 changed files with 342 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/miro/init.go
+33 -1
View File
@@ -1,6 +1,38 @@
package miro
// Init is the current no-op initializer placeholder.
import (
"errors"
"fmt"
"os"
"path/filepath"
miroconfig "miro/internal/config"
)
const defaultTestDir = "e2e"
// Init creates the default config when missing and leaves valid config untouched.
func Init() error {
root, err := currentProjectRoot()
if err != nil {
return err
}
configPath := filepath.Join(root, "miro.toml")
if _, err := os.Stat(configPath); err == nil {
if _, err := miroconfig.ReadConfig(configPath); err != nil {
return err
}
return nil
} else if !errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("failed to check %s: %v", configPath, err)
}
if err := miroconfig.WriteConfig(configPath, miroconfig.Config{
TestDir: defaultTestDir,
}); err != nil {
return fmt.Errorf("failed to write %s: %v", configPath, err)
}
return nil
}
internal/miro/record_test.go
+4 -1
View File
@@ -15,6 +15,7 @@ func TestRecordCreatesRelativePath(t *testing.T) {
root := t.TempDir()
testDir := filepath.Join(root, "e2e")
mustMkdirAll(t, testDir)
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"e2e\"\n")
addFakeRecordDependencies(t, "script")
got := withWorkingDir(t, root, func() string {
@@ -45,10 +46,11 @@ func TestRecordCreatesRelativePath(t *testing.T) {
}
}
func TestRecordStripsExplicitTestDirPrefix(t *testing.T) {
func TestRecordAcceptsExplicitTestDirPrefix(t *testing.T) {
root := t.TempDir()
testDir := filepath.Join(root, "e2e")
mustMkdirAll(t, testDir)
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"e2e\"\n")
addFakeRecordDependencies(t, "script")
got := withWorkingDir(t, root, func() string {
@@ -79,6 +81,7 @@ func TestRecordStripsExplicitTestDirPrefix(t *testing.T) {
func TestRecordRejectsAbsolutePathOutsideTestDir(t *testing.T) {
root := t.TempDir()
mustMkdirAll(t, filepath.Join(root, "e2e"))
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"e2e\"\n")
outside := filepath.Join(root, "outside", "a", "b", "c")
err := withWorkingDir(t, root, func() error {
internal/miro/testdir.go
+33 -56
View File
@@ -11,52 +11,50 @@ import (
miroconfig "miro/internal/config"
)
var fallbackTestDirs = []string{
"e2e",
filepath.Join("test", "e2e"),
filepath.Join("tests", "e2e"),
"miro",
filepath.Join("test", "miro"),
filepath.Join("tests", "miro"),
// ResolveTestDir resolves the project test directory from config.
func ResolveTestDir() (string, error) {
root, err := currentProjectRoot()
if err != nil {
return "", err
}
return resolveTestDirFromRoot(root)
}
// ResolveTestDir resolves the project test directory from config or conventions.
func ResolveTestDir() (string, error) {
func resolveTestDirFromRoot(root string) (string, error) {
configPath := filepath.Join(root, "miro.toml")
cfg, err := miroconfig.ReadConfig(configPath)
if err != nil {
return "", err
}
testDir := filepath.Join(root, cfg.TestDir)
info, err := os.Stat(testDir)
if err == nil {
if !info.IsDir() {
return "", fmt.Errorf("configured test_dir is not a directory: %s", testDir)
}
return testDir, nil
}
if err != nil && !errors.Is(err, os.ErrNotExist) {
return "", fmt.Errorf("failed to check test directory %s: %v", testDir, err)
}
return testDir, nil
}
func currentProjectRoot() (string, error) {
cwd, err := os.Getwd()
if err != nil {
return "", fmt.Errorf("failed to get working directory: %v", err)
}
root := projectRoot(cwd)
return resolveTestDirFromRoot(root)
}
func resolveTestDirFromRoot(root string) (string, error) {
candidates, err := testDirCandidates(root)
if err != nil {
return "", err
}
for _, candidate := range candidates {
info, err := os.Stat(candidate)
if err == nil && info.IsDir() {
return candidate, nil
}
if err != nil && !errors.Is(err, os.ErrNotExist) {
return "", fmt.Errorf("failed to check test directory %s: %v", candidate, err)
}
}
if len(candidates) == 0 {
return "", errors.New("no test directory candidates available")
}
return candidates[0], nil
return projectRoot(cwd), nil
}
// returns the git root if in a git repo else current pwd
func projectRoot(cwd string) string {
out, err := exec.Command("git", "rev-parse", "--show-toplevel").CombinedOutput()
out, err := exec.Command("git", "-C", cwd, "rev-parse", "--show-toplevel").CombinedOutput()
if err != nil {
return cwd
}
@@ -67,24 +65,3 @@ func projectRoot(cwd string) string {
}
return filepath.Clean(root)
}
// list of e2e test directory candidates. uses from config if it exists
// else uses fallback paths
func testDirCandidates(root string) ([]string, error) {
configPath := filepath.Join(root, "miro.toml")
cfg, err := miroconfig.ReadConfig(configPath)
if err == nil && cfg.TestDir != "" {
return []string{filepath.Join(root, cfg.TestDir)}, nil
}
if err != nil && !errors.Is(err, os.ErrNotExist) {
return nil, err
}
candidates := make([]string, 0, len(fallbackTestDirs))
for _, candidate := range fallbackTestDirs {
candidates = append(candidates, filepath.Join(root, candidate))
}
return candidates, nil
}
internal/miro/testdir_test.go
+117 -96
View File
@@ -8,12 +8,77 @@ import (
"testing"
)
func TestResolveTestDirConfigOverride(t *testing.T) {
func TestInitCreatesConfigAtProjectRoot(t *testing.T) {
root := t.TempDir()
withWorkingDir(t, root, func() struct{} {
if err := Init(); err != nil {
t.Fatalf("Init() error = %v", err)
}
return struct{}{}
})
got := readFile(t, filepath.Join(root, "miro.toml"))
if got != "test_dir = \"e2e\"\n" {
t.Fatalf("config = %q, want %q", got, "test_dir = \"e2e\"\n")
}
}
func TestInitUsesGitRoot(t *testing.T) {
root := t.TempDir()
mustGitInit(t, root)
subdir := filepath.Join(root, "nested", "dir")
mustMkdirAll(t, subdir)
withWorkingDir(t, subdir, func() struct{} {
if err := Init(); err != nil {
t.Fatalf("Init() error = %v", err)
}
return struct{}{}
})
if _, err := os.Stat(filepath.Join(root, "miro.toml")); err != nil {
t.Fatalf("Stat(%q) error = %v", filepath.Join(root, "miro.toml"), err)
}
}
func TestInitLeavesExistingValidConfigUntouched(t *testing.T) {
root := t.TempDir()
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"custom/suite\"\n")
withWorkingDir(t, root, func() struct{} {
if err := Init(); err != nil {
t.Fatalf("Init() error = %v", err)
}
return struct{}{}
})
got := readFile(t, filepath.Join(root, "miro.toml"))
if got != "test_dir = \"custom/suite\"\n" {
t.Fatalf("config = %q, want %q", got, "test_dir = \"custom/suite\"\n")
}
}
func TestInitFailsWhenExistingConfigInvalid(t *testing.T) {
root := t.TempDir()
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"e2e\"\n")
err := withWorkingDir(t, root, func() error {
return Init()
})
if err == nil {
t.Fatal("Init() error = nil, want error")
}
if !strings.Contains(err.Error(), "missing required test_dir") {
t.Fatalf("Init() error = %q, want missing test_dir error", err.Error())
}
}
func TestResolveTestDirFromConfig(t *testing.T) {
root := t.TempDir()
configured := filepath.Join(root, "custom", "suite")
mustMkdirAll(t, configured)
mustMkdirAll(t, filepath.Join(root, "e2e"))
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"custom/suite\"\n")
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"custom/suite\"\n")
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
@@ -28,47 +93,59 @@ func TestResolveTestDirConfigOverride(t *testing.T) {
}
}
func TestResolveTestDirFallsBackWhenConfigOmitsTestDir(t *testing.T) {
func TestResolveTestDirMissingConfigFails(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "e2e")
mustMkdirAll(t, want)
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\n")
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
if err != nil {
t.Fatalf("ResolveTestDir() error = %v", err)
}
return path
err := withWorkingDir(t, root, func() error {
_, err := ResolveTestDir()
return err
})
if got != want {
t.Fatalf("ResolveTestDir() = %q, want %q", got, want)
if err == nil {
t.Fatal("ResolveTestDir() error = nil, want error")
}
if !os.IsNotExist(err) {
t.Fatalf("ResolveTestDir() error = %v, want os.ErrNotExist", err)
}
}
func TestResolveTestDirFallsBackWhenConfiguredPathEmpty(t *testing.T) {
func TestResolveTestDirMissingTestDirFails(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "e2e")
mustMkdirAll(t, want)
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"\"\n")
writeFile(t, filepath.Join(root, "miro.toml"), "")
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
if err != nil {
t.Fatalf("ResolveTestDir() error = %v", err)
}
return path
err := withWorkingDir(t, root, func() error {
_, err := ResolveTestDir()
return err
})
if got != want {
t.Fatalf("ResolveTestDir() = %q, want %q", got, want)
if err == nil {
t.Fatal("ResolveTestDir() error = nil, want error")
}
if !strings.Contains(err.Error(), "missing required test_dir") {
t.Fatalf("ResolveTestDir() error = %q, want missing required test_dir", err.Error())
}
}
func TestResolveTestDirEmptyTestDirFails(t *testing.T) {
root := t.TempDir()
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"\"\n")
err := withWorkingDir(t, root, func() error {
_, err := ResolveTestDir()
return err
})
if err == nil {
t.Fatal("ResolveTestDir() error = nil, want error")
}
if !strings.Contains(err.Error(), "empty test_dir") {
t.Fatalf("ResolveTestDir() error = %q, want empty test_dir", err.Error())
}
}
func TestResolveTestDirMalformedConfigFails(t *testing.T) {
root := t.TempDir()
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = [\n")
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = [\n")
err := withWorkingDir(t, root, func() error {
_, err := ResolveTestDir()
@@ -79,14 +156,14 @@ func TestResolveTestDirMalformedConfigFails(t *testing.T) {
t.Fatal("ResolveTestDir() error = nil, want error")
}
if !strings.Contains(err.Error(), "failed to read") {
t.Fatalf("ResolveTestDir() error = %q, want read failure", err)
t.Fatalf("ResolveTestDir() error = %q, want read failure", err.Error())
}
}
func TestResolveTestDirConfiguredMissingDirectoryReturnsConfiguredPath(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "missing")
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"missing\"\n")
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"missing\"\n")
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
@@ -101,60 +178,21 @@ func TestResolveTestDirConfiguredMissingDirectoryReturnsConfiguredPath(t *testin
}
}
func TestResolveTestDirConfiguredFileReturnsConfiguredPath(t *testing.T) {
func TestResolveTestDirConfiguredFileFails(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "case.txt")
writeFile(t, filepath.Join(root, "case.txt"), "hello\n")
writeFile(t, filepath.Join(root, "miro.toml"), "[miro]\ntest_dir = \"case.txt\"\n")
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"case.txt\"\n")
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
if err != nil {
t.Fatalf("ResolveTestDir() error = %v", err)
}
return path
err := withWorkingDir(t, root, func() error {
_, err := ResolveTestDir()
return err
})
if got != want {
t.Fatalf("ResolveTestDir() = %q, want %q", got, want)
if err == nil {
t.Fatal("ResolveTestDir() error = nil, want error")
}
}
func TestResolveTestDirFallbackOrder(t *testing.T) {
root := t.TempDir()
lower := filepath.Join(root, "tests", "miro")
higher := filepath.Join(root, "tests", "e2e")
mustMkdirAll(t, lower)
mustMkdirAll(t, higher)
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
if err != nil {
t.Fatalf("ResolveTestDir() error = %v", err)
}
return path
})
if got != higher {
t.Fatalf("ResolveTestDir() = %q, want %q", got, higher)
}
}
func TestResolveTestDirFallbackToMiroDirectories(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "test", "miro")
mustMkdirAll(t, want)
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
if err != nil {
t.Fatalf("ResolveTestDir() error = %v", err)
}
return path
})
if got != want {
t.Fatalf("ResolveTestDir() = %q, want %q", got, want)
if !strings.Contains(err.Error(), "configured test_dir is not a directory") {
t.Fatalf("ResolveTestDir() error = %q, want file path error", err.Error())
}
}
@@ -162,7 +200,7 @@ func TestResolveTestDirUsesGitRoot(t *testing.T) {
root := t.TempDir()
mustGitInit(t, root)
want := filepath.Join(root, "e2e")
mustMkdirAll(t, want)
writeFile(t, filepath.Join(root, "miro.toml"), "test_dir = \"e2e\"\n")
subdir := filepath.Join(root, "nested", "dir")
mustMkdirAll(t, subdir)
@@ -179,23 +217,6 @@ func TestResolveTestDirUsesGitRoot(t *testing.T) {
}
}
func TestResolveTestDirReturnsFirstFallbackWhenNothingDetected(t *testing.T) {
root := t.TempDir()
want := filepath.Join(root, "e2e")
got := withWorkingDir(t, root, func() string {
path, err := ResolveTestDir()
if err != nil {
t.Fatalf("ResolveTestDir() error = %v", err)
}
return path
})
if got != want {
t.Fatalf("ResolveTestDir() = %q, want %q", got, want)
}
}
func withWorkingDir[T any](t *testing.T, dir string, fn func() T) T {
t.Helper()