distrobox/internal/cli/enter_internal_test.go

package cli

import (
	"context"
	"strings"
	"sync"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/urfave/cli/v3"

	"github.com/89luca89/distrobox/pkg/config"
	"github.com/89luca89/distrobox/pkg/containermanager"
	"github.com/89luca89/distrobox/pkg/ui"
)

// spyContainerManager records every Enter call so the test can assert on
// the EnterOptions the enter subcommand built from its argv. All other
// methods are no-ops — enterAction only ever calls Enter.
type spyContainerManager struct {
	mu     sync.Mutex
	calls  []containermanager.EnterOptions
	failOn bool
}

func (s *spyContainerManager) Enter(_ context.Context, opts containermanager.EnterOptions, _ *ui.Progress, _ *ui.Printer) error {
	s.mu.Lock()
	defer s.mu.Unlock()
	s.calls = append(s.calls, opts)
	return nil
}

// The remaining methods are stubs to satisfy containermanager.ContainerManager.
// enterAction never reaches them.
func (s *spyContainerManager) Name() string                                   { return "spy" }
func (s *spyContainerManager) CloneAsRoot() containermanager.ContainerManager { return s }
func (s *spyContainerManager) Create(_ context.Context, _ containermanager.CreateOptions) error {
	return nil
}
func (s *spyContainerManager) ListContainers(_ context.Context) ([]containermanager.Container, error) {
	return nil, nil
}
func (s *spyContainerManager) Remove(_ context.Context, _ string, _ containermanager.RmOptions) error {
	return nil
}
func (s *spyContainerManager) Exists(_ context.Context, _ string) bool  { return false }
func (s *spyContainerManager) Stop(_ context.Context, _ []string) error { return nil }
func (s *spyContainerManager) InspectContainer(_ context.Context, _ string) (*containermanager.InspectResult, error) {
	return &containermanager.InspectResult{}, nil
}
func (s *spyContainerManager) Commit(_ context.Context, _, _ string) error { return nil }
func (s *spyContainerManager) ImageExists(_ context.Context, _ string) bool {
	return false
}
func (s *spyContainerManager) PullImage(_ context.Context, _, _ string, _ bool) error { return nil }

// runEnter runs the enter subcommand with the given argv (starting from
// "enter") against a spy container manager and returns the EnterOptions
// the spy was invoked with.
func runEnter(t *testing.T, argv ...string) containermanager.EnterOptions {
	t.Helper()

	spy := &spyContainerManager{}
	cmd := newEnterCommand(config.DefaultValues())

	// The production Before hook (installed by withContainerManager in
	// root.go) tries to detect a real container manager and validate
	// sudo. We don't need any of that for parsing tests — we just want
	// to plant the spy where enterAction looks for it.
	cmd.Before = func(ctx context.Context, _ *cli.Command) (context.Context, error) {
		return context.WithValue(ctx, containerManagerKey, spy), nil
	}

	root := &cli.Command{Commands: []*cli.Command{cmd}}
	full := append([]string{"distrobox"}, argv...)

	require.NoError(t, root.Run(context.Background(), full))
	require.NotEmpty(t, spy.calls, "expected Enter to be called for argv %v", argv)

	return spy.calls[0]
}

// TestEnterCommand_CustomCommandVariants locks down the three equivalent
// ways of supplying a custom command to `distrobox enter` — `-e`,
// `--exec`, and the bare `--` separator — as well as the implicit form
// where positional args after the container name are taken as the
// custom command. All four must produce the same (container,
// customCommand) pair, matching the original bash distrobox-enter.
func TestEnterCommand_CustomCommandVariants(t *testing.T) {
	cases := []struct {
		name string
		argv []string
	}{
		{
			name: "short -e flag",
			argv: []string{"enter", "suse", "-e", "echo", "ciao"},
		},
		{
			name: "long --exec flag",
			argv: []string{"enter", "suse", "--exec", "echo", "ciao"},
		},
		{
			name: "bare -- separator",
			argv: []string{"enter", "suse", "--", "echo", "ciao"},
		},
		{
			name: "implicit (no -e/--exec/--)",
			argv: []string{"enter", "suse", "echo", "ciao"},
		},
		{
			name: "explicit --name with -e",
			argv: []string{"enter", "--name", "suse", "-e", "echo", "ciao"},
		},
		{
			name: "explicit --name with --",
			argv: []string{"enter", "--name", "suse", "--", "echo", "ciao"},
		},
		{
			// Regression: the custom command itself contains a short
			// flag (e.g. `bash -c echo`). The CLI must not eat it as
			// a distrobox flag — matching the original bash script.
			name: "custom command with short flag after -e",
			argv: []string{"enter", "suse", "-e", "bash", "-c", "echo"},
		},
		{
			name: "custom command with short flag after --",
			argv: []string{"enter", "suse", "--", "bash", "-c", "echo"},
		},
		{
			name: "-e before the container name",
			argv: []string{"enter", "-e", "suse", "bash", "-c", "echo"},
		},
		{
			name: "short flag combo with --no-tty before container name",
			argv: []string{"enter", "--no-tty", "suse", "-e", "bash", "-c", "echo"},
		},
	}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			opts := runEnter(t, tc.argv...)

			assert.Equal(t, "suse", opts.ContainerName)

			want := []string{"echo", "ciao"}
			if strings.HasPrefix(tc.name, "custom command with short flag") ||
				strings.HasPrefix(tc.name, "-e before the container name") ||
				strings.HasPrefix(tc.name, "short flag combo with --no-tty") {
				want = []string{"bash", "-c", "echo"}
			}
			assert.Equal(t, want, opts.CustomCommand)
		})
	}
}

func TestFindExecMarkerIndex(t *testing.T) {
	cases := []struct {
		name string
		args []string
		want int
	}{
		{
			name: "empty args",
			args: nil,
			want: -1,
		},
		{
			name: "no marker",
			args: []string{"suse", "echo", "ciao"},
			want: -1,
		},
		{
			name: "short -e is the only arg",
			args: []string{"-e"},
			want: 0,
		},
		{
			name: "long --exec is the only arg",
			args: []string{"--exec"},
			want: 0,
		},
		{
			name: "-e at the start",
			args: []string{"-e", "bash", "-c", "echo"},
			want: 0,
		},
		{
			name: "--exec in the middle",
			args: []string{"suse", "--exec", "bash", "-c", "echo"},
			want: 1,
		},
		{
			name: "-e at the end with no command after it",
			args: []string{"suse", "-e"},
			want: 1,
		},
		{
			name: "first match wins when both forms are present",
			args: []string{"-e", "suse", "--exec", "echo"},
			want: 0,
		},
		{
			name: "marker-looking arg inside the custom command is not a match",
			// `bash` happens to start with `b`, not `-`, so it must
			// never be picked up. This guards against a future
			// regression that would substring-match.
			args: []string{"suse", "bash", "-e", "echo"},
			want: 2,
		},
		{
			name: "looks similar but is not the marker",
			// `--exec-foo` shares a prefix with `--exec` but is a
			// distinct token; it must not be treated as the marker.
			args: []string{"suse", "--exec-foo", "echo"},
			want: -1,
		},
	}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			assert.Equal(t, tc.want, findExecMarkerIndex(tc.args))
		})
	}
}