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
|
package main
import (
"context"
"encoding/json"
"errors"
"fmt"
"sort"
"strings"
"time"
buildahcli "github.com/containers/buildah/pkg/cli"
"github.com/containers/buildah/pkg/parse"
"github.com/containers/common/libimage"
"github.com/containers/common/pkg/formats"
"github.com/docker/go-units"
"github.com/spf13/cobra"
)
const none = "<none>"
type jsonImage struct {
ID string `json:"id"`
Names []string `json:"names"`
Digest string `json:"digest"`
CreatedAt string `json:"createdat"`
Size string `json:"size"`
Created int64 `json:"created"`
CreatedAtRaw time.Time `json:"createdatraw"`
ReadOnly bool `json:"readonly"`
History []string `json:"history"`
}
type imageOutputParams struct {
Tag string
ID string
Name string
Digest string
Created int64
CreatedAt string
Size string
CreatedAtRaw time.Time
ReadOnly bool
History string
}
type imageOptions struct {
all bool
digests bool
format string
json bool
noHeading bool
truncate bool
quiet bool
readOnly bool
history bool
}
type imageResults struct {
imageOptions
filter []string
}
var imagesHeader = map[string]string{
"Name": "REPOSITORY",
"Tag": "TAG",
"ID": "IMAGE ID",
"CreatedAt": "CREATED",
"Size": "SIZE",
"ReadOnly": "R/O",
"History": "HISTORY",
}
func init() {
var (
opts imageResults
imagesDescription = "\n Lists locally stored images."
)
imagesCommand := &cobra.Command{
Use: "images",
Short: "List images in local storage",
Long: imagesDescription,
RunE: func(cmd *cobra.Command, args []string) error {
return imagesCmd(cmd, args, &opts)
},
Example: `buildah images --all
buildah images [imageName]
buildah images --format '{{.ID}} {{.Name}} {{.Size}} {{.CreatedAtRaw}}'`,
}
imagesCommand.SetUsageTemplate(UsageTemplate())
flags := imagesCommand.Flags()
flags.SetInterspersed(false)
flags.BoolVarP(&opts.all, "all", "a", false, "show all images, including intermediate images from a build")
flags.BoolVar(&opts.digests, "digests", false, "show digests")
flags.StringSliceVarP(&opts.filter, "filter", "f", []string{}, "filter output based on conditions provided")
flags.StringVar(&opts.format, "format", "", "pretty-print images using a Go template")
flags.BoolVar(&opts.json, "json", false, "output in JSON format")
flags.BoolVarP(&opts.noHeading, "noheading", "n", false, "do not print column headings")
// TODO needs alias here -- to `notruncate`
flags.BoolVar(&opts.truncate, "no-trunc", false, "do not truncate output")
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "display only image IDs")
flags.BoolVarP(&opts.history, "history", "", false, "display the image name history")
rootCmd.AddCommand(imagesCommand)
}
func imagesCmd(c *cobra.Command, args []string, iopts *imageResults) error {
if len(args) > 0 {
if iopts.all {
return errors.New("when using the --all switch, you may not pass any images names or IDs")
}
if err := buildahcli.VerifyFlagsArgsOrder(args); err != nil {
return err
}
if len(args) > 1 {
return errors.New("'buildah images' requires at most 1 argument")
}
}
store, err := getStore(c)
if err != nil {
return err
}
systemContext, err := parse.SystemContextFromOptions(c)
if err != nil {
return fmt.Errorf("building system context: %w", err)
}
runtime, err := libimage.RuntimeFromStore(store, &libimage.RuntimeOptions{SystemContext: systemContext})
if err != nil {
return err
}
ctx := context.Background()
options := &libimage.ListImagesOptions{}
if len(iopts.filter) > 0 {
options.Filters = iopts.filter
}
if !iopts.all {
options.Filters = append(options.Filters, "intermediate=false")
}
images, err := runtime.ListImages(ctx, options)
if err != nil {
return err
}
if len(args) > 0 {
imagesMatchName, err := runtime.ListImagesByNames(args)
if err != nil {
return err
}
imagesIDs := map[string]struct{}{}
for _, image := range imagesMatchName {
imagesIDs[image.ID()] = struct{}{}
}
var imagesMatchNameAndFilter []*libimage.Image
for _, image := range images {
if _, ok := imagesIDs[image.ID()]; ok {
imagesMatchNameAndFilter = append(imagesMatchNameAndFilter, image)
}
}
images = imagesMatchNameAndFilter
}
if iopts.quiet && iopts.format != "" {
return errors.New("quiet and format are mutually exclusive")
}
opts := imageOptions{
all: iopts.all,
digests: iopts.digests,
format: iopts.format,
json: iopts.json,
noHeading: iopts.noHeading,
truncate: !iopts.truncate,
quiet: iopts.quiet,
history: iopts.history,
}
if opts.json {
return formatImagesJSON(images, opts)
}
return formatImages(images, opts)
}
func outputHeader(opts imageOptions) string {
if opts.format != "" {
return strings.ReplaceAll(opts.format, `\t`, "\t")
}
if opts.quiet {
return formats.IDString
}
format := "table {{.Name}}\t{{.Tag}}\t"
if opts.noHeading {
format = "{{.Name}}\t{{.Tag}}\t"
}
if opts.digests {
format += "{{.Digest}}\t"
}
format += "{{.ID}}\t{{.CreatedAt}}\t{{.Size}}"
if opts.readOnly {
format += "\t{{.ReadOnly}}"
}
if opts.history {
format += "\t{{.History}}"
}
return format
}
func formatImagesJSON(images []*libimage.Image, opts imageOptions) error {
jsonImages := []jsonImage{}
for _, image := range images {
// Copy the base data over to the output param.
size, err := image.Size()
if err != nil {
return err
}
created := image.Created()
jsonImages = append(jsonImages,
jsonImage{
CreatedAtRaw: created,
Created: created.Unix(),
CreatedAt: units.HumanDuration(time.Since(created)) + " ago",
Digest: image.Digest().String(),
ID: truncateID(image.ID(), opts.truncate),
Names: image.Names(),
ReadOnly: image.IsReadOnly(),
Size: formattedSize(size),
})
}
data, err := json.MarshalIndent(jsonImages, "", " ")
if err != nil {
return err
}
fmt.Printf("%s\n", data)
return nil
}
type imagesSorted []imageOutputParams
func (a imagesSorted) Less(i, j int) bool {
return a[i].CreatedAtRaw.After(a[j].CreatedAtRaw)
}
func (a imagesSorted) Len() int {
return len(a)
}
func (a imagesSorted) Swap(i, j int) {
a[i], a[j] = a[j], a[i]
}
func formatImages(images []*libimage.Image, opts imageOptions) error {
var outputData imagesSorted
for _, image := range images {
var outputParam imageOutputParams
size, err := image.Size()
if err != nil {
return err
}
created := image.Created()
outputParam.CreatedAtRaw = created
outputParam.Created = created.Unix()
outputParam.CreatedAt = units.HumanDuration(time.Since(created)) + " ago"
outputParam.Digest = image.Digest().String()
outputParam.ID = truncateID(image.ID(), opts.truncate)
outputParam.Size = formattedSize(size)
outputParam.ReadOnly = image.IsReadOnly()
repoTags, err := image.NamedRepoTags()
if err != nil {
return err
}
nameTagPairs, err := libimage.ToNameTagPairs(repoTags)
if err != nil {
return err
}
for _, pair := range nameTagPairs {
newParam := outputParam
newParam.Name = pair.Name
newParam.Tag = pair.Tag
newParam.History = formatHistory(image.NamesHistory(), pair.Name, pair.Tag)
outputData = append(outputData, newParam)
// `images -q` should a given ID only once.
if opts.quiet {
break
}
}
}
sort.Sort(outputData)
out := formats.StdoutTemplateArray{Output: imagesToGeneric(outputData), Template: outputHeader(opts), Fields: imagesHeader}
return formats.Writer(out).Out()
}
func formatHistory(history []string, name, tag string) string {
if len(history) == 0 {
return none
}
// Skip the first history entry if already existing as name
if fmt.Sprintf("%s:%s", name, tag) == history[0] {
if len(history) == 1 {
return none
}
return strings.Join(history[1:], ", ")
}
return strings.Join(history, ", ")
}
func truncateID(id string, truncate bool) string {
if !truncate {
return "sha256:" + id
}
idTruncLength := 12
if len(id) > idTruncLength {
return id[:idTruncLength]
}
return id
}
func imagesToGeneric(templParams []imageOutputParams) (genericParams []any) {
if len(templParams) > 0 {
for _, v := range templParams {
genericParams = append(genericParams, any(v))
}
}
return genericParams
}
func formattedSize(size int64) string {
suffixes := [5]string{"B", "KB", "MB", "GB", "TB"}
count := 0
formattedSize := float64(size)
for formattedSize >= 1000 && count < 4 {
formattedSize /= 1000
count++
}
return fmt.Sprintf("%.3g %s", formattedSize, suffixes[count])
}
func matchesID(imageID, argID string) bool {
return strings.HasPrefix(imageID, argID)
}
func matchesReference(name, argName string) bool {
if argName == "" {
return true
}
splitName := strings.Split(name, ":")
// If the arg contains a tag, we handle it differently than if it does not
if strings.Contains(argName, ":") {
splitArg := strings.Split(argName, ":")
return strings.HasSuffix(splitName[0], splitArg[0]) && (splitName[1] == splitArg[1])
}
return strings.HasSuffix(splitName[0], argName)
}
|