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
|
package ciutils
import (
"context"
"fmt"
"io"
"regexp"
"strconv"
"strings"
"sync"
"time"
"gitlab.com/gitlab-org/cli/commands/cmdutils"
"gitlab.com/gitlab-org/cli/internal/glrepo"
"gitlab.com/gitlab-org/cli/pkg/git"
"gitlab.com/gitlab-org/cli/pkg/iostreams"
"gitlab.com/gitlab-org/cli/pkg/prompt"
"gitlab.com/gitlab-org/cli/api"
"gitlab.com/gitlab-org/cli/pkg/tableprinter"
"gitlab.com/gitlab-org/cli/pkg/utils"
"github.com/AlecAivazis/survey/v2"
"github.com/AlecAivazis/survey/v2/terminal"
"github.com/pkg/errors"
gitlab "gitlab.com/gitlab-org/api/client-go"
)
var (
once sync.Once
offset int64
)
func makeHyperlink(s *iostreams.IOStreams, pipeline *gitlab.PipelineInfo) string {
return s.Hyperlink(fmt.Sprintf("%d", pipeline.ID), pipeline.WebURL)
}
func DisplaySchedules(i *iostreams.IOStreams, s []*gitlab.PipelineSchedule, projectID string) string {
if len(s) > 0 {
table := tableprinter.NewTablePrinter()
table.AddRow("ID", "Description", "Cron", "Owner", "Active")
for _, schedule := range s {
table.AddRow(schedule.ID, schedule.Description, schedule.Cron, schedule.Owner.Username, schedule.Active)
}
return table.Render()
}
// return empty string, since when there is no schedule, the title will already display it accordingly
return ""
}
func DisplayMultiplePipelines(s *iostreams.IOStreams, p []*gitlab.PipelineInfo, projectID string) string {
c := s.Color()
table := tableprinter.NewTablePrinter()
if len(p) > 0 {
for _, pipeline := range p {
duration := ""
if pipeline.CreatedAt != nil {
duration = c.Magenta("(" + utils.TimeToPrettyTimeAgo(*pipeline.CreatedAt) + ")")
}
var pipeState string
if pipeline.Status == "success" {
pipeState = c.Green(fmt.Sprintf("(%s) • #%s", pipeline.Status, makeHyperlink(s, pipeline)))
} else if pipeline.Status == "failed" {
pipeState = c.Red(fmt.Sprintf("(%s) • #%s", pipeline.Status, makeHyperlink(s, pipeline)))
} else {
pipeState = c.Gray(fmt.Sprintf("(%s) • #%s", pipeline.Status, makeHyperlink(s, pipeline)))
}
table.AddRow(pipeState, fmt.Sprintf("(#%d)", pipeline.IID), pipeline.Ref, duration)
}
return table.Render()
}
return "No Pipelines available on " + projectID
}
func RunTraceSha(ctx context.Context, apiClient *gitlab.Client, w io.Writer, pid interface{}, sha, name string) error {
job, err := api.PipelineJobWithSha(apiClient, pid, sha, name)
if err != nil || job == nil {
return errors.Wrap(err, "failed to find job")
}
return runTrace(ctx, apiClient, w, pid, job.ID)
}
func runTrace(ctx context.Context, apiClient *gitlab.Client, w io.Writer, pid interface{}, jobId int) error {
fmt.Fprintln(w, "Getting job trace...")
for range time.NewTicker(time.Second * 3).C {
if ctx.Err() == context.Canceled {
break
}
job, _, err := apiClient.Jobs.GetJob(pid, jobId)
if err != nil {
return errors.Wrap(err, "failed to find job")
}
switch job.Status {
case "pending":
fmt.Fprintf(w, "%s is pending... waiting for job to start.\n", job.Name)
continue
case "manual":
fmt.Fprintf(w, "Manual job %s not started, waiting for job to start.\n", job.Name)
continue
case "skipped":
fmt.Fprintf(w, "%s has been skipped.\n", job.Name)
}
once.Do(func() {
fmt.Fprintf(w, "Showing logs for %s job #%d.\n", job.Name, job.ID)
})
trace, _, err := apiClient.Jobs.GetTraceFile(pid, jobId)
if err != nil || trace == nil {
return errors.Wrap(err, "failed to find job")
}
_, _ = io.CopyN(io.Discard, trace, offset)
lenT, err := io.Copy(w, trace)
if err != nil {
return err
}
offset += lenT
if job.Status == "success" ||
job.Status == "failed" ||
job.Status == "cancelled" {
return nil
}
}
return nil
}
func GetJobId(inputs *JobInputs, opts *JobOptions) (int, error) {
// If the user hasn't supplied an argument, we display the jobs list interactively.
if inputs.JobName == "" {
return getJobIdInteractive(inputs, opts)
}
// If the user supplied a job ID, we can use it directly.
if jobID, err := strconv.Atoi(inputs.JobName); err == nil {
return jobID, nil
}
// Otherwise, we try to find the latest job ID based on the job name.
pipelineId, err := getPipelineId(inputs, opts)
if err != nil {
return 0, fmt.Errorf("get pipeline: %w", err)
}
jobs, _, err := opts.ApiClient.Jobs.ListPipelineJobs(opts.Repo.FullName(), pipelineId, nil)
if err != nil {
return 0, fmt.Errorf("list pipeline jobs: %w", err)
}
for _, job := range jobs {
if job.Name == inputs.JobName {
return job.ID, nil
}
}
return 0, fmt.Errorf("pipeline %d contains no jobs.", pipelineId)
}
func getPipelineId(inputs *JobInputs, opts *JobOptions) (int, error) {
if inputs.PipelineId != 0 {
return inputs.PipelineId, nil
}
branch, err := getBranch(inputs.Branch, opts)
if err != nil {
return 0, fmt.Errorf("get branch: %w", err)
}
pipeline, err := api.GetLastPipeline(opts.ApiClient, opts.Repo.FullName(), branch)
if err != nil {
return 0, fmt.Errorf("get last pipeline: %w", err)
}
return pipeline.ID, err
}
func GetDefaultBranch(f *cmdutils.Factory) string {
repo, err := f.BaseRepo()
if err != nil {
return "master"
}
remotes, err := f.Remotes()
if err != nil {
return "master"
}
repoRemote, err := remotes.FindByRepo(repo.RepoOwner(), repo.RepoName())
if err != nil {
return "master"
}
branch, _ := git.GetDefaultBranch(repoRemote.Name)
return branch
}
func getBranch(branch string, opts *JobOptions) (string, error) {
if branch != "" {
return branch, nil
}
branch, err := git.CurrentBranch()
if err != nil {
return "", err
}
return branch, nil
}
func getJobIdInteractive(inputs *JobInputs, opts *JobOptions) (int, error) {
pipelineId, err := getPipelineId(inputs, opts)
if err != nil {
return 0, err
}
fmt.Fprintf(opts.IO.StdOut, "Getting jobs for pipeline %d...\n\n", pipelineId)
jobs, err := api.GetPipelineJobs(opts.ApiClient, pipelineId, opts.Repo.FullName())
if err != nil {
return 0, err
}
var jobOptions []string
var selectedJob string
for _, job := range jobs {
if inputs.SelectionPredicate == nil || inputs.SelectionPredicate(job) {
jobOptions = append(jobOptions, fmt.Sprintf("%s (%d) - %s", job.Name, job.ID, job.Status))
}
}
messagePrompt := inputs.SelectionPrompt
if messagePrompt == "" {
messagePrompt = "Select pipeline job to trace:"
}
promptOpts := &survey.Select{
Message: messagePrompt,
Options: jobOptions,
}
if len(jobOptions) > 0 {
err = prompt.AskOne(promptOpts, &selectedJob)
if err != nil {
if errors.Is(err, terminal.InterruptErr) {
return 0, nil
}
return 0, err
}
}
if selectedJob != "" {
re := regexp.MustCompile(`(?s)\((.*)\)`)
m := re.FindAllStringSubmatch(selectedJob, -1)
return utils.StringToInt(m[0][1]), nil
} else if len(jobs) > 0 {
return 0, nil
}
pipeline, err := api.GetPipeline(opts.ApiClient, pipelineId, nil, opts.Repo.FullName())
if err != nil {
return 0, err
}
// use commit statuses to show external jobs
cs, err := api.GetCommitStatuses(opts.ApiClient, opts.Repo.FullName(), pipeline.SHA)
if err != nil {
return 0, nil
}
c := opts.IO.Color()
fmt.Fprint(opts.IO.StdOut, "Getting external jobs...\n")
for _, status := range cs {
var s string
switch status.Status {
case "success":
s = c.Green(status.Status)
case "error":
s = c.Red(status.Status)
default:
s = c.Gray(status.Status)
}
fmt.Fprintf(opts.IO.StdOut, "(%s) %s\nURL: %s\n\n", s, c.Bold(status.Name), c.Gray(status.TargetURL))
}
return 0, nil
}
type JobInputs struct {
JobName string
Branch string
PipelineId int
SelectionPrompt string
SelectionPredicate func(s *gitlab.Job) bool
}
type JobOptions struct {
ApiClient *gitlab.Client
Repo glrepo.Interface
IO *iostreams.IOStreams
}
func TraceJob(inputs *JobInputs, opts *JobOptions) error {
jobID, err := GetJobId(inputs, opts)
if err != nil {
fmt.Fprintln(opts.IO.StdErr, "invalid job ID:", inputs.JobName)
return err
}
if jobID == 0 {
return nil
}
fmt.Fprintln(opts.IO.StdOut)
return runTrace(context.Background(), opts.ApiClient, opts.IO.StdOut, opts.Repo.FullName(), jobID)
}
// IDsFromArgs parses list of IDs from space or comma-separated values
func IDsFromArgs(args []string) ([]int, error) {
var parsedValues []int
f := func(r rune) bool {
return r == ',' || r == ' '
}
processed := strings.FieldsFunc(strings.Join(args, " "), f)
for _, v := range processed {
id, err := strconv.Atoi(v)
if err != nil {
return nil, err
}
parsedValues = append(parsedValues, id)
}
return parsedValues, nil
}
|