|
| 1 | +package agent |
| 2 | + |
| 3 | +import ( |
| 4 | + "testing" |
| 5 | + |
| 6 | + "github.com/cli/cli/v2/internal/config" |
| 7 | + "github.com/cli/cli/v2/internal/gh" |
| 8 | + ghmock "github.com/cli/cli/v2/internal/gh/mock" |
| 9 | + "github.com/cli/cli/v2/pkg/cmdutil" |
| 10 | + "github.com/cli/cli/v2/pkg/iostreams" |
| 11 | + "github.com/stretchr/testify/require" |
| 12 | +) |
| 13 | + |
| 14 | +// setupMockOAuthConfig configures a blank config with a default host and optional token behavior. |
| 15 | +func setupMockOAuthConfig(t *testing.T, tokenSource string) gh.Config { |
| 16 | + t.Helper() |
| 17 | + c := config.NewBlankConfig() |
| 18 | + switch tokenSource { |
| 19 | + case "oauth_token": |
| 20 | + // valid OAuth device flow token stored in config |
| 21 | + c.Set("github.com", "oauth_token", "gho_OAUTH123") |
| 22 | + case "keyring": |
| 23 | + // valid OAuth device flow token stored in keyring |
| 24 | + c.Set("github.com", "oauth_token", "gho_OAUTH123") |
| 25 | + case "GH_TOKEN": |
| 26 | + // classic style token stored in config (will fail prefix check) |
| 27 | + c.Set("github.com", "oauth_token", "ghp_CLASSIC123") |
| 28 | + case "GH_ENTERPRISE_TOKEN": |
| 29 | + // enterprise style token stored in config (will fail prefix check) |
| 30 | + c.Set("something.ghes.com", "oauth_token", "ghe_ENTERPRISE123") |
| 31 | + } |
| 32 | + return c |
| 33 | +} |
| 34 | + |
| 35 | +func TestNewCmdAgentTask(t *testing.T) { |
| 36 | + tests := []struct { |
| 37 | + name string |
| 38 | + tokenSource string |
| 39 | + customConfig func() (gh.Config, error) |
| 40 | + wantErr bool |
| 41 | + wantErrContains string |
| 42 | + wantStdout string |
| 43 | + }{ |
| 44 | + { |
| 45 | + name: "oauth token is accepted", |
| 46 | + tokenSource: "oauth_token", |
| 47 | + wantErr: false, |
| 48 | + wantStdout: "", |
| 49 | + }, |
| 50 | + { |
| 51 | + name: "keyring oauth token is accepted", |
| 52 | + tokenSource: "keyring", |
| 53 | + wantErr: false, |
| 54 | + wantStdout: "", |
| 55 | + }, |
| 56 | + { |
| 57 | + name: "env var token is rejected", |
| 58 | + tokenSource: "GH_TOKEN", |
| 59 | + wantErr: true, |
| 60 | + wantErrContains: "requires an OAuth token", |
| 61 | + }, |
| 62 | + { |
| 63 | + name: "enterprise token alone is ignored and rejected", |
| 64 | + tokenSource: "GH_ENTERPRISE_TOKEN", |
| 65 | + wantErr: true, |
| 66 | + }, |
| 67 | + { |
| 68 | + name: "github.com oauth is accepted and enterprise token ignored", |
| 69 | + customConfig: func() (gh.Config, error) { |
| 70 | + c := config.NewBlankConfig() |
| 71 | + c.Set("something.ghes.com", "oauth_token", "ghe_ENTERPRISE123") |
| 72 | + c.Set("github.com", "oauth_token", "gho_OAUTH123") |
| 73 | + return c, nil |
| 74 | + }, |
| 75 | + wantErr: false, |
| 76 | + wantStdout: "", |
| 77 | + }, |
| 78 | + { |
| 79 | + name: "enterprise host is rejected", |
| 80 | + customConfig: func() (gh.Config, error) { |
| 81 | + return &ghmock.ConfigMock{ |
| 82 | + AuthenticationFunc: func() gh.AuthConfig { |
| 83 | + c := &config.AuthConfig{} |
| 84 | + c.SetDefaultHost("something.ghes.com", "GH_HOST") |
| 85 | + return c |
| 86 | + }, |
| 87 | + }, nil |
| 88 | + }, |
| 89 | + wantErr: true, |
| 90 | + wantErrContains: "not supported on this host", |
| 91 | + }, |
| 92 | + { |
| 93 | + name: "empty host is rejected", |
| 94 | + customConfig: func() (gh.Config, error) { |
| 95 | + return &ghmock.ConfigMock{ |
| 96 | + AuthenticationFunc: func() gh.AuthConfig { |
| 97 | + c := &config.AuthConfig{} |
| 98 | + c.SetDefaultHost("", "GH_HOST") |
| 99 | + return c |
| 100 | + }, |
| 101 | + }, nil |
| 102 | + }, |
| 103 | + wantErr: true, |
| 104 | + wantErrContains: "no default host configured", |
| 105 | + }, |
| 106 | + { |
| 107 | + name: "no auth is rejected", |
| 108 | + tokenSource: "", |
| 109 | + wantErr: true, |
| 110 | + }, |
| 111 | + } |
| 112 | + |
| 113 | + for _, tt := range tests { |
| 114 | + t.Run(tt.name, func(t *testing.T) { |
| 115 | + f := &cmdutil.Factory{} |
| 116 | + ios, _, stdout, _ := iostreams.Test() |
| 117 | + f.IOStreams = ios |
| 118 | + if tt.customConfig != nil { |
| 119 | + f.Config = tt.customConfig |
| 120 | + } else { |
| 121 | + f.Config = func() (gh.Config, error) { return setupMockOAuthConfig(t, tt.tokenSource), nil } |
| 122 | + } |
| 123 | + |
| 124 | + cmd := NewCmdAgentTask(f) |
| 125 | + err := cmd.Execute() |
| 126 | + |
| 127 | + if tt.wantErr { |
| 128 | + require.Error(t, err) |
| 129 | + if tt.wantErrContains != "" { |
| 130 | + require.Contains(t, err.Error(), tt.wantErrContains) |
| 131 | + } |
| 132 | + } else { |
| 133 | + require.NoError(t, err) |
| 134 | + require.Equal(t, tt.wantStdout, stdout.String()) |
| 135 | + } |
| 136 | + }) |
| 137 | + } |
| 138 | +} |
| 139 | + |
| 140 | +func TestAliasAreSet(t *testing.T) { |
| 141 | + f := &cmdutil.Factory{} |
| 142 | + ios, _, _, _ := iostreams.Test() |
| 143 | + f.IOStreams = ios |
| 144 | + f.Config = func() (gh.Config, error) { return setupMockOAuthConfig(t, "oauth_token"), nil } |
| 145 | + |
| 146 | + cmd := NewCmdAgentTask(f) |
| 147 | + |
| 148 | + require.ElementsMatch(t, []string{"agent-tasks", "agent", "agents"}, cmd.Aliases) |
| 149 | +} |
0 commit comments