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 566 567 568 569 570 571 572 573 574 575 576
|
package main
import (
"context"
"encoding/json"
"fmt"
"sort"
"strings"
"time"
buildahcli "github.com/containers/buildah/pkg/cli"
"github.com/containers/buildah/pkg/formats"
"github.com/containers/buildah/pkg/parse"
is "github.com/containers/image/v5/storage"
"github.com/containers/image/v5/types"
"github.com/containers/storage"
units "github.com/docker/go-units"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"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"`
CreatedAtRaw time.Time `json:"createdatraw"`
ReadOnly bool `json:"readonly"`
History []string `json:"history"`
}
type imageOutputParams struct {
Tag string
ID string
Name string
Digest string
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 filterParams struct {
dangling string
label string
beforeImage string
sinceImage string
beforeDate time.Time
sinceDate time.Time
referencePattern string
readOnly string
history string
}
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.StringVarP(&opts.filter, "filter", "f", "", "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 {
name := ""
if len(args) > 0 {
if iopts.all {
return errors.Errorf("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 {
name = args[0]
} else {
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 errors.Wrapf(err, "error building system context")
}
images, err := store.Images()
if err != nil {
return errors.Wrapf(err, "error reading images")
}
if iopts.quiet && iopts.format != "" {
return errors.Errorf("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,
}
ctx := getContext()
var params *filterParams
if iopts.filter != "" {
params, err = parseFilter(ctx, store, images, iopts.filter)
if err != nil {
return err
}
}
return outputImages(ctx, systemContext, store, images, params, name, opts)
}
func parseFilter(ctx context.Context, store storage.Store, images []storage.Image, filter string) (*filterParams, error) {
params := new(filterParams)
filterStrings := strings.Split(filter, ",")
for _, param := range filterStrings {
pair := strings.SplitN(param, "=", 2)
if len(pair) < 2 {
return nil, errors.Errorf("invalid filter: %q requires value", filter)
}
switch strings.TrimSpace(pair[0]) {
case "dangling":
if pair[1] == "true" || pair[1] == "false" {
params.dangling = pair[1]
} else {
return nil, errors.Errorf("invalid filter: '%s=[%s]'", pair[0], pair[1])
}
case "label":
params.label = pair[1]
case "before":
beforeDate, err := setFilterDate(ctx, store, images, pair[1])
if err != nil {
return nil, errors.Wrapf(err, "invalid filter: '%s=[%s]'", pair[0], pair[1])
}
params.beforeDate = beforeDate
params.beforeImage = pair[1]
case "since":
sinceDate, err := setFilterDate(ctx, store, images, pair[1])
if err != nil {
return nil, errors.Wrapf(err, "invalid filter: '%s=[%s]'", pair[0], pair[1])
}
params.sinceDate = sinceDate
params.sinceImage = pair[1]
case "reference":
params.referencePattern = pair[1]
case "readonly":
if pair[1] == "true" || pair[1] == "false" {
params.readOnly = pair[1]
} else {
return nil, errors.Errorf("invalid filter: '%s=[%s]'", pair[0], pair[1])
}
default:
return nil, errors.Errorf("invalid filter: '%s'", pair[0])
}
}
return params, nil
}
func setFilterDate(ctx context.Context, store storage.Store, images []storage.Image, imgName string) (time.Time, error) {
for _, image := range images {
for _, name := range image.Names {
if matchesReference(name, imgName) {
// Set the date to this image
ref, err := is.Transport.ParseStoreReference(store, image.ID)
if err != nil {
return time.Time{}, errors.Wrapf(err, "error parsing reference to image %q", image.ID)
}
img, err := ref.NewImage(ctx, nil)
if err != nil {
return time.Time{}, errors.Wrapf(err, "error reading image %q", image.ID)
}
defer img.Close()
inspect, err := img.Inspect(ctx)
if err != nil {
return time.Time{}, errors.Wrapf(err, "error inspecting image %q", image.ID)
}
date := *inspect.Created
return date, nil
}
}
}
return time.Time{}, errors.Errorf("could not locate image %q", imgName)
}
func outputHeader(opts imageOptions) string {
if opts.format != "" {
return strings.Replace(opts.format, `\t`, "\t", -1)
}
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
}
type imagesSorted []imageOutputParams
func outputImages(ctx context.Context, systemContext *types.SystemContext, store storage.Store, images []storage.Image, filters *filterParams, argName string, opts imageOptions) error {
found := false
var imagesParams imagesSorted
jsonImages := []jsonImage{}
for _, image := range images {
if image.ReadOnly {
opts.readOnly = true
}
createdTime := image.Created
inspectedTime, digest, size, _ := getDateAndDigestAndSize(ctx, systemContext, store, image)
if !inspectedTime.IsZero() {
if createdTime != inspectedTime {
logrus.Debugf("image record and configuration disagree on the image's creation time for %q, using the configuration creation time: %s", image.ID, inspectedTime)
createdTime = inspectedTime
}
}
createdTime = createdTime.Local()
// If "all" is false and this image doesn't have a name, check
// to see if the image is the parent of any other image. If it
// is, then it is an intermediate image, so don't list it if
// the --all flag is not set.
if !opts.all && len(image.Names) == 0 {
isParent, err := imageIsParent(ctx, systemContext, store, &image)
if err != nil {
logrus.Errorf("error checking if image is a parent %q: %v", image.ID, err)
}
if isParent {
continue
}
}
imageID := "sha256:" + image.ID
if opts.truncate {
imageID = shortID(image.ID)
}
outer:
for name, tags := range imageReposToMap(image.Names) {
for _, tag := range tags {
if !matchesReference(name+":"+tag, argName) {
continue
}
found = true
if !matchesFilter(ctx, store, image, name+":"+tag, filters) {
continue
}
if opts.json {
jsonImages = append(jsonImages,
jsonImage{ID: image.ID,
Names: image.Names,
Digest: digest,
CreatedAtRaw: createdTime,
CreatedAt: units.HumanDuration(time.Since((createdTime))) + " ago",
Size: formattedSize(size),
ReadOnly: image.ReadOnly,
History: image.NamesHistory,
})
// We only want to print each id once
break outer
}
params := imageOutputParams{
Tag: tag,
ID: imageID,
Name: name,
Digest: digest,
CreatedAtRaw: createdTime,
CreatedAt: units.HumanDuration(time.Since((createdTime))) + " ago",
Size: formattedSize(size),
ReadOnly: image.ReadOnly,
History: formatHistory(image.NamesHistory, name, tag),
}
imagesParams = append(imagesParams, params)
if opts.quiet {
// We only want to print each id once
break outer
}
}
}
}
if !found && argName != "" {
return errors.Errorf("No such image %s", argName)
}
if opts.json {
data, err := json.MarshalIndent(jsonImages, "", " ")
if err != nil {
return err
}
fmt.Printf("%s\n", data)
return nil
}
imagesParams = sortImagesOutput(imagesParams)
out := formats.StdoutTemplateArray{Output: imagesToGeneric(imagesParams), 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 shortID(id string) string {
idTruncLength := 12
if len(id) > idTruncLength {
return id[:idTruncLength]
}
return id
}
func sortImagesOutput(imagesOutput imagesSorted) imagesSorted {
sort.Sort(imagesOutput)
return imagesOutput
}
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 imagesToGeneric(templParams []imageOutputParams) (genericParams []interface{}) {
if len(templParams) > 0 {
for _, v := range templParams {
genericParams = append(genericParams, interface{}(v))
}
}
return genericParams
}
func matchesFilter(ctx context.Context, store storage.Store, image storage.Image, name string, params *filterParams) bool {
if params == nil {
return true
}
if params.dangling != "" && !matchesDangling(name, params.dangling) {
return false
}
if params.label != "" && !matchesLabel(ctx, store, image, params.label) {
return false
}
if params.beforeImage != "" && !matchesBeforeImage(image, params) {
return false
}
if params.sinceImage != "" && !matchesSinceImage(image, params) {
return false
}
if params.referencePattern != "" && !matchesReference(name, params.referencePattern) {
return false
}
if params.readOnly != "" && !matchesReadOnly(image, params.readOnly) {
return false
}
if params.history != "" && !matchesHistory(image, params.history) {
return false
}
return true
}
func matchesDangling(name string, dangling string) bool {
if dangling == "false" && !strings.Contains(name, none) {
return true
}
if dangling == "true" && strings.Contains(name, none) {
return true
}
return false
}
func matchesReadOnly(image storage.Image, readOnly string) bool {
if readOnly == "false" && !image.ReadOnly {
return true
}
if readOnly == "true" && image.ReadOnly {
return true
}
return false
}
func matchesHistory(image storage.Image, readOnly string) bool {
if readOnly == "false" && len(image.NamesHistory) == 0 {
return true
}
if readOnly == "true" && len(image.NamesHistory) > 0 {
return true
}
return false
}
func matchesLabel(ctx context.Context, store storage.Store, image storage.Image, label string) bool {
storeRef, err := is.Transport.ParseStoreReference(store, image.ID)
if err != nil {
return false
}
img, err := storeRef.NewImage(ctx, nil)
if err != nil {
return false
}
defer img.Close()
info, err := img.Inspect(ctx)
if err != nil {
return false
}
pair := strings.SplitN(label, "=", 2)
for key, value := range info.Labels {
if key == pair[0] {
if len(pair) == 2 {
if value == pair[1] {
return true
}
} else {
return false
}
}
}
return false
}
// Returns true if the image was created since the filter image. Returns
// false otherwise
func matchesBeforeImage(image storage.Image, params *filterParams) bool {
return image.Created.IsZero() || image.Created.Before(params.beforeDate)
}
// Returns true if the image was created since the filter image. Returns
// false otherwise
func matchesSinceImage(image storage.Image, params *filterParams) bool {
return image.Created.IsZero() || image.Created.After(params.sinceDate)
}
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)
}
/*
According to https://en.wikipedia.org/wiki/Binary_prefix
We should be return numbers based on 1000, rather then 1024
*/
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])
}
// reposToMap parses the specified repotags and returns a map with repositories
// as keys and the corresponding arrays of tags as values.
func imageReposToMap(repotags []string) map[string][]string {
// map format is repo -> tag
repos := make(map[string][]string)
for _, repo := range repotags {
var repository, tag string
if strings.Contains(repo, ":") {
li := strings.LastIndex(repo, ":")
repository = repo[0:li]
tag = repo[li+1:]
} else if len(repo) > 0 {
repository = repo
tag = none
} else {
logrus.Warnf("Found image with empty name")
}
repos[repository] = append(repos[repository], tag)
}
if len(repos) == 0 {
repos[none] = []string{none}
}
return repos
}
|