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 * TODO: remove FUSE_WRITE_CACHE definition when upgrading to protocol 7.9.
33 * This bit was actually part of kernel protocol version 7.2, but never
34 * documented until 7.9
36 #ifndef FUSE_WRITE_CACHE
37 #define FUSE_WRITE_CACHE 1
40 class FuseTest : public ::testing::Test {
42 uint32_t m_maxreadahead;
43 uint32_t m_init_flags;
45 bool m_default_permissions;
46 bool m_push_symlinks_in;
48 MockFS *m_mock = NULL;
49 const static uint64_t FH = 0xdeadbeef1a7ebabe;
56 * libfuse's default max_readahead is UINT_MAX, though it can
59 m_maxreadahead(UINT_MAX),
62 m_default_permissions(false),
63 m_push_symlinks_in(false),
69 virtual void TearDown() {
75 * Create an expectation that FUSE_ACCESS will be called once for the
76 * given inode with the given access_mode, returning the given errno
78 void expect_access(uint64_t ino, mode_t access_mode, int error);
81 * Create an expectation that FUSE_FLUSH will be called times times for
84 void expect_flush(uint64_t ino, int times, ProcessMockerT r);
87 * Create an expectation that FUSE_GETATTR will be called for the given
88 * inode any number of times. It will respond with a few basic
89 * attributes, like the given size and the mode S_IFREG | 0644
91 void expect_getattr(uint64_t ino, uint64_t size);
94 * Create an expectation that FUSE_LOOKUP will be called for the given
95 * path exactly times times. It will respond with inode ino, mode
96 * mode, filesize size, and cache validity forever.
98 void expect_lookup(const char *relpath, uint64_t ino, mode_t mode,
99 uint64_t size, int times);
102 * Create an expectation that FUSE_GETATTR will be called for the given
103 * inode exactly times times. It will return with open_flags flags and
106 void expect_open(uint64_t ino, uint32_t flags, int times);
109 * Create an expectation that FUSE_OPENDIR will be called exactly once
112 void expect_opendir(uint64_t ino);
115 * Create an expectation that FUSE_READ will be called exactly once for
116 * the given inode, at offset offset and with size isize. It will
117 * return the first osize bytes from contents
119 void expect_read(uint64_t ino, uint64_t offset, uint64_t isize,
120 uint64_t osize, const void *contents);
123 * Create an expectation that FUSE_RELEASE will be called exactly once
124 * for the given inode and filehandle, returning success
126 void expect_release(uint64_t ino, uint64_t fh);
129 * Create an expectation that FUSE_RELEASEDIR will be called exactly
130 * once for the given inode
132 void expect_releasedir(uint64_t ino, ProcessMockerT r);
135 * Create an expectation that FUSE_WRITE will be called exactly once
136 * for the given inode, at offset offset, with write_flags flags,
137 * size isize and buffer contents. It will return osize
139 void expect_write(uint64_t ino, uint64_t offset, uint64_t isize,
140 uint64_t osize, uint32_t flags, const void *contents);
143 * Helper that runs code in a child process.
145 * First, parent_func runs in the parent process.
146 * Then, child_func runs in the child process, dropping privileges if
148 * Finally, fusetest_fork returns.
152 * fusetest_fork will FAIL the test if child_func returns nonzero.
153 * It may SKIP the test, which the caller should detect with the
154 * IsSkipped() method.
156 void fork(bool drop_privs,
157 std::function<void()> parent_func,
158 std::function<int()> child_func);