//go:build !integration package orbit import ( "context" "errors" "os" "path/filepath" "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/zalando/go-keyring" "gitlab.com/gitlab-org/cli/internal/api" "gitlab.com/gitlab-org/cli/internal/binarymgr" "gitlab.com/gitlab-org/cli/internal/binarymgr/binaries" "gitlab.com/gitlab-org/cli/internal/config" "gitlab.com/gitlab-org/cli/internal/iostreams" "gitlab.com/gitlab-org/cli/internal/testing/cmdtest" ) func TestNewCmd_PassthroughStructure(t *testing.T) { t.Parallel() ios, _, _, _ := cmdtest.TestIOStreams() f := cmdtest.NewTestFactory(ios) cmd := NewCmd(f) assert.Equal(t, "orbit", cmd.Name()) assert.True(t, cmd.DisableFlagParsing) assert.Empty(t, cmd.Annotations["mcp:safe"]) assert.NotNil(t, cmd.Flags().Lookup("install")) assert.NotNil(t, cmd.Flags().Lookup("update")) yesFlag := cmd.Flags().Lookup("yes") require.NotNil(t, yesFlag) assert.Equal(t, "y", yesFlag.Shorthand) } func TestValidate_InstallUpdateMutuallyExclusive(t *testing.T) { t.Parallel() opts := &options{flags: binarymgr.SplitFlags([]string{"--install", "--update"})} err := opts.validate() require.Error(t, err) assert.Contains(t, err.Error(), "mutually exclusive") } func TestValidate_InstallWithCommandErrors(t *testing.T) { t.Parallel() opts := &options{flags: binarymgr.SplitFlags([]string{"--update", "status"})} err := opts.validate() require.Error(t, err) assert.Contains(t, err.Error(), "cannot be combined with a command") } func TestNewCmd_HelpShowsInstallHintWhenBinaryIsMissing(t *testing.T) { t.Setenv("GLAB_ORBIT_CLI_BINARY_PATH", "") t.Setenv("GLAB_CONFIG_DIR", t.TempDir()) exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithConfig(config.NewBlankConfig())) for _, args := range []string{"", "--help", "-h status"} { out, err := exec(args) require.NoError(t, err, args) assert.Contains(t, out.String(), "The GitLab Orbit CLI is not installed.", args) assert.Contains(t, out.String(), "glab orbit --install --yes", args) } } func TestRun_HelpExecsTheInstalledBinaryWithoutRunLifecycle(t *testing.T) { binary := filepath.Join(t.TempDir(), "orbit") require.NoError(t, os.WriteFile(binary, []byte("#!/bin/sh\n"), 0o755)) t.Setenv("GLAB_ORBIT_CLI_BINARY_PATH", binary) t.Setenv("GITLAB_TOKEN", "glpat-remote") client, err := api.NewClientFromConfig("gitlab.com", config.NewBlankConfig(), false, "test-agent") require.NoError(t, err) ios, _, stdout, _ := cmdtest.TestIOStreams(cmdtest.WithTestIOStreamsAsTTY(true)) f := cmdtest.NewTestFactory(ios, cmdtest.WithConfig(config.NewBlankConfig()), cmdtest.WithApiClient(client)) for _, args := range [][]string{{}, {"--help"}, {"-h", "status"}, {"--yes", "--help"}} { var forwarded []string opts := &options{ io: ios, cfg: f.Config(), factory: f, flags: binarymgr.SplitFlags(args), execute: func(_ context.Context, _ *iostreams.IOStreams, path string, execArgs, env []string) error { assert.Equal(t, binary, path, "%v", args) assert.Contains(t, env, "ORBIT_AUTH_HEADER_VALUE=glpat-remote", "%v", args) forwarded = execArgs return nil }, } require.NoError(t, opts.run(t.Context()), "%v", args) assert.Equal(t, opts.flags.Forwarded, forwarded, "%v", args) } assert.Empty(t, stdout.String()) } func TestNewCmd_HelpNamesBrokenCustomBinaryPath(t *testing.T) { missing := filepath.Join(t.TempDir(), "missing-orbit") t.Setenv("GLAB_ORBIT_CLI_BINARY_PATH", missing) exec := cmdtest.SetupCmdForTest(t, NewCmd, false, cmdtest.WithConfig(config.NewBlankConfig())) out, err := exec("") require.NoError(t, err) assert.Contains(t, out.String(), missing) assert.Contains(t, out.String(), "GLAB_ORBIT_CLI_BINARY_PATH") assert.Contains(t, out.String(), "orbit_cli_binary_path") assert.NotContains(t, out.String(), "is not installed") } func TestOrbitCredentialEnv_InjectsResolvedCredential(t *testing.T) { t.Setenv("GITLAB_TOKEN", "glpat-remote") client, err := api.NewClientFromConfig("gitlab.com", config.NewBlankConfig(), false, "test-agent") require.NoError(t, err) f := cmdtest.NewTestFactory(nil, cmdtest.WithApiClient(client)) env := orbitCredentialEnv(t.Context(), f) assert.Contains(t, env, "ORBIT_API_BASE_URL=https://gitlab.com") assert.Contains(t, env, "ORBIT_AUTH_HEADER_NAME=Private-Token") assert.Contains(t, env, "ORBIT_AUTH_HEADER_VALUE=glpat-remote") } func TestOrbitCredentialEnv_SkipsWhenUnauthenticated(t *testing.T) { t.Setenv("GITLAB_TOKEN", "") keyring.MockInit() client, err := api.NewClientFromConfig("gitlab.com", config.NewBlankConfig(), false, "test-agent") require.NoError(t, err) ios, _, _, stderr := cmdtest.TestIOStreams() f := cmdtest.NewTestFactory(ios, cmdtest.WithApiClient(client)) assert.Nil(t, orbitCredentialEnv(t.Context(), f)) assert.Empty(t, stderr.String()) } func TestRunWithCustomPath_Validation(t *testing.T) { if _, err := binarymgr.ManagedBinaryPath(binaries.Orbit()); errors.Is(err, binarymgr.ErrUnsupportedPlatform) { t.Skipf("skipping on unsupported platform: %v", err) } t.Run("non-existent path returns clear error", func(t *testing.T) { ios, _, _, _ := cmdtest.TestIOStreams(cmdtest.WithTestIOStreamsAsTTY(false)) factory := cmdtest.NewTestFactory(ios) t.Setenv("GLAB_ORBIT_CLI_BINARY_PATH", "/nonexistent/path/to/orbit") runner := binarymgr.NewRunner(factory.IO(), factory.Config(), binaries.Orbit()) err := runner.Run(t.Context()) require.Error(t, err) assert.Contains(t, err.Error(), "GLAB_ORBIT_CLI_BINARY_PATH") assert.Contains(t, err.Error(), "orbit_cli_binary_path") assert.Contains(t, err.Error(), "/nonexistent/path/to/orbit") assert.Contains(t, err.Error(), "was not found") }) t.Run("non-executable file returns clear error", func(t *testing.T) { ios, _, _, _ := cmdtest.TestIOStreams(cmdtest.WithTestIOStreamsAsTTY(false)) factory := cmdtest.NewTestFactory(ios) dir := t.TempDir() nonExecFile := filepath.Join(dir, "orbit") require.NoError(t, os.WriteFile(nonExecFile, []byte("#!/bin/sh\n"), 0o644)) t.Setenv("GLAB_ORBIT_CLI_BINARY_PATH", nonExecFile) runner := binarymgr.NewRunner(factory.IO(), factory.Config(), binaries.Orbit()) err := runner.Run(t.Context()) require.Error(t, err) assert.Contains(t, err.Error(), "GLAB_ORBIT_CLI_BINARY_PATH") assert.Contains(t, err.Error(), "is not executable") }) } func TestHandleInstall_CustomPath(t *testing.T) { if _, err := binarymgr.ManagedBinaryPath(binaries.Orbit()); errors.Is(err, binarymgr.ErrUnsupportedPlatform) { t.Skipf("skipping on unsupported platform: %v", err) } ios, _, stderr, _ := cmdtest.TestIOStreams(cmdtest.WithTestIOStreamsAsTTY(false)) factory := cmdtest.NewTestFactory(ios) dir := t.TempDir() execFile := filepath.Join(dir, "orbit") require.NoError(t, os.WriteFile(execFile, []byte("#!/bin/sh\n"), 0o755)) t.Setenv("GLAB_ORBIT_CLI_BINARY_PATH", execFile) runner := binarymgr.NewRunner(factory.IO(), factory.Config(), binaries.Orbit()) err := runner.HandleInstall(t.Context()) require.NoError(t, err) assert.Contains(t, stderr.String(), "Using custom GitLab Orbit CLI binary:") assert.Contains(t, stderr.String(), execFile) } func TestNewCmd_UpdateRouting(t *testing.T) { t.Parallel() tests := []struct { name string args []string want string }{ {name: "update is glab's subcommand", args: []string{"update"}, want: "update"}, {name: "update after --yes is glab's subcommand", args: []string{"--yes", "update"}, want: "update"}, {name: "--update stays on the pass-through command", args: []string{"--update"}, want: "orbit"}, {name: "update after another command passes through", args: []string{"grep", "update"}, want: "orbit"}, } for _, tc := range tests { t.Run(tc.name, func(t *testing.T) { t.Parallel() ios, _, _, _ := cmdtest.TestIOStreams(cmdtest.WithTestIOStreamsAsTTY(false)) cmd := NewCmd(cmdtest.NewTestFactory(ios)) found, _, err := cmd.Find(tc.args) require.NoError(t, err) assert.Equal(t, tc.want, found.Name()) }) } }