Add validate method to Image type

Author: Wilken Rivera

packer/registry/image/fromartifact_example_test.go

@@ -6,6 +6,34 @@ import (
 	"github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 )
 
+type simpleArtifact struct {
+	image_id string
+}
+
+func (a *simpleArtifact) BuilderId() string {
+	return "example.happycloud"
+}
+
+func (a *simpleArtifact) Files() []string {
+	return nil
+}
+
+func (a *simpleArtifact) Id() string {
+	return a.image_id
+}
+
+func (a *simpleArtifact) String() string {
+	return fmt.Sprintf("Imported image URL: %s", a.Id())
+}
+
+func (a *simpleArtifact) State(name string) interface{} {
+	return nil
+}
+
+func (a *simpleArtifact) Destroy() error {
+	return nil
+}
+
 func ExampleFromArtifact() {
 
 	a := &simpleArtifact{
@@ -35,37 +63,8 @@ func ExampleSetLabels() {
 		image_id: "service-id-123",
 	}
 
-	// This example also includes an override for the ProviderRegion to illustrate how ArtifactOverrideFunc(s) can be chained.
 	hcimage, _ := image.FromArtifact(a, image.SetLabels(map[string]interface{}{"kernel": "4.0", "python": "3.5"}))
 	fmt.Printf("%v", hcimage.Labels)
 	// Unordered output:
 	// map[kernel:4.0 python:3.5]
 }
-
-type simpleArtifact struct {
-	image_id string
-}
-
-func (a *simpleArtifact) BuilderId() string {
-	return "example.happycloud"
-}
-
-func (a *simpleArtifact) Files() []string {
-	return nil
-}
-
-func (a *simpleArtifact) Id() string {
-	return a.image_id
-}
-
-func (a *simpleArtifact) String() string {
-	return fmt.Sprintf("Imported image URL: %s", a.Id())
-}
-
-func (a *simpleArtifact) State(name string) interface{} {
-	return nil
-}
-
-func (a *simpleArtifact) Destroy() error {
-	return nil
-}

packer/registry/image/frommappeddata_example_test.go

@@ -9,41 +9,6 @@ import (
 	"github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 )
 
-func ExampleFromMappedData() {
-
-	a := &artifact{
-		images: map[string]string{
-			"west": "happycloud-1",
-			"east": "happycloud-2",
-		},
-	}
-
-	f := func(key, value interface{}) (*image.Image, error) {
-		v, ok := value.(string)
-		if !ok {
-			return nil, errors.New("for happycloud maps value should always be string")
-		}
-		k, ok := key.(string)
-		if !ok {
-			return nil, errors.New("for happycloud maps key should always be string")
-		}
-
-		img := image.Image{ProviderName: "happycloud", ProviderRegion: k, ImageID: v}
-		return &img, nil
-	}
-
-	hcimages, _ := image.FromMappedData(a.images, f)
-	fmt.Println("Image count:", len(hcimages))
-	for _, hcimage := range hcimages {
-		fmt.Printf("%#v\n", *hcimage)
-	}
-	// Unordered output:
-	// Image count: 2
-	// image.Image{ImageID:"happycloud-1", ProviderName:"happycloud", ProviderRegion:"west", Labels:map[string]string(nil)}
-	// image.Image{ImageID:"happycloud-2", ProviderName:"happycloud", ProviderRegion:"east", Labels:map[string]string(nil)}
-
-}
-
 type artifact struct {
 	images map[string]string
 }
@@ -76,3 +41,34 @@ func (a *artifact) State(name string) interface{} {
 func (a *artifact) Destroy() error {
 	return nil
 }
+
+func ExampleFromMappedData() {
+	a := &artifact{
+		images: map[string]string{
+			"west": "happycloud-1",
+			"east": "happycloud-2",
+		},
+	}
+
+	f := func(key, value interface{}) (*image.Image, error) {
+		v, ok := value.(string)
+		if !ok {
+			return nil, errors.New("for happycloud maps value should always be string")
+		}
+		k, ok := key.(string)
+		if !ok {
+			return nil, errors.New("for happycloud maps key should always be string")
+		}
+
+		img := image.Image{ProviderName: "happycloud", ProviderRegion: k, ImageID: v}
+		return &img, nil
+	}
+
+	hcimages, _ := image.FromMappedData(a.images, f)
+	for _, hcimage := range hcimages {
+		fmt.Printf("%#v\n", *hcimage)
+	}
+	// Unordered output:
+	// image.Image{ImageID:"happycloud-1", ProviderName:"happycloud", ProviderRegion:"west", Labels:map[string]string(nil)}
+	// image.Image{ImageID:"happycloud-2", ProviderName:"happycloud", ProviderRegion:"east", Labels:map[string]string(nil)}
+}

packer/registry/image/image.go

@@ -1,3 +1,5 @@
+/* Package image allows for the management of image metadata that can be stored in a HCP Packer registry.
+ */
 package image
 
 import (
@@ -7,7 +9,7 @@ import (
 	"github.com/hashicorp/packer-plugin-sdk/packer"
 )
 
-// ArtifactStateURI represents the key used by Packer when querying an packersdk.Artifact
+// ArtifactStateURI represents the key used by Packer when querying a packersdk.Artifact
 // for Image metadata that a particular component would like to have stored on the HCP Packer Registry.
 const ArtifactStateURI = "par.artifact.metadata"
 
@@ -19,20 +21,30 @@ type ArtifactOverrideFunc func(*Image) error
 type Image struct {
 	// ImageID is a unique reference identifier stored on the HCP Packer registry
 	// that can be used to get back the built artifact of a builder or post-processor.
-	ImageID string
+	ImageID string `mapstructure:"image_id"`
 	// ProviderName represents the name of the top level cloud or service where the built artifact resides.
 	// For example "aws, azure, docker, gcp, and vsphere".
+	ProviderName string `mapstructure:"provider_name"`
 	// ProviderRegion represents the location of the built artifact.
 	// For cloud providers region usually maps to a cloud region or zone, but for things like the file builder,
 	// S3 bucket or vsphere cluster region can represent a path on the upstream datastore, or cluster.
-	ProviderName, ProviderRegion string
+	ProviderRegion string `mapstructure:"provider_region"`
 	// Labels represents additional details about an image that a builder or post-processor may with to provide for a given build.
 	// Any additional metadata will be made available as build labels within a HCP Packer registry iteration.
 	Labels map[string]string `mapstructure:"labels"`
 }
 
-func New() *Image {
-	return &Image{}
+// Validate checks that the Image i contains a non-empty ImageID and ProviderName.
+func (i *Image) Validate() error {
+	if i.ImageID == "" {
+		return errors.New("error registry image does not contain a valid ImageId")
+	}
+
+	if i.ProviderName == "" {
+		return errors.New("error registry image does not contain a valid ProviderName")
+	}
+
+	return nil
 }
 
 // FromMappedData calls f sequentially for each key and value present in mappedData to create a []*Image
@@ -63,29 +75,28 @@ func FromMappedData(mappedData interface{}, f func(key, value interface{}) (*Ima
 }
 
 // FromArtifact returns an *Image that can be used by Packer core for publishing to the HCP Packer Registry.
-// By default FromArtifact will use the a.BuilderID as the Image Provider, and the a.Id() as the ImageID that
-// should be tracked within the HCP Packer Registry. No Region is selected by default as region varies per build.
+// By default FromArtifact will use the a.BuilderID() as the ProviderName, and the a.Id() as the ImageID that
+// should be tracked within the HCP Packer Registry. No Region is selected by default as region varies per builder.
 // The use of one or more ArtifactOverrideFunc can be used to override any of the defaults used.
 func FromArtifact(a packer.Artifact, opts ...ArtifactOverrideFunc) (*Image, error) {
 	if a == nil {
 		return nil, errors.New("unable to create Image from nil artifact")
 	}
 
-	img := &Image{
+	img := Image{
 		ProviderName: a.BuilderId(),
 		ImageID:      a.Id(),
 		Labels:       make(map[string]string),
 	}
 
-	// Let's grab some state data
 	for _, opt := range opts {
-		err := opt(img)
+		err := opt(&img)
 		if err != nil {
 			return nil, err
 		}
 	}
 
-	return img, nil
+	return &img, nil
 }
 
 // WithProvider takes a name, and returns a ArtifactOverrideFunc that can be