feat(schemas): default Talos image build output and tighten dir constraint

schemas/lab/talos/README.md

@@ -9,25 +9,32 @@ The CUE schema is the source of truth; Go types are generated from `schema.cue`.
 
 ## Example
 
+The minimum valid configuration relies on schema defaults for the Image
+Factory URL, schematic ID, platform, architecture, artifact, output format,
+output directory, and the boot/cidata artifact filenames:
+
 ```cue
 package images
 
 import talos "github.com/gilmanlab/platform/schemas/lab/talos"
 
 build: talos.#ImageBuild & {
 	name: "bootstrap-talos-controlplane"
-	source: {
-		version: "v1.13.0"
-	}
+	source: version: "v1.13.0"
 	config: {
 		userData: path: "controlplane.yaml"
 		metaData: localHostname: "bootstrap-controlplane-1"
 	}
-	output: {
-		dir:                ".state/images/talos-bootstrap"
-		format:             "img"
-		bootArtifactName:   "talos-bootstrap-amd64.img"
-		configArtifactName: "talos-bootstrap-cidata.img"
-	}
+}
+```
+
+Override any default by setting the field explicitly. For example, to land
+artifacts in a different directory with bespoke filenames:
+
+```cue
+build: output: {
+	dir:                ".state/images/talos-bootstrap"
+	bootArtifactName:   "talos-bootstrap-amd64.img"
+	configArtifactName: "talos-bootstrap-cidata.img"
 }
 ```

schemas/lab/talos/schema.cue

@@ -97,14 +97,17 @@ package talos
 #ImageOutput: {
 	@go(ImageOutput)
 
-	// Dir is the output directory for generated artifacts.
-	dir!: #NonEmptyString
+	// Dir is the output directory for generated artifacts. Must be a
+	// repo-relative path; defaults to ".state/images".
+	dir: *".state/images" | #RelativePath
 	// Format is the local artifact format.
 	format: #OutputFormat
-	// BootArtifactName is the Talos boot disk IMG filename.
-	bootArtifactName!: #ArtifactName @go(BootArtifactName)
-	// ConfigArtifactName is the NoCloud cidata IMG filename.
-	configArtifactName!: #ArtifactName @go(ConfigArtifactName)
+	// BootArtifactName is the Talos boot disk IMG filename. Defaults to
+	// "talos-boot.img".
+	bootArtifactName: *"talos-boot.img" | #ArtifactName @go(BootArtifactName)
+	// ConfigArtifactName is the NoCloud cidata IMG filename. Defaults to
+	// "talos-cidata.img".
+	configArtifactName: *"talos-cidata.img" | #ArtifactName @go(ConfigArtifactName)
 }
 
 // ImageBuild is the top-level Talos image download and config packaging contract.
@@ -117,6 +120,7 @@ package talos
 	source!: #ImageSource
 	// Config describes Talos machine configuration delivery.
 	config!: #MachineConfig
-	// Output describes the local artifacts produced by the build.
-	output!: #ImageOutput
+	// Output describes the local artifacts produced by the build. Every
+	// field has a default, so authors can omit the block entirely.
+	output: #ImageOutput
 }

tools/labctl/cmd/labctl/main_test.go

@@ -93,6 +93,20 @@ output:
 		return err
 	}
 
+	minimalConfig := fmt.Appendf(nil, `name: talos-test
+source:
+  factoryURL: %s
+  version: v1.13.0
+config:
+  userData:
+    path: controlplane.yaml
+  metaData:
+    localHostname: bootstrap-controlplane-1
+`, server.URL)
+	if err := os.WriteFile(filepath.Join(env.WorkDir, "talos-minimal.yaml"), minimalConfig, 0o600); err != nil {
+		return err
+	}
+
 	return nil
 }
 

tools/labctl/cmd/labctl/testdata/script/talos_image_build.txtar

@@ -43,6 +43,11 @@ stdout '"arch":"amd64"'
 stdout '"format":"img"'
 ! stderr .
 
+exec labctl bootstrap talos image build talos-minimal.yaml
+exists .state/images/talos-boot.img
+exists .state/images/talos-cidata.img
+! stderr .
+
 -- invalid.yaml --
 name: talos-test
 source:

tools/labctl/internal/adapters/talosconfig/validator_test.go

@@ -98,3 +98,22 @@ output:
   configArtifactName: talos-cidata.img
 `
 }
+
+func TestValidateYAMLAppliesOutputDefaults(t *testing.T) {
+	minimal := `name: talos-test
+source:
+  version: v1.13.0
+config:
+  userData:
+    path: controlplane.yaml
+  metaData:
+    localHostname: bootstrap-controlplane-1
+`
+	config, err := talosconfig.New().ValidateYAML("minimal.yaml", []byte(minimal))
+
+	require.NoError(t, err)
+	assert.Equal(t, ".state/images", config.Output.Dir)
+	assert.Equal(t, "talos-boot.img", config.Output.BootArtifactName)
+	assert.Equal(t, "talos-cidata.img", config.Output.ConfigArtifactName)
+	assert.Equal(t, "img", string(config.Output.Format))
+}

tools/labctl/internal/app/talosimage/service.go

@@ -390,16 +390,16 @@ type buildPaths struct {
 }
 
 func resolvePaths(baseDir string, output schematalos.ImageOutput) (buildPaths, error) {
-	outputDir, err := resolvePath(baseDir, string(output.Dir))
+	outputDir, err := resolvePath(baseDir, output.Dir)
 	if err != nil {
 		return buildPaths{}, err
 	}
 
 	return buildPaths{
 		downloadsDir:       filepath.Join(filepath.Dir(outputDir), "downloads", "talos"),
 		outputDir:          outputDir,
-		bootArtifactPath:   filepath.Join(outputDir, string(output.BootArtifactName)),
-		configArtifactPath: filepath.Join(outputDir, string(output.ConfigArtifactName)),
+		bootArtifactPath:   filepath.Join(outputDir, output.BootArtifactName),
+		configArtifactPath: filepath.Join(outputDir, output.ConfigArtifactName),
 	}, nil
 }