Add fmt/lint targets and check on ci.

.github/workflows/build-test.yml

@@ -0,0 +1,29 @@
+name: build & test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: "go.mod"
+      - name: build
+        run: make build
+      - name: lint
+        run: make lint
+      - name: generate
+        run: |
+          make generate
+          if ! git diff --exit-code; then
+            echo 'Generated files are out of date. Run `make generate` and commit the result.'
+            exit 1
+          fi

.gitignore

@@ -1,3 +1,6 @@
+# Go dependencies.
+vendor/
+
 # Build artifacts.
 main
 packer-plugin-oxide

.golangci.yml

@@ -0,0 +1,18 @@
+version: "2"
+
+linters:
+  default: standard
+  disable:
+    - errcheck
+
+formatters:
+  enable:
+    - goimports
+    - golines
+  settings:
+    golines:
+      max-len: 100
+      shorten-comments: true
+
+run:
+  timeout: 5m

.web-docs/README.md

@@ -30,10 +30,9 @@ packer plugins install github.com/oxidecomputer/oxide
 [`oxide-instance`](/packer/integrations/oxidecomputer/oxide/latest/components/builder/instance)
 <!-- Code generated from the comments of the Builder struct in component/builder/instance/builder.go; DO NOT EDIT MANUALLY -->
 
-The `oxide-instance` builder creates custom images for use with
-[Oxide](https://oxide.computer). The builder launches a temporary instance
-from an existing source image, connects to the instance using its external
-IP, provisions the instance, and then creates a new image from the instance's
+The `oxide-instance` builder creates custom images for use with [Oxide](https://oxide.computer).
+The builder launches a temporary instance from an existing source image, connects to the instance
+using its external IP, provisions the instance, and then creates a new image from the instance's
 boot disk. The resulting image can be used to launch new instances on Oxide.
 
 The builder does not manage images. Once it creates an image, it is up to you
@@ -47,9 +46,8 @@ to use it or delete it.
 [`oxide-image`](/packer/integrations/oxidecomputer/oxide/latest/components/data-source/image)
 <!-- Code generated from the comments of the Datasource struct in component/data-source/image/data_source.go; DO NOT EDIT MANUALLY -->
 
-The `oxide-image` data source fetches [Oxide](https://oxide.computer) image
-information for use in a Packer build. The image can be a project image or
-silo image.
+The `oxide-image` data source fetches [Oxide](https://oxide.computer) image information for use
+in a Packer build. The image can be a project image or silo image.
 
 <!-- End of code generated from the comments of the Datasource struct in component/data-source/image/data_source.go; -->
 

.web-docs/components/builder/instance/README.md

@@ -2,10 +2,9 @@ Type: `oxide-instance`
 
 <!-- Code generated from the comments of the Builder struct in component/builder/instance/builder.go; DO NOT EDIT MANUALLY -->
 
-The `oxide-instance` builder creates custom images for use with
-[Oxide](https://oxide.computer). The builder launches a temporary instance
-from an existing source image, connects to the instance using its external
-IP, provisions the instance, and then creates a new image from the instance's
+The `oxide-instance` builder creates custom images for use with [Oxide](https://oxide.computer).
+The builder launches a temporary instance from an existing source image, connects to the instance
+using its external IP, provisions the instance, and then creates a new image from the instance's
 boot disk. The resulting image can be used to launch new instances on Oxide.
 
 The builder does not manage images. Once it creates an image, it is up to you
@@ -18,8 +17,7 @@ to use it or delete it.
 
 <!-- Code generated from the comments of the Config struct in component/builder/instance/config.go; DO NOT EDIT MANUALLY -->
 
-The configuration arguments for the builder. Arguments can either be required
-or optional.
+The configuration arguments for the builder. Arguments can either be required or optional.
 
 <!-- End of code generated from the comments of the Config struct in component/builder/instance/config.go; -->
 

.web-docs/components/data-source/image/README.md

@@ -2,9 +2,8 @@ Type: `oxide-image`
 
 <!-- Code generated from the comments of the Datasource struct in component/data-source/image/data_source.go; DO NOT EDIT MANUALLY -->
 
-The `oxide-image` data source fetches [Oxide](https://oxide.computer) image
-information for use in a Packer build. The image can be a project image or
-silo image.
+The `oxide-image` data source fetches [Oxide](https://oxide.computer) image information for use
+in a Packer build. The image can be a project image or silo image.
 
 <!-- End of code generated from the comments of the Datasource struct in component/data-source/image/data_source.go; -->
 
@@ -13,8 +12,7 @@ silo image.
 
 <!-- Code generated from the comments of the Config struct in component/data-source/image/config.go; DO NOT EDIT MANUALLY -->
 
-The configuration arguments for the data source. Arguments can either be
-required or optional.
+The configuration arguments for the data source. Arguments can either be required or optional.
 
 <!-- End of code generated from the comments of the Config struct in component/data-source/image/config.go; -->
 

Makefile

@@ -38,6 +38,14 @@ generate: install-packer-sdc
 test:
 	go test -race -count $(TEST_COUNT) $(TEST_PACKAGES) -timeout=3m
 
+.PHONY: fmt
+fmt:
+	@ go tool -modfile=tools/go.mod golangci-lint fmt
+
+.PHONY: lint
+lint:
+	@ go tool -modfile=tools/go.mod golangci-lint run
+
 .PHONY: testacc
 testacc: dev
 	PACKER_ACC=1 OXIDE_PROJECT=$(OXIDE_PROJECT) OXIDE_BOOT_DISK_IMAGE_NAME=$(OXIDE_BOOT_DISK_IMAGE_NAME) go test -count $(TEST_COUNT) -v $(TEST_PACKAGES) -timeout=120m

component/builder/instance/builder.go

@@ -22,10 +22,9 @@ const BuilderID = "oxide.instance"
 
 var _ packer.Builder = (*Builder)(nil)
 
-// The `oxide-instance` builder creates custom images for use with
-// [Oxide](https://oxide.computer). The builder launches a temporary instance
-// from an existing source image, connects to the instance using its external
-// IP, provisions the instance, and then creates a new image from the instance's
+// The `oxide-instance` builder creates custom images for use with [Oxide](https://oxide.computer).
+// The builder launches a temporary instance from an existing source image, connects to the instance
+// using its external IP, provisions the instance, and then creates a new image from the instance's
 // boot disk. The resulting image can be used to launch new instances on Oxide.
 //
 // The builder does not manage images. Once it creates an image, it is up to you
@@ -51,7 +50,11 @@ func (b *Builder) Prepare(args ...any) ([]string, []string, error) {
 }
 
 // Run executes the builder steps to create an Oxide image.
-func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (packer.Artifact, error) {
+func (b *Builder) Run(
+	ctx context.Context,
+	ui packer.Ui,
+	hook packer.Hook,
+) (packer.Artifact, error) {
 	opts := make([]oxide.ClientOption, 0)
 	if b.config.Host != "" {
 		opts = append(opts, oxide.WithHost(b.config.Host))
@@ -79,7 +82,7 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 		&stepImageView{},
 		multistep.If(genTempSSHKeyPair, &communicator.StepSSHKeyGen{
 			CommConf:            &b.config.Comm,
-			SSHTemporaryKeyPair: b.config.Comm.SSH.SSHTemporaryKeyPair,
+			SSHTemporaryKeyPair: b.config.Comm.SSHTemporaryKeyPair,
 		}),
 		multistep.If(genTempSSHKeyPair, &stepSSHKeyCreate{}),
 		&stepInstanceCreate{},

component/builder/instance/builder_test.go

@@ -8,7 +8,6 @@ import (
 	"embed"
 	"errors"
 	"fmt"
-	"io"
 	"os"
 	"os/exec"
 	"regexp"
@@ -241,7 +240,10 @@ func TestAccBuilder_Instance(t *testing.T) {
 						Image:   oxide.NameOrId(artifactName),
 						Project: oxide.NameOrId(oxideProject),
 					}); err != nil {
-						joinedError = errors.Join(joinedError, fmt.Errorf("failed deleting oxide image %s: %v", artifactName, err))
+						joinedError = errors.Join(
+							joinedError,
+							fmt.Errorf("failed deleting oxide image %s: %v", artifactName, err),
+						)
 					}
 
 					if joinedError != nil {
@@ -267,13 +269,7 @@ func TestAccBuilder_Instance(t *testing.T) {
 }
 
 func assertFileContains(t *testing.T, filename string, expected string) {
-	f, err := os.Open(filename)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer f.Close()
-
-	b, err := io.ReadAll(f)
+	b, err := os.ReadFile(filename)
 	if err != nil {
 		t.Fatal(err)
 	}

component/builder/instance/config.go

@@ -19,8 +19,7 @@ import (
 	"github.com/mitchellh/mapstructure"
 )
 
-// The configuration arguments for the builder. Arguments can either be required
-// or optional.
+// The configuration arguments for the builder. Arguments can either be required or optional.
 type Config struct {
 	common.PackerConfig `mapstructure:",squash"`
 
@@ -118,7 +117,10 @@ func (c *Config) Prepare(args ...any) ([]string, error) {
 		if c.Name == "" {
 			name, err := interpolate.Render("packer-{{timestamp}}", nil)
 			if err != nil {
-				return nil, fmt.Errorf("failed rendering default name, this bug should be reported: %w", err)
+				return nil, fmt.Errorf(
+					"failed rendering default name, this bug should be reported: %w",
+					err,
+				)
 			}
 
 			c.Name = name
@@ -127,7 +129,10 @@ func (c *Config) Prepare(args ...any) ([]string, error) {
 		if c.Hostname == "" {
 			hostname, err := interpolate.Render("packer-{{timestamp}}", nil)
 			if err != nil {
-				return nil, fmt.Errorf("failed rendering default hostname, this bug should be reported: %w", err)
+				return nil, fmt.Errorf(
+					"failed rendering default hostname, this bug should be reported: %w",
+					err,
+				)
 			}
 
 			c.Hostname = hostname
@@ -165,7 +170,10 @@ func (c *Config) Prepare(args ...any) ([]string, error) {
 		if c.Comm.SSHTemporaryKeyPairName == "" {
 			sshTemporaryKeyPairName, err := interpolate.Render("packer-{{timestamp}}", nil)
 			if err != nil {
-				return nil, fmt.Errorf("failed rendering default ssh temporary key pair name, this bug should be reported: %w", err)
+				return nil, fmt.Errorf(
+					"failed rendering default ssh temporary key pair name, this bug should be reported: %w",
+					err,
+				)
 			}
 
 			c.Comm.SSHTemporaryKeyPairName = sshTemporaryKeyPairName
@@ -178,7 +186,10 @@ func (c *Config) Prepare(args ...any) ([]string, error) {
 		}
 
 		if c.BootDiskImageID == "" {
-			multiErr = packer.MultiErrorAppend(multiErr, errors.New("boot_disk_image_id is required"))
+			multiErr = packer.MultiErrorAppend(
+				multiErr,
+				errors.New("boot_disk_image_id is required"),
+			)
 		}
 
 		if multiErr != nil && len(multiErr.Errors) > 0 {

component/builder/instance/step_image_create.go

@@ -18,7 +18,10 @@ var _ multistep.Step = (*stepImageCreate)(nil)
 type stepImageCreate struct{}
 
 // Run creates an Oxide image and stores its information in stateBag.
-func (s *stepImageCreate) Run(ctx context.Context, stateBag multistep.StateBag) multistep.StepAction {
+func (s *stepImageCreate) Run(
+	ctx context.Context,
+	stateBag multistep.StateBag,
+) multistep.StepAction {
 	oxideClient := stateBag.Get("client").(*oxide.Client)
 	ui := stateBag.Get("ui").(packer.Ui)
 	config := stateBag.Get("config").(*Config)

component/builder/instance/step_instance_create.go

@@ -20,7 +20,10 @@ var _ multistep.Step = (*stepInstanceCreate)(nil)
 type stepInstanceCreate struct{}
 
 // Run creates an Oxide instance and stores its information in stateBag.
-func (o *stepInstanceCreate) Run(ctx context.Context, stateBag multistep.StateBag) multistep.StepAction {
+func (o *stepInstanceCreate) Run(
+	ctx context.Context,
+	stateBag multistep.StateBag,
+) multistep.StepAction {
 	oxideClient := stateBag.Get("client").(*oxide.Client)
 	ui := stateBag.Get("ui").(packer.Ui)
 	config := stateBag.Get("config").(*Config)
@@ -159,7 +162,10 @@ func (o *stepInstanceCreate) Cleanup(stateBag multistep.StateBag) {
 
 		ui.Sayf("Checking if Oxide instance is stopped: %s", instanceID)
 
-		instanceStopCtx, instanceStopCtxCancel := context.WithTimeout(context.TODO(), 30*time.Second)
+		instanceStopCtx, instanceStopCtxCancel := context.WithTimeout(
+			context.TODO(),
+			30*time.Second,
+		)
 		defer instanceStopCtxCancel()
 
 		instance, err := oxideClient.InstanceView(instanceStopCtx, oxide.InstanceViewParams{
@@ -179,7 +185,10 @@ func (o *stepInstanceCreate) Cleanup(stateBag multistep.StateBag) {
 		if _, err := oxideClient.InstanceStop(instanceStopCtx, oxide.InstanceStopParams{
 			Instance: oxide.NameOrId(instanceID),
 		}); err != nil {
-			ui.Errorf("Failed stopping Oxide instance during cleanup. Please delete it manually: %v", err)
+			ui.Errorf(
+				"Failed stopping Oxide instance during cleanup. Please delete it manually: %v",
+				err,
+			)
 			return
 		}
 
@@ -204,20 +213,31 @@ func (o *stepInstanceCreate) Cleanup(stateBag multistep.StateBag) {
 				break
 			}
 
-			ui.Say(fmt.Sprintf("Waiting for instance to stop. Instance is currently %s.", instance.RunState))
+			ui.Say(
+				fmt.Sprintf(
+					"Waiting for instance to stop. Instance is currently %s.",
+					instance.RunState,
+				),
+			)
 			time.Sleep(3 * time.Second)
 		}
 
 	deleteInstance:
 		ui.Sayf("Deleting Oxide instance: %s", instanceID)
 
-		instanceDeleteCtx, instanceDeleteCtxCancel := context.WithTimeout(context.TODO(), 30*time.Second)
+		instanceDeleteCtx, instanceDeleteCtxCancel := context.WithTimeout(
+			context.TODO(),
+			30*time.Second,
+		)
 		defer instanceDeleteCtxCancel()
 
 		if err := oxideClient.InstanceDelete(instanceDeleteCtx, oxide.InstanceDeleteParams{
 			Instance: oxide.NameOrId(instanceID),
 		}); err != nil {
-			ui.Errorf("Failed deleting Oxide instance during cleanup. Please delete it manually: %v", err)
+			ui.Errorf(
+				"Failed deleting Oxide instance during cleanup. Please delete it manually: %v",
+				err,
+			)
 			return
 		}
 	}
@@ -233,7 +253,10 @@ func (o *stepInstanceCreate) Cleanup(stateBag multistep.StateBag) {
 		if err := oxideClient.DiskDelete(diskDeleteCtx, oxide.DiskDeleteParams{
 			Disk: oxide.NameOrId(bootDiskID),
 		}); err != nil {
-			ui.Errorf("Failed deleting Oxide disk during cleanup. Please delete it manually: %v", err)
+			ui.Errorf(
+				"Failed deleting Oxide disk during cleanup. Please delete it manually: %v",
+				err,
+			)
 			return
 		}
 	}

component/builder/instance/step_instance_external_ip_list.go

@@ -20,7 +20,10 @@ type stepInstanceExternalIPList struct{}
 
 // Run lists the external IP addresses for an Oxide instance and stores its
 // information in stateBag.
-func (s *stepInstanceExternalIPList) Run(ctx context.Context, stateBag multistep.StateBag) multistep.StepAction {
+func (s *stepInstanceExternalIPList) Run(
+	ctx context.Context,
+	stateBag multistep.StateBag,
+) multistep.StepAction {
 	oxideClient := stateBag.Get("client").(*oxide.Client)
 	ui := stateBag.Get("ui").(packer.Ui)
 
@@ -52,7 +55,9 @@ func (s *stepInstanceExternalIPList) Run(ctx context.Context, stateBag multistep
 	}
 
 	if len(validExternalIPs) == 0 {
-		ui.Error("Instance does not have any valid external IPs. Packer will be unable to connect to this instance.")
+		ui.Error(
+			"Instance does not have any valid external IPs. Packer will be unable to connect to this instance.",
+		)
 		return multistep.ActionHalt
 	}