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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
|
package cmdutils
import (
"errors"
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strconv"
"strings"
"gitlab.com/gitlab-org/cli/pkg/iostreams"
gitlab "gitlab.com/gitlab-org/api/client-go"
"gitlab.com/gitlab-org/cli/api"
"gitlab.com/gitlab-org/cli/internal/glrepo"
"gitlab.com/gitlab-org/cli/pkg/utils"
"github.com/AlecAivazis/survey/v2"
"gitlab.com/gitlab-org/cli/pkg/prompt"
"gitlab.com/gitlab-org/cli/pkg/surveyext"
"gitlab.com/gitlab-org/cli/internal/config"
"gitlab.com/gitlab-org/cli/pkg/git"
)
const (
IssueTemplate = "issue_templates"
MergeRequestTemplate = "merge_request_templates"
)
// LoadGitLabTemplate finds and loads the GitLab template from the working git directory
// Follows the format officially supported by GitLab
// https://docs.gitlab.com/ee/user/project/description_templates.html#setting-a-default-template-for-issues-and-merge-requests.
//
// TODO: load from remote repository if repo is overridden by -R flag
func LoadGitLabTemplate(tmplType, tmplName string) (string, error) {
wdir, err := git.ToplevelDir()
if err != nil {
return "", err
}
if !strings.HasSuffix(tmplName, ".md") {
tmplName = tmplName + ".md"
}
tmplFile := filepath.Join(wdir, ".gitlab", tmplType, tmplName)
f, err := os.Open(tmplFile)
if os.IsNotExist(err) {
return "", nil
} else if err != nil {
return "", err
}
tmpl, err := io.ReadAll(f)
if err != nil {
return "", err
}
return strings.TrimSpace(string(tmpl)), nil
}
// TODO: properly handle errors in this function.
//
// For now, it returns nil and empty slice if there's an error
func ListGitLabTemplates(tmplType string) ([]string, error) {
wdir, err := git.ToplevelDir()
if err != nil {
return []string{}, nil
}
tmplFolder := filepath.Join(wdir, ".gitlab", tmplType)
var files []string
f, err := os.Open(tmplFolder)
// if error return an empty slice since it only returns PathError
if err != nil {
return files, nil
}
fileNames, err := f.Readdirnames(-1)
defer f.Close()
if err != nil {
// return empty slice if error
return files, nil
}
for _, file := range fileNames {
if strings.HasPrefix(file, ".") || !strings.HasSuffix(file, ".md") {
continue
}
files = append(files, strings.TrimSuffix(file, ".md"))
}
sort.Slice(files, func(i, j int) bool { return files[i] < files[j] })
return files, nil
}
func GetEditor(cf func() (config.Config, error)) (string, error) {
cfg, err := cf()
if err != nil {
return "", fmt.Errorf("could not read config: %w", err)
}
// will search in the order glab_editor, visual, editor first from the env before the config file
editorCommand, _ := cfg.Get("", "editor")
return editorCommand, nil
}
func EditorPrompt(response *string, question, templateContent, editorCommand string) error {
defaultBody := *response
if templateContent != "" {
if defaultBody != "" {
// prevent excessive newlines between default body and template
defaultBody = strings.TrimRight(defaultBody, "\n")
defaultBody += "\n\n"
}
defaultBody += templateContent
}
qs := []*survey.Question{
{
Name: question,
Prompt: &surveyext.GLabEditor{
BlankAllowed: true,
EditorCommand: editorCommand,
Editor: &survey.Editor{
Message: "Description",
FileName: "*.md",
Default: defaultBody,
HideDefault: true,
AppendDefault: true,
},
},
},
}
err := prompt.Ask(qs, response)
if err != nil {
return err
}
if *response == "" {
*response = defaultBody
}
return nil
}
type GetTextUsingEditor func(editor, tmpFileName, content string) (string, error)
func LabelsPrompt(response *[]string, apiClient *gitlab.Client, repoRemote *glrepo.Remote) (err error) {
labelOpts := &api.ListLabelsOptions{}
labelOpts.PerPage = 100
labels, err := api.ListLabels(apiClient, repoRemote.FullName(), labelOpts)
if err != nil {
return err
}
if len(labels) != 0 {
var labelOptions []string
for i := range labels {
labelOptions = append(labelOptions, labels[i].Name)
}
var selectedLabels []string
err = prompt.MultiSelect(&selectedLabels, "labels", "Select labels", labelOptions)
if err != nil {
return err
}
*response = append(*response, selectedLabels...)
return nil
}
var responseString string
err = prompt.AskQuestionWithInput(&responseString, "labels", "Label(s) (comma-separated)", "", false)
if err != nil {
return err
}
if responseString != "" {
*response = append(*response, strings.Split(responseString, ",")...)
}
return nil
}
func MilestonesPrompt(response *int, apiClient *gitlab.Client, repoRemote *glrepo.Remote, io *iostreams.IOStreams) (err error) {
var milestoneOptions []string
milestoneMap := map[string]int{}
lOpts := &api.ListMilestonesOptions{
IncludeParentMilestones: gitlab.Ptr(true),
State: gitlab.Ptr("active"),
PerPage: 100,
}
milestones, err := api.ListAllMilestones(apiClient, repoRemote.FullName(), lOpts)
if err != nil {
return err
}
if len(milestones) == 0 {
fmt.Fprintln(io.StdErr, "No active milestones exist for this project.")
return nil
}
for i := range milestones {
milestoneOptions = append(milestoneOptions, milestones[i].Title)
milestoneMap[milestones[i].Title] = milestones[i].ID
}
var selectedMilestone string
err = prompt.Select(&selectedMilestone, "milestone", "Select milestone", milestoneOptions)
if err != nil {
return err
}
*response = milestoneMap[selectedMilestone]
return nil
}
// GroupMemberLevel maps a number representing the access level to a string shown to the
// user.
// API docs:
// https://docs.gitlab.com/ce/api/members.html#valid-access-levels
var GroupMemberLevel = map[int]string{
0: "no access",
5: "minimal access",
10: "guest",
20: "reporter",
30: "developer",
40: "maintainer",
50: "owner",
}
// UsersPrompt creates a multi-selection prompt of all the users above the given access level
// for the remote referenced by the `*glrepo.Remote`.
//
// `role` will appear on the prompt to keep the user informed of the reason of the selection.
func UsersPrompt(response *[]string, apiClient *gitlab.Client, repoRemote *glrepo.Remote, io *iostreams.IOStreams, minimumAccessLevel int, role string) (err error) {
var userOptions []string
userMap := map[string]string{}
lOpts := &gitlab.ListProjectMembersOptions{}
lOpts.PerPage = 100
members, err := api.ListProjectMembers(apiClient, repoRemote.FullName(), lOpts)
if err != nil {
return err
}
for i := range members {
if members[i].AccessLevel >= gitlab.AccessLevelValue(minimumAccessLevel) {
userOptions = append(userOptions, fmt.Sprintf("%s (%s)",
members[i].Username,
GroupMemberLevel[int(members[i].AccessLevel)],
))
userMap[fmt.Sprintf("%s (%s)", members[i].Username, GroupMemberLevel[int(members[i].AccessLevel)])] = members[i].Username
}
}
if len(userOptions) == 0 {
fmt.Fprintf(io.StdErr, "Couldn't fetch any members with minimum permission level %d.\n", minimumAccessLevel)
return nil
}
var selectedUsers []string
err = prompt.MultiSelect(&selectedUsers, role, fmt.Sprintf("Select %s", role), userOptions)
if err != nil {
return err
}
for _, x := range selectedUsers {
*response = append(*response, userMap[x])
}
return nil
}
type Action int
const (
NoAction Action = iota
SubmitAction
PreviewAction
AddMetadataAction
CancelAction
EditCommitMessageAction
)
func ConfirmSubmission(allowPreview bool, allowAddMetadata bool) (Action, error) {
const (
submitLabel = "Submit"
previewLabel = "Continue in browser"
addMetadataLabel = "Add metadata"
cancelLabel = "Cancel"
)
options := []string{submitLabel}
if allowPreview {
options = append(options, previewLabel)
}
if allowAddMetadata {
options = append(options, addMetadataLabel)
}
options = append(options, cancelLabel)
var confirmAnswer string
err := prompt.Select(&confirmAnswer, "confirmation", "What's next?", options)
if err != nil {
return -1, fmt.Errorf("could not prompt: %w", err)
}
switch confirmAnswer {
case submitLabel:
return SubmitAction, nil
case previewLabel:
return PreviewAction, nil
case addMetadataLabel:
return AddMetadataAction, nil
case cancelLabel:
return CancelAction, nil
default:
return -1, fmt.Errorf("invalid value: %s", confirmAnswer)
}
}
const (
AddLabelAction Action = iota
AddAssigneeAction
AddMilestoneAction
)
func PickMetadata() ([]Action, error) {
const (
labelsLabel = "labels"
assigneeLabel = "assignees"
milestoneLabel = "milestones"
)
options := []string{
labelsLabel,
assigneeLabel,
milestoneLabel,
}
var confirmAnswers []string
err := prompt.MultiSelect(&confirmAnswers, "metadata", "Which metadata types to add?", options)
if err != nil {
return nil, fmt.Errorf("could not prompt: %w", err)
}
var pickedActions []Action
for _, x := range confirmAnswers {
switch x {
case labelsLabel:
pickedActions = append(pickedActions, AddLabelAction)
case assigneeLabel:
pickedActions = append(pickedActions, AddAssigneeAction)
case milestoneLabel:
pickedActions = append(pickedActions, AddMilestoneAction)
}
}
return pickedActions, nil
}
// IDsFromUsers collects all user IDs from a slice of users
func IDsFromUsers(users []*gitlab.User) *[]int {
ids := make([]int, len(users))
for i, user := range users {
ids[i] = user.ID
}
return &ids
}
func ParseMilestone(apiClient *gitlab.Client, repo glrepo.Interface, milestoneTitle string) (int, error) {
if milestoneID, err := strconv.Atoi(milestoneTitle); err == nil {
return milestoneID, nil
}
milestone, err := api.ProjectMilestoneByTitle(apiClient, repo.FullName(), milestoneTitle)
if err != nil {
return 0, err
}
return milestone.ID, nil
}
// UserAssignments holds 3 slice strings that represent which assignees should be added, removed, and replaced
// helper functions are also provided
type UserAssignments struct {
ToAdd []string
ToRemove []string
ToReplace []string
AssignmentType UserAssignmentType
}
type UserAssignmentType int
const (
AssigneeAssignment UserAssignmentType = iota
ReviewerAssignment
)
// ParseAssignees takes a String Slice and splits them into 3 Slice Strings based on
// the first character of a string.
//
// '+' is put in the first slice, '!' and '-' in the second slice and all other cases
// in the third slice.
//
// The 3 String slices are returned regardless if anything was put it in or not the user
// is responsible for checking the length to see if anything is in it
func ParseAssignees(assignees []string) *UserAssignments {
ua := UserAssignments{
AssignmentType: AssigneeAssignment,
}
for _, assignee := range assignees {
switch string([]rune(assignee)[0]) {
case "+":
ua.ToAdd = append(ua.ToAdd, string([]rune(assignee)[1:]))
case "!", "-":
ua.ToRemove = append(ua.ToRemove, string([]rune(assignee)[1:]))
default:
ua.ToReplace = append(ua.ToReplace, assignee)
}
}
return &ua
}
// VerifyAssignees is a method for UserAssignments that checks them for validity
func (ua *UserAssignments) VerifyAssignees() error {
// Fail if relative and absolute assignees were given, there is no reason to mix them.
if len(ua.ToReplace) != 0 && (len(ua.ToAdd) != 0 || len(ua.ToRemove) != 0) {
return errors.New("mixing relative (+,!,-) and absolute assignments is forbidden.")
}
if m := utils.CommonElementsInStringSlice(ua.ToAdd, ua.ToRemove); len(m) != 0 {
return fmt.Errorf("%s %q present in both add and remove, which is forbidden.",
utils.Pluralize(len(m), "element"),
strings.Join(m, " "))
}
return nil
}
// UsersFromReplaces converts all users from the `ToReplace` member of the struct into
// an Slice of String representing the Users' IDs, it also takes a Slice of Strings and
// writes a proper action message to it
func (ua *UserAssignments) UsersFromReplaces(apiClient *gitlab.Client, actions []string) (*[]int, []string, error) {
users, err := api.UsersByNames(apiClient, ua.ToReplace)
if err != nil {
return &[]int{}, actions, err
}
var usernames []string
for i := range users {
usernames = append(usernames, fmt.Sprintf("@%s", users[i].Username))
}
if len(usernames) != 0 {
if ua.AssignmentType == ReviewerAssignment {
actions = append(actions, fmt.Sprintf("requested review from %q", strings.Join(usernames, " ")))
} else {
actions = append(actions, fmt.Sprintf("assigned to %q", strings.Join(usernames, " ")))
}
}
return IDsFromUsers(users), actions, nil
}
// UsersFromAddRemove works with both `ToAdd` and `ToRemove` members to produce a Slice of Ints that
// represents the final collection of IDs to assigned.
//
// It starts by getting all IDs already assigned, but ignoring ones present in `ToRemove`, it then
// converts all `usernames` in `ToAdd` into IDs by using the `api` package and adds them to the
// IDs to be assigned
func (ua *UserAssignments) UsersFromAddRemove(
issueAssignees []*gitlab.IssueAssignee,
mergeRequestAssignees []*gitlab.BasicUser,
apiClient *gitlab.Client,
actions []string,
) (*[]int, []string, error) {
var assignedIDs []int
var usernames []string
// Only one of those is required
if mergeRequestAssignees != nil && issueAssignees != nil {
return &[]int{}, actions, fmt.Errorf("issueAssignees and mergeRequestAssignees can't both be set.")
}
// Path for Issues
for i := range issueAssignees {
// Only store them in assigneedIDs if they are not marked for removal
if !utils.PresentInStringSlice(ua.ToRemove, issueAssignees[i].Username) {
assignedIDs = append(assignedIDs, issueAssignees[i].ID)
}
}
// Path for Merge Requests
for i := range mergeRequestAssignees {
// Only store them in assigneedIDs if they are not marked for removal
if !utils.PresentInStringSlice(ua.ToRemove, mergeRequestAssignees[i].Username) {
assignedIDs = append(assignedIDs, mergeRequestAssignees[i].ID)
}
}
// Add action string
if len(ua.ToRemove) != 0 {
for _, x := range ua.ToRemove {
usernames = append(usernames, fmt.Sprintf("@%s", x))
}
if ua.AssignmentType == ReviewerAssignment {
actions = append(actions, fmt.Sprintf("removed review request for %q.", strings.Join(usernames, " ")))
} else {
actions = append(actions, fmt.Sprintf("unassigned %q", strings.Join(usernames, " ")))
}
}
if len(ua.ToAdd) != 0 {
users, err := api.UsersByNames(apiClient, ua.ToAdd)
if err != nil {
return nil, nil, err
}
// Work-around GitLab (the company's own instance, not all instances have this) bug
// which causes a 500 Internal Error if duplicate `IDs` are used. Filter out any
// IDs that is already present
for i := range users {
if !utils.PresentInIntSlice(assignedIDs, users[i].ID) {
assignedIDs = append(assignedIDs, users[i].ID)
}
}
// Reset the usernames array because it might have been used by `unassignedUsers`
usernames = []string{}
for _, x := range ua.ToAdd {
usernames = append(usernames, fmt.Sprintf("@%s", x))
}
if ua.AssignmentType == ReviewerAssignment {
actions = append(actions, fmt.Sprintf("requested review from %q.", strings.Join(usernames, " ")))
} else {
actions = append(actions, fmt.Sprintf("assigned %q", strings.Join(usernames, " ")))
}
}
// That means that all assignees were removed but we can't pass an empty Slice of Ints so
// pass the documented value of 0
if len(assignedIDs) == 0 {
assignedIDs = []int{0}
}
return &assignedIDs, actions, nil
}
func ConfirmTransfer() error {
const (
performTransferLabel = "Confirm repository transfer"
abortTransferLabel = "Abort repository transfer"
)
options := []string{abortTransferLabel, performTransferLabel}
var confirmTransfer string
err := prompt.Select(&confirmTransfer, "confirmation", "Continue with the repository transfer?", options)
if err != nil {
return fmt.Errorf("could not prompt: %w", err)
}
switch confirmTransfer {
case performTransferLabel:
return nil
case abortTransferLabel:
return fmt.Errorf("user aborted operation")
default:
return fmt.Errorf("invalid value: %s", confirmTransfer)
}
}
|