Update to use registry image from packersdk

Author: Wilken Rivera

builder/file/artifact.go

@@ -6,7 +6,7 @@ import (
 	"os"
 	"path"
 
-	"github.com/hashicorp/packer-plugin-sdk/packer/registryimage"
+	registryimage "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 )
 
 type FileArtifact struct {
@@ -31,10 +31,17 @@ func (a *FileArtifact) String() string {
 
 func (a *FileArtifact) State(name string) interface{} {
 	if name == registryimage.ArtifactStateURI {
-		return registryimage.FromArtifact(a,
+		img, err := registryimage.FromArtifact(a,
 			registryimage.WithID(path.Base(a.filename)),
 			registryimage.WithRegion(path.Dir(a.filename)),
 		)
+
+		if err != nil {
+			log.Printf("[DEBUG] error encountered when creating a registry image %v", err)
+			return nil
+		}
+
+		return img
 	}
 
 	return nil

go.mod

@@ -24,13 +24,13 @@ require (
 	github.com/hashicorp/packer-plugin-alicloud v1.0.0
 	github.com/hashicorp/packer-plugin-amazon v1.0.1-dev
 	github.com/hashicorp/packer-plugin-ansible v1.0.0
-	github.com/hashicorp/packer-plugin-azure v1.0.3-0.20210827204949-2db2f8f742f5
+	github.com/hashicorp/packer-plugin-azure v1.0.3-0.20210901194000-92cb558280ea
 	github.com/hashicorp/packer-plugin-chef v1.0.1
 	github.com/hashicorp/packer-plugin-cloudstack v1.0.0
 	github.com/hashicorp/packer-plugin-converge v1.0.0
 	github.com/hashicorp/packer-plugin-digitalocean v1.0.0
 	github.com/hashicorp/packer-plugin-docker v1.0.1
-	github.com/hashicorp/packer-plugin-googlecompute v1.0.1-0.20210827170357-eff61b67a6ce
+	github.com/hashicorp/packer-plugin-googlecompute v1.0.1-0.20210901195800-781d29aa5ab5
 	github.com/hashicorp/packer-plugin-hcloud v1.0.0
 	github.com/hashicorp/packer-plugin-hyperone v1.0.0
 	github.com/hashicorp/packer-plugin-hyperv v1.0.0
@@ -49,7 +49,7 @@ require (
 	github.com/hashicorp/packer-plugin-puppet v1.0.0
 	github.com/hashicorp/packer-plugin-qemu v1.0.0
 	github.com/hashicorp/packer-plugin-scaleway v1.0.1
-	github.com/hashicorp/packer-plugin-sdk v0.2.4-0.20210824193240-6b55f55dd41b
+	github.com/hashicorp/packer-plugin-sdk v0.2.5-0.20210902203720-8464b03760f4
 	github.com/hashicorp/packer-plugin-tencentcloud v1.0.1
 	github.com/hashicorp/packer-plugin-triton v1.0.0
 	github.com/hashicorp/packer-plugin-ucloud v1.0.0
@@ -59,27 +59,27 @@ require (
 	github.com/hashicorp/packer-plugin-vsphere v1.0.0
 	github.com/hashicorp/packer-plugin-yandex v1.0.0
 	github.com/klauspost/pgzip v0.0.0-20151221113845-47f36e165cec
-	github.com/masterzen/winrm v0.0.0-20210504160029-28ed956f5227
+	github.com/masterzen/winrm v0.0.0-20210623064412-3b76017826b0
 	github.com/mattn/go-tty v0.0.0-20191112051231-74040eebce08
-	github.com/mitchellh/cli v1.1.0
+	github.com/mitchellh/cli v1.1.2
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/mitchellh/mapstructure v1.4.1
 	github.com/mitchellh/panicwrap v1.0.0
 	github.com/mitchellh/prefixedio v0.0.0-20151214002211-6e6954073784
-	github.com/pierrec/lz4 v2.5.2+incompatible
+	github.com/pierrec/lz4 v2.6.1+incompatible
 	github.com/posener/complete v1.2.3
 	github.com/shirou/gopsutil v3.21.1+incompatible
 	github.com/stretchr/testify v1.7.0
-	github.com/ulikunitz/xz v0.5.8
-	github.com/zclconf/go-cty v1.9.0
+	github.com/ulikunitz/xz v0.5.10
+	github.com/zclconf/go-cty v1.9.1
 	github.com/zclconf/go-cty-yaml v1.0.1
-	golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a
-	golang.org/x/mod v0.4.1
-	golang.org/x/net v0.0.0-20210614182718-04defd469f4e
-	golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84
+	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5
+	golang.org/x/mod v0.5.0
+	golang.org/x/net v0.0.0-20210825183410-e898025ed96a
+	golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
-	golang.org/x/tools v0.1.0
-	google.golang.org/grpc v1.36.1
+	golang.org/x/tools v0.1.5
+	google.golang.org/grpc v1.40.0
 )
 
 go 1.16

go.sum

@@ -10,6 +10,7 @@ import (
 
 	"github.com/hashicorp/go-multierror"
 	"github.com/hashicorp/hcp-sdk-go/clients/cloud-packer-service/preview/2021-04-30/models"
+	registryimage "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 	"github.com/hashicorp/packer/internal/packer_registry/env"
 	"google.golang.org/grpc/codes"
 )
@@ -127,7 +128,7 @@ func (b *Bucket) CreateInitialBuildForIteration(ctx context.Context, componentTy
 		RunUUID:       b.Iteration.RunUUID,
 		Status:        status,
 		Labels:        make(map[string]string),
-		Images:        make(map[string]Image),
+		Images:        make(map[string]registryimage.Image),
 	}
 
 	log.Println("[TRACE] creating initial build for component", componentType)
@@ -219,7 +220,7 @@ func (b *Bucket) markBuildComplete(ctx context.Context, name string) error {
 		if providerName == "" {
 			providerName = image.ProviderName
 		}
-		images = append(images, &models.HashicorpCloudPackerImage{ImageID: image.ID, Region: image.ProviderRegion})
+		images = append(images, &models.HashicorpCloudPackerImage{ImageID: image.ImageID, Region: image.ProviderRegion})
 	}
 
 	buildInput.Updates.CloudProvider = providerName
@@ -236,7 +237,7 @@ func (b *Bucket) markBuildComplete(ctx context.Context, name string) error {
 }
 
 // UpdateImageForBuild appends one or more images artifacts to the build referred to by componentType.
-func (b *Bucket) UpdateImageForBuild(componentType string, images ...Image) error {
+func (b *Bucket) UpdateImageForBuild(componentType string, images ...registryimage.Image) error {
 	return b.Iteration.AddImageToBuild(componentType, images...)
 }
 
@@ -340,8 +341,8 @@ func (b *Bucket) initializeIteration(ctx context.Context) error {
 				// potential issue on updating the status of a build that is already DONE. Is this possible?
 				for _, image := range existing.Images {
 
-					err := b.UpdateImageForBuild(existing.ComponentType, Image{
-						ID:             image.ImageID,
+					err := b.UpdateImageForBuild(existing.ComponentType, registryimage.Image{
+						ImageID:        image.ImageID,
 						ProviderRegion: image.Region,
 					})
 

internal/packer_registry/types.bucket.go

@@ -1,9 +1,8 @@
 package packer_registry
 
 import (
-	"fmt"
-
 	"github.com/hashicorp/hcp-sdk-go/clients/cloud-packer-service/preview/2021-04-30/models"
+	registryimage "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 )
 
 // Build represents a build of a given component type for some bucket on the HCP Packer Registry.
@@ -13,17 +12,6 @@ type Build struct {
 	ComponentType string
 	RunUUID       string
 	Labels        map[string]string
-	Images        map[string]Image
+	Images        map[string]registryimage.Image
 	Status        models.HashicorpCloudPackerBuildStatus
 }
-
-// Image represents an artifact on some external provider (e.g AWS, GCP, Azure) that should be tracked
-// as the main image artifact for some iteration of a Bucket on the HCP Packer Registry.
-type Image struct {
-	ID                           string
-	ProviderName, ProviderRegion string
-}
-
-func (i Image) String() string {
-	return fmt.Sprintf("provider:%s, image:%s, region:%s", i.ProviderName, i.ID, i.ProviderRegion)
-}

internal/packer_registry/types.builds.go

@@ -7,6 +7,7 @@ import (
 	"sync"
 
 	git "github.com/go-git/go-git/v5"
+	registryimage "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 )
 
 type Iteration struct {
@@ -82,7 +83,7 @@ func GetGitFingerprint(opts IterationOptions) (string, error) {
 }
 
 // AddImageToBuild appends one or more images artifacts to the build referred to by buildName.
-func (i *Iteration) AddImageToBuild(buildName string, images ...Image) error {
+func (i *Iteration) AddImageToBuild(buildName string, images ...registryimage.Image) error {
 	existingBuild, ok := i.builds.Load(buildName)
 	if !ok {
 		return errors.New("no build found for the name " + buildName)
@@ -94,14 +95,25 @@ func (i *Iteration) AddImageToBuild(buildName string, images ...Image) error {
 	}
 
 	if build.Images == nil {
-		build.Images = make(map[string]Image)
+		build.Images = make(map[string]registryimage.Image)
 	}
 
 	for _, image := range images {
+		if err := image.Validate(); err != nil {
+			return fmt.Errorf("failed to add image to build %q: %v", buildName, err)
+		}
+
 		if build.CloudProvider == "" {
 			build.CloudProvider = image.ProviderName
 		}
 
+		for k, v := range image.Labels {
+			if _, ok := build.Labels[k]; ok {
+				continue
+			}
+			build.Labels[k] = v
+		}
+
 		build.Images[image.String()] = image
 	}
 

internal/packer_registry/types.iterations.go

@@ -7,9 +7,9 @@ import (
 
 	"github.com/hashicorp/hcp-sdk-go/clients/cloud-packer-service/preview/2021-04-30/models"
 	packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
-	"github.com/hashicorp/packer-plugin-sdk/packer/registryimage"
+	registryimage "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
+	"github.com/hashicorp/packer-plugin-sdk/template/config"
 	packerregistry "github.com/hashicorp/packer/internal/packer_registry"
-	"github.com/mitchellh/mapstructure"
 )
 
 type RegistryBuilder struct {
@@ -61,36 +61,28 @@ func (b *RegistryBuilder) Run(ctx context.Context, ui packersdk.Ui, hook packers
 	// close chan to mark completion
 	close(runCompleted)
 
-	// Lets post state
-	if artifact != nil {
-		switch state := artifact.State(registryimage.ArtifactStateURI).(type) {
-		case map[interface{}]interface{}:
-			var image registryimage.Image
-			mapstructure.Decode(state, &image)
-			// TODO handle these error better
-			err := b.ArtifactMetadataPublisher.UpdateImageForBuild(b.Name, packerregistry.Image{
-				ProviderName:   image.ProviderName,
-				ProviderRegion: image.ProviderRegion,
-				ID:             image.ImageID,
-			})
-			if err != nil {
-				log.Printf("[TRACE] failed to add image artifact for %q: %s", b.Name, err)
-			}
-		case []interface{}:
-			var images []registryimage.Image
-			mapstructure.Decode(state, &images)
-			for _, image := range images {
-				// TODO handle these error better
-				err := b.ArtifactMetadataPublisher.UpdateImageForBuild(b.Name, packerregistry.Image{
-					ProviderName:   image.ProviderName,
-					ProviderRegion: image.ProviderRegion,
-					ID:             image.ImageID,
-				})
-				if err != nil {
-					log.Printf("[TRACE] failed to add image artifact for %q: %s", b.Name, err)
-				}
-			}
-		}
+	if err != nil {
+		return nil, err
+	}
+
+	if artifact == nil {
+		return nil, nil
+	}
+
+	switch state := artifact.State(registryimage.ArtifactStateURI).(type) {
+	case map[interface{}]interface{}:
+		var image registryimage.Image
+		config.Decode(&image, &config.DecodeOpts{}, state)
+		err = b.ArtifactMetadataPublisher.UpdateImageForBuild(b.Name, image)
+	case []interface{}:
+		var images []registryimage.Image
+		config.Decode(&images, &config.DecodeOpts{}, state)
+		err = b.ArtifactMetadataPublisher.UpdateImageForBuild(b.Name, images...)
 	}
+
+	if err != nil {
+		log.Printf("[TRACE] failed to add image artifact for %q: %s", b.Name, err)
+	}
+
 	return artifact, err
 }

packer/registry_builder.go

@@ -8,7 +8,8 @@ import (
 	"github.com/hashicorp/hcl/v2/hcldec"
 	"github.com/hashicorp/hcp-sdk-go/clients/cloud-packer-service/preview/2021-04-30/models"
 	packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
-	"github.com/hashicorp/packer-plugin-sdk/packer/registryimage"
+	registryimage "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
+	"github.com/hashicorp/packer-plugin-sdk/template/config"
 	packerregistry "github.com/hashicorp/packer/internal/packer_registry"
 	"github.com/mitchellh/mapstructure"
 )
@@ -61,35 +62,21 @@ func (p *RegistryPostProcessor) PostProcess(ctx context.Context, ui packersdk.Ui
 		return source, false, false, err
 	}
 
-	// Lets post state
-	if source != nil {
-		switch state := source.State(registryimage.ArtifactStateURI).(type) {
-		case map[interface{}]interface{}:
-			var image registryimage.Image
-			mapstructure.Decode(state, &image)
-			err := p.ArtifactMetadataPublisher.UpdateImageForBuild(p.BuilderType, packerregistry.Image{
-				ProviderName:   image.ProviderName,
-				ProviderRegion: image.ProviderRegion,
-				ID:             image.ImageID,
-			})
-			if err != nil {
-				log.Printf("[TRACE] failed to add image artifact for %q: %s", p.BuilderType, err)
-			}
-		case []interface{}:
-			var images []registryimage.Image
-			mapstructure.Decode(state, &images)
-			for _, image := range images {
-				// TODO handle these error better
-				err := p.ArtifactMetadataPublisher.UpdateImageForBuild(p.BuilderType, packerregistry.Image{
-					ProviderName:   image.ProviderName,
-					ProviderRegion: image.ProviderRegion,
-					ID:             image.ImageID,
-				})
-				if err != nil {
-					log.Printf("[TRACE] failed to add image artifact for %q: %s", p.BuilderType, err)
-				}
-			}
-		}
+	switch state := source.State(registryimage.ArtifactStateURI).(type) {
+	case map[interface{}]interface{}:
+		var image registryimage.Image
+		config.Decode(&image, &config.DecodeOpts{}, state)
+		err = p.ArtifactMetadataPublisher.UpdateImageForBuild(p.BuilderType, image)
+	case []interface{}:
+		var images []registryimage.Image
+		mapstructure.Decode(state, &images)
+		config.Decode(&images, &config.DecodeOpts{}, state)
+		err = p.ArtifactMetadataPublisher.UpdateImageForBuild(p.BuilderType, images...)
 	}
-	return source, keep, override, nil
+
+	if err != nil {
+		log.Printf("[TRACE] failed to add image artifact for %q: %s", p.BuilderType, err)
+	}
+
+	return source, keep, override, err
 }