2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 The FreeBSD Foundation
6 * This software was developed by BFF Storage Systems, LLC under sponsorship
7 * from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/param.h>
34 #include <sys/module.h>
35 #include <sys/sysctl.h>
39 #include <semaphore.h>
43 #include <gtest/gtest.h>
48 using namespace testing;
50 /* Check that fusefs(4) is accessible and the current user can mount(2) */
51 void check_environment()
53 const char *devnode = "/dev/fuse";
54 const char *usermount_node = "vfs.usermount";
55 int usermount_val = 0;
56 size_t usermount_size = sizeof(usermount_val);
57 if (eaccess(devnode, R_OK | W_OK)) {
58 if (errno == ENOENT) {
59 GTEST_SKIP() << devnode << " does not exist";
60 } else if (errno == EACCES) {
61 GTEST_SKIP() << devnode <<
62 " is not accessible by the current user";
64 GTEST_SKIP() << strerror(errno);
67 sysctlbyname(usermount_node, &usermount_val, &usermount_size,
69 if (geteuid() != 0 && !usermount_val)
70 GTEST_SKIP() << "current user is not allowed to mount";
73 class FuseEnv: public Environment {
74 virtual void SetUp() {
78 void FuseTest::SetUp() {
79 const char *node = "vfs.maxbcachebuf";
81 size_t size = sizeof(val);
84 * XXX check_environment should be called from FuseEnv::SetUp, but
85 * can't due to https://github.com/google/googletest/issues/2189
91 ASSERT_EQ(0, sysctlbyname(node, &val, &size, NULL, 0))
96 m_mock = new MockFS(m_maxreadahead, m_allow_other,
97 m_default_permissions, m_push_symlinks_in, m_ro,
100 * FUSE_ACCESS is called almost universally. Expecting it in
101 * each test case would be super-annoying. Instead, set a
102 * default expectation for FUSE_ACCESS and return ENOSYS.
104 * Individual test cases can override this expectation since
105 * googlemock evaluates expectations in LIFO order.
107 EXPECT_CALL(*m_mock, process(
108 ResultOf([=](auto in) {
109 return (in->header.opcode == FUSE_ACCESS);
113 .WillRepeatedly(Invoke(ReturnErrno(ENOSYS)));
114 } catch (std::system_error err) {
115 FAIL() << err.what();
120 FuseTest::expect_access(uint64_t ino, mode_t access_mode, int error)
122 EXPECT_CALL(*m_mock, process(
123 ResultOf([=](auto in) {
124 return (in->header.opcode == FUSE_ACCESS &&
125 in->header.nodeid == ino &&
126 in->body.access.mask == access_mode);
129 ).WillOnce(Invoke(ReturnErrno(error)));
133 FuseTest::expect_flush(uint64_t ino, int times, ProcessMockerT r)
135 EXPECT_CALL(*m_mock, process(
136 ResultOf([=](auto in) {
137 return (in->header.opcode == FUSE_FLUSH &&
138 in->header.nodeid == ino);
142 .WillRepeatedly(Invoke(r));
145 void FuseTest::expect_getattr(uint64_t ino, uint64_t size)
147 EXPECT_CALL(*m_mock, process(
148 ResultOf([=](auto in) {
149 return (in->header.opcode == FUSE_GETATTR &&
150 in->header.nodeid == ino);
153 ).WillOnce(Invoke(ReturnImmediate([=](auto i __unused, auto out) {
154 SET_OUT_HEADER_LEN(out, attr);
155 out->body.attr.attr.ino = ino; // Must match nodeid
156 out->body.attr.attr.mode = S_IFREG | 0644;
157 out->body.attr.attr.size = size;
158 out->body.attr.attr_valid = UINT64_MAX;
162 void FuseTest::expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
163 uint64_t size, int times)
165 EXPECT_LOOKUP(1, relpath)
167 .WillRepeatedly(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
168 SET_OUT_HEADER_LEN(out, entry);
169 out->body.entry.attr.mode = mode;
170 out->body.entry.nodeid = ino;
171 out->body.entry.attr.nlink = 1;
172 out->body.entry.attr_valid = UINT64_MAX;
173 out->body.entry.attr.size = size;
177 void FuseTest::expect_open(uint64_t ino, uint32_t flags, int times)
179 EXPECT_CALL(*m_mock, process(
180 ResultOf([=](auto in) {
181 return (in->header.opcode == FUSE_OPEN &&
182 in->header.nodeid == ino);
186 .WillRepeatedly(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
187 out->header.len = sizeof(out->header);
188 SET_OUT_HEADER_LEN(out, open);
189 out->body.open.fh = FH;
190 out->body.open.open_flags = flags;
194 void FuseTest::expect_opendir(uint64_t ino)
196 /* opendir(3) calls fstatfs */
197 EXPECT_CALL(*m_mock, process(
198 ResultOf([](auto in) {
199 return (in->header.opcode == FUSE_STATFS);
202 ).WillRepeatedly(Invoke(ReturnImmediate([=](auto i __unused, auto out) {
203 SET_OUT_HEADER_LEN(out, statfs);
206 EXPECT_CALL(*m_mock, process(
207 ResultOf([=](auto in) {
208 return (in->header.opcode == FUSE_OPENDIR &&
209 in->header.nodeid == ino);
212 ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
213 out->header.len = sizeof(out->header);
214 SET_OUT_HEADER_LEN(out, open);
215 out->body.open.fh = FH;
219 void FuseTest::expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
220 uint64_t osize, const void *contents)
222 EXPECT_CALL(*m_mock, process(
223 ResultOf([=](auto in) {
224 return (in->header.opcode == FUSE_READ &&
225 in->header.nodeid == ino &&
226 in->body.read.fh == FH &&
227 in->body.read.offset == offset &&
228 in->body.read.size == isize);
231 ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
232 out->header.len = sizeof(struct fuse_out_header) + osize;
233 memmove(out->body.bytes, contents, osize);
234 }))).RetiresOnSaturation();
237 void FuseTest::expect_release(uint64_t ino, uint64_t fh)
239 EXPECT_CALL(*m_mock, process(
240 ResultOf([=](auto in) {
241 return (in->header.opcode == FUSE_RELEASE &&
242 in->header.nodeid == ino &&
243 in->body.release.fh == fh);
246 ).WillOnce(Invoke(ReturnErrno(0)));
249 void FuseTest::expect_releasedir(uint64_t ino, ProcessMockerT r)
251 EXPECT_CALL(*m_mock, process(
252 ResultOf([=](auto in) {
253 return (in->header.opcode == FUSE_RELEASEDIR &&
254 in->header.nodeid == ino &&
255 in->body.release.fh == FH);
258 ).WillOnce(Invoke(r));
261 void FuseTest::expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
262 uint64_t osize, uint32_t flags, const void *contents)
264 EXPECT_CALL(*m_mock, process(
265 ResultOf([=](auto in) {
266 const char *buf = (const char*)in->body.bytes +
267 sizeof(struct fuse_write_in);
270 if (in->body.write.write_flags & FUSE_WRITE_CACHE)
273 pid_ok = (pid_t)in->header.pid == getpid();
275 return (in->header.opcode == FUSE_WRITE &&
276 in->header.nodeid == ino &&
277 in->body.write.fh == FH &&
278 in->body.write.offset == offset &&
279 in->body.write.size == isize &&
281 in->body.write.write_flags == flags &&
282 0 == bcmp(buf, contents, isize));
285 ).WillOnce(Invoke(ReturnImmediate([=](auto in __unused, auto out) {
286 SET_OUT_HEADER_LEN(out, write);
287 out->body.write.size = osize;
292 get_unprivileged_uid(uid_t *uid)
297 * First try "tests", Kyua's default unprivileged user. XXX after
298 * GoogleTest gains a proper Kyua wrapper, get this with the Kyua API
300 pw = getpwnam("tests");
302 /* Fall back to "nobody" */
303 pw = getpwnam("nobody");
306 GTEST_SKIP() << "Test requires an unprivileged user";
311 FuseTest::fork(bool drop_privs, std::function<void()> parent_func,
312 std::function<int()> child_func)
315 int mprot = PROT_READ | PROT_WRITE;
316 int mflags = MAP_ANON | MAP_SHARED;
321 get_unprivileged_uid(&uid);
326 sem = (sem_t*)mmap(NULL, sizeof(*sem), mprot, mflags, -1, 0);
327 ASSERT_NE(MAP_FAILED, sem) << strerror(errno);
328 ASSERT_EQ(0, sem_init(sem, 1, 0)) << strerror(errno);
330 if ((child = ::fork()) == 0) {
340 if (drop_privs && 0 != setreuid(-1, uid)) {
350 } else if (child > 0) {
354 * In parent. Cleanup must happen here, because it's still
357 m_mock->m_child_pid = child;
358 ASSERT_NO_FATAL_FAILURE(parent_func());
360 /* Signal the child process to go */
361 ASSERT_EQ(0, sem_post(sem)) << strerror(errno);
363 ASSERT_LE(0, wait(&child_status)) << strerror(errno);
364 ASSERT_EQ(0, WEXITSTATUS(child_status));
366 FAIL() << strerror(errno);
368 munmap(sem, sizeof(*sem));
371 static void usage(char* progname) {
372 fprintf(stderr, "Usage: %s [-v]\n\t-v increase verbosity\n", progname);
376 int main(int argc, char **argv) {
378 FuseEnv *fuse_env = new FuseEnv;
380 InitGoogleTest(&argc, argv);
381 AddGlobalTestEnvironment(fuse_env);
383 while ((ch = getopt(argc, argv, "v")) != -1) {
394 return (RUN_ALL_TESTS());