Skip to content

Commit fad712e

Browse files
committed
Rename InitialNode to InitialChild
I want to add a common interface for Leaf and InitialContentsFetcher. I think the best name for that is InitialNode, but that name is already taken. Rename the existing InitialNode type to InitialChild, which is a better fit, because it's based on Child.
1 parent 0e0c240 commit fad712e

10 files changed

+135
-135
lines changed

pkg/builder/virtual_build_directory.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ func (d *virtualBuildDirectory) Lstat(name path.Component) (filesystem.FileInfo,
140140
}
141141

142142
func (d *virtualBuildDirectory) Mkdir(name path.Component, mode os.FileMode) error {
143-
return d.CreateChildren(map[path.Component]virtual.InitialNode{
144-
name: virtual.InitialNode{}.FromDirectory(virtual.EmptyInitialContentsFetcher),
143+
return d.CreateChildren(map[path.Component]virtual.InitialChild{
144+
name: virtual.InitialChild{}.FromDirectory(virtual.EmptyInitialContentsFetcher),
145145
}, false)
146146
}
147147

@@ -150,8 +150,8 @@ func (d *virtualBuildDirectory) Mknod(name path.Component, perm os.FileMode, dev
150150
return status.Error(codes.InvalidArgument, "The provided file mode is not for a character device")
151151
}
152152
characterDevice := d.options.characterDeviceFactory.LookupCharacterDevice(deviceNumber)
153-
if err := d.CreateChildren(map[path.Component]virtual.InitialNode{
154-
name: virtual.InitialNode{}.FromLeaf(characterDevice),
153+
if err := d.CreateChildren(map[path.Component]virtual.InitialChild{
154+
name: virtual.InitialChild{}.FromLeaf(characterDevice),
155155
}, false); err != nil {
156156
characterDevice.Unlink()
157157
return err

pkg/filesystem/virtual/access_monitoring_initial_contents_fetcher.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func NewAccessMonitoringInitialContentsFetcher(base InitialContentsFetcher, root
2121
}
2222
}
2323

24-
func (icf *accessMonitoringInitialContentsFetcher) FetchContents(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialNode, error) {
24+
func (icf *accessMonitoringInitialContentsFetcher) FetchContents(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialChild, error) {
2525
// Call into underlying initial contents fetcher. Wrap the file
2626
// read monitors that are installed on the files, so that we can
2727
// detect file access.
@@ -43,16 +43,16 @@ func (icf *accessMonitoringInitialContentsFetcher) FetchContents(fileReadMonitor
4343

4444
// Wrap all of the child directories, so that we can detect
4545
// directory access.
46-
wrappedContents := make(map[path.Component]InitialNode, len(contents))
46+
wrappedContents := make(map[path.Component]InitialChild, len(contents))
4747
for name, node := range contents {
4848
childInitialContentsFetcher, leaf := node.GetPair()
4949
if childInitialContentsFetcher != nil {
50-
wrappedContents[name] = InitialNode{}.FromDirectory(&accessMonitoringInitialContentsFetcher{
50+
wrappedContents[name] = InitialChild{}.FromDirectory(&accessMonitoringInitialContentsFetcher{
5151
InitialContentsFetcher: childInitialContentsFetcher,
5252
unreadDirectoryMonitor: readDirectoryMonitor.ResolvedDirectory(name),
5353
})
5454
} else {
55-
wrappedContents[name] = InitialNode{}.FromLeaf(leaf)
55+
wrappedContents[name] = InitialChild{}.FromLeaf(leaf)
5656
}
5757
}
5858
return wrappedContents, nil

pkg/filesystem/virtual/access_monitoring_initial_contents_fetcher_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ func TestAccessMonitoringInitialContentsFetcher(t *testing.T) {
4949
baseFileReadMonitorFactory.EXPECT().Call(path.MustNewComponent("file")).Return(baseChildFileReadMonitor.Call)
5050
var childFileReadMonitor virtual.FileReadMonitor
5151
baseInitialContentsFetcher.EXPECT().FetchContents(gomock.Any()).
52-
DoAndReturn(func(fileReadMonitorFactory virtual.FileReadMonitorFactory) (map[path.Component]virtual.InitialNode, error) {
52+
DoAndReturn(func(fileReadMonitorFactory virtual.FileReadMonitorFactory) (map[path.Component]virtual.InitialChild, error) {
5353
childFileReadMonitor = fileReadMonitorFactory(path.MustNewComponent("file"))
54-
return map[path.Component]virtual.InitialNode{
55-
path.MustNewComponent("dir"): virtual.InitialNode{}.FromDirectory(baseChildInitialContentsFetcher),
56-
path.MustNewComponent("file"): virtual.InitialNode{}.FromLeaf(baseChildFile),
54+
return map[path.Component]virtual.InitialChild{
55+
path.MustNewComponent("dir"): virtual.InitialChild{}.FromDirectory(baseChildInitialContentsFetcher),
56+
path.MustNewComponent("file"): virtual.InitialChild{}.FromLeaf(baseChildFile),
5757
}, nil
5858
})
5959
rootReadDirectoryMonitor := mock.NewMockReadDirectoryMonitor(ctrl)
@@ -69,7 +69,7 @@ func TestAccessMonitoringInitialContentsFetcher(t *testing.T) {
6969
childInitialContentsFetcher, _ := rootContents[path.MustNewComponent("dir")].GetPair()
7070

7171
t.Run("FetchContentsSucceeded", func(t *testing.T) {
72-
baseChildInitialContentsFetcher.EXPECT().FetchContents(gomock.Any()).Return(map[path.Component]virtual.InitialNode{}, nil)
72+
baseChildInitialContentsFetcher.EXPECT().FetchContents(gomock.Any()).Return(map[path.Component]virtual.InitialChild{}, nil)
7373
childReadDirectoryMonitor := mock.NewMockReadDirectoryMonitor(ctrl)
7474
childUnreadDirectoryMonitor.EXPECT().ReadDirectory().Return(childReadDirectoryMonitor)
7575
baseChildFileReadMonitorFactory := mock.NewMockFileReadMonitorFactory(ctrl)

pkg/filesystem/virtual/cas_initial_contents_fetcher.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ func NewCASInitialContentsFetcher(ctx context.Context, directoryWalker cas.Direc
4444
}
4545
}
4646

47-
func (icf *casInitialContentsFetcher) fetchContentsUnwrapped(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialNode, error) {
47+
func (icf *casInitialContentsFetcher) fetchContentsUnwrapped(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialChild, error) {
4848
directory, err := icf.directoryWalker.GetDirectory(icf.options.context)
4949
if err != nil {
5050
return nil, err
@@ -53,7 +53,7 @@ func (icf *casInitialContentsFetcher) fetchContentsUnwrapped(fileReadMonitorFact
5353
// Create InitialContentsFetchers for all child directories.
5454
// These can yield even more InitialContentsFetchers for
5555
// grandchildren.
56-
children := make(map[path.Component]InitialNode, len(directory.Directories)+len(directory.Files)+len(directory.Symlinks))
56+
children := make(map[path.Component]InitialChild, len(directory.Directories)+len(directory.Files)+len(directory.Symlinks))
5757
for _, entry := range directory.Directories {
5858
component, ok := path.NewComponent(entry.Name)
5959
if !ok {
@@ -67,7 +67,7 @@ func (icf *casInitialContentsFetcher) fetchContentsUnwrapped(fileReadMonitorFact
6767
if err != nil {
6868
return nil, util.StatusWrapf(err, "Failed to obtain digest for directory %#v", entry.Name)
6969
}
70-
children[component] = InitialNode{}.FromDirectory(&casInitialContentsFetcher{
70+
children[component] = InitialChild{}.FromDirectory(&casInitialContentsFetcher{
7171
options: icf.options,
7272
directoryWalker: icf.directoryWalker.GetChild(childDigest),
7373
})
@@ -96,7 +96,7 @@ func (icf *casInitialContentsFetcher) fetchContentsUnwrapped(fileReadMonitorFact
9696
return nil, util.StatusWrapf(err, "Failed to obtain digest for file %#v", entry.Name)
9797
}
9898
leaf := icf.options.casFileFactory.LookupFile(childDigest, entry.IsExecutable, fileReadMonitorFactory(component))
99-
children[component] = InitialNode{}.FromLeaf(leaf)
99+
children[component] = InitialChild{}.FromLeaf(leaf)
100100
leavesToUnlink = append(leavesToUnlink, leaf)
101101
}
102102

@@ -111,15 +111,15 @@ func (icf *casInitialContentsFetcher) fetchContentsUnwrapped(fileReadMonitorFact
111111
}
112112

113113
leaf := icf.options.symlinkFactory.LookupSymlink([]byte(entry.Target))
114-
children[component] = InitialNode{}.FromLeaf(leaf)
114+
children[component] = InitialChild{}.FromLeaf(leaf)
115115
leavesToUnlink = append(leavesToUnlink, leaf)
116116
}
117117

118118
leavesToUnlink = nil
119119
return children, nil
120120
}
121121

122-
func (icf *casInitialContentsFetcher) FetchContents(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialNode, error) {
122+
func (icf *casInitialContentsFetcher) FetchContents(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialChild, error) {
123123
children, err := icf.fetchContentsUnwrapped(fileReadMonitorFactory)
124124
if err != nil {
125125
return nil, util.StatusWrap(err, icf.directoryWalker.GetDescription())

pkg/filesystem/virtual/cas_initial_contents_fetcher_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -217,11 +217,11 @@ func TestCASInitialContentsFetcherFetchContents(t *testing.T) {
217217
children, err := initialContentsFetcher.FetchContents(fileReadMonitorFactory.Call)
218218
require.NoError(t, err)
219219
childInitialContentsFetcher, _ := children[path.MustNewComponent("directory")].GetPair()
220-
require.Equal(t, map[path.Component]virtual.InitialNode{
221-
path.MustNewComponent("directory"): virtual.InitialNode{}.FromDirectory(childInitialContentsFetcher),
222-
path.MustNewComponent("executable"): virtual.InitialNode{}.FromLeaf(executableLeaf),
223-
path.MustNewComponent("file"): virtual.InitialNode{}.FromLeaf(fileLeaf),
224-
path.MustNewComponent("symlink"): virtual.InitialNode{}.FromLeaf(symlinkLeaf),
220+
require.Equal(t, map[path.Component]virtual.InitialChild{
221+
path.MustNewComponent("directory"): virtual.InitialChild{}.FromDirectory(childInitialContentsFetcher),
222+
path.MustNewComponent("executable"): virtual.InitialChild{}.FromLeaf(executableLeaf),
223+
path.MustNewComponent("file"): virtual.InitialChild{}.FromLeaf(fileLeaf),
224+
path.MustNewComponent("symlink"): virtual.InitialChild{}.FromLeaf(symlinkLeaf),
225225
}, children)
226226

227227
// Check that the InitialContentsFetcher that is created

pkg/filesystem/virtual/empty_initial_contents_fetcher.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import (
99

1010
type emptyInitialContentsFetcher struct{}
1111

12-
func (f emptyInitialContentsFetcher) FetchContents(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialNode, error) {
13-
return map[path.Component]InitialNode{}, nil
12+
func (f emptyInitialContentsFetcher) FetchContents(fileReadMonitorFactory FileReadMonitorFactory) (map[path.Component]InitialChild, error) {
13+
return map[path.Component]InitialChild{}, nil
1414
}
1515

1616
func (f emptyInitialContentsFetcher) GetContainingDigests(ctx context.Context) (digest.Set, error) {

pkg/filesystem/virtual/in_memory_prepopulated_directory.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ func (c *inMemoryDirectoryContents) isDeletable(hiddenFilesMatcher StringMatcher
167167
return true
168168
}
169169

170-
func (c *inMemoryDirectoryContents) createChildren(subtree *inMemorySubtree, children map[path.Component]InitialNode) {
170+
func (c *inMemoryDirectoryContents) createChildren(subtree *inMemorySubtree, children map[path.Component]InitialChild) {
171171
// Either sort or shuffle the children before inserting them
172172
// into the directory. This either makes VirtualReadDir() behave
173173
// deterministically, or not, based on preference.
@@ -519,7 +519,7 @@ func (i *inMemoryPrepopulatedDirectory) InstallHooks(fileAllocator FileAllocator
519519
}
520520
}
521521

522-
func (i *inMemoryPrepopulatedDirectory) CreateChildren(children map[path.Component]InitialNode, overwrite bool) error {
522+
func (i *inMemoryPrepopulatedDirectory) CreateChildren(children map[path.Component]InitialChild, overwrite bool) error {
523523
i.lock.Lock()
524524
contents, err := i.getContents()
525525
if err != nil {
@@ -598,7 +598,7 @@ func (i *inMemoryPrepopulatedDirectory) filterChildrenRecursive(childFilter Chil
598598
// instantiate it. Simply provide the
599599
// InitialContentsFetcher to the callback.
600600
i.lock.Unlock()
601-
return childFilter(InitialNode{}.FromDirectory(initialContentsFetcher), func() error {
601+
return childFilter(InitialChild{}.FromDirectory(initialContentsFetcher), func() error {
602602
return i.RemoveAllChildren(false)
603603
})
604604
}
@@ -626,7 +626,7 @@ func (i *inMemoryPrepopulatedDirectory) filterChildrenRecursive(childFilter Chil
626626
// Invoke the callback for all children.
627627
for _, child := range leaves {
628628
name := child.name
629-
if !childFilter(InitialNode{}.FromLeaf(child.leaf), func() error {
629+
if !childFilter(InitialChild{}.FromLeaf(child.leaf), func() error {
630630
return i.Remove(name)
631631
}) {
632632
return false

0 commit comments

Comments
 (0)