GitLabgitlab-org

cli

main
ply8 git calls235 ms99 KiB5 cachedprotocol v2
183 lines4.9 KiBRaw
1package remove
3import (
4 "context"
5 "fmt"
6 "strconv"
8 "github.com/MakeNowJust/heredoc/v2"
9 "github.com/spf13/cobra"
11 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
13 "gitlab.com/gitlab-org/cli/internal/cmdutils"
14 "gitlab.com/gitlab-org/cli/internal/commands/securefile/helpers"
15 "gitlab.com/gitlab-org/cli/internal/glrepo"
16 "gitlab.com/gitlab-org/cli/internal/iostreams"
17 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
20type options struct {
21 forceDelete bool
22 fileID int64
23 fileName string
25 io *iostreams.IOStreams
26 gitlabClient func() (*gitlab.Client, error)
27 baseRepo func() (glrepo.Interface, error)
30func NewCmdRemove(f cmdutils.Factory) *cobra.Command {
31 opts := &options{
32 io: f.IO(),
33 gitlabClient: f.GitLabClient,
34 baseRepo: f.BaseRepo,
35 }
36 securefileRemoveCmd := &cobra.Command{
37 Use: "remove [<id> | --id <id> | --name <name>] [flags]",
38 Short: `Remove a secure file from a project.`,
39 Long: heredoc.Docf(`
40 Remove a secure file from a project, identified by its numeric ID.
41 The command asks for confirmation before deleting; use %[1]s-y%[1]s to skip
42 the prompt in scripts.
44 By default, the file is removed from the current project. Use %[1]s--repo%[1]s
45 to target another project.
46 `, "`"),
47 Aliases: []string{"rm", "delete"},
48 Args: cobra.MaximumNArgs(1),
49 Example: heredoc.Doc(`
50 # Remove a secure file by ID
51 glab securefile remove 1
52 glab securefile remove --id 1
54 # Remove a secure file by name
55 glab securefile remove --name example.txt
57 # Skip the confirmation prompt
58 glab securefile remove 1 -y
59 glab securefile remove --name example.txt -y
61 # Use the 'rm' alias
62 glab securefile rm 1
64 # Use the 'delete' alias
65 glab securefile delete --name example.txt
66 `),
67 Annotations: map[string]string{
68 mcpannotations.Destructive: "true",
69 },
70 RunE: func(cmd *cobra.Command, args []string) error {
71 if err := opts.complete(cmd, args); err != nil {
72 return err
73 }
75 if err := opts.validate(); err != nil {
76 return err
77 }
79 return opts.run(cmd.Context())
80 },
81 }
83 securefileRemoveCmd.Flags().BoolVarP(&opts.forceDelete, "yes", "y", false, "Skip the confirmation prompt.")
84 securefileRemoveCmd.Flags().Int64("id", 0, "ID of the secure file to remove.")
85 securefileRemoveCmd.Flags().String("name", "", "Name of the secure file to remove.")
87 securefileRemoveCmd.MarkFlagsMutuallyExclusive("id", "name")
89 return securefileRemoveCmd
92func (o *options) complete(cmd *cobra.Command, args []string) error {
93 // A positional ID and the --id/--name flags select the file in conflicting
94 // ways. Rejecting the combination avoids silently ignoring the argument and
95 // removing a different file than the one named on the command line.
96 if len(args) > 0 && (cmd.Flags().Changed("id") || cmd.Flags().Changed("name")) {
97 return &cmdutils.FlagError{
98 Err: fmt.Errorf("the secure file ID argument %q cannot be combined with --id or --name", args[0]),
99 }
100 }
102 name, err := cmd.Flags().GetString("name")
103 if err != nil {
104 return fmt.Errorf("unable to get name flag: %w", err)
105 }
106 if name != "" {
107 o.fileName = name
108 return nil
109 }
111 if cmd.Flags().Changed("id") {
112 o.fileID, err = cmd.Flags().GetInt64("id")
113 if err != nil {
114 return fmt.Errorf("unable to get id flag: %w", err)
115 }
116 } else {
117 if len(args) == 0 {
118 return &cmdutils.FlagError{Err: fmt.Errorf("provide a secure file ID argument, or the --id or --name flag")}
119 }
120 o.fileID, err = strconv.ParseInt(args[0], 10, 64)
121 if err != nil {
122 return fmt.Errorf("secure file ID must be an integer: %s", args[0])
123 }
124 }
126 return nil
129func (o *options) validate() error {
130 if !o.forceDelete && !o.io.PromptEnabled() {
131 return &cmdutils.FlagError{Err: fmt.Errorf("--yes or -y flag is required when not running interactively")}
132 }
134 return nil
137func (o *options) run(ctx context.Context) error {
138 client, err := o.gitlabClient()
139 if err != nil {
140 return err
141 }
143 repo, err := o.baseRepo()
144 if err != nil {
145 return err
146 }
148 if o.fileName != "" {
149 secureFile, err := helpers.GetSecureFileByName(client, o.fileName, repo.FullName())
150 if err != nil {
151 return err
152 }
154 o.fileID = secureFile.ID
155 }
157 if !o.forceDelete && o.io.PromptEnabled() {
158 o.io.LogInfof("This action will permanently delete secure file %d immediately.\n\n", o.fileID)
159 err = o.io.Confirm(ctx, &o.forceDelete, fmt.Sprintf("Are you ABSOLUTELY SURE you wish to delete this secure file %d?", o.fileID))
160 if err != nil {
161 return cmdutils.WrapError(err, "could not prompt")
162 }
163 }
165 if !o.forceDelete {
166 return cmdutils.CancelError()
167 }
169 color := o.io.Color()
170 o.io.LogInfof("%s Deleting secure file %s=%s %s=%d\n",
171 color.ProgressIcon(),
172 color.Blue("repo"), repo.FullName(),
173 color.Blue("fileID"), o.fileID)
175 _, err = client.SecureFiles.RemoveSecureFile(repo.FullName(), o.fileID)
176 if err != nil {
177 return fmt.Errorf("error removing secure file: %w", err)
178 }
180 o.io.LogInfof(color.Bold("%s Secure file %d deleted.\n"), color.RedCheck(), o.fileID)
182 return nil
Diagnostics8 git calls · 235 ms
CallStatusSizeTime0235 ms
discover200185 B4 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 · hit3 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=3
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=3
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:0200353 B · hit3 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=353
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=d9f8b91b7f75f6920fea2e149ed3fba5f61766da
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=353
git.pkt.payload.max=326
git.sideband.band1.bytes=326
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=326
git.pack.trailer=353875a8d3dc1310585685b9eadd95754bcf8d98
Open pack map
fetchtree:0200138 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=220
git.response.bytes=138
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=366709900042748db0b3ac901bbd33b51bebb15e
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=138
git.pkt.payload.max=111
git.sideband.band1.bytes=111
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=111
git.pack.trailer=5121df88ae8e725ec19cea2fd292aa5a6f251113
Open pack map
fetch2001.9 KiB220 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1928
git.response.cache=MISS
git.response.duration_ms=220
git.fetch.wants=5253f320976ad7121fea72122fc78488c5d03f02
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=1928
git.pkt.payload.max=1901
git.sideband.band1.bytes=1901
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
a5e282f8bd066483
Request
50de70f2…
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