Add label to images (#2814)

* feat: add label flag toflyctl

* feat: Add labels to image

* fix: Update description

* wip: brute force test

* feat: extract gh values

* fix: Move env look up to env package

* Show labels in `image show`

* Properly test for null json value

* Add a test

---------

Co-authored-by: William Batista <[email protected]>

Author: Divya

internal/build/imgsrc/dockerfile_builder.go

@@ -290,6 +290,7 @@ func runClassicBuild(ctx context.Context, streams *iostreams.IOStreams, docker *
 		Dockerfile:  dockerfilePath,
 		Target:      opts.Target,
 		NoCache:     opts.NoCache,
+		Labels:      opts.Label,
 	}
 
 	resp, err := docker.ImageBuild(ctx, r, options)
@@ -326,6 +327,10 @@ func solveOptFromImageOptions(opts ImageOptions, dockerfilePath string, buildArg
 		attrs["no-cache"] = ""
 	}
 
+	for k, v := range opts.Label {
+		attrs["label:"+k] = v
+	}
+
 	for k, v := range buildArgs {
 		if v == nil {
 			continue

internal/build/imgsrc/resolver.go

@@ -43,6 +43,7 @@ type ImageOptions struct {
 	BuiltInSettings map[string]interface{}
 	Builder         string
 	Buildpacks      []string
+	Label           map[string]string
 }
 
 type RefOptions struct {
@@ -55,9 +56,10 @@ type RefOptions struct {
 }
 
 type DeploymentImage struct {
-	ID   string
-	Tag  string
-	Size int64
+	ID     string
+	Tag    string
+	Size   int64
+	Labels map[string]string
 }
 
 type Resolver struct {

internal/command/deploy/deploy.go

@@ -127,6 +127,10 @@ var CommonFlags = flag.Set{
 		Name:        "only-regions",
 		Description: "Deploy to machines only in these regions. Multiple regions can be specified with comma separated values or by providing the flag multiple times. --only-regions iad,sea --only-regions syd will deploy to all three iad, sea, and syd regions. Applied before --exclude-regions. V2 machines platform only.",
 	},
+	flag.StringArray{
+		Name:        "label",
+		Description: "Add custom metadata to an image via docker labels",
+	},
 	flag.VMSizeFlags,
 }
 

internal/command/deploy/deploy_build.go

@@ -108,6 +108,19 @@ func determineImage(ctx context.Context, appConfig *appconfig.Config) (img *imgs
 		opts.BuildSecrets = cliBuildSecrets
 	}
 
+	arrLabels := flag.GetStringArray(ctx, "label")
+	labels, err := cmdutil.ParseKVStringsToMap(arrLabels)
+	if err != nil {
+		return
+	}
+	if env.IS_GH_ACTION() {
+		labels["GH_SHA"] = env.GitCommitSHA()
+		labels["GH_EVENT_NAME"] = env.GitActionEventName()
+	}
+	if labels != nil {
+		opts.Label = labels
+	}
+
 	var buildArgs map[string]string
 	if buildArgs, err = mergeBuildArgs(ctx, build.Args); err != nil {
 		return

internal/command/image/show.go

@@ -2,6 +2,7 @@ package image
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"strings"
 
@@ -167,13 +168,30 @@ func showMachineImage(ctx context.Context, app *api.AppCompact) error {
 			version = machine.ImageVersion()
 		}
 
+		var labelsString string
+
+		if cfg.JSONOutput {
+			json, err := json.Marshal(machine.ImageRef.Labels)
+			if err != nil {
+				return err
+			}
+			if string(json) != "null" {
+				labelsString = string(json)
+			}
+		} else {
+			for key, val := range machine.ImageRef.Labels {
+				labelsString += fmt.Sprintf("%s=%s", key, val)
+			}
+		}
+
 		obj := map[string]string{
 			"MachineID":  machine.ID,
 			"Registry":   machine.ImageRef.Registry,
 			"Repository": machine.ImageRef.Repository,
 			"Tag":        machine.ImageRef.Tag,
 			"Version":    version,
 			"Digest":     machine.ImageRef.Digest,
+			"Labels":     labelsString,
 		}
 
 		rows := [][]string{
@@ -183,6 +201,7 @@ func showMachineImage(ctx context.Context, app *api.AppCompact) error {
 				machine.ImageRef.Tag,
 				version,
 				machine.ImageRef.Digest,
+				labelsString,
 			},
 		}
 
@@ -196,6 +215,7 @@ func showMachineImage(ctx context.Context, app *api.AppCompact) error {
 			"Tag",
 			"Version",
 			"Digest",
+			"Labels",
 		)
 
 	}
@@ -265,13 +285,30 @@ func showMachineImage(ctx context.Context, app *api.AppCompact) error {
 			version = machine.ImageVersion()
 		}
 
+		var labelsString string
+
+		if cfg.JSONOutput {
+			json, err := json.Marshal(image.Labels)
+			if err != nil {
+				return err
+			}
+			if string(json) != "null" {
+				labelsString = string(json)
+			}
+		} else {
+			for key, val := range image.Labels {
+				labelsString += fmt.Sprintf("%s=%s", key, val)
+			}
+		}
+
 		objs = append(objs, map[string]string{
 			"MachineID":  machine.ID,
 			"Registry":   image.Registry,
 			"Repository": image.Repository,
 			"Tag":        image.Tag,
 			"Version":    version,
 			"Digest":     image.Digest,
+			"Labels":     labelsString,
 		})
 
 		rows = append(rows, []string{
@@ -281,6 +318,7 @@ func showMachineImage(ctx context.Context, app *api.AppCompact) error {
 			image.Tag,
 			version,
 			image.Digest,
+			labelsString,
 		})
 	}
 
@@ -298,5 +336,6 @@ func showMachineImage(ctx context.Context, app *api.AppCompact) error {
 		"Tag",
 		"Version",
 		"Digest",
+		"Labels",
 	)
 }

internal/env/env.go

@@ -54,6 +54,20 @@ func IsSet(keys ...string) bool {
 	return false
 }
 
+func IS_GH_ACTION() bool {
+	return IsTruthy("GH_ACTIONS")
+}
+
+func GitCommitSHA() string {
+	sha := os.Getenv("GITHUB_SHA")
+	return sha
+}
+
+func GitActionEventName() string {
+	eventName := os.Getenv("GITHUB_EVENT_NAME")
+	return eventName
+}
+
 // IsCI reports whether the environment is a CI one.
 //
 // Based on https://github.com/watson/ci-info/blob/c4f1553f254c78babef5c200c48569ede313b718/index.js

test/preflight/apps_v2_integration_test.go

@@ -561,3 +561,29 @@ func TestErrOutput(t *testing.T) {
 	res = f.FlyAllowExitFailure("machine update -a %s %s -y --wait-timeout 1 --vm-size performance-1x", appName, firstMachine.ID)
 	require.Contains(f, res.StdErrString(), "timeout reached waiting for machine's state to change")
 }
+
+func TestImageLabel(t *testing.T) {
+	f := testlib.NewTestEnvFromEnv(t)
+	appName := f.CreateRandomAppName()
+
+	dockerfileContent := `FROM nginx:1.23.3
+
+ENV BUILT_BY_DOCKERFILE=true
+`
+	dockerfilePath := filepath.Join(f.WorkDir(), "Dockerfile")
+	err := os.WriteFile(dockerfilePath, []byte(dockerfileContent), 0644)
+	if err != nil {
+		f.Fatalf("failed to write dockerfile at %s error: %v", dockerfilePath, err)
+	}
+
+	f.Fly("launch --org %s --name %s --region %s --now --internal-port 80 --auto-confirm", f.OrgSlug(), appName, f.PrimaryRegion())
+	f.Fly("deploy --label Z=ZZZ -a %s", appName)
+	res := f.Fly("image show -a %s --json", appName)
+
+	var machineImages []map[string]string
+	res.StdOutJSON(&machineImages)
+
+	for _, image := range machineImages {
+		require.Contains(f, image["Labels"], `"Z":"ZZZ"`)
+	}
+}