feat: make variant in pkg.yaml explicit

smira · smira · commit 4a79aebb1095 · 2025-01-31T19:49:02.000+04:00
Fixes #183 Note: this is a breaking change. Also highlight alpine variant in the graph. Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
diff --git a/internal/pkg/integration/testdata/arch-amd64/final/pkg.yaml b/internal/pkg/integration/testdata/arch-amd64/final/pkg.yaml
@@ -1,5 +1,6 @@
 ---
 name: final
+variant: alpine
 dependencies:
   # this arm64 variant of the image  only contains the u-boot binary,
   # so this is a good test to ensure that we can copy the binary from
diff --git a/internal/pkg/integration/testdata/arch-arm64/final/pkg.yaml b/internal/pkg/integration/testdata/arch-arm64/final/pkg.yaml
@@ -1,5 +1,6 @@
 ---
 name: final
+variant: alpine
 steps:
 - test:
     - test "${BUILD:-x}" = "aarch64-linux-musl"
diff --git a/internal/pkg/integration/testdata/cache/check-cache/pkg.yaml b/internal/pkg/integration/testdata/cache/check-cache/pkg.yaml
@@ -1,4 +1,5 @@
 name: check-cache
+variant: alpine
 dependencies:
   - stage: fill-cache
 steps:
diff --git a/internal/pkg/integration/testdata/cache/fill-cache/pkg.yaml b/internal/pkg/integration/testdata/cache/fill-cache/pkg.yaml
@@ -1,4 +1,5 @@
 name: fill-cache
+variant: alpine
 steps:
 - cachePaths:
     - /.cache
diff --git a/internal/pkg/integration/testdata/platform-override/final/pkg.yaml b/internal/pkg/integration/testdata/platform-override/final/pkg.yaml
@@ -1,5 +1,6 @@
 ---
 name: final
+variant: scratch
 dependencies:
   - stage: onlyarm
     platform: linux/arm64
diff --git a/internal/pkg/integration/testdata/platform-override/onlyarm/pkg.yaml b/internal/pkg/integration/testdata/platform-override/onlyarm/pkg.yaml
@@ -1,5 +1,6 @@
 ---
 name: onlyarm
+variant: alpine
 steps:
 - test:
     - test "${BUILD:-x}" = "aarch64-linux-musl"
diff --git a/internal/pkg/integration/testdata/simple/go/pkg.yaml b/internal/pkg/integration/testdata/simple/go/pkg.yaml
@@ -1,4 +1,5 @@
 name: go
+variant: alpine
 steps:
 - sources:
   - url: https://dl.google.com/go/go1.12.5.src.tar.gz
diff --git a/internal/pkg/integration/testdata/stages/final/pkg.yaml b/internal/pkg/integration/testdata/stages/final/pkg.yaml
@@ -1,4 +1,5 @@
 name: final
+variant: alpine
 dependencies:
 - stage: stage-a
 - stage: stage-b
diff --git a/internal/pkg/integration/testdata/stages/stage-a/pkg.yaml b/internal/pkg/integration/testdata/stages/stage-a/pkg.yaml
@@ -1,4 +1,5 @@
 name: stage-a
+variant: alpine
 steps:
 - prepare:
     - mkdir -p /root
diff --git a/internal/pkg/integration/testdata/stages/stage-b/pkg.yaml b/internal/pkg/integration/testdata/stages/stage-b/pkg.yaml
@@ -1,4 +1,5 @@
 name: stage-b
+variant: alpine
 steps:
 - prepare:
     - mkdir -p /root
diff --git a/internal/pkg/integration/testdata/stages/stage-d/stage-c/pkg.yaml b/internal/pkg/integration/testdata/stages/stage-d/stage-c/pkg.yaml
@@ -1,4 +1,5 @@
 name: stage-c
+variant: alpine
 steps:
 - prepare:
     - mkdir -p /root
diff --git a/internal/pkg/integration/testdata/stages/stage-d/stage-d/pkg.yaml b/internal/pkg/integration/testdata/stages/stage-d/stage-d/pkg.yaml
@@ -1,4 +1,5 @@
 name: stage-d
+variant: alpine
 dependencies:
 - stage: stage-c
 steps:
diff --git a/internal/pkg/integration/testdata/variables/final/pkg.yaml b/internal/pkg/integration/testdata/variables/final/pkg.yaml
@@ -1,4 +1,5 @@
 name: final
+variant: alpine
 dependencies:
   - stage: global-vars
   - stage: std-vars
diff --git a/internal/pkg/integration/testdata/variables/global-vars/pkg.yaml b/internal/pkg/integration/testdata/variables/global-vars/pkg.yaml
@@ -1,4 +1,5 @@
 name: global-vars
+variant: alpine
 steps:
 - prepare:
     - mkdir -p /root
diff --git a/internal/pkg/integration/testdata/variables/local-vars/pkg.yaml b/internal/pkg/integration/testdata/variables/local-vars/pkg.yaml
@@ -1,4 +1,5 @@
 name: local-vars
+variant: alpine
 steps:
 - prepare:
     - mkdir -p /root
diff --git a/internal/pkg/integration/testdata/variables/override/pkg.yaml b/internal/pkg/integration/testdata/variables/override/pkg.yaml
@@ -1,4 +1,5 @@
 name: override
+variant: alpine
 steps:
 - prepare:
     - mkdir -p /root
diff --git a/internal/pkg/integration/testdata/variables/std-vars/pkg.yaml b/internal/pkg/integration/testdata/variables/std-vars/pkg.yaml
@@ -1,4 +1,5 @@
 name: std-vars
+variant: alpine
 steps:
 -
   prepare:
diff --git a/internal/pkg/integration/testdata/variables/vars-yaml/inner/pkg.yaml b/internal/pkg/integration/testdata/variables/vars-yaml/inner/pkg.yaml
@@ -1,4 +1,5 @@
 name: vars-yaml-inner
+variant: alpine
 steps:
 -
   prepare:
diff --git a/internal/pkg/integration/testdata/variables/vars-yaml/pkg.yaml b/internal/pkg/integration/testdata/variables/vars-yaml/pkg.yaml
@@ -1,4 +1,5 @@
 name: vars-yaml-0
+variant: alpine
 dependencies:
   - stage: vars-yaml-inner
     from: /result
diff --git a/internal/pkg/solver/graph.go b/internal/pkg/solver/graph.go
@@ -6,6 +6,7 @@ package solver
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/emicklei/dot"
 
@@ -41,7 +42,11 @@ func (node *PackageNode) DumpDot(g *dot.Graph) dot.Node {
 		if dep.IsInternal() {
 			depNode = g.Node(dep.Stage)
 		} else {
-			depNode = g.Node(dep.Image)
+			imageRef := dep.Image
+			// cut the digest
+			imageRef, _, _ = strings.Cut(imageRef, "@")
+
+			depNode = g.Node(imageRef)
 			depNode.Box()
 			depNode.Attr("fillcolor", "lemonchiffon")
 			depNode.Attr("style", "filled")
@@ -55,6 +60,15 @@ func (node *PackageNode) DumpDot(g *dot.Graph) dot.Node {
 		}
 	}
 
+	if node.Pkg.Variant == v1alpha2.Alpine {
+		packageNode := g.Node("alpine")
+		packageNode.Box()
+		packageNode.Attr("fillcolor", "aquamarine")
+		packageNode.Attr("style", "filled")
+
+		packageNode.Edge(n)
+	}
+
 	for _, dep := range node.Pkg.Install {
 		packageNode := g.Node("Alpine: " + dep)
 		packageNode.Box()
diff --git a/internal/pkg/types/v1alpha2/pkg.go b/internal/pkg/types/v1alpha2/pkg.go
@@ -37,7 +37,6 @@ func NewPkg(baseDir, fileName string, contents []byte, vars types.Variables) (*P
 		BaseDir:  baseDir,
 		FileName: fileName,
 		Shell:    "/bin/sh",
-		Variant:  Alpine,
 		Context:  vars.Copy(),
 	}
 
@@ -72,6 +71,10 @@ func (p *Pkg) Validate() error {
 		multiErr = multierror.Append(multiErr, errors.New("package name can't be empty"))
 	}
 
+	if p.Variant == Unset {
+		multiErr = multierror.Append(multiErr, errors.New("variant should be set"))
+	}
+
 	if len(p.Steps) > 0 && len(p.Finalize) == 0 {
 		multiErr = multierror.Append(multiErr, errors.New("finalize steps are missing, this is going to lead to empty build"))
 	}
diff --git a/internal/pkg/types/v1alpha2/variant.go b/internal/pkg/types/v1alpha2/variant.go
@@ -12,14 +12,16 @@ import "fmt"
 type Variant int
 
 const (
+	// Unset is a variant that is not set.
+	Unset Variant = iota
 	// Alpine variant uses Alpine as base image for the build.
-	Alpine Variant = iota
+	Alpine
 	// Scratch variant uses scratch image as base image for the build.
 	Scratch
 )
 
 func (v Variant) String() string {
-	return []string{"alpine", "scratch"}[v]
+	return []string{"unset", "alpine", "scratch"}[v]
 }
 
 // UnmarshalYAML implements yaml.Unmarshaller interface.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: check-cache`
	`2`	`+variant: alpine`
`2`	`3`	`dependencies:`
`3`	`4`	`- stage: fill-cache`
`4`	`5`	`steps:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: fill-cache`
	`2`	`+variant: alpine`
`2`	`3`	`steps:`
`3`	`4`	`- cachePaths:`
`4`	`5`	`- /.cache`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: go`
	`2`	`+variant: alpine`
`2`	`3`	`steps:`
`3`	`4`	`- sources:`
`4`	`5`	`- url: https://dl.google.com/go/go1.12.5.src.tar.gz`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: final`
	`2`	`+variant: alpine`
`2`	`3`	`dependencies:`
`3`	`4`	`- stage: stage-a`
`4`	`5`	`- stage: stage-b`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: stage-a`
	`2`	`+variant: alpine`
`2`	`3`	`steps:`
`3`	`4`	`- prepare:`
`4`	`5`	`- mkdir -p /root`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`name: stage-b`
	`2`	`+variant: alpine`
`2`	`3`	`steps:`
`3`	`4`	`- prepare:`
`4`	`5`	`- mkdir -p /root`