base/v0_6_exp: add parent directory sugar

prestist · yasminvalim · jmarrero · prestist · commit 14511967d58a · 2024-02-16T17:39:03.000-05:00
Add a field called 'Parent' which is used to specify a file's parent
directory. When a parent is specified, all directories from the parent to
the file will be created, with the 'mode' supplied in the parent directory.

Co-authored-by: Yasmin Valim  &lt;ydesouza@redhat.com&gt;
Co-authored-by: Joseph Corchado &lt;jmarrero@redhat.com&gt;
Co-authored-by: Adam Piasecki &lt;apiaseck@redhat.com&gt;
diff --git a/base/v0_6_exp/schema.go b/base/v0_6_exp/schema.go
@@ -67,6 +67,12 @@ type File struct {
 	Append    []Resource `yaml:"append"`
 	Contents  Resource   `yaml:"contents"`
 	Mode      *int       `yaml:"mode"`
+	Parent    Parent     `yaml:"parent"`
+}
+
+type Parent struct {
+	Path *string `yaml:"path"`
+	Mode *int    `yaml:"mode"`
 }
 
 type Filesystem struct {
diff --git a/base/v0_6_exp/translate.go b/base/v0_6_exp/translate.go
@@ -83,9 +83,7 @@ func (c Config) ToIgn3_5Unvalidated(options common.TranslateOptions) (types.Conf
 
 	tr := translate.NewTranslator("yaml", "json", options)
 	tr.AddCustomTranslator(translateIgnition)
-	tr.AddCustomTranslator(translateFile)
-	tr.AddCustomTranslator(translateDirectory)
-	tr.AddCustomTranslator(translateLink)
+	tr.AddCustomTranslator(translateStorage)
 	tr.AddCustomTranslator(translateResource)
 	tr.AddCustomTranslator(translatePasswdUser)
 	tr.AddCustomTranslator(translateUnit)
@@ -99,7 +97,6 @@ func (c Config) ToIgn3_5Unvalidated(options common.TranslateOptions) (types.Conf
 	translate.MergeP(tr, tm, &r, "systemd", &c.Systemd, &ret.Systemd)
 
 	c.addMountUnits(&ret, &tm)
-
 	tm2, r2 := c.processTrees(&ret, options)
 	tm.Merge(tm2)
 	r.Merge(r2)
@@ -121,6 +118,71 @@ func translateIgnition(from Ignition, options common.TranslateOptions) (to types
 	return
 }
 
+func translateStorage(from Storage, options common.TranslateOptions) (to types.Storage, tm translate.TranslationSet, r report.Report) {
+	tr := translate.NewTranslator("yaml", "json", options)
+	tr.AddCustomTranslator(translateFile)
+	tr.AddCustomTranslator(translateDirectory)
+	tr.AddCustomTranslator(translateLink)
+	tr.AddCustomTranslator(translateLuks)
+	tm, r = translate.Prefixed(tr, "directories", &from.Directories, &to.Directories)
+	translate.MergeP(tr, tm, &r, "disks", &from.Disks, &to.Disks)
+	translate.MergeP(tr, tm, &r, "files", &from.Files, &to.Files)
+	translate.MergeP(tr, tm, &r, "filesystems", &from.Filesystems, &to.Filesystems)
+	translate.MergeP(tr, tm, &r, "links", &from.Links, &to.Links)
+	translate.MergeP(tr, tm, &r, "luks", &from.Luks, &to.Luks)
+	translate.MergeP(tr, tm, &r, "raid", &from.Raid, &to.Raid)
+	for i, file := range from.Files {
+		if util.NotEmpty(file.Parent.Path) {
+			yamlPath := path.New("yaml", "files", i, "parent")
+			if !strings.Contains(file.Path, *file.Parent.Path) {
+				r.AddOnError(yamlPath, common.ErrInvalidParent)
+				continue
+			}
+
+			parentDirectory := types.Directory{
+				Node: types.Node{
+					Path:  *file.Parent.Path,
+					Group: types.NodeGroup{ID: file.Group.ID, Name: file.Group.Name},
+					User:  types.NodeUser{ID: file.User.ID, Name: file.User.Name},
+				},
+				DirectoryEmbedded1: types.DirectoryEmbedded1{
+					Mode: file.Parent.Mode,
+				},
+			}
+
+			to.Directories = append(to.Directories, parentDirectory)
+			// find what is between parent and file path
+			theInBetween := strings.Replace(file.Path, *file.Parent.Path, "", 1)
+
+			workingDirectory := *file.Parent.Path
+			// render all directories between the filepath and the parent with the parent's mode
+			// must be a goline for splitting on path.
+			arrayDirectory := strings.Split(theInBetween, "/")
+			for i := 0; i < len(arrayDirectory)-1; i++ {
+				dirTobeCreated := arrayDirectory[i]
+				if dirTobeCreated == "" {
+					continue
+				}
+				workingDirectory += "/" + dirTobeCreated
+				directoryToBeRendered := types.Directory{
+					Node: types.Node{
+						Path:  workingDirectory,
+						Group: types.NodeGroup{ID: file.Group.ID, Name: file.Group.Name},
+						User:  types.NodeUser{ID: file.User.ID, Name: file.User.Name},
+					},
+					DirectoryEmbedded1: types.DirectoryEmbedded1{
+						Mode: file.Parent.Mode,
+					},
+				}
+				to.Directories = append(to.Directories, directoryToBeRendered)
+			}
+			tm.AddFromCommonSource(yamlPath, path.New("json", "directories"), to.Directories)
+		}
+
+	}
+	return
+}
+
 func translateFile(from File, options common.TranslateOptions) (to types.File, tm translate.TranslationSet, r report.Report) {
 	tr := translate.NewTranslator("yaml", "json", options)
 	tr.AddCustomTranslator(translateResource)
@@ -134,6 +196,22 @@ func translateFile(from File, options common.TranslateOptions) (to types.File, t
 	return
 }
 
+func translateLuks(from Luks, options common.TranslateOptions) (to types.Luks, tm translate.TranslationSet, r report.Report) {
+	tr := translate.NewTranslator("yaml", "json", options)
+	tr.AddCustomTranslator(translateResource)
+	tm, r = translate.Prefixed(tr, "clevis", &from.Clevis, &to.Clevis)
+	translate.MergeP(tr, tm, &r, "device", &from.Device, &to.Device)
+	translate.MergeP(tr, tm, &r, "discard", &from.Discard, &to.Discard)
+	translate.MergeP2(tr, tm, &r, "key_file", &from.KeyFile, "keyFile", &to.KeyFile)
+	translate.MergeP(tr, tm, &r, "label", &from.Label, &to.Label)
+	translate.MergeP(tr, tm, &r, "name", &from.Name, &to.Name)
+	translate.MergeP2(tr, tm, &r, "open_options", &from.OpenOptions, "openOptions", &to.OpenOptions)
+	translate.MergeP(tr, tm, &r, "options", &from.Options, &to.Options)
+	translate.MergeP(tr, tm, &r, "uuid", &from.UUID, &to.UUID)
+	translate.MergeP2(tr, tm, &r, "wipe_volume", &from.WipeVolume, "wipeVolume", &to.WipeVolume)
+	return
+}
+
 func translateResource(from Resource, options common.TranslateOptions) (to types.Resource, tm translate.TranslationSet, r report.Report) {
 	tr := translate.NewTranslator("yaml", "json", options)
 	tm, r = translate.Prefixed(tr, "verification", &from.Verification, &to.Verification)
@@ -294,7 +372,7 @@ func (c Config) processTrees(ret *types.Config, options common.TranslateOptions)
 		return ts, r
 	}
 	t := newNodeTracker(ret)
-
+	ts.AddTranslation(path.New("yaml", "storage"), path.New("json", "storage"))
 	for i, tree := range c.Storage.Trees {
 		yamlPath := path.New("yaml", "storage", "trees", i)
 		if options.FilesDir == "" {
diff --git a/base/v0_6_exp/translate_test.go b/base/v0_6_exp/translate_test.go
@@ -599,6 +599,171 @@ func TestTranslateFile(t *testing.T) {
 		})
 	}
 }
+func TestTranslateStorage(t *testing.T) {
+	tests := []struct {
+		in      Storage
+		out     types.Storage
+		errPath path.ContextPath
+		errors  error
+	}{
+		// Basic parent file directory
+		{
+			Storage{
+				Files: []File{
+					{
+						Path:     "/foo/bar/txt.txt",
+						Contents: Resource{},
+						Mode:     util.IntToPtr(420),
+						Parent: Parent{
+							Path: util.StrToPtr("/foo"),
+							Mode: util.IntToPtr(420),
+						},
+					},
+				},
+			},
+			types.Storage{
+				Files: []types.File{
+					{
+						Node: types.Node{
+							Path: "/foo/bar/txt.txt",
+						},
+						FileEmbedded1: types.FileEmbedded1{
+							Mode:     util.IntToPtr(420),
+							Contents: types.Resource{},
+						},
+					},
+				},
+				Directories: []types.Directory{
+					{
+						Node: types.Node{
+							Path: "/foo",
+						},
+						DirectoryEmbedded1: types.DirectoryEmbedded1{
+							Mode: util.IntToPtr(420),
+						},
+					},
+					{
+						Node: types.Node{
+							Path: "/foo/bar",
+						},
+						DirectoryEmbedded1: types.DirectoryEmbedded1{
+							Mode: util.IntToPtr(420),
+						},
+					},
+				},
+			},
+			path.ContextPath{},
+			nil,
+		},
+		// Empty parent file directory
+		{
+			Storage{
+				Files: []File{
+					{
+						Path:     "/foo/bar/txt.txt",
+						Contents: Resource{},
+						Mode:     util.IntToPtr(420),
+						Parent: Parent{
+							Path: util.StrToPtr(""),
+							Mode: util.IntToPtr(420),
+						},
+					},
+				},
+			},
+			types.Storage{
+				Files: []types.File{
+					{
+						Node: types.Node{
+							Path: "/foo/bar/txt.txt",
+						},
+						FileEmbedded1: types.FileEmbedded1{
+							Mode:     util.IntToPtr(420),
+							Contents: types.Resource{},
+						},
+					},
+				},
+			},
+			path.ContextPath{},
+			nil,
+		},
+		// Parent not defined
+		{
+			Storage{
+				Files: []File{
+					{
+						Path:     "/foo/bar/txt.txt",
+						Contents: Resource{},
+						Mode:     util.IntToPtr(420),
+					},
+				},
+			},
+			types.Storage{
+				Files: []types.File{
+					{
+						Node: types.Node{
+							Path: "/foo/bar/txt.txt",
+						},
+						FileEmbedded1: types.FileEmbedded1{
+							Mode:     util.IntToPtr(420),
+							Contents: types.Resource{},
+						},
+					},
+				},
+			},
+			path.ContextPath{},
+			nil,
+		},
+
+		// Parent path is not related to file path
+		{
+			Storage{
+				Files: []File{
+					{
+						Path:     "/foo/bar/txt.txt",
+						Contents: Resource{},
+						Mode:     util.IntToPtr(420),
+						Parent: Parent{
+							Path: util.StrToPtr("/godzilla"),
+							Mode: util.IntToPtr(420),
+						},
+					},
+				},
+			},
+			types.Storage{
+				Files: []types.File{
+					{
+						Node: types.Node{
+							Path: "/foo/bar/txt.txt",
+						},
+						FileEmbedded1: types.FileEmbedded1{
+							Mode:     util.IntToPtr(420),
+							Contents: types.Resource{},
+						},
+					},
+				},
+			},
+			path.New("yaml", "files", 0, "parent"),
+			common.ErrInvalidParent,
+		},
+	}
+
+	for i, test := range tests {
+		t.Run(fmt.Sprintf("translate %d", i), func(t *testing.T) {
+			actual, translations, r := translateStorage(test.in, common.TranslateOptions{})
+			r = confutil.TranslateReportPaths(r, translations)
+			baseutil.VerifyReport(t, test.in, r)
+			assert.Equal(t, test.out, actual, "translation mismatch")
+			assert.NoError(t, translations.DebugVerifyCoverage(actual), "incomplete TranslationSet coverage")
+			if test.errors != nil {
+				expected := report.Report{}
+				expected.AddOnError(test.errPath, test.errors)
+				assert.Equal(t, expected, r, "bad report for test case %d", i)
+			} else {
+				assert.Equal(t, report.Report{}, r, "non-empty report")
+			}
+		})
+	}
+}
 
 // TestTranslateDirectory tests translating the ct storage.directories.[i] entries to ignition storage.directories.[i] entires.
 func TestTranslateDirectory(t *testing.T) {
diff --git a/config/common/errors.go b/config/common/errors.go
@@ -89,6 +89,7 @@ var (
 	ErrLinkSupport       = errors.New("links are not supported in this spec version")
 	ErrLuksSupport       = errors.New("luks is not supported in this spec version")
 	ErrRaidSupport       = errors.New("raid is not supported in this spec version")
+	ErrInvalidParent     = errors.New("parent must be included in the file path")
 
 	// Grub
 	ErrGrubUserNameNotSpecified = errors.New("field \"name\" is required")
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -13,6 +13,8 @@ nav_order: 9
 ### Features
 
 - Support s390x layouts in `boot_device` section (fcos 1.6.0-exp, openshift 4.15.0-exp)
+- Add `parent` field to `files`, to reduce verbosity when configuring a deeply
+  nested file. _(base 0.6.0-exp)_
 
 ### Bug fixes
 
