Add support for artifact file (#7)

* Add support for artifact file

* Fix UT

* Fix get digest

* Add UT

* Fix digest error log

Author: rutvijmehta-harness

.drone.yml

@@ -12,7 +12,7 @@ platform:
 
 steps:
   - name: vet
-    image: golang:1.17
+    image: golang:1.20
     commands:
       - go vet ./...
     environment:
@@ -22,7 +22,7 @@ steps:
         path: /go
 
   - name: test
-    image: golang:1.17
+    image: golang:1.20
     commands:
       - go test -cover ./...
     environment:

app.go

@@ -3,6 +3,7 @@ package docker
 import (
 	"os"
 
+	"github.com/drone-plugins/drone-plugin-lib/drone"
 	"github.com/joho/godotenv"
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli"
@@ -300,6 +301,21 @@ func Run() {
 			Name:   "buildx-load",
 			EnvVar: "PLUGIN_BUILDX_LOAD",
 		},
+		cli.StringFlag{
+			Name:   "metadata-file",
+			Usage:  "Location of metadata file that will be generated by the plugin. This file will include information of docker images that are uploaded by the plugin which will be used to create the artifact file.",
+			EnvVar: "PLUGIN_METADATA_FILE",
+		},
+		cli.StringFlag{
+			Name:   "artifact-file",
+			Usage:  "Artifact file location that will be generated by the plugin. This file will include information of docker images that are uploaded by the plugin.",
+			EnvVar: "PLUGIN_ARTIFACT_FILE",
+		},
+		cli.StringFlag{
+			Name:   "registry-type",
+			Usage:  "registry type",
+			EnvVar: "PLUGIN_REGISTRY_TYPE",
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -308,6 +324,11 @@ func Run() {
 }
 
 func run(c *cli.Context) error {
+	registryType := drone.Docker
+	if c.String("registry-type") != "" {
+		registryType = drone.RegistryType(c.String("registry-type"))
+	}
+
 	plugin := Plugin{
 		Dryrun:  c.Bool("dry-run"),
 		Cleanup: c.BoolT("docker.purge"),
@@ -318,7 +339,9 @@ func run(c *cli.Context) error {
 			Email:    c.String("docker.email"),
 			Config:   c.String("docker.config"),
 		},
-		CardPath: c.String("drone-card-path"),
+		CardPath:     c.String("drone-card-path"),
+		MetadataFile: c.String("metadata-file"),
+		ArtifactFile: c.String("artifact-file"),
 		Build: Build{
 			Remote:      c.String("remote.url"),
 			Name:        c.String("commit.sha"),
@@ -361,6 +384,7 @@ func run(c *cli.Context) error {
 			DNS:           c.StringSlice("daemon.dns"),
 			DNSSearch:     c.StringSlice("daemon.dns-search"),
 			MTU:           c.String("daemon.mtu"),
+			RegistryType:  registryType,
 		},
 		Builder: Builder{
 			Name:       c.String("builder-name"),

docker.go

@@ -1,29 +1,33 @@
 package docker
 
 import (
+	"encoding/json"
 	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strings"
 	"time"
+
+	"github.com/drone-plugins/drone-plugin-lib/drone"
 )
 
 type (
 	// Daemon defines Docker daemon parameters.
 	Daemon struct {
-		Registry      string   // Docker registry
-		Mirror        string   // Docker registry mirror
-		Insecure      bool     // Docker daemon enable insecure registries
-		StorageDriver string   // Docker daemon storage driver
-		StoragePath   string   // Docker daemon storage path
-		Disabled      bool     // DOcker daemon is disabled (already running)
-		Debug         bool     // Docker daemon started in debug mode
-		Bip           string   // Docker daemon network bridge IP address
-		DNS           []string // Docker daemon dns server
-		DNSSearch     []string // Docker daemon dns search domain
-		MTU           string   // Docker daemon mtu setting
-		IPv6          bool     // Docker daemon IPv6 networking
+		Registry      string             // Docker registry
+		Mirror        string             // Docker registry mirror
+		Insecure      bool               // Docker daemon enable insecure registries
+		StorageDriver string             // Docker daemon storage driver
+		StoragePath   string             // Docker daemon storage path
+		Disabled      bool               // DOcker daemon is disabled (already running)
+		Debug         bool               // Docker daemon started in debug mode
+		Bip           string             // Docker daemon network bridge IP address
+		DNS           []string           // Docker daemon dns server
+		DNSSearch     []string           // Docker daemon dns search domain
+		MTU           string             // Docker daemon mtu setting
+		IPv6          bool               // Docker daemon IPv6 networking
+		RegistryType  drone.RegistryType // Docker registry type
 	}
 
 	Builder struct {
@@ -76,13 +80,15 @@ type (
 
 	// Plugin defines the Docker plugin parameters.
 	Plugin struct {
-		Login    Login   // Docker login configuration
-		Build    Build   // Docker build configuration
-		Builder  Builder // Docker Buildx builder configuration
-		Daemon   Daemon  // Docker daemon configuration
-		Dryrun   bool    // Docker push is skipped
-		Cleanup  bool    // Docker purge is enabled
-		CardPath string  // Card path to write file to
+		Login        Login   // Docker login configuration
+		Build        Build   // Docker build configuration
+		Builder      Builder // Docker Buildx builder configuration
+		Daemon       Daemon  // Docker daemon configuration
+		Dryrun       bool    // Docker push is skipped
+		Cleanup      bool    // Docker purge is enabled
+		CardPath     string  // Card path to write file to
+		MetadataFile string  // Location to write the metadata file
+		ArtifactFile string  // Artifact path to write file to
 	}
 
 	Card []struct {
@@ -204,7 +210,7 @@ func (p Plugin) Exec() error {
 	cmds = append(cmds, commandInfo())    // docker info
 
 	// Command to build, tag and push
-	cmds = append(cmds, commandBuildx(p.Build, p.Builder, p.Dryrun)) // docker build
+	cmds = append(cmds, commandBuildx(p.Build, p.Builder, p.Dryrun, p.MetadataFile)) // docker build
 
 	// execute all commands in batch mode.
 	for _, cmd := range cmds {
@@ -223,8 +229,21 @@ func (p Plugin) Exec() error {
 	}
 
 	// output the adaptive card
-	if err := p.writeCard(); err != nil {
-		fmt.Printf("Could not create adaptive card. %s\n", err)
+	if p.Builder.Driver == defaultDriver {
+		if err := p.writeCard(); err != nil {
+			fmt.Printf("Could not create adaptive card. %s\n", err)
+		}
+	}
+
+	// write to artifact file
+	if p.ArtifactFile != "" {
+		if digest, err := getDigest(p.MetadataFile); err == nil {
+			if err = drone.WritePluginArtifactFile(p.Daemon.RegistryType, p.ArtifactFile, p.Daemon.Registry, p.Build.Repo, digest, p.Build.Tags); err != nil {
+				fmt.Printf("Failed to write plugin artifact file at path: %s with error: %s\n", p.ArtifactFile, err)
+			}
+		} else {
+			fmt.Printf("Could not fetch the digest. %s\n", err)
+		}
 	}
 
 	// execute cleanup routines in batch mode
@@ -245,6 +264,27 @@ func (p Plugin) Exec() error {
 	return nil
 }
 
+func getDigest(metadataFile string) (string, error) {
+	file, err := os.Open(metadataFile)
+	if err != nil {
+		return "", fmt.Errorf("unable to open the metadata file %s with error: %s", metadataFile, err)
+	}
+	defer file.Close()
+
+	var metadata map[string]interface{}
+	if err = json.NewDecoder(file).Decode(&metadata); err != nil {
+		return "", fmt.Errorf("unable to decode the metadata with error: %s", err)
+	}
+
+	if d, found := metadata["containerimage.digest"]; found {
+		if digest, ok := d.(string); ok {
+			return digest, nil
+		}
+		return "", fmt.Errorf("unable to parse containerimage.digest from metadata json")
+	}
+	return "", fmt.Errorf("containerimage.digest not found in metadata json")
+}
+
 // helper function to create the docker login command.
 func commandLogin(login Login) *exec.Cmd {
 	if login.Email != "" {
@@ -288,7 +328,7 @@ func commandInfo() *exec.Cmd {
 }
 
 // helper function to create the docker buildx command.
-func commandBuildx(build Build, builder Builder, dryrun bool) *exec.Cmd {
+func commandBuildx(build Build, builder Builder, dryrun bool, metadataFile string) *exec.Cmd {
 	args := []string{
 		"buildx",
 		"build",
@@ -310,6 +350,9 @@ func commandBuildx(build Build, builder Builder, dryrun bool) *exec.Cmd {
 		args = append(args, "--push")
 	}
 	args = append(args, build.Context)
+	if metadataFile != "" {
+		args = append(args, "--metadata-file", metadataFile)
+	}
 	if build.Squash {
 		args = append(args, "--squash")
 	}

docker_test.go

@@ -1,18 +1,20 @@
 package docker
 
 import (
+	"os"
 	"os/exec"
 	"reflect"
 	"testing"
 )
 
 func TestCommandBuildx(t *testing.T) {
 	tcs := []struct {
-		name    string
-		build   Build
-		builder Builder
-		dryrun  bool
-		want    *exec.Cmd
+		name     string
+		build    Build
+		builder  Builder
+		dryrun   bool
+		metadata string
+		want     *exec.Cmd
 	}{
 		{
 			name: "secret from env var",
@@ -181,17 +183,78 @@ func TestCommandBuildx(t *testing.T) {
 				"--ssh id_rsa=/root/.ssh/id_rsa",
 			),
 		},
+		{
+			name: "metadata file",
+			build: Build{
+				Name:       "plugins/drone-docker:latest",
+				Dockerfile: "Dockerfile",
+				Context:    ".",
+				Repo:       "plugins/drone-docker",
+				Tags:       []string{"latest"},
+			},
+			metadata: "/tmp/metadata.json",
+			want: exec.Command(
+				dockerExe,
+				"buildx",
+				"build",
+				"--rm=true",
+				"-f",
+				"Dockerfile",
+				"-t",
+				"plugins/drone-docker:latest",
+				"--push",
+				".",
+				"--metadata-file /tmp/metadata.json",
+			),
+		},
 	}
 
 	for _, tc := range tcs {
 		tc := tc
 
 		t.Run(tc.name, func(t *testing.T) {
-			cmd := commandBuildx(tc.build, tc.builder, tc.dryrun)
+			cmd := commandBuildx(tc.build, tc.builder, tc.dryrun, tc.metadata)
 
 			if !reflect.DeepEqual(cmd.String(), tc.want.String()) {
 				t.Errorf("Got cmd %v, want %v", cmd, tc.want)
 			}
 		})
 	}
 }
+
+func TestGetDigest(t *testing.T) {
+
+	tcs := []struct {
+		name   string
+		path   string
+		digest string
+	}{
+		{
+			name:   "single platform",
+			path:   "testdata/metadata.json",
+			digest: "sha256:02fd68a300e3a863791744802ea3eeaac43a36e98888cdb9ffb22da8006f7eee",
+		},
+		{
+			name:   "cross platform",
+			path:   "testdata/metadata_cross_platform.json",
+			digest: "sha256:0cff645119742b04807c4a3953925a579e21654baaeaf20f33c05554a6decbce",
+		},
+	}
+
+	dir, err := os.Getwd()
+	if err != nil {
+		t.Fatal("unable to get working dir")
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.name, func(t *testing.T) {
+			digest, err := getDigest(dir + "/" + tc.path)
+			if err != nil {
+				t.Errorf("unable to get digest with error %s", err)
+			}
+			if digest != tc.digest {
+				t.Errorf("Got digest %s, want %s", digest, tc.digest)
+			}
+		})
+	}
+}

go.mod

@@ -3,22 +3,20 @@ module github.com/drone-plugins/drone-buildx
 require (
 	github.com/aws/aws-sdk-go v1.26.7
 	github.com/coreos/go-semver v0.3.0
+	github.com/drone-plugins/drone-plugin-lib v0.4.1
 	github.com/drone/drone-go v1.7.1
 	github.com/inhies/go-bytesize v0.0.0-20210819104631-275770b98743
 	github.com/joho/godotenv v1.3.0
-	github.com/sirupsen/logrus v1.3.0
+	github.com/sirupsen/logrus v1.9.0
 	github.com/urfave/cli v1.22.2
 )
 
 require (
-	github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af // indirect
-	github.com/konsorten/go-windows-terminal-sequences v1.0.1 // indirect
-	github.com/russross/blackfriday/v2 v2.0.1 // indirect
-	github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
-	golang.org/x/crypto v0.0.0-20180904163835-0709b304e793 // indirect
-	golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	golang.org/x/sys v0.0.0-20220731174439-a90be440212d // indirect
 	gopkg.in/yaml.v2 v2.2.8 // indirect
 )
 
-go 1.17
+go 1.20