feat(builder): HCP Packer image metadata support (#33)

Author: peknur

CHANGELOG.md

@@ -6,6 +6,7 @@ See updating [Changelog example here](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
+- HCP Packer image metadata support
 - enviroment variables `UPCLOUD_USERNAME` and `UPCLOUD_PASSWORD` for authentication
 
 ### Deprecated

builder/upcloud/artifact.go

@@ -2,10 +2,12 @@ package upcloud
 
 import (
 	"fmt"
+	"log"
 	"strings"
 
 	"github.com/UpCloudLtd/packer-plugin-upcloud/internal/driver"
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
+	"github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 )
 
 // packersdk.Artifact implementation
@@ -40,6 +42,14 @@ func (a *Artifact) String() string {
 }
 
 func (a *Artifact) State(name string) interface{} {
+	if name == image.ArtifactStateURI {
+		images, err := a.buildHCPPackerRegistryMetadata()
+		if err != nil {
+			log.Printf("[DEBUG] error encountered when creating a registry image %v", err)
+			return nil
+		}
+		return images
+	}
 	return a.StateData[name]
 }
 
@@ -52,3 +62,35 @@ func (a *Artifact) Destroy() error {
 	}
 	return nil
 }
+
+func (a *Artifact) buildHCPPackerRegistryMetadata() ([]*image.Image, error) {
+	var sourceTemplateUUID, sourceTemplateTitle string
+	if v, ok := a.StateData["source_template_uuid"]; ok {
+		sourceTemplateUUID = v.(string)
+	}
+
+	if v, ok := a.StateData["source_template_title"]; ok {
+		sourceTemplateTitle = v.(string)
+	}
+
+	images := make([]*image.Image, 0)
+	for _, template := range a.Templates {
+		img, err := image.FromArtifact(a,
+			image.WithID(template.UUID),
+			image.WithRegion(template.Zone),
+			image.WithProvider("upcloud"),
+		)
+		if err != nil {
+			return images, err
+		}
+
+		img.SourceImageID = sourceTemplateUUID
+		img.Labels["source_id"] = sourceTemplateUUID
+		img.Labels["source"] = sourceTemplateTitle
+		img.Labels["name"] = template.Title
+		img.Labels["name_prefix"] = a.config.TemplatePrefix
+		img.Labels["size"] = fmt.Sprint(template.Size)
+		images = append(images, img)
+	}
+	return images, nil
+}

builder/upcloud/artifact_test.go

@@ -6,6 +6,8 @@ import (
 
 	"github.com/UpCloudLtd/upcloud-go-api/v4/upcloud"
 	packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
+	"github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestArtifact_impl(t *testing.T) {
@@ -42,3 +44,49 @@ func TestArtifact_String(t *testing.T) {
 		t.Errorf("Expected: %q, got: %q", expected, result)
 	}
 }
+
+func TestArtifact_Metadata(t *testing.T) {
+	templates := []*upcloud.Storage{}
+	templates = append(templates,
+		&upcloud.Storage{
+			UUID:  "some-uuid",
+			Size:  10,
+			Title: "some-title",
+			Zone:  "fi-hel1",
+		},
+		&upcloud.Storage{
+			UUID:  "some-other-uuid",
+			Size:  10,
+			Title: "some-title",
+			Zone:  "fi-hel2",
+		},
+	)
+
+	a := &Artifact{
+		Templates: templates,
+		config: &Config{
+			Zone:           "fi-hel1",
+			CloneZones:     []string{"fi-hel2"},
+			TemplatePrefix: "prefix",
+		},
+		StateData: map[string]interface{}{
+			"source_template_title": "source-title",
+			"source_template_uuid":  "source-uuid",
+		},
+	}
+	got := a.State(image.ArtifactStateURI).([]*image.Image)
+	want := &image.Image{
+		ImageID:        "some-uuid",
+		ProviderName:   "upcloud",
+		ProviderRegion: "fi-hel1",
+		Labels: map[string]string{
+			"source":      "source-title",
+			"source_id":   "source-uuid",
+			"name":        "some-title",
+			"name_prefix": "prefix",
+			"size":        "10",
+		},
+		SourceImageID: "source-uuid",
+	}
+	assert.Equal(t, want, got[0])
+}

builder/upcloud/builder.go

@@ -99,9 +99,11 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 		config:    &b.config,
 		driver:    b.driver,
 		StateData: map[string]interface{}{
-			"generated_data":  state.Get("generated_data"),
-			"template_prefix": b.config.TemplatePrefix,
-			"template_name":   b.config.TemplateName,
+			"generated_data":        state.Get("generated_data"),
+			"template_prefix":       b.config.TemplatePrefix,
+			"template_name":         b.config.TemplateName,
+			"source_template_uuid":  state.Get("source_template_uuid"),
+			"source_template_title": state.Get("source_template_title"),
 		},
 	}
 

builder/upcloud/step_create_server.go

@@ -72,6 +72,8 @@ func (s *StepCreateServer) Run(_ context.Context, state multistep.StateBag) mult
 		ui.Say(fmt.Sprintf("Auto-selecting ip '%s' as Server IP", addr.Address))
 	}
 
+	state.Put("source_template_uuid", storage.UUID)
+	state.Put("source_template_title", storage.Title)
 	state.Put("server_ip_address", addr)
 	state.Put("server_uuid", response.UUID)
 	state.Put("server_title", response.Title)

builder/upcloud/step_create_template.go

@@ -30,7 +30,7 @@ func (s *StepCreateTemplate) Run(_ context.Context, state multistep.StateBag) mu
 		return stepHaltWithError(state, err)
 	}
 
-	// clonning to zones
+	// cloning to zones
 	cleanupStorageUuid := []string{}
 	storageUuids := []string{}
 	storageUuids = append(storageUuids, storage.UUID)
@@ -45,7 +45,7 @@ func (s *StepCreateTemplate) Run(_ context.Context, state multistep.StateBag) mu
 		storageUuids = append(storageUuids, clonedStorage.UUID)
 		cleanupStorageUuid = append(cleanupStorageUuid, clonedStorage.UUID)
 	}
-	ui.Say("Clonning completed...")
+	ui.Say("Cloning completed...")
 
 	// creating template
 	templates := []*upcloud.Storage{}

go.mod

@@ -3,10 +3,10 @@ module github.com/UpCloudLtd/packer-plugin-upcloud
 go 1.17
 
 require (
-	github.com/UpCloudLtd/upcloud-go-api/v4 v4.5.2
+	github.com/UpCloudLtd/upcloud-go-api/v4 v4.6.0
 	github.com/hashicorp/hcl/v2 v2.12.0
 	github.com/hashicorp/packer-plugin-sdk v0.2.12
-	github.com/stretchr/testify v1.7.0
+	github.com/stretchr/testify v1.7.2
 	github.com/zclconf/go-cty v1.10.0
 	golang.org/x/crypto v0.0.0-20220427172511-eb4f295cb31f
 )
@@ -105,5 +105,5 @@ require (
 	google.golang.org/grpc v1.42.0 // indirect
 	google.golang.org/protobuf v1.27.1 // indirect
 	gopkg.in/square/go-jose.v2 v2.6.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )