test: add end to end tests

Author: Codelax

e2e_tests/GNUmakefile

@@ -0,0 +1,11 @@
+build-binary:
+	make -C .. build
+
+link-binary:
+	ln -fs ../packer-plugin-scaleway
+
+test-simple: build-binary link-binary
+	packer build ./simple/build_scaleway.pkr.hcl
+	go run ./simple/test.go
+
+test:

e2e_tests/README.md

@@ -0,0 +1,9 @@
+# End to end tests
+
+This folder contains packer projects with each one go binaries that will check the behavior of the packer plugin.
+
+## Test environment
+
+- Tests should run in an empty project. Tests will check for non deleted resources and a non-empty project will interfere with the checks.
+- 
+

e2e_tests/checks/image.go

@@ -0,0 +1,67 @@
+package checks
+
+import (
+	"context"
+	"e2e_tests/tester"
+	"fmt"
+
+	"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+var _ tester.PackerCheck = (*ImageCheck)(nil)
+
+func Image(zone scw.Zone, name string) *ImageCheck {
+	return &ImageCheck{
+		zone:      zone,
+		imageName: name,
+	}
+}
+
+type ImageCheck struct {
+	zone      scw.Zone
+	imageName string
+
+	rootVolumeType *string
+}
+
+func (c *ImageCheck) RootVolumeType(rootVolumeType string) *ImageCheck {
+	c.rootVolumeType = &rootVolumeType
+
+	return c
+}
+
+func (c *ImageCheck) Check(ctx context.Context) error {
+	testCtx := tester.ExtractCtx(ctx)
+	api := instance.NewAPI(testCtx.ScwClient)
+
+	resp, err := api.ListImages(&instance.ListImagesRequest{
+		Name: &c.imageName,
+		Zone: c.zone,
+	}, scw.WithAllPages(), scw.WithContext(ctx))
+	if err != nil {
+		return fmt.Errorf("failed to list images: %w", err)
+	}
+
+	if len(resp.Images) == 0 {
+		return fmt.Errorf("image %s not found", c.imageName)
+	}
+
+	if len(resp.Images) > 1 {
+		return fmt.Errorf("multiple images found with name %s", c.imageName)
+	}
+
+	image := resp.Images[0]
+
+	if image.Name != c.imageName {
+		return fmt.Errorf("image name %s does not match expected %s", image.Name, c.imageName)
+	}
+
+	if c.rootVolumeType != nil {
+		if string(image.RootVolume.VolumeType) != *c.rootVolumeType {
+			return fmt.Errorf("image root volume type %s does not match expected %s", image.RootVolume.VolumeType, *c.rootVolumeType)
+		}
+	}
+
+	return nil
+}

e2e_tests/checks/volume.go

@@ -0,0 +1,54 @@
+package checks
+
+import (
+	"context"
+	"e2e_tests/tester"
+	"fmt"
+
+	block "github.com/scaleway/scaleway-sdk-go/api/block/v1alpha1"
+	"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+var _ tester.PackerCheck = (*NoVolumesCheck)(nil)
+
+type NoVolumesCheck struct {
+	zone scw.Zone
+}
+
+func (c *NoVolumesCheck) Check(ctx context.Context) error {
+	testCtx := tester.ExtractCtx(ctx)
+	instanceAPI := instance.NewAPI(testCtx.ScwClient)
+	blockAPI := block.NewAPI(testCtx.ScwClient)
+
+	resp, err := instanceAPI.ListVolumes(&instance.ListVolumesRequest{
+		Zone: c.zone,
+	}, scw.WithContext(ctx))
+	if err != nil {
+		return fmt.Errorf("failed to list instance volumes: %w", err)
+	}
+
+	if len(resp.Volumes) != 0 {
+		return fmt.Errorf("expected 0 instance volumes, got %d", len(resp.Volumes))
+	}
+
+	blockResp, err := blockAPI.ListVolumes(&block.ListVolumesRequest{
+		Zone: c.zone,
+	}, scw.WithContext(ctx))
+	if err != nil {
+		return fmt.Errorf("failed to list block volumes: %w", err)
+	}
+
+	if len(blockResp.Volumes) != 0 {
+		return fmt.Errorf("expected 0 block volumes, got %d", len(blockResp.Volumes))
+	}
+
+	return nil
+}
+
+// NoVolume checks that the current project does not contain any volume, block or instance.
+func NoVolume(zone scw.Zone) *NoVolumesCheck {
+	return &NoVolumesCheck{
+		zone: zone,
+	}
+}

e2e_tests/go.mod

@@ -0,0 +1,7 @@
+module e2e_tests
+
+go 1.23.4
+
+require github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30
+
+require gopkg.in/yaml.v2 v2.4.0 // indirect

e2e_tests/go.sum

@@ -0,0 +1,6 @@
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30 h1:yoKAVkEVwAqbGbR8n87rHQ1dulL25rKloGadb3vm770=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30/go.mod h1:sH0u6fq6x4R5M7WxkoQFY/o7UaiItec0o1LinLCJNq8=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

e2e_tests/simple/build_scaleway.pkr.hcl

@@ -0,0 +1,17 @@
+packer {
+  required_plugins {
+  }
+}
+
+source "scaleway" "basic" {
+  commercial_type = "PRO2-XXS"
+  zone = "fr-par-1"
+  image = "ubuntu_jammy"
+  image_name = "temp-build-packer"
+  ssh_username = "root"
+  remove_volume = true
+}
+
+build {
+  sources = ["source.scaleway.basic"]
+}

e2e_tests/simple/test.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"context"
+	"e2e_tests/checks"
+	"e2e_tests/tester"
+
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+func main() {
+	zone := scw.ZoneFrPar1
+
+	tester.Run(context.Background(),
+		checks.Image(zone, "temp-build-packer").
+			RootVolumeType("unified"),
+		checks.NoVolume(zone),
+	)
+}

e2e_tests/tester/checks.go

@@ -0,0 +1,10 @@
+package tester
+
+import (
+	"context"
+)
+
+// PackerCheck represents a check for a scaleway resource
+type PackerCheck interface {
+	Check(ctx context.Context) error
+}

e2e_tests/tester/tester.go

@@ -0,0 +1,56 @@
+package tester
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+const PackerCtxKey = "PACKER_CTX_KEY"
+
+type PackerCtx struct {
+	ScwClient *scw.Client
+}
+
+func NewContext(ctx context.Context) (context.Context, error) {
+	cfg, err := scw.LoadConfig()
+	if err != nil {
+		return nil, err
+	}
+	activeProfile, err := cfg.GetActiveProfile()
+	if err != nil {
+		return nil, err
+	}
+
+	profile := scw.MergeProfiles(activeProfile, scw.LoadEnvProfile())
+	client, err := scw.NewClient(scw.WithProfile(profile))
+	if err != nil {
+		return nil, err
+	}
+	return context.WithValue(ctx, PackerCtxKey, &PackerCtx{client}), nil
+}
+
+func ExtractCtx(ctx context.Context) *PackerCtx {
+	return ctx.Value(PackerCtxKey).(*PackerCtx)
+}
+
+func Run(ctx context.Context, packerChecks ...PackerCheck) {
+	log.Println("Running tests...")
+	ctx, err := NewContext(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	for i, check := range packerChecks {
+		log.Println("Running test", i)
+		err := check.Check(ctx)
+		if err != nil {
+			log.Fatalln(fmt.Sprintf("Packer check %d failed:", i), err)
+		}
+	}
+
+	os.Exit(0)
+}