feat: add validate-release debug command

cmd/chisel/cmd_debug_validate_release.go

@@ -0,0 +1,46 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/jessevdk/go-flags"
+)
+
+var (
+	shortValidateReleaseHelp = "Validate a Chisel release"
+	longValidateReleaseHelp  = `
+The validate-release command performs the static validation of a Chisel
+release, checking the slice definition files (SDFs) and the chisel.yaml
+file for structural issues without downloading any package.
+
+By default it fetches the slices for the same Ubuntu version as the
+current host, unless the --release flag is used. Pointing --release to a
+local directory avoids any network access.
+`
+)
+
+var validateReleaseDescs = map[string]string{
+	"release": "Chisel release name or directory (e.g. ubuntu-22.04)",
+}
+
+type cmdDebugValidateRelease struct {
+	Release string `long:"release" value-name:"<branch|dir>"`
+}
+
+func init() {
+	addDebugCommand("validate-release", shortValidateReleaseHelp, longValidateReleaseHelp, func() flags.Commander { return &cmdDebugValidateRelease{} }, validateReleaseDescs, nil)
+}
+
+func (cmd *cmdDebugValidateRelease) Execute(args []string) error {
+	if len(args) > 0 {
+		return ErrExtraArgs
+	}
+
+	_, err := obtainRelease(cmd.Release)
+	if err != nil {
+		return err
+	}
+
+	fmt.Fprintln(Stdout, "Release is valid")
+	return nil
+}

cmd/chisel/cmd_debug_validate_release_test.go

@@ -0,0 +1,93 @@
+package main_test
+
+import (
+	"os"
+	"path/filepath"
+
+	. "gopkg.in/check.v1"
+
+	chisel "github.com/canonical/chisel/cmd/chisel"
+	"github.com/canonical/chisel/internal/testutil"
+)
+
+// writeRelease writes the provided release files into a temporary directory
+// and returns its path.
+func writeRelease(c *C, files map[string]string) string {
+	dir := c.MkDir()
+	for path, data := range files {
+		fpath := filepath.Join(dir, path)
+		err := os.MkdirAll(filepath.Dir(fpath), 0o755)
+		c.Assert(err, IsNil)
+		err = os.WriteFile(fpath, testutil.Reindent(data), 0o644)
+		c.Assert(err, IsNil)
+	}
+	err := os.MkdirAll(filepath.Join(dir, "slices"), 0o755)
+	c.Assert(err, IsNil)
+	return dir
+}
+
+func (s *ChiselSuite) TestValidateReleaseSuccess(c *C) {
+	s.ResetStdStreams()
+
+	dir := writeRelease(c, map[string]string{
+		"chisel.yaml": testutil.DefaultChiselYaml,
+		"slices/mydir/pkg-a.yaml": `
+			package: pkg-a
+			slices:
+				myslice:
+					contents:
+						/file/path:
+		`,
+	})
+	_, err := chisel.Parser().ParseArgs(
+		[]string{"debug", "validate-release", "--release", dir},
+	)
+	c.Assert(err, IsNil)
+	c.Assert(s.Stdout(), Equals, "Release is valid\n")
+}
+
+func (s *ChiselSuite) TestValidateReleaseErrorPropagation(c *C) {
+	s.ResetStdStreams()
+
+	dir := writeRelease(c, map[string]string{
+		"chisel.yaml": testutil.DefaultChiselYaml,
+		"slices/mydir/pkg-a.yaml": `
+			package: pkg-a
+			slices:
+				myslice:
+					contents:
+						/path1:
+		`,
+		"slices/mydir/pkg-b.yaml": `
+			package: pkg-b
+			slices:
+				myslice:
+					contents:
+						/path1:
+		`,
+	})
+	_, err := chisel.Parser().ParseArgs(
+		[]string{"debug", "validate-release", "--release", dir},
+	)
+	c.Assert(err, ErrorMatches, `slices pkg-a_myslice and pkg-b_myslice conflict on /path1`)
+	c.Assert(s.Stdout(), Equals, "")
+}
+
+func (s *ChiselSuite) TestValidateReleaseExtraArgs(c *C) {
+	s.ResetStdStreams()
+
+	dir := writeRelease(c, map[string]string{
+		"chisel.yaml": testutil.DefaultChiselYaml,
+		"slices/mydir/pkg-a.yaml": `
+			package: pkg-a
+			slices:
+				myslice:
+					contents:
+						/file/path:
+		`,
+	})
+	_, err := chisel.Parser().ParseArgs(
+		[]string{"debug", "validate-release", "--release", dir, "extra"},
+	)
+	c.Assert(err, ErrorMatches, `too many arguments for command`)
+}

tests/debug-validate-release/task.yaml

@@ -0,0 +1,4 @@
+summary: Validate a Chisel release statically
+
+execute: |
+  chisel debug validate-release --release ${OS}-${RELEASE} 2>&1 | MATCH "Release is valid"