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
|
#include <filesystem>
#include <optional>
#include <sstream>
#include "ast/passes/parser.h"
#include "ast/passes/printer.h"
#include "ast/passes/resolve_imports.h"
#include "util/temp.h"
#include "gmock/gmock-matchers.h"
#include "gtest/gtest.h"
namespace bpftrace::test::imports {
using ::bpftrace::ast::Imports;
using ::bpftrace::util::TempDir;
using ::bpftrace::util::TempFile;
using ::testing::HasSubstr;
class ImportTest : public ::testing::Test {
protected:
std::vector<TempFile> files;
[[nodiscard]] static bool set_perms(TempDir &base,
const std::string &path,
const std::filesystem::perms &perms)
{
std::error_code ec = {};
std::filesystem::permissions(
base.path() / path, perms, std::filesystem::perm_options::replace, ec);
return !static_cast<bool>(ec);
}
[[nodiscard]] bool create_dir(
TempDir &base,
const std::string &path,
std::optional<std::filesystem::perms> perms = std::nullopt)
{
std::error_code ec = {};
std::filesystem::create_directories(base.path() / path, ec);
if (ec) {
return false;
}
if (perms.has_value()) {
return set_perms(base, path, perms.value());
}
return true;
}
[[nodiscard]] bool create_file(
TempDir &base,
const std::string &path,
std::string contents,
std::optional<std::filesystem::perms> perms = std::nullopt)
{
std::filesystem::path p(path);
std::filesystem::path parent = p;
while (parent.has_parent_path()) {
// These will always use the default permissions.
parent = parent.parent_path();
if (!create_dir(base, parent.string())) {
return false;
}
}
// Create the file at the given path.
auto f = base.create_file(path, false);
if (!f) {
return false;
}
if (!f->write_all(contents)) {
return false;
}
files.emplace_back(std::move(*f));
if (perms.has_value()) {
return set_perms(base, path, perms.value());
}
return true;
}
};
using checkFn = std::function<void(Imports &)>;
void test(const std::string &input,
std::vector<std::string> &&import_paths,
std::variant<checkFn, std::string> check)
{
BPFtrace bpftrace;
bpftrace.config_->unstable_import = ConfigUnstable::enable;
ast::ASTContext ast("stdin", input);
std::stringstream msg;
msg << "\nInput:\n" << input << "\n\nOutput:\n";
auto ok = ast::PassManager()
.put(ast)
.put(bpftrace)
.add(ast::AllParsePasses({}, std::move(import_paths)))
.run();
std::stringstream out;
ast.diagnostics().emit(out);
if (std::holds_alternative<checkFn>(check)) {
ASSERT_TRUE(ok && ast.diagnostics().ok()) << msg.str() << out.str();
ast::Printer printer(msg);
printer.visit(ast.root);
std::get<checkFn>(check)(ok->get<Imports>());
} else {
ASSERT_FALSE(ok && ast.diagnostics().ok()) << msg.str() << out.str();
EXPECT_THAT(out.str(), HasSubstr(std::get<std::string>(check)))
<< msg.str() << out.str();
}
}
TEST(Imports, stdlib_works)
{
std::function<void(Imports &)> fn = []([[maybe_unused]] Imports &imports) {
// Should be implicitly imported. As we add files to the standard library,
// we should check that one of each kind exists here.
};
// The standard library import should be implicit.
test(R"(begin {})", {}, fn);
// Importing explicitly without any explicit file system paths should be the
// same result as importing the standard library implicitly.
test(R"(import "stdlib"; begin {})", {}, fn);
}
TEST_F(ImportTest, stdlib_implicit_rules)
{
auto dir = TempDir::create();
ASSERT_TRUE(bool(dir));
// If we have a `stdlib` directory, it should override the implicit import.
ASSERT_TRUE(create_file(*dir, "stdlib/foo.bt", ""));
test(R"(import "stdlib"; begin {})", { dir->path() }, [](Imports &imports) {
EXPECT_TRUE(imports.scripts.contains("stdlib/foo.bt"));
EXPECT_FALSE(imports.scripts.contains("stdlib/base.bt"));
});
// Without the explicit import, it should use the builtin one.
test(R"(begin {})", { dir->path() }, [](Imports &imports) {
EXPECT_FALSE(imports.scripts.contains("stdlib/foo.bt"));
EXPECT_TRUE(imports.scripts.contains("stdlib/base.bt"));
});
}
TEST_F(ImportTest, world_writable_ignored)
{
const std::string &err = "global write permissions";
// This is the directory itself that is broken. This should fail all
// recursive imports.
auto dir = TempDir::create();
ASSERT_TRUE(bool(dir));
ASSERT_TRUE(create_dir(*dir, "a"));
ASSERT_TRUE(create_dir(*dir, "a/lib", std::filesystem::perms(0777)));
ASSERT_TRUE(create_file(*dir, "a/lib/foo.bt", ""));
test(R"(import "lib"; begin {})", { dir->path() / "a" }, err);
test(R"(import "lib/foo.bt"; begin {})", { dir->path() / "a" }, err);
// This is a base that is broken. We don't allow the recursive import
// (because that could move), but do allow the nested import, because
// the contents of the `lib` directory itself should not change.
ASSERT_TRUE(create_dir(*dir, "b", std::filesystem::perms(0777)));
ASSERT_TRUE(create_dir(*dir, "b/lib"));
ASSERT_TRUE(create_file(*dir, "b/lib/foo.bt", ""));
test(R"(import "lib"; begin {})", { dir->path() / "b" }, err);
test(R"(import "lib/foo.bt"; begin {})",
{ dir->path() / "b" },
[]([[maybe_unused]] Imports &import) {});
}
TEST_F(ImportTest, import_ordering)
{
auto dir = TempDir::create();
ASSERT_TRUE(bool(dir));
ASSERT_TRUE(create_file(*dir, "a/lib/foo.bt", ""));
ASSERT_TRUE(create_file(*dir, "b/lib/bar.bt", ""));
// This should match the first directory, and import everything there only.
test(R"(import "lib"; begin {})",
{ dir->path() / "a", dir->path() / "b" },
[](Imports &imports) {
EXPECT_TRUE(imports.scripts.contains("lib/foo.bt"));
EXPECT_FALSE(imports.scripts.contains("lib/bar.bt"));
});
// This should match only the second import.
test(R"(import "lib/bar.bt"; begin {})",
{ dir->path() / "a", dir->path() / "b" },
[](Imports &imports) {
EXPECT_FALSE(imports.scripts.contains("lib/foo.bt"));
EXPECT_TRUE(imports.scripts.contains("lib/bar.bt"));
});
}
} // namespace bpftrace::test::imports
|
