GitLabgitlab-org

cli

main
ply8 git calls206 ms99 KiB5 cachedprotocol v2
122 lines4.0 KiBRaw
1package cisummary
3import (
4 "os"
6 "github.com/MakeNowJust/heredoc/v2"
7 "github.com/spf13/cobra"
9 "gitlab.com/gitlab-org/cli/internal/cmdutils"
10 "gitlab.com/gitlab-org/cli/internal/dependencyfirewall/cilog"
11 "gitlab.com/gitlab-org/cli/internal/dependencyfirewall/summary"
12 "gitlab.com/gitlab-org/cli/internal/dependencyfirewall/verdict"
13 "gitlab.com/gitlab-org/cli/internal/iostreams"
14 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
15 "gitlab.com/gitlab-org/cli/internal/text"
18type options struct {
19 io *iostreams.IOStreams
20 baseDirs []string
23func NewCmd(f cmdutils.Factory) *cobra.Command {
24 opts := &options{io: f.IO()}
26 cmd := &cobra.Command{
27 Use: "ci-summary",
28 Short: "Summarize Dependency Firewall activity from the CI log. (BETA)",
29 Long: heredoc.Docf(`
30 Read %[1]s.gitlab/df/ci-log.json%[1]s and print blocked and flagged packages
31 recorded during a %[1]sglab dependency-firewall%[1]s run.
33 The log is read from the current working directory and, when set, from the
34 directory in %[1]sGLAB_DF_CI_LOG_DIR%[1]s. Run this command from the same directory
35 as the %[1]sglab dependency-firewall%[1]s run that wrote the log, otherwise no
36 activity is reported. The job-level proxy sets %[1]sGLAB_DF_CI_LOG_DIR%[1]s, so jobs
37 that use it can run this command from any directory.
39 To fail a CI/CD job when any package was blocked, run this command as the
40 last command in %[1]sscript%[1]s. This catches a block even when a package
41 manager continues after a refused download. In %[1]safter_script%[1]s, the
42 command prints the report but can't fail the job, because GitLab ignores
43 %[1]safter_script%[1]s exit codes.
45 %[1]s%[1]s%[1]syaml
46 install:
47 variables:
48 GLAB_ENABLE_CI_AUTOLOGIN: "true"
49 script:
50 - glab dependency-firewall npm ci
51 - glab dependency-firewall pip install -r requirements.txt
52 - glab dependency-firewall ci-summary
53 %[1]s%[1]s%[1]s
55 Entries accumulate across runs, and the command never clears them. A block
56 from an earlier run keeps the command exiting with %[1]s3%[1]s until you delete
57 %[1]s.gitlab/df/ci-log.json%[1]s.
59 | Exit code | Meaning |
60 |-----------|---------|
61 | %[1]s0%[1]s | No blocked entries in the log (allow-only or warnings). |
62 | %[1]s1%[1]s | The log could not be read. |
63 | %[1]s3%[1]s | At least one entry in the log is blocked. |
64 `, "`") + text.BetaString,
65 Example: heredoc.Doc(`
66 # Show blocked and flagged packages from the last firewall run
67 glab dependency-firewall ci-summary
68 `),
69 Args: cobra.NoArgs,
70 ValidArgsFunction: cobra.NoFileCompletions,
71 Annotations: map[string]string{
72 mcpannotations.Safe: "true",
73 "help:environment": cilog.DirEnv + ": a directory whose .gitlab/df/ci-log.json is read in addition to the working directory's. The job-level proxy sets it.\n",
74 },
75 RunE: func(cmd *cobra.Command, args []string) error {
76 if err := opts.complete(); err != nil {
77 return err
78 }
79 return opts.run()
80 },
81 }
83 return cmd
86func (o *options) complete() error {
87 // baseDirs anchor the .gitlab/df/ci-log.json lookup. A firewall run writes its
88 // log relative to the directory the package manager ran in, so read it back
89 // relative to the current working directory rather than the repository root.
90 // The job-level proxy writes under the directory in cilog.DirEnv instead.
91 wd, err := os.Getwd()
92 if err != nil {
93 return err
94 }
95 o.baseDirs = []string{wd}
96 if dir := os.Getenv(cilog.DirEnv); dir != "" && dir != wd {
97 o.baseDirs = append(o.baseDirs, dir)
98 }
99 return nil
102func (o *options) run() error {
103 log := cilog.New("")
104 for _, dir := range o.baseDirs {
105 l, err := cilog.Load(dir)
106 if err != nil {
107 return cmdutils.WrapError(err, "failed to read Dependency Firewall CI log.")
108 }
109 for _, e := range l.Entries {
110 log.Append(e)
111 }
112 }
113 summary.Render(o.io, log.Entries)
115 for _, e := range log.Entries {
116 if e.Verdict == verdict.Blocked {
117 return cmdutils.WrapErrorWithCode(cmdutils.SilentError, verdict.BlockedExitCode,
118 "Dependency Firewall blocked one or more packages during this run.")
119 }
120 }
121 return nil
Diagnostics8 git calls · 206 ms
CallStatusSizeTime0206 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit5 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=5
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchtree:02001.8 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=1
git.response.bytes=1857
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1857
git.pkt.payload.max=1830
git.sideband.band1.bytes=1830
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1830
git.pack.trailer=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200650 B · hit1 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=650
git.response.cache=HIT
git.response.duration_ms=1
git.fetch.filter=tree:0
git.fetch.wants=cdbc4acb219224e81172d025f80739e1e383a784
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=650
git.pkt.payload.max=623
git.sideband.band1.bytes=623
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=623
git.pack.trailer=aabedefb11d4348efc4e1168413c6ec52cbf90d2
Open pack map
fetchtree:0200141 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=196
git.response.bytes=141
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=ca74973fecd1e8a5ae6c0996577882c6576266bc
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=141
git.pkt.payload.max=114
git.sideband.band1.bytes=114
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=114
git.pack.trailer=00db4df9b29297bfc2b8077d2443240f11bded51
Open pack map
fetch2001.7 KiB196 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1732
git.response.cache=MISS
git.response.duration_ms=196
git.fetch.wants=3272823d7be3035f9246d507b835076b993cd0c7
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1732
git.pkt.payload.max=1705
git.sideband.band1.bytes=1705
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e3573fcdf52c38
Request
92805062…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format