c3865faf56
This commit introduces two new commands: `borg search` and `borg index`. The `borg index` command builds a trigram index for an archive, which can be used to significantly speed up searches. The `borg search` command allows users to search for patterns within archives. It supports regular expressions, context control, file type filtering, and result limits. The command will automatically use a pre-built index if one is available, falling back to a full scan if not. This commit also includes: - Unit tests for the new commands. - Documentation for the new commands in `docs/cli.md`. - Updates to `.gitignore` to exclude index files. - Improvements to the test infrastructure to prevent state pollution. Co-authored-by: Snider <631881+Snider@users.noreply.github.com>
80 lines
2.1 KiB
Go
80 lines
2.1 KiB
Go
package cmd
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"log/slog"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// executeCommand is a helper function to execute a cobra command and return the output.
|
|
func executeCommand(root *cobra.Command, args ...string) (string, error) {
|
|
_, output, err := executeCommandC(root, args...)
|
|
return output, err
|
|
}
|
|
|
|
// executeCommandC is a helper function to execute a cobra command and return the output.
|
|
func executeCommandC(root *cobra.Command, args ...string) (*cobra.Command, string, error) {
|
|
// We need to create a new instance of the root command for each test to avoid state pollution.
|
|
testRootCmd := NewRootCmd()
|
|
initAllCommands(testRootCmd) // Pass the new instance to the init function.
|
|
|
|
buf := new(bytes.Buffer)
|
|
testRootCmd.SetOut(buf)
|
|
testRootCmd.SetErr(buf)
|
|
testRootCmd.SetArgs(args)
|
|
|
|
c, err := testRootCmd.ExecuteC()
|
|
|
|
return c, buf.String(), err
|
|
}
|
|
|
|
func TestExecute_Good(t *testing.T) {
|
|
// This is a basic test to ensure the command runs without panicking.
|
|
err := Execute(slog.New(slog.NewTextHandler(io.Discard, nil)))
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
}
|
|
|
|
func TestRootCmd_Good(t *testing.T) {
|
|
t.Run("No args", func(t *testing.T) {
|
|
_, err := executeCommand(RootCmd)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
})
|
|
|
|
t.Run("Help flag", func(t *testing.T) {
|
|
output, err := executeCommand(RootCmd, "--help")
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if !strings.Contains(output, "Usage:") {
|
|
t.Errorf("expected help output to contain 'Usage:', but it did not")
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestRootCmd_Bad(t *testing.T) {
|
|
t.Run("Unknown command", func(t *testing.T) {
|
|
_, err := executeCommand(RootCmd, "unknown-command")
|
|
if err == nil {
|
|
t.Fatal("expected an error for an unknown command, but got none")
|
|
}
|
|
})
|
|
}
|
|
|
|
// initAllCommands re-initializes all commands for testing.
|
|
func initAllCommands(cmd *cobra.Command) {
|
|
cmd.AddCommand(GetAllCmd())
|
|
cmd.AddCommand(GetCollectCmd())
|
|
cmd.AddCommand(GetCompileCmd())
|
|
cmd.AddCommand(GetRunCmd())
|
|
cmd.AddCommand(GetServeCmd())
|
|
cmd.AddCommand(GetIndexCmd())
|
|
cmd.AddCommand(GetSearchCmd())
|
|
}
|