-
Notifications
You must be signed in to change notification settings - Fork 232
/
setup.go
276 lines (226 loc) · 9.05 KB
/
setup.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
package cmd
import (
"fmt"
"github.com/CircleCI-Public/circleci-cli/api"
"github.com/CircleCI-Public/circleci-cli/api/graphql"
"github.com/CircleCI-Public/circleci-cli/prompt"
"github.com/CircleCI-Public/circleci-cli/settings"
"github.com/pkg/errors"
"github.com/spf13/cobra"
)
type setupOptions struct {
cfg *settings.Config
cl *graphql.Client
noPrompt bool
// Add host and token for use with --no-prompt
host string
token string
args []string
// This lets us pass in our own interface for testing
tty setupUserInterface
// Linked with --integration-testing flag for stubbing UI in gexec tests
integrationTesting bool
}
// setupUserInterface is created to allow us to pass a mock user interface for testing.
// Since we can't properly run integration tests on code that calls PromptUI.
// This is because the first call to PromptUI reads from stdin correctly,
// but subsequent calls return EOF.
type setupUserInterface interface {
readTokenFromUser(message string) (string, error)
readHostFromUser(message string, defaultValue string) string
askUserToConfirmEndpoint(message string) bool
askUserToConfirmToken(message string) bool
}
// setupUI implements the setupUserInterface used by the real program, not in tests.
type setupInteractiveUI struct{}
// readHostFromUser implements the setupInteractiveUI interface for asking a user's input.
func (setupInteractiveUI) readHostFromUser(message string, defaultValue string) string {
return prompt.ReadStringFromUser(message, defaultValue)
}
// readTokenFromUser implements the setupInteractiveUI interface for asking a user's token.
func (setupInteractiveUI) readTokenFromUser(message string) (string, error) {
return prompt.ReadSecretStringFromUser(message)
}
func (setupInteractiveUI) askUserToConfirmEndpoint(message string) bool {
return prompt.AskUserToConfirm(message)
}
func (setupInteractiveUI) askUserToConfirmToken(message string) bool {
return prompt.AskUserToConfirm(message)
}
// setupTestUI implements the setupUserInterface for our testing purposes.
type setupTestUI struct {
host string
token string
confirmEndpoint bool
confirmToken bool
}
// readHostFromUser implements the setupTestUI interface for asking a user's input.
// It works by simply printing the message to standard output and passing the input through.
func (ui setupTestUI) readHostFromUser(message string, defaultValue string) string {
fmt.Println(message)
return ui.host
}
// readTokenFromUser implements the setupTestUI interface for asking a user's token.
// It works by simply printing the message to standard output and passing the token through.
func (ui setupTestUI) readTokenFromUser(message string) (string, error) {
fmt.Println(message)
return ui.token, nil
}
// askUserToConfirmEndpoint works by printing the provided message to standard out and returning a Confirm dialogue up the chain.
func (ui setupTestUI) askUserToConfirmEndpoint(message string) bool {
fmt.Println(message)
return ui.confirmEndpoint
}
// askUserToConfirmToken works by printing the provided message to standard out and returning a Confirm dialogue up the chain.
func (ui setupTestUI) askUserToConfirmToken(message string) bool {
fmt.Println(message)
return ui.confirmToken
}
// shouldAskForToken wraps an askUserToConfirm dialogue only if their token is empty or blank.
func shouldAskForToken(token string, ui setupUserInterface) bool {
if token == "" {
return true
}
return ui.askUserToConfirmToken("A CircleCI token is already set. Do you want to change it")
}
// shouldAskForEndpoint wraps an askUserToConfirm dialogue only if their endpoint has changed from the default value.
func shouldAskForEndpoint(endpoint string, ui setupUserInterface, defaultValue string) bool {
if endpoint == defaultValue {
return true
}
return ui.askUserToConfirmEndpoint(fmt.Sprintf("Do you want to reset the endpoint? (default: %s)", defaultValue))
}
func newSetupCommand(config *settings.Config) *cobra.Command {
opts := setupOptions{
cfg: config,
tty: setupInteractiveUI{},
}
setupCommand := &cobra.Command{
Use: "setup",
Short: "Setup the CLI with your credentials",
PreRun: func(cmd *cobra.Command, args []string) {
opts.args = args
opts.cl = graphql.NewClient(config.HTTPClient, config.Host, config.Endpoint, config.Token, config.Debug)
},
RunE: func(_ *cobra.Command, _ []string) error {
if opts.integrationTesting {
opts.tty = setupTestUI{
host: "boondoggle",
token: "boondoggle",
confirmEndpoint: true,
confirmToken: true,
}
}
if opts.noPrompt {
return setupNoPrompt(opts)
}
return setup(opts)
},
}
setupCommand.Flags().BoolVar(&opts.integrationTesting, "integration-testing", false, "Enable test mode to bypass interactive UI.")
if err := setupCommand.Flags().MarkHidden("integration-testing"); err != nil {
panic(err)
}
setupCommand.Flags().BoolVar(&opts.noPrompt, "no-prompt", false, "Disable prompt to bypass interactive UI. (MUST supply --host and --token)")
setupCommand.Flags().StringVar(&opts.host, "host", "", "URL to your CircleCI host")
if err := setupCommand.Flags().MarkHidden("host"); err != nil {
panic(err)
}
setupCommand.Flags().StringVar(&opts.token, "token", "", "your token for using CircleCI")
if err := setupCommand.Flags().MarkHidden("token"); err != nil {
panic(err)
}
return setupCommand
}
func setup(opts setupOptions) error {
if shouldAskForToken(opts.cfg.Token, opts.tty) {
token, err := opts.tty.readTokenFromUser("CircleCI API Token")
if err != nil {
return errors.Wrap(err, "Error reading token")
}
opts.cfg.Token = token
fmt.Println("API token has been set.")
}
opts.cfg.Host = opts.tty.readHostFromUser("CircleCI Host", defaultHost)
fmt.Println("CircleCI host has been set.")
// Reset endpoint to default when running setup
// This ensures any accidental changes to this field can be fixed simply by rerunning this command.
if shouldAskForEndpoint(opts.cfg.Endpoint, opts.tty, defaultEndpoint) {
opts.cfg.Endpoint = defaultEndpoint
}
if err := opts.cfg.WriteToDisk(); err != nil {
return errors.Wrap(err, "Failed to save config file")
}
fmt.Printf("Setup complete.\nYour configuration has been saved to %s.\n", opts.cfg.FileUsed)
if !opts.integrationTesting {
setupDiagnosticCheck(opts)
}
return nil
}
func setupDiagnosticCheck(opts setupOptions) {
// Reset client after setup config
opts.cl.Reset(opts.cfg.Host, opts.cfg.Endpoint, opts.cfg.Token, opts.cfg.Debug)
fmt.Printf("\n")
fmt.Printf("Trying an introspection query on API to verify your setup... ")
responseIntro, err := api.IntrospectionQuery(opts.cl)
if err != nil || responseIntro.Schema.QueryType.Name == "" {
fmt.Println("\nUnable to make a query against the GraphQL API, please check your settings.")
} else {
fmt.Println("Ok.")
}
fmt.Printf("Trying to query our API for your profile name... ")
responseWho, err := api.WhoamiQuery(opts.cl)
if err != nil {
fmt.Println("\nUnable to query our API for your profile name, please check your settings.")
// If user does not have a name set in their VCS, let's just say hi :)
} else if responseWho.Me.Name == "" {
fmt.Printf("Hello!")
} else {
fmt.Printf("Hello, %s.\n", responseWho.Me.Name)
}
}
func shouldKeepExistingConfig(opts setupOptions) bool {
// Host will always be set, since it has a default value of circleci.com
// We assume by an empty token there is no existing config.
if opts.cfg.Token == "" {
return false
}
// If they pass either host or token with a value this will be false, overwriting their existing config
return opts.host == "" && opts.token == ""
}
func setupNoPrompt(opts setupOptions) error {
if shouldKeepExistingConfig(opts) {
fmt.Printf("Setup has kept your existing configuration at %s.\n", opts.cfg.FileUsed)
return nil
}
// Throw an error if both flags are blank are blank!
if opts.host == "" && opts.token == "" {
return errors.New("No existing host or token saved.\nThe proper format is `circleci setup --host HOST --token TOKEN --no-prompt")
}
config := settings.Config{}
// First calling load will ensure the new config can be saved to disk
if err := config.LoadFromDisk(); err != nil {
return errors.Wrap(err, "Failed to create config file on disk")
}
// Use the default endpoint since we don't expose that to users
config.Endpoint = defaultEndpoint
config.RestEndpoint = defaultRestEndpoint
config.Host = opts.host // Set new host to flag
config.Token = opts.token // Set new token to flag
// Reset their host if the flag was blank
if opts.host == "" {
fmt.Println("Host unchanged from existing config. Use --host with --no-prompt to overwrite it.")
config.Host = opts.cfg.Host
}
// Reset their token if the flag was blank
if opts.token == "" {
fmt.Println("Token unchanged from existing config. Use --token with --no-prompt to overwrite it.")
config.Token = opts.cfg.Token
}
// Then save the new config to disk
if err := config.WriteToDisk(); err != nil {
return errors.Wrap(err, "Failed to save config file")
}
fmt.Printf("Setup complete.\nYour configuration has been saved to %s.\n", config.FileUsed)
return nil
}