Phase 1: Packer Build Metadata

hcl2template/types.build.hcp_packer_registry_test.go

@@ -57,6 +57,7 @@ func Test_ParseHCPPackerRegistryBlock(t *testing.T) {
 					Builder:        emptyMockBuilder,
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
+					BuilderType:    "virtualbox-iso",
 				},
 			},
 			false,
@@ -110,6 +111,7 @@ func Test_ParseHCPPackerRegistryBlock(t *testing.T) {
 					Builder:        emptyMockBuilder,
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
+					BuilderType:    "virtualbox-iso",
 				},
 			},
 			false,
@@ -241,6 +243,7 @@ func Test_ParseHCPPackerRegistryBlock(t *testing.T) {
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
 					Prepared:       true,
+					BuilderType:    "null",
 				},
 			},
 			false,

hcl2template/types.build_test.go

@@ -283,6 +283,7 @@ func TestParse_build(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:         "virtualbox-iso.ubuntu-1204",
+					BuilderType:  "virtualbox-iso",
 					Prepared:     true,
 					Builder:      emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{},
@@ -317,6 +318,7 @@ func TestParse_build(t *testing.T) {
 				},
 				&packer.CoreBuild{
 					Type:         "amazon-ebs.aws-ubuntu-16.04",
+					BuilderType:  "amazon-ebs",
 					Prepared:     true,
 					Builder:      emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{},
@@ -397,9 +399,10 @@ func TestParse_build(t *testing.T) {
 			false, false,
 			[]packersdk.Build{
 				&packer.CoreBuild{
-					Type:     "virtualbox-iso.ubuntu-1204",
-					Prepared: true,
-					Builder:  emptyMockBuilder,
+					Type:        "virtualbox-iso.ubuntu-1204",
+					BuilderType: "virtualbox-iso",
+					Prepared:    true,
+					Builder:     emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{
 						{
 							PType: "shell",
@@ -427,9 +430,10 @@ func TestParse_build(t *testing.T) {
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
 				},
 				&packer.CoreBuild{
-					Type:     "amazon-ebs.aws-ubuntu-16.04",
-					Prepared: true,
-					Builder:  emptyMockBuilder,
+					Type:        "amazon-ebs.aws-ubuntu-16.04",
+					BuilderType: "amazon-ebs",
+					Prepared:    true,
+					Builder:     emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{
 						{
 							PType: "file",
@@ -486,9 +490,10 @@ func TestParse_build(t *testing.T) {
 			false, false,
 			[]packersdk.Build{
 				&packer.CoreBuild{
-					Type:     "virtualbox-iso.ubuntu-1204",
-					Prepared: true,
-					Builder:  emptyMockBuilder,
+					Type:        "virtualbox-iso.ubuntu-1204",
+					BuilderType: "virtualbox-iso",
+					Prepared:    true,
+					Builder:     emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{
 						{
 							PType: "shell",
@@ -550,6 +555,7 @@ func TestParse_build(t *testing.T) {
 				&packer.CoreBuild{
 					BuildName:      "build-name",
 					Type:           "virtualbox-iso.ubuntu-1204",
+					BuilderType:    "virtualbox-iso",
 					Prepared:       true,
 					Builder:        emptyMockBuilder,
 					Provisioners:   []packer.CoreBuildProvisioner{},
@@ -604,6 +610,7 @@ func TestParse_build(t *testing.T) {
 				&packer.CoreBuild{
 					BuildName:    "test-build",
 					Type:         "virtualbox-iso.ubuntu-1204",
+					BuilderType:  "virtualbox-iso",
 					Prepared:     true,
 					Builder:      emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{},
@@ -659,10 +666,11 @@ func TestParse_build(t *testing.T) {
 			false, false,
 			[]packersdk.Build{
 				&packer.CoreBuild{
-					BuildName: "build-name-test",
-					Type:      "virtualbox-iso.ubuntu-1204",
-					Prepared:  true,
-					Builder:   emptyMockBuilder,
+					BuildName:   "build-name-test",
+					Type:        "virtualbox-iso.ubuntu-1204",
+					BuilderType: "virtualbox-iso",
+					Prepared:    true,
+					Builder:     emptyMockBuilder,
 					Provisioners: []packer.CoreBuildProvisioner{
 						{
 							PName: "build-name-test",

hcl2template/types.datasource_test.go

@@ -57,6 +57,7 @@ func TestParse_datasource(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
@@ -134,6 +135,7 @@ func TestParse_datasource(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},

hcl2template/types.packer_config.go

@@ -622,6 +622,7 @@ func (cfg *PackerConfig) GetBuilds(opts packer.GetBuildsOptions) ([]packersdk.Bu
 
 			decoded, _ := decodeHCL2Spec(srcUsage.Body, cfg.EvalContext(BuildContext, nil), builder)
 			pcb.HCLConfig = decoded
+			pcb.BuilderType = srcUsage.Type
 
 			// If the builder has provided a list of to-be-generated variables that
 			// should be made accessible to provisioners, pass that list into

hcl2template/types.packer_config_test.go

@@ -208,8 +208,9 @@ func TestParser_complete(t *testing.T) {
 			false, false,
 			[]packersdk.Build{
 				&packer.CoreBuild{
-					Type:     "virtualbox-iso.ubuntu-1204",
-					Prepared: true,
+					Type:        "virtualbox-iso.ubuntu-1204",
+					BuilderType: "virtualbox-iso",
+					Prepared:    true,
 					Builder: &MockBuilder{
 						Config: MockConfig{
 							NestedMockConfig: NestedMockConfig{
@@ -319,8 +320,9 @@ func TestParser_complete(t *testing.T) {
 					},
 				},
 				&packer.CoreBuild{
-					Type:     "amazon-ebs.ubuntu-1604",
-					Prepared: true,
+					Type:        "amazon-ebs.ubuntu-1604",
+					BuilderType: "amazon-ebs",
+					Prepared:    true,
 					Builder: &MockBuilder{
 						Config: MockConfig{
 							NestedMockConfig: NestedMockConfig{

hcl2template/types.source_test.go

@@ -55,6 +55,7 @@ func TestParse_source(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},

hcl2template/types.variables_test.go

@@ -129,6 +129,7 @@ func TestParse_variables(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
@@ -293,6 +294,7 @@ func TestParse_variables(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
@@ -379,6 +381,7 @@ func TestParse_variables(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
@@ -442,6 +445,7 @@ func TestParse_variables(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
@@ -483,6 +487,7 @@ func TestParse_variables(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},
@@ -538,9 +543,10 @@ func TestParse_variables(t *testing.T) {
 			},
 			false, false,
 			[]packersdk.Build{&packer.CoreBuild{
-				Type:     "null.null-builder",
-				Prepared: true,
-				Builder:  &null.Builder{},
+				Type:        "null.null-builder",
+				BuilderType: "null",
+				Prepared:    true,
+				Builder:     &null.Builder{},
 				Provisioners: []packer.CoreBuildProvisioner{
 					{
 						PType: "shell",
@@ -627,6 +633,7 @@ func TestParse_variables(t *testing.T) {
 			[]packersdk.Build{
 				&packer.CoreBuild{
 					Type:           "null.test",
+					BuilderType:    "null",
 					Builder:        &null.Builder{},
 					Provisioners:   []packer.CoreBuildProvisioner{},
 					PostProcessors: [][]packer.CoreBuildPostProcessor{},

internal/hcp/api/service_build.go

@@ -58,6 +58,7 @@ func (c *Client) UpdateBuild(
 	buildLabels map[string]string,
 	buildStatus hcpPackerModels.HashicorpCloudPacker20230101BuildStatus,
 	artifacts []*hcpPackerModels.HashicorpCloudPacker20230101ArtifactCreateBody,
+	metadata *hcpPackerModels.HashicorpCloudPacker20230101BuildMetadata,
 ) (string, error) {
 
 	params := hcpPackerAPI.NewPackerServiceUpdateBuildParamsWithContext(ctx)
@@ -76,6 +77,7 @@ func (c *Client) UpdateBuild(
 		Platform:                 platform,
 		SourceExternalIdentifier: sourceExternalIdentifier,
 		Status:                   &buildStatus,
+		Metadata:                 metadata,
 	}
 
 	resp, err := c.Packer.PackerServiceUpdateBuild(params, nil)

internal/hcp/registry/hcl.go

@@ -70,6 +70,12 @@ func (h *HCLRegistry) StartBuild(ctx context.Context, build sdkpacker.Build) err
 	if ok {
 		name = cb.Type
 	}
+
+	metadata := cb.GetMetadata()
+	err := h.bucket.Version.AddMetadataToBuild(ctx, name, metadata)
+	if err != nil {
+		return err
+	}
 	return h.bucket.startBuild(ctx, name)
 }
 
@@ -80,12 +86,18 @@ func (h *HCLRegistry) CompleteBuild(
 	artifacts []sdkpacker.Artifact,
 	buildErr error,
 ) ([]sdkpacker.Artifact, error) {
-	name := build.Name()
+	buildName := build.Name()
 	cb, ok := build.(*packer.CoreBuild)
 	if ok {
-		name = cb.Type
+		buildName = cb.Type
+	}
+
+	buildMetadata := cb.GetMetadata()
+	err := h.bucket.Version.AddMetadataToBuild(ctx, buildName, buildMetadata)
+	if err != nil {
+		return nil, err
 	}
-	return h.bucket.completeBuild(ctx, name, artifacts, buildErr)
+	return h.bucket.completeBuild(ctx, buildName, artifacts, buildErr)
 }
 
 // VersionStatusSummary prints a status report in the UI if the version is not yet done

internal/hcp/registry/json.go

@@ -83,7 +83,14 @@ func (h *JSONRegistry) PopulateVersion(ctx context.Context) error {
 
 // StartBuild is invoked when one build for the configuration is starting to be processed
 func (h *JSONRegistry) StartBuild(ctx context.Context, build sdkpacker.Build) error {
-	return h.bucket.startBuild(ctx, build.Name())
+	name := build.Name()
+
+	metadata := build.(*packer.CoreBuild).GetMetadata()
+	err := h.bucket.Version.AddMetadataToBuild(ctx, name, metadata)
+	if err != nil {
+		return err
+	}
+	return h.bucket.startBuild(ctx, name)
 }
 
 // CompleteBuild is invoked when one build for the configuration has finished
@@ -93,7 +100,13 @@ func (h *JSONRegistry) CompleteBuild(
 	artifacts []sdkpacker.Artifact,
 	buildErr error,
 ) ([]sdkpacker.Artifact, error) {
-	return h.bucket.completeBuild(ctx, build.Name(), artifacts, buildErr)
+	buildName := build.Name()
+	buildMetadata := build.(*packer.CoreBuild).GetMetadata()
+	err := h.bucket.Version.AddMetadataToBuild(ctx, buildName, buildMetadata)
+	if err != nil {
+		return nil, err
+	}
+	return h.bucket.completeBuild(ctx, buildName, artifacts, buildErr)
 }
 
 // VersionStatusSummary prints a status report in the UI if the version is not yet done

internal/hcp/registry/types.bucket.go

@@ -213,6 +213,7 @@ func (bucket *Bucket) UpdateBuildStatus(
 		nil,
 		status,
 		nil,
+		&buildToUpdate.Metadata,
 	)
 	if err != nil {
 		return err
@@ -285,6 +286,7 @@ func (bucket *Bucket) markBuildComplete(ctx context.Context, name string) error
 		buildToUpdate.Labels,
 		status,
 		artifacts,
+		&buildToUpdate.Metadata,
 	)
 	if err != nil {
 		return err
@@ -535,6 +537,7 @@ func (bucket *Bucket) HeartbeatBuild(ctx context.Context, build string) (func(),
 					nil,
 					hcpPackerModels.HashicorpCloudPacker20230101BuildStatusBUILDRUNNING,
 					nil,
+					nil,
 				)
 				if err != nil {
 					log.Printf("[ERROR] failed to send heartbeat for build %q: %s", build, err)

internal/hcp/registry/types.builds.go

@@ -19,6 +19,7 @@ type Build struct {
 	Labels        map[string]string
 	Artifacts     map[string]packerSDKRegistry.Image
 	Status        hcpPackerModels.HashicorpCloudPacker20230101BuildStatus
+	Metadata      hcpPackerModels.HashicorpCloudPacker20230101BuildMetadata
 }
 
 // NewBuildFromCloudPackerBuild converts a HashicorpCloudPackerBuild to a local build that can be tracked and

internal/hcp/registry/types.version.go

@@ -4,6 +4,7 @@
 package registry
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"math/rand"
@@ -16,6 +17,7 @@ import (
 	sdkpacker "github.com/hashicorp/packer-plugin-sdk/packer"
 	packerSDKRegistry "github.com/hashicorp/packer-plugin-sdk/packer/registry/image"
 	"github.com/hashicorp/packer/internal/hcp/env"
+	"github.com/hashicorp/packer/packer"
 	"github.com/oklog/ulid"
 )
 
@@ -174,3 +176,29 @@ func (version *Version) statusSummary(ui sdkpacker.Ui) {
 
 	ui.Say(buf.String())
 }
+
+// AddMetadataToBuild adds metadata to a build in the HCP Packer registry.
+func (version *Version) AddMetadataToBuild(
+	ctx context.Context, buildName string, metadata packer.BuildMetadata,
+) error {
+	buildToUpdate, err := version.Build(buildName)
+	if err != nil {
+		return err
+	}
+
+	packerMetadata := make(map[string]interface{})
+	packerMetadata["version"] = metadata.PackerVersion
+
+	var pluginsMetadata []map[string]interface{}
+	for _, plugin := range metadata.Plugins {
+		pluginMetadata := map[string]interface{}{
+			"version": plugin.Description.Version,
+			"name":    plugin.Name,
+		}
+		pluginsMetadata = append(pluginsMetadata, pluginMetadata)
+	}
+	packerMetadata["plugins"] = pluginsMetadata
+
+	buildToUpdate.Metadata.Packer = packerMetadata
+	return nil
+}