danielmiessler.fabric/internal/plugins/db/fsdb/patterns_test.go

package fsdb

import (
	"os"
	"path/filepath"
	"strings"
	"testing"

	"github.com/danielmiessler/fabric/internal/i18n"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func setupTestPatternsEntity(t *testing.T) (*PatternsEntity, func()) {
	// Create a temporary directory for test patterns
	tmpDir, err := os.MkdirTemp("", "test-patterns-*")
	require.NoError(t, err)

	entity := &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       tmpDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
	}

	// Return cleanup function
	cleanup := func() {
		os.RemoveAll(tmpDir)
	}

	return entity, cleanup
}

// Helper to create a test pattern file
func createTestPattern(t *testing.T, entity *PatternsEntity, name, content string) {
	patternDir := filepath.Join(entity.Dir, name)
	err := os.MkdirAll(patternDir, 0755)
	require.NoError(t, err)

	err = os.WriteFile(filepath.Join(patternDir, entity.SystemPatternFile), []byte(content), 0644)
	require.NoError(t, err)
}

func TestApplyVariables(t *testing.T) {
	entity := &PatternsEntity{}

	tests := []struct {
		name      string
		pattern   *Pattern
		variables map[string]string
		input     string
		want      string
		wantErr   bool
	}{
		{
			name: "pattern with explicit input placement",
			pattern: &Pattern{
				Pattern: "You are a {{role}}.\n{{input}}\nPlease analyze.",
			},
			variables: map[string]string{
				"role": "security expert",
			},
			input: "Check this code",
			want:  "You are a security expert.\nCheck this code\nPlease analyze.",
		},
		{
			name: "pattern without input variable gets input appended",
			pattern: &Pattern{
				Pattern: "You are a {{role}}.\nPlease analyze.",
			},
			variables: map[string]string{
				"role": "code reviewer",
			},
			input: "Review this PR",
			want:  "You are a code reviewer.\nPlease analyze.\nReview this PR",
		},
		// ... previous test cases ...
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			err := entity.applyVariables(tt.pattern, tt.variables, tt.input)

			if tt.wantErr {
				assert.Error(t, err)
				return
			}

			assert.NoError(t, err)
			assert.Equal(t, tt.want, tt.pattern.Pattern)
		})
	}
}

func TestGetApplyVariables(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	// Create a test pattern
	createTestPattern(t, entity, "test-pattern", "You are a {{role}}.\n{{input}}")

	tests := []struct {
		name      string
		source    string
		variables map[string]string
		input     string
		want      string
		wantErr   bool
	}{
		{
			name:   "basic pattern with variables and input",
			source: "test-pattern",
			variables: map[string]string{
				"role": "reviewer",
			},
			input: "check this code",
			want:  "You are a reviewer.\ncheck this code",
		},
		{
			name:      "pattern with missing variable",
			source:    "test-pattern",
			variables: map[string]string{},
			input:     "test input",
			wantErr:   true,
		},
		{
			name:    "non-existent pattern",
			source:  "non-existent",
			wantErr: true,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			result, err := entity.GetApplyVariables(tt.source, tt.variables, tt.input)

			if tt.wantErr {
				assert.Error(t, err)
				return
			}

			require.NoError(t, err)
			assert.Equal(t, tt.want, result.Pattern)
		})
	}
}

func TestGetWithoutVariables(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	createTestPattern(t, entity, "test-pattern", "Prefix {{input}} {{roam}}")

	result, err := entity.GetWithoutVariables("test-pattern", "hello")
	require.NoError(t, err)
	assert.Equal(t, "Prefix hello {{roam}}", result.Pattern)

	createTestPattern(t, entity, "no-input", "Static content")
	result, err = entity.GetWithoutVariables("no-input", "hi")
	require.NoError(t, err)
	assert.Equal(t, "Static content\nhi", result.Pattern)
}

func TestPatternsEntity_Save(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	name := "new-pattern"
	content := []byte("test pattern content")
	require.NoError(t, entity.Save(name, content))

	patternDir := filepath.Join(entity.Dir, name)
	info, err := os.Stat(patternDir)
	require.NoError(t, err)
	assert.True(t, info.IsDir())

	data, err := os.ReadFile(filepath.Join(patternDir, entity.SystemPatternFile))
	require.NoError(t, err)
	assert.Equal(t, content, data)
}

// Save must reject a name that loadPattern uses as a filesystem path,
// and that includes a traversal name. For such a name,
// GetApplyVariables reads from the disk, not from the database.
func TestPatternsEntity_SaveRejectsFilePathNames(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	for _, name := range []string{"..", ".foo", "..bar", "~bar", "/abs/path", `\win\path`} {
		err := entity.Save(name, []byte("pwned"))
		assert.Error(t, err, "expected error for file-path name: %q", name)
		if strings.HasPrefix(name, "/") || strings.HasPrefix(name, `\`) {
			// If Save accepts an absolute name, it does not write in
			// entity.Dir, and the join below points to the incorrect
			// location. For these two names, only the error assertion
			// gives protection.
			continue
		}
		// For ".." this path is the system.md of the parent directory,
		// which Save makes if it accepts a traversal name.
		_, statErr := os.Stat(filepath.Join(entity.Dir, name, entity.SystemPatternFile))
		assert.True(t, os.IsNotExist(statErr), "wrote a pattern file for: %q", name)
	}
}

// Rename must reject a file-path-like destination, the same as Save.
// The inherited StorageEntity.Rename accepts such a destination.
func TestPatternsEntity_RenameRejectsFilePathDestination(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	createTestPattern(t, entity, "good-name", "content")
	for _, newName := range []string{".foo", "~bar"} {
		err := entity.Rename("good-name", newName)
		var invalidName *InvalidStorageNameError
		require.ErrorAs(t, err, &invalidName, "expected rejection for destination: %q", newName)
		_, statErr := os.Stat(filepath.Join(entity.Dir, newName))
		assert.True(t, os.IsNotExist(statErr), "renamed to: %q", newName)
	}

	// A valid destination still works.
	require.NoError(t, entity.Rename("good-name", "better-name"))
	_, err := os.Stat(filepath.Join(entity.Dir, "better-name"))
	require.NoError(t, err)
}

// Save must not write through a symlinked pattern directory or a
// symlinked pattern file that points outside the storage tree.
func TestPatternsEntity_SaveRejectsSymlinkEscape(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	outsideDir := t.TempDir()
	mustSymlink(t, outsideDir, filepath.Join(entity.Dir, "linked-dir"))
	err := entity.Save("linked-dir", []byte("pwned"))
	var invalidName *InvalidStorageNameError
	require.ErrorAs(t, err, &invalidName)
	_, statErr := os.Stat(filepath.Join(outsideDir, entity.SystemPatternFile))
	assert.True(t, os.IsNotExist(statErr), "wrote through the symlinked pattern dir")

	outsideFile := filepath.Join(outsideDir, "target.md")
	require.NoError(t, os.WriteFile(outsideFile, []byte("keep"), 0o644))
	require.NoError(t, os.MkdirAll(filepath.Join(entity.Dir, "real-pattern"), 0o755))
	mustSymlink(t, outsideFile, filepath.Join(entity.Dir, "real-pattern", entity.SystemPatternFile))
	err = entity.Save("real-pattern", []byte("pwned"))
	require.ErrorAs(t, err, &invalidName)
	got, readErr := os.ReadFile(outsideFile)
	require.NoError(t, readErr)
	assert.Equal(t, "keep", string(got), "outside pattern file was overwritten")
}

func TestGetApplyVariables_FromFile(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	path := filepath.Join(t.TempDir(), "fromfile.md")
	require.NoError(t, os.WriteFile(path, []byte("Hello {{input}}"), 0o644))

	result, err := entity.GetApplyVariables(path, nil, "world")
	require.NoError(t, err)
	assert.Equal(t, "Hello world", result.Pattern)
}

func TestPatternsEntity_CustomPatterns(t *testing.T) {
	// Create main patterns directory
	mainDir, err := os.MkdirTemp("", "test-main-patterns-*")
	require.NoError(t, err)
	defer os.RemoveAll(mainDir)

	// Create custom patterns directory
	customDir, err := os.MkdirTemp("", "test-custom-patterns-*")
	require.NoError(t, err)
	defer os.RemoveAll(customDir)

	entity := &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       mainDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
		CustomPatternsDir: customDir,
	}

	// Create a pattern in main directory
	createTestPattern(t, &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       mainDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
	}, "main-pattern", "Main pattern content")

	// Create a pattern in custom directory
	createTestPattern(t, &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       customDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
	}, "custom-pattern", "Custom pattern content")

	// Create a pattern with same name in both directories (custom should override)
	createTestPattern(t, &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       mainDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
	}, "shared-pattern", "Main shared pattern")

	createTestPattern(t, &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       customDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
	}, "shared-pattern", "Custom shared pattern")

	// Test GetNames includes both directories
	names, err := entity.GetNames()
	require.NoError(t, err)
	assert.Contains(t, names, "main-pattern")
	assert.Contains(t, names, "custom-pattern")
	assert.Contains(t, names, "shared-pattern")

	// Test that custom pattern overrides main pattern
	pattern, err := entity.getFromDB("shared-pattern")
	require.NoError(t, err)
	assert.Equal(t, "Custom shared pattern", pattern.Pattern)

	// Test that main pattern is accessible when not overridden
	pattern, err = entity.getFromDB("main-pattern")
	require.NoError(t, err)
	assert.Equal(t, "Main pattern content", pattern.Pattern)

	// Test GetRaw also respects custom patterns directory
	rawPattern, err := entity.GetRaw("shared-pattern")
	require.NoError(t, err)
	assert.Equal(t, "Custom shared pattern", rawPattern.Pattern)

	// Test that custom pattern is accessible
	pattern, err = entity.getFromDB("custom-pattern")
	require.NoError(t, err)
	assert.Equal(t, "Custom pattern content", pattern.Pattern)
}

func TestPrintPattern(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	createTestPattern(t, entity, "test-pattern", "# IDENTITY\nYou are a test assistant.\n")

	t.Run("prints pattern content to stdout", func(t *testing.T) {
		// Capture stdout
		oldStdout := os.Stdout
		r, w, err := os.Pipe()
		require.NoError(t, err)
		os.Stdout = w

		printErr := entity.PrintPattern("test-pattern")

		w.Close()
		os.Stdout = oldStdout

		var buf [4096]byte
		n, _ := r.Read(buf[:])
		output := string(buf[:n])

		require.NoError(t, printErr)
		assert.Equal(t, "# IDENTITY\nYou are a test assistant.\n", output)
	})

	t.Run("returns error for non-existent pattern", func(t *testing.T) {
		err := entity.PrintPattern("nonexistent-pattern")
		assert.Error(t, err)
	})

	t.Run("custom pattern directory takes precedence", func(t *testing.T) {
		customDir, err := os.MkdirTemp("", "test-custom-*")
		require.NoError(t, err)
		defer os.RemoveAll(customDir)

		entityWithCustom := &PatternsEntity{
			StorageEntity:     entity.StorageEntity,
			SystemPatternFile: entity.SystemPatternFile,
			CustomPatternsDir: customDir,
		}
		createTestPattern(t, &PatternsEntity{
			StorageEntity:     &StorageEntity{Dir: customDir, Label: "patterns", ItemIsDir: true},
			SystemPatternFile: "system.md",
		}, "test-pattern", "# CUSTOM\nCustom version.\n")

		oldStdout := os.Stdout
		r, w, err := os.Pipe()
		require.NoError(t, err)
		os.Stdout = w

		printErr := entityWithCustom.PrintPattern("test-pattern")

		w.Close()
		os.Stdout = oldStdout

		var buf [4096]byte
		n, _ := r.Read(buf[:])
		output := string(buf[:n])

		require.NoError(t, printErr)
		assert.Equal(t, "# CUSTOM\nCustom version.\n", output)
	})
}

func TestGetFromDB_PathTraversal(t *testing.T) {
	if _, err := i18n.Init("en"); err != nil {
		t.Fatalf("i18n.Init() error = %v", err)
	}

	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	for _, name := range invalidStorageNames {
		t.Run(name, func(t *testing.T) {
			_, err := entity.GetRaw(name)
			require.Error(t, err, "expected error for traversal name: %q", name)
			assert.Contains(t, err.Error(), "invalid pattern name", "wrong error for: %q", name)
			var invalidName *InvalidStorageNameError
			assert.ErrorAs(t, err, &invalidName, "want typed rejection for: %q", name)
		})
	}
}

// A ".." in a name without separators is one safe path element.
// ValidateStorageName accepts it, and getFromDB also accepts it.
func TestGetFromDB_AllowsDotsWithinName(t *testing.T) {
	entity, cleanup := setupTestPatternsEntity(t)
	defer cleanup()

	createTestPattern(t, entity, "foo..bar", "dotty {{input}}")

	pattern, err := entity.GetRaw("foo..bar")
	require.NoError(t, err)
	assert.Equal(t, "dotty {{input}}", pattern.Pattern)
}

func TestLooksLikePatternFilePath(t *testing.T) {
	for _, source := range []string{"/x", `~\x`, `\x`, `.\x`, "~", ".", ".."} {
		assert.True(t, LooksLikePatternFilePath(source), "expected file-path detection for: %q", source)
	}
	for _, source := range []string{"", "pattern", "foo..bar", "a/b", "x~y", "x.y"} {
		assert.False(t, LooksLikePatternFilePath(source), "unexpected file-path detection for: %q", source)
	}
}

func TestPatternsEntity_CustomPatternsEmpty(t *testing.T) {
	// Test behavior when custom patterns directory is empty or doesn't exist
	mainDir, err := os.MkdirTemp("", "test-main-patterns-*")
	require.NoError(t, err)
	defer os.RemoveAll(mainDir)

	entity := &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       mainDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
		CustomPatternsDir: "/nonexistent/directory",
	}

	// Create a pattern in main directory
	createTestPattern(t, &PatternsEntity{
		StorageEntity: &StorageEntity{
			Dir:       mainDir,
			Label:     "patterns",
			ItemIsDir: true,
		},
		SystemPatternFile: "system.md",
	}, "main-pattern", "Main pattern content")

	// Test GetNames works even with nonexistent custom directory
	names, err := entity.GetNames()
	require.NoError(t, err)
	assert.Contains(t, names, "main-pattern")

	// Test that main pattern is accessible
	pattern, err := entity.getFromDB("main-pattern")
	require.NoError(t, err)
	assert.Equal(t, "Main pattern content", pattern.Pattern)
}