refactor(plugin): layout and tooling (#20)

- refactor 'internal' folder
- update Makefile targets
- code generation with packer-sdc
- clean up Config type by removing non-config fields
- update CHANGELOG
- added version package (versioning is required by validation tooling)
- fix network_interfaces config

Author: peknur

CHANGELOG.md

@@ -1,6 +1,40 @@
-# Change log
+# Changelog
 
-## 1.0.0
+All notable changes to this project will be documented in this file.
+See updating [Changelog example here](https://keepachangelog.com/en/1.0.0/)
 
-* Upgrade to Packer 1.7.0
-* Copy codebase from https://github.com/UpCloudLtd/upcloud-packer
+## [Unreleased]
+
+### Added
+-  add new template name param 
+
+### Changed
+- update README file
+- update acceptance test to embed HCL2 configs 
+
+### Fixed
+- fix network interface config
+
+## [1.2.0] - 2021-06-17
+
+### Fixed
+
+- fix template prefix usage
+
+## [1.1.0] 2021-05-30
+
+### Changed
+- bump go version to 1.6 to enable darwin/arm build
+- update dependencies
+- update intergration tests
+
+## [1.0.0] 2021-02-19
+
+### Changed
+- Upgrade to Packer 1.7.0
+- Copy codebase from https://github.com/UpCloudLtd/upcloud-packer
+
+[Unreleased]: https://github.com/UpCloudLtd/packer-plugin-upcloud/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/UpCloudLtd/packer-plugin-upcloud/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/UpCloudLtd/packer-plugin-upcloud/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/UpCloudLtd/packer-plugin-upcloud/releases/tag/v1.0.0

Makefile

@@ -1,21 +1,48 @@
+BINARY=packer-plugin-upcloud
+HASHICORP_PACKER_PLUGIN_SDK_VERSION?=$(shell go list -m github.com/hashicorp/packer-plugin-sdk | cut -d " " -f2)
+COUNT?=1
+TEST?=$(shell go list ./...)
+
+ifeq (,$(shell go env GOBIN))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
+
+PACKER_SDC=$(GOBIN)/packer-sdc
+
 default: build
 
 test:
-	go test -v ./...
+	@go test -race -count $(COUNT) $(TEST) -timeout=3m
 
 test_integration: build
-	cp ./packer-plugin-upcloud builder/upcloud/
+	cp $(BINARY) builder/upcloud/
 	PACKER_ACC=1 go test -count 1 -v ./...  -timeout=120m
 
 lint:
 	go vet .
 	golint .
 
 build:
-	go build -v
+	go build -v -o $(BINARY)
 
 install: build
-	mkdir -p ~/.packer.d/plugins
-	install ./packer-plugin-upcloud ~/.packer.d/plugins/
+	@mkdir -p ~/.packer.d/plugins
+	install $(BINARY) ~/.packer.d/plugins/
+
+install-packer-sdc: ## Install packer sofware development command
+	go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@$(HASHICORP_PACKER_PLUGIN_SDK_VERSION)
+
+ci-release-docs: install-packer-sdc
+	@$(PACKER_SDC) renderdocs -src docs -partials docs-partials/ -dst docs/
+	@/bin/sh -c "[ -d docs ] && zip -r docs.zip docs/"
+
+plugin-check: install-packer-sdc build
+	$(PACKER_SDC) plugin-check $(BINARY)
+
+generate: install-packer-sdc
+	@PATH=$(PATH):$(GOBIN) go generate ./...
+	packer-sdc renderdocs -src ./docs -dst ./.docs -partials ./docs-partials
 
 .PHONY: default test test_integration lint build install

builder/upcloud/artifact.go

@@ -4,14 +4,14 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/UpCloudLtd/packer-plugin-upcloud/internal/driver"
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
-	internal "github.com/UpCloudLtd/packer-plugin-upcloud/internal"
 )
 
 // packersdk.Artifact implementation
 type Artifact struct {
 	config    *Config
-	driver    internal.Driver
+	driver    driver.Driver
 	Templates []*upcloud.Storage
 
 	// StateData should store data such as GeneratedData

builder/upcloud/builder.go

@@ -4,13 +4,13 @@ import (
 	"context"
 	"fmt"
 
-	internal "github.com/UpCloudLtd/packer-plugin-upcloud/internal"
+	"github.com/UpCloudLtd/packer-plugin-upcloud/internal/driver"
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"github.com/hashicorp/hcl/v2/hcldec"
 	"github.com/hashicorp/packer-plugin-sdk/communicator"
 	"github.com/hashicorp/packer-plugin-sdk/multistep"
 	"github.com/hashicorp/packer-plugin-sdk/multistep/commonsteps"
-	packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
+	"github.com/hashicorp/packer-plugin-sdk/packer"
 	"github.com/hashicorp/packer-plugin-sdk/packerbuilderdata"
 )
 
@@ -19,7 +19,7 @@ const BuilderId = "upcloud.builder"
 type Builder struct {
 	config Config
 	runner multistep.Runner
-	driver internal.Driver
+	driver driver.Driver
 }
 
 func (b *Builder) ConfigSpec() hcldec.ObjectSpec { return b.config.FlatMapstructure().HCL2Spec() }
@@ -41,9 +41,9 @@ func (b *Builder) Prepare(raws ...interface{}) (generatedVars []string, warnings
 	return buildGeneratedData, nil, nil
 }
 
-func (b *Builder) Run(ctx context.Context, ui packersdk.Ui, hook packersdk.Hook) (packersdk.Artifact, error) {
+func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (packer.Artifact, error) {
 	// Setup the state bag and initial state for the steps
-	b.driver = internal.NewDriver(&internal.DriverConfig{
+	b.driver = driver.NewDriver(&driver.DriverConfig{
 		Username:    b.config.Username,
 		Password:    b.config.Password,
 		Timeout:     b.config.Timeout,
@@ -70,7 +70,7 @@ func (b *Builder) Run(ctx context.Context, ui packersdk.Ui, hook packersdk.Hook)
 		},
 		&communicator.StepConnect{
 			Config:    &b.config.Comm,
-			Host:      internal.SshHostCallback,
+			Host:      sshHostCallback,
 			SSHConfig: b.config.Comm.SSHConfigFunc(),
 		},
 		&commonsteps.StepProvision{},

builder/upcloud/builder_acc_test.go

@@ -11,7 +11,7 @@ import (
 	"strings"
 	"testing"
 
-	internal "github.com/UpCloudLtd/packer-plugin-upcloud/internal"
+	"github.com/UpCloudLtd/packer-plugin-upcloud/internal/driver"
 	"github.com/hashicorp/packer-plugin-sdk/acctest"
 )
 
@@ -202,15 +202,15 @@ func teardown(testName string) func() error {
 			return err
 		}
 
-		driver := internal.NewDriver(&internal.DriverConfig{
+		drv := driver.NewDriver(&driver.DriverConfig{
 			Username: os.Getenv("UPCLOUD_API_USER"),
 			Password: os.Getenv("UPCLOUD_API_PASSWORD"),
 			Timeout:  DefaultTimeout,
 		})
 
 		for _, u := range uuids {
 			fmt.Printf("Cleaning up created templates: %s\n", u)
-			if err := driver.DeleteTemplate(u); err != nil {
+			if err := drv.DeleteTemplate(u); err != nil {
 				return err
 			}
 		}

builder/upcloud/config.go

@@ -1,13 +1,11 @@
+//go:generate packer-sdc mapstructure-to-hcl2 -type Config,NetworkInterface,IPAddress
 package upcloud
 
 import (
 	"errors"
-	"fmt"
-	"io/ioutil"
 	"os"
 	"time"
 
-	internal "github.com/UpCloudLtd/packer-plugin-upcloud/internal"
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud"
 	"github.com/UpCloudLtd/upcloud-go-api/upcloud/request"
 	"github.com/hashicorp/packer-plugin-sdk/common"
@@ -37,6 +35,18 @@ var (
 	}
 )
 
+// for config type convertion
+type NetworkInterface struct {
+	IPAddresses []IPAddress `mapstructure:"ip_addresses"`
+	Type        string      `mapstructure:"type"`
+	Network     string      `mapstructure:"network,omitempty"`
+}
+
+type IPAddress struct {
+	Family  string `mapstructure:"family"`
+	Address string `mapstructure:"address,omitempty"`
+}
+
 type Config struct {
 	common.PackerConfig `mapstructure:",squash"`
 	Comm                communicator.Config `mapstructure:",squash"`
@@ -55,13 +65,10 @@ type Config struct {
 	Timeout        time.Duration `mapstructure:"state_timeout_duration"`
 	CloneZones     []string      `mapstructure:"clone_zones"`
 
-	RawNetworking []internal.NetworkInterface `mapstructure:"network_interfaces"`
-	Networking    []request.CreateServerInterface
+	NetworkInterfaces []NetworkInterface `mapstructure:"network_interfaces"`
 
 	SSHPrivateKeyPath string `mapstructure:"ssh_private_key_path"`
 	SSHPublicKeyPath  string `mapstructure:"ssh_public_key_path"`
-	SSHPrivateKey     []byte
-	SSHPublicKey      []byte
 
 	ctx interpolate.Context
 }
@@ -79,7 +86,7 @@ func (c *Config) Prepare(raws ...interface{}) ([]string, error) {
 	c.setEnv()
 
 	// defaults
-	if c.TemplatePrefix == "" && len(c.TemplateName) == 0{
+	if c.TemplatePrefix == "" && len(c.TemplateName) == 0 {
 		c.TemplatePrefix = DefaultTemplatePrefix
 	}
 
@@ -95,12 +102,6 @@ func (c *Config) Prepare(raws ...interface{}) ([]string, error) {
 		c.Comm.SSHUsername = DefaultSSHUsername
 	}
 
-	if len(c.RawNetworking) == 0 {
-		c.Networking = DefaultNetworking
-	} else {
-		c.Networking = internal.ConvertNetworkTypes(c.RawNetworking)
-	}
-
 	// validate
 	var errs *packer.MultiError
 	if es := c.Comm.Prepare(&c.ctx); len(es) > 0 {
@@ -131,22 +132,6 @@ func (c *Config) Prepare(raws ...interface{}) ([]string, error) {
 		)
 	}
 
-	if c.SSHPrivateKeyPath != "" {
-		c.SSHPrivateKey, err = ioutil.ReadFile(c.SSHPrivateKeyPath)
-		if err != nil {
-			errs = packer.MultiErrorAppend(
-				errs, fmt.Errorf("Failed to read private key: %s", err))
-		}
-	}
-
-	if c.SSHPublicKeyPath != "" {
-		c.SSHPublicKey, err = ioutil.ReadFile(c.SSHPublicKeyPath)
-		if err != nil {
-			errs = packer.MultiErrorAppend(
-				errs, fmt.Errorf("Failed to read public key: %s", err))
-		}
-	}
-
 	if len(c.TemplatePrefix) > 40 {
 		errs = packer.MultiErrorAppend(
 			errs, errors.New("'template_prefix' must be 0-40 characters"),