Rename basedOn → base

Signed-off-by: Jan Dubois <[email protected]>

Author: jandubois

pkg/limatmpl/abs.go

@@ -25,17 +25,17 @@ func (tmpl *Template) useAbsLocators() error {
 	if err != nil {
 		return err
 	}
-	for i, baseLocator := range tmpl.Config.BasedOn {
+	for i, baseLocator := range tmpl.Config.Base {
 		locator, err := absPath(baseLocator, basePath)
 		if err != nil {
 			return err
 		}
 		if i == 0 {
-			// basedOn can either be a single string, or a list of strings
-			tmpl.expr.WriteString(fmt.Sprintf("| ($a.basedOn | select(type == \"!!str\")) |= %q\n", locator))
-			tmpl.expr.WriteString(fmt.Sprintf("| ($a.basedOn | select(type == \"!!seq\") | .[0]) |= %q\n", locator))
+			// base can either be a single string, or a list of strings
+			tmpl.expr.WriteString(fmt.Sprintf("| ($a.base | select(type == \"!!str\")) |= %q\n", locator))
+			tmpl.expr.WriteString(fmt.Sprintf("| ($a.base | select(type == \"!!seq\") | .[0]) |= %q\n", locator))
 		} else {
-			tmpl.expr.WriteString(fmt.Sprintf("| $a.basedOn[%d] = %q\n", i, locator))
+			tmpl.expr.WriteString(fmt.Sprintf("| $a.base[%d] = %q\n", i, locator))
 		}
 	}
 	for i, p := range tmpl.Config.Probes {

pkg/limatmpl/abs_test.go

@@ -18,46 +18,46 @@ type useAbsLocatorsTestCase struct {
 
 var useAbsLocatorsTestCases = []useAbsLocatorsTestCase{
 	{
-		"Template without basedOn or script file",
+		"Template without base or script file",
 		"template://foo",
 		`arch: aarch64`,
 		`arch: aarch64`,
 	},
 	{
 		"Single string base template",
 		"template://foo",
-		`basedOn: bar.yaml`,
-		`basedOn: template://bar.yaml`,
+		`base: bar.yaml`,
+		`base: template://bar.yaml`,
 	},
 	{
 		"Flow style array of one base template",
 		"template://foo",
-		`basedOn: [bar.yaml]`,
-		`basedOn: ['template://bar.yaml']`,
+		`base: [bar.yaml]`,
+		`base: ['template://bar.yaml']`,
 	},
 	{
 		"Block style array of one base template",
 		"template://foo",
 		`
-basedOn:
+base:
 - bar.yaml
 `,
 		`
-basedOn:
+base:
 - template://bar.yaml`,
 	},
 	{
 		"Block style of four base templates",
 		"template://foo",
 		`
-basedOn:
+base:
 - bar.yaml
 - template://my
 - https://example.com/my.yaml
 - baz.yaml
 `,
 		`
-basedOn:
+base:
 - template://bar.yaml
 - template://my
 - https://example.com/my.yaml

pkg/limatmpl/embed.go

@@ -15,7 +15,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// Embed will recursively resolve all "basedOn" dependencies and update the
+// Embed will recursively resolve all "base" dependencies and update the
 // template with the merged result. It also inlines all external provisioning
 // and probe scripts.
 func (tmpl *Template) Embed(ctx context.Context) error {
@@ -51,19 +51,19 @@ func (tmpl *Template) embed(ctx context.Context, defaultBase bool, seen map[stri
 	if err := tmpl.Unmarshal(); err != nil {
 		return err
 	}
-	basedOn := tmpl.Config.BasedOn
+	bases := tmpl.Config.Base
 	if defaultBase {
-		// Prepend $LIMA_HOME/_config/base.yaml to basedOn list.
+		// Prepend $LIMA_HOME/_config/base.yaml to bases list.
 		configDir, err := dirnames.LimaConfigDir()
 		if err != nil {
 			return err
 		}
 		defaultBaseFilename := filepath.Join(configDir, filenames.Base)
 		if _, err := os.Stat(defaultBaseFilename); err == nil {
-			basedOn = append([]string{defaultBaseFilename}, basedOn...)
+			bases = append([]string{defaultBaseFilename}, bases...)
 		}
 	}
-	for _, baseLocator := range basedOn {
+	for _, baseLocator := range bases {
 		logrus.Debugf("Merging base template %q", baseLocator)
 		base, err := Read(ctx, "", baseLocator)
 		if err != nil {
@@ -154,7 +154,7 @@ func (tmpl *Template) mergeBase(base *Template) error {
 // * dns lists are not merged and only copied when the template doesn't have any dns entries at all.
 // * probes and provision scripts are appended in reverse order.
 // * mountTypesUnsupported have duplicate values removed.
-// * basedOn is removed from the template.
+// * base is removed from the template.
 const mergeDocuments = `
   select(document_index == 0) as $a
 | select(document_index == 1) as $b
@@ -195,7 +195,7 @@ const mergeDocuments = `
 # Make sure mountTypesUnsupported elements are unique.
 | $a | (select(.mountTypesUnsupported) | .mountTypesUnsupported) |= unique
 
-| del($a.basedOn)
+| del($a.base)
 
 # Remove the custom tags again so they do not clutter up the YAML output.
 | $a | .. tag = ""

pkg/limatmpl/embed_test.go

@@ -27,7 +27,7 @@ type embedTestCase struct {
 // * If the description starts with "TODO" then the test is expected to fail (until it is fixed).
 // * base is split on "---\n" and stored as base0.yaml, base1.yaml, ... in the same dir as the template.
 // * If any base template starts with "#!" then the extension will be .sh instead of .yaml.
-// * The template is automatically prefixed with "basedOn: base0.yaml" unless base0 is a script.
+// * The template is automatically prefixed with "base: base0.yaml" unless base0 is a script.
 // * All line comments will be separated by 2 spaces from the value on output.
 // * Merge order of additionalDisks, mounts, and networks depends on the logic in the
 //   combineListEntries() functions and will not follow the order of the base template(s).
@@ -173,7 +173,7 @@ mounts:
 arch: aarch64
 `,
 		`
-basedOn: base0.yaml
+base: base0.yaml
 # failure would mean this test loops forever, not that it fails the test
 vmType: qemu
 `,
@@ -187,10 +187,10 @@ vmType: qemu
 		"Bases are embedded depth-first",
 		`#`,
 		`
-basedOn: [base1.yaml, base2.yaml]
+base: [base1.yaml, base2.yaml]
 additionalDisks: [disk0]
 ---
-basedOn: base3.yaml
+base: base3.yaml
 additionalDisks: [disk1]
 ---
 additionalDisks: [disk2]
@@ -281,7 +281,7 @@ provision:
 `,
 	},
 	{
-		"Script files are embedded even when no basedOn property exists",
+		"Script files are embedded even when no base property exists",
 		"provision: [{file: base0.sh}]",
 		"#! my script",
 		`provision: [{script: "#! my script"}]`,
@@ -322,10 +322,10 @@ func RunEmbedTest(t *testing.T, tc embedTestCase) {
 		assert.NilError(t, err, tc.description)
 	}
 	tmpl := &limatmpl.Template{
-		Bytes:   []byte(fmt.Sprintf("basedOn: base0.yaml\n%s", tc.template)),
+		Bytes:   []byte(fmt.Sprintf("base: base0.yaml\n%s", tc.template)),
 		Locator: "tmpl.yaml",
 	}
-	// Don't include `basedOn` property if base0 is a script
+	// Don't include `base` property if base0 is a script
 	if strings.HasPrefix(tc.base, "#!") {
 		tmpl.Bytes = []byte(tc.template)
 	}

pkg/limayaml/limayaml.go

@@ -7,7 +7,7 @@ import (
 )
 
 type LimaYAML struct {
-	BasedOn               BaseTemplates `yaml:"basedOn,omitempty" json:"basedOn,omitempty" jsonschema:"nullable"`
+	Base                  BaseTemplates `yaml:"base,omitempty" json:"base,omitempty" jsonschema:"nullable"`
 	MinimumLimaVersion    *string       `yaml:"minimumLimaVersion,omitempty" json:"minimumLimaVersion,omitempty" jsonschema:"nullable"`
 	VMType                *VMType       `yaml:"vmType,omitempty" json:"vmType,omitempty" jsonschema:"nullable"`
 	VMOpts                VMOpts        `yaml:"vmOpts,omitempty" json:"vmOpts,omitempty"`

pkg/limayaml/marshal.go

@@ -35,7 +35,7 @@ func unmarshalDisk(dst *Disk, b []byte) error {
 	return yaml.Unmarshal(b, dst)
 }
 
-// unmarshalBaseTemplates unmarshalls `basedOn` which is either a string or a list of strings.
+// unmarshalBaseTemplates unmarshalls `base` which is either a string or a list of strings.
 func unmarshalBaseTemplates(dst *BaseTemplates, b []byte) error {
 	var s string
 	if err := yaml.Unmarshal(b, &s); err == nil {

pkg/limayaml/validate.go

@@ -47,8 +47,8 @@ func validateFileObject(f File, fieldName string) error {
 }
 
 func Validate(y *LimaYAML, warn bool) error {
-	if len(y.BasedOn) > 0 {
-		return errors.New("field `basedOn` must be empty for YAML validation")
+	if len(y.Base) > 0 {
+		return errors.New("field `base` must be empty for YAML validation")
 	}
 	if y.MinimumLimaVersion != nil {
 		if _, err := versionutil.Parse(*y.MinimumLimaVersion); err != nil {

templates/default.yaml

@@ -285,7 +285,7 @@ minimumLimaVersion: null
 # This setting ca be either a single string, or a list of strings.
 # Any relative base template name will be resolved relative to the location of the main template.
 # 🟢 Builtin default: no base template
-basedOn: null
+base: null
 
 # User to be used inside the VM
 user:
@@ -570,7 +570,7 @@ nestedVirtualization: null
 # the mount of the home directory writable.
 
 # A third mechanism is $LIMA_HOME/_config/base.yaml. It is similar to
-# `default.yaml` but will be merged during the `basedOn` template assembly
+# `default.yaml` but will be merged during the `base` template embedding
 # when the instance is created, and not on every start. It becomes part
 # of the lima.yaml file.