1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.task.util.fs;
import com.yahoo.vespa.hosted.node.admin.nodeagent.UserNamespace;
import com.yahoo.vespa.hosted.node.admin.nodeagent.UserScope;
import com.yahoo.vespa.hosted.node.admin.task.util.file.UnixPath;
import com.yahoo.vespa.hosted.node.admin.task.util.file.UnixUser;
import com.yahoo.vespa.test.file.TestFileSystem;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.FileSystem;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.nio.file.StandardOpenOption;
import java.nio.file.attribute.FileAttribute;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Map;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
/**
* @author freva
*/
class ContainerFileSystemTest {
private final FileSystem fileSystem = TestFileSystem.create();
private final UnixPath containerRootOnHost = new UnixPath(fileSystem.getPath("/data/storage/ctr1"));
private final UserScope userScope = UserScope.create(new UserNamespace(10_000, 11_000, 10000));
private final ContainerFileSystem containerFs = ContainerFileSystem.create(containerRootOnHost.createDirectories().toPath(), userScope);
@Test
public void creates_files_and_directories_with_container_root_as_owner() throws IOException {
ContainerPath containerPath = ContainerPath.fromPathInContainer(containerFs, Path.of("/opt/vespa/logs/file"), userScope.root());
UnixPath unixPath = new UnixPath(containerPath).createParents().writeUtf8File("hello world");
for (ContainerPath p = containerPath; p.getParent() != null; p = p.getParent())
assertOwnership(p, 0, 0, 10000, 11000);
unixPath.setOwnerId(500).setGroupId(1000);
assertOwnership(containerPath, 500, 1000, 10500, 12000);
UnixPath hostFile = new UnixPath(fileSystem.getPath("/file")).createNewFile();
ContainerPath destination = ContainerPath.fromPathInContainer(containerFs, Path.of("/copy1"), userScope.root());
Files.copy(hostFile.toPath(), destination);
assertOwnership(destination, 0, 0, 10000, 11000);
}
@Test
public void file_write_and_read() throws IOException {
ContainerPath containerPath = ContainerPath.fromPathInContainer(containerFs, Path.of("/file"), userScope.root());
UnixPath unixPath = new UnixPath(containerPath);
unixPath.writeUtf8File("hello");
assertOwnership(containerPath, 0, 0, 10000, 11000);
unixPath.setOwnerId(500).setGroupId(200);
assertOwnership(containerPath, 500, 200, 10500, 11200);
Files.writeString(containerPath, " world", StandardOpenOption.APPEND);
assertOwnership(containerPath, 500, 200, 10500, 11200); // Owner should not have been updated as the file already existed
assertEquals("hello world", unixPath.readUtf8File());
unixPath.deleteIfExists();
new UnixPath(containerPath.withUser(userScope.vespa())).writeUtf8File("test123");
assertOwnership(containerPath, 1000, 1000, 11000, 12000);
}
@Test
public void copy() throws IOException {
UnixPath hostFile = new UnixPath(fileSystem.getPath("/file")).createNewFile();
ContainerPath destination = ContainerPath.fromPathInContainer(containerFs, Path.of("/dest"), userScope.root());
// If file is copied to JimFS path, the UID/GIDs are not fixed
Files.copy(hostFile.toPath(), destination.pathOnHost());
assertEquals(String.valueOf(userScope.namespace().overflowId()), Files.getOwner(destination).getName());
Files.delete(destination);
Files.copy(hostFile.toPath(), destination);
assertOwnership(destination, 0, 0, 10000, 11000);
// Set owner + group on both source host file and destination container file
hostFile.setOwnerId(5).setGroupId(10);
new UnixPath(destination).setOwnerId(500).setGroupId(200);
assertOwnership(destination, 500, 200, 10500, 11200);
// Copy the host file to destination again with COPY_ATTRIBUTES and REPLACE_EXISTING
Files.copy(hostFile.toPath(), destination, StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
// The destination is recreated, so the owner should be root
assertOwnership(destination, 0, 0, 10000, 11000);
// Set owner + group and copy within ContainerFS
new UnixPath(destination).setOwnerId(500).setGroupId(200);
ContainerPath destination2 = ContainerPath.fromPathInContainer(containerFs, Path.of("/dest2"), userScope.root());
Files.copy(destination, destination2, StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
assertOwnership(destination2, 500, 200, 10500, 11200);
}
@Test
public void move() throws IOException {
UnixPath hostFile = new UnixPath(fileSystem.getPath("/file")).createNewFile();
ContainerPath destination = ContainerPath.fromPathInContainer(containerFs, Path.of("/dest"), userScope.root());
// If file is moved to JimFS path, the UID/GIDs are not fixed
Files.move(hostFile.toPath(), destination.pathOnHost());
assertEquals(String.valueOf(userScope.namespace().overflowId()), Files.getOwner(destination).getName());
Files.delete(destination);
hostFile.createNewFile();
Files.move(hostFile.toPath(), destination);
assertOwnership(destination, 0, 0, 10000, 11000);
// Set owner + group on both source host file and destination container file
hostFile.createNewFile();
hostFile.setOwnerId(5).setGroupId(10);
new UnixPath(destination).setOwnerId(500).setGroupId(200);
assertOwnership(destination, 500, 200, 10500, 11200);
// Move the host file to destination again with COPY_ATTRIBUTES and REPLACE_EXISTING
Files.move(hostFile.toPath(), destination, StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
// The destination is recreated, so the owner should be root
assertOwnership(destination, 0, 0, 10000, 11000);
// Set owner + group and move within ContainerFS
new UnixPath(destination).setOwnerId(500).setGroupId(200);
ContainerPath destination2 = ContainerPath.fromPathInContainer(containerFs, Path.of("/dest2"), userScope.root());
Files.move(destination, destination2, StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
assertOwnership(destination2, 500, 200, 10500, 11200);
}
@Test
public void symlink() throws IOException {
ContainerPath source = ContainerPath.fromPathInContainer(containerFs, Path.of("/src"), userScope.root());
// Symlink from ContainerPath to some relative path (different FS provider)
Files.createSymbolicLink(source, fileSystem.getPath("../relative/target"));
assertEquals(fileSystem.getPath("../relative/target"), Files.readSymbolicLink(source));
Files.delete(source);
// Symlinks from ContainerPath to a ContainerPath: Target is resolved within container with base FS provider
Files.createSymbolicLink(source, ContainerPath.fromPathInContainer(containerFs, Path.of("/path/in/container"), userScope.root()));
assertEquals(fileSystem.getPath("/path/in/container"), Files.readSymbolicLink(source));
assertOwnership(source, 0, 0, 10000, 11000);
}
@Test
public void disallow_operations_on_symlink() throws IOException {
Path destination = fileSystem.getPath("/dir/file");
Files.createDirectories(destination.getParent());
ContainerPath link = containerFs.getPath("/link");
Files.createSymbolicLink(link, destination);
// Cannot write file via symlink
assertThrows(IOException.class, () -> Files.writeString(link, "hello"));
assertOwnership(link, 0, 0, 10_000, 11_000);
Files.setAttribute(link, "unix:uid", 10); // This succeeds because attribute is set on the link (destination does not exist)
assertFalse(Files.exists(destination));
assertOwnership(link, 10, 0, 10_010, 11_000);
}
@Test
public void disallow_operations_on_parent_symlink() throws IOException {
Path destination = fileSystem.getPath("/dir/sub/folder");
Files.createDirectories(destination.getParent());
// Create symlink /some/dir/link -> /dir/sub
ContainerPath link = containerFs.getPath("/some/dir/link");
Files.createDirectories(link.getParent());
Files.createSymbolicLink(link, destination.getParent());
ContainerPath file = link.resolve("file");
assertThrows(IOException.class, () -> Files.writeString(file, "hello"));
Files.writeString(file.pathOnHost(), "hello"); // Writing through host FS works
}
@Test
public void permissions() throws IOException {
assertPermissions(Files.createDirectory(containerFs.getPath("/dir1")), "rwxr-x---");
assertPermissions(Files.createDirectory(containerFs.getPath("/dir2"), permissionsFromString("r-x-w-rw-")), "r-x-w-rw-");
assertPermissions(Files.createDirectories(containerFs.getPath("/sub/dir/leaf"), permissionsFromString("r-x-w-rw-")), "r-x-w-rw-");
assertPermissions(containerFs.getPath("/sub/dir"), "r-x-w-rw-"); // Non-leafs get the same permission as the leaf
// TODO: Uncomment when JimFS forwards attributes for SecureDirectoryStream::newByteChannel
// assertPermissions(Files.createFile(containerFs.getPath("/file1")), "rw-r-----");
// assertPermissions(Files.createFile(containerFs.getPath("/file2"), permissionsFromString("r-x-w-rw-")), "r-x-w-rw-");
}
private static void assertOwnership(ContainerPath path, int contUid, int contGid, int hostUid, int hostGid) throws IOException {
assertOwnership(path, contUid, contGid);
assertOwnership(path.pathOnHost(), hostUid, hostGid);
}
private static void assertOwnership(Path path, int uid, int gid) throws IOException {
Map<String, Object> attrs = Files.readAttributes(path, "unix:*", LinkOption.NOFOLLOW_LINKS);
assertEquals(uid, attrs.get("uid"));
assertEquals(gid, attrs.get("gid"));
}
private static void assertPermissions(Path path, String expected) throws IOException {
String actual = PosixFilePermissions.toString(Files.getPosixFilePermissions(path));
assertEquals(expected, actual);
}
private static FileAttribute<?> permissionsFromString(String permissions) {
return PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString(permissions));
}
}
|
