aboutsummaryrefslogtreecommitdiff
path: root/lldb/unittests/Utility/FileSpecListTest.cpp
blob: d3f89ad0dfcb3c66c35cb13141f7ceecf84841b3 (plain)
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
//===-- FileSpecListTest.cpp ----------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "gtest/gtest.h"

#include "MockSymlinkFileSystem.h"
#include "lldb/Utility/FileSpecList.h"
#include "lldb/Utility/RealpathPrefixes.h"

using namespace lldb_private;

static FileSpec PosixSpec(llvm::StringRef path) {
  return FileSpec(path, FileSpec::Style::posix);
}

static FileSpec WindowsSpec(llvm::StringRef path) {
  return FileSpec(path, FileSpec::Style::windows);
}

TEST(SupportFileListTest, RelativePathMatchesPosix) {

  const FileSpec fullpath = PosixSpec("/build/src/main.cpp");
  const FileSpec relative = PosixSpec("./src/main.cpp");
  const FileSpec basename = PosixSpec("./main.cpp");
  const FileSpec full_wrong = PosixSpec("/other/wrong/main.cpp");
  const FileSpec rel_wrong = PosixSpec("./wrong/main.cpp");
  // Make sure these don't match "src/main.cpp" as we want to match full
  // directories only
  const FileSpec rel2_wrong = PosixSpec("asrc/main.cpp");
  const FileSpec rel3_wrong = PosixSpec("rc/main.cpp");

  SupportFileList files;
  files.Append(fullpath);
  files.Append(relative);
  files.Append(basename);
  files.Append(full_wrong);
  files.Append(rel_wrong);
  files.Append(rel2_wrong);
  files.Append(rel3_wrong);

  // Make sure the full path only matches the first entry
  EXPECT_EQ((size_t)0, files.FindCompatibleIndex(0, fullpath));
  EXPECT_EQ((size_t)1, files.FindCompatibleIndex(1, fullpath));
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(2, fullpath));
  EXPECT_EQ((size_t)UINT32_MAX, files.FindCompatibleIndex(3, fullpath));
  // Make sure the relative path matches the all of the entries that contain
  // the relative path
  EXPECT_EQ((size_t)0, files.FindCompatibleIndex(0, relative));
  EXPECT_EQ((size_t)1, files.FindCompatibleIndex(1, relative));
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(2, relative));
  EXPECT_EQ((size_t)UINT32_MAX, files.FindCompatibleIndex(3, relative));

  // Make sure looking file a file using the basename matches all entries
  EXPECT_EQ((size_t)0, files.FindCompatibleIndex(0, basename));
  EXPECT_EQ((size_t)1, files.FindCompatibleIndex(1, basename));
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(2, basename));
  EXPECT_EQ((size_t)3, files.FindCompatibleIndex(3, basename));
  EXPECT_EQ((size_t)4, files.FindCompatibleIndex(4, basename));
  EXPECT_EQ((size_t)5, files.FindCompatibleIndex(5, basename));
  EXPECT_EQ((size_t)6, files.FindCompatibleIndex(6, basename));

  // Make sure that paths that have a common suffix don't return values that
  // don't match on directory delimiters.
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(0, rel2_wrong));
  EXPECT_EQ((size_t)5, files.FindCompatibleIndex(3, rel2_wrong));
  EXPECT_EQ((size_t)UINT32_MAX, files.FindCompatibleIndex(6, rel2_wrong));

  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(0, rel3_wrong));
  EXPECT_EQ((size_t)6, files.FindCompatibleIndex(3, rel3_wrong));
}

TEST(SupportFileListTest, RelativePathMatchesWindows) {

  const FileSpec fullpath = WindowsSpec(R"(C:\build\src\main.cpp)");
  const FileSpec relative = WindowsSpec(R"(.\src\main.cpp)");
  const FileSpec basename = WindowsSpec(R"(.\main.cpp)");
  const FileSpec full_wrong = WindowsSpec(R"(\other\wrong\main.cpp)");
  const FileSpec rel_wrong = WindowsSpec(R"(.\wrong\main.cpp)");
  // Make sure these don't match "src\main.cpp" as we want to match full
  // directories only
  const FileSpec rel2_wrong = WindowsSpec(R"(asrc\main.cpp)");
  const FileSpec rel3_wrong = WindowsSpec(R"("rc\main.cpp)");

  SupportFileList files;
  files.Append(fullpath);
  files.Append(relative);
  files.Append(basename);
  files.Append(full_wrong);
  files.Append(rel_wrong);
  files.Append(rel2_wrong);
  files.Append(rel3_wrong);

  // Make sure the full path only matches the first entry
  EXPECT_EQ((size_t)0, files.FindCompatibleIndex(0, fullpath));
  EXPECT_EQ((size_t)1, files.FindCompatibleIndex(1, fullpath));
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(2, fullpath));
  EXPECT_EQ((size_t)UINT32_MAX, files.FindCompatibleIndex(3, fullpath));
  // Make sure the relative path matches the all of the entries that contain
  // the relative path
  EXPECT_EQ((size_t)0, files.FindCompatibleIndex(0, relative));
  EXPECT_EQ((size_t)1, files.FindCompatibleIndex(1, relative));
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(2, relative));
  EXPECT_EQ((size_t)UINT32_MAX, files.FindCompatibleIndex(3, relative));

  // Make sure looking file a file using the basename matches all entries
  EXPECT_EQ((size_t)0, files.FindCompatibleIndex(0, basename));
  EXPECT_EQ((size_t)1, files.FindCompatibleIndex(1, basename));
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(2, basename));
  EXPECT_EQ((size_t)3, files.FindCompatibleIndex(3, basename));
  EXPECT_EQ((size_t)4, files.FindCompatibleIndex(4, basename));
  EXPECT_EQ((size_t)5, files.FindCompatibleIndex(5, basename));
  EXPECT_EQ((size_t)6, files.FindCompatibleIndex(6, basename));

  // Make sure that paths that have a common suffix don't return values that
  // don't match on directory delimiters.
  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(0, rel2_wrong));
  EXPECT_EQ((size_t)5, files.FindCompatibleIndex(3, rel2_wrong));
  EXPECT_EQ((size_t)UINT32_MAX, files.FindCompatibleIndex(6, rel2_wrong));

  EXPECT_EQ((size_t)2, files.FindCompatibleIndex(0, rel3_wrong));
  EXPECT_EQ((size_t)6, files.FindCompatibleIndex(3, rel3_wrong));
}

// Support file is a symlink to the breakpoint file.
// Absolute paths are used.
// A matching prefix is set.
// Should find it compatible.
TEST(SupportFileListTest, SymlinkedAbsolutePaths) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("/symlink_dir/foo.h"), PosixSpec("/real_dir/foo.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("/symlink_dir"));
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("/symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("/real_dir/foo.h"), &prefixes);
  EXPECT_EQ(ret, (size_t)0);
}

// Support file is a symlink to the breakpoint file.
// Absolute paths are used.
// A matching prefix is set, which is the root directory.
// Should find it compatible.
TEST(SupportFileListTest, RootDirectory) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("/symlink_dir/foo.h"), PosixSpec("/real_dir/foo.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("/"));
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("/symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("/real_dir/foo.h"), &prefixes);
  EXPECT_EQ(ret, (size_t)0);
}

// Support file is a symlink to the breakpoint file.
// Relative paths are used.
// A matching prefix is set.
// Should find it compatible.
TEST(SupportFileListTest, SymlinkedRelativePaths) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("symlink_dir/foo.h"), PosixSpec("real_dir/foo.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("symlink_dir"));
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("real_dir/foo.h"), &prefixes);
  EXPECT_EQ(ret, (size_t)0);
}

// Support file is a symlink to the breakpoint file.
// A matching prefix is set.
// Input file only match basename and not directory.
// Should find it incompatible.
TEST(SupportFileListTest, RealpathOnlyMatchFileName) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("symlink_dir/foo.h"), PosixSpec("real_dir/foo.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("symlink_dir"));
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("some_other_dir/foo.h"), &prefixes);
  EXPECT_EQ(ret, UINT32_MAX);
}

// Support file is a symlink to the breakpoint file.
// A prefix is set, which is a matching string prefix, but not a path prefix.
// Should find it incompatible.
TEST(SupportFileListTest, DirectoryMatchStringPrefixButNotWholeDirectoryName) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("symlink_dir/foo.h"), PosixSpec("real_dir/foo.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("symlink")); // This is a string prefix of the
                                               // symlink but not a path prefix.
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("real_dir/foo.h"), &prefixes);
  EXPECT_EQ(ret, UINT32_MAX);
}

// Support file is a symlink to the breakpoint file.
// A matching prefix is set.
// However, the breakpoint is set with a partial path.
// Should find it compatible.
TEST(SupportFileListTest, PartialBreakpointPath) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("symlink_dir/foo.h"), PosixSpec("/real_dir/foo.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("symlink_dir"));
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("real_dir/foo.h"), &prefixes);
  EXPECT_EQ(ret, (size_t)0);
}

// Support file is a symlink to the breakpoint file.
// A matching prefix is set.
// However, the basename is different between the symlink and its target.
// Should find it incompatible.
TEST(SupportFileListTest, DifferentBasename) {
  // Prepare FS
  llvm::IntrusiveRefCntPtr<MockSymlinkFileSystem> fs(new MockSymlinkFileSystem(
      PosixSpec("/symlink_dir/foo.h"), PosixSpec("/real_dir/bar.h"),
      FileSpec::Style::posix));

  // Prepare RealpathPrefixes
  FileSpecList file_spec_list;
  file_spec_list.Append(PosixSpec("/symlink_dir"));
  RealpathPrefixes prefixes(file_spec_list, fs);

  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("/symlink_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("real_dir/bar.h"), &prefixes);
  EXPECT_EQ(ret, UINT32_MAX);
}

// No prefixes are configured.
// The support file and the breakpoint file are different.
// Should find it incompatible.
TEST(SupportFileListTest, NoPrefixes) {
  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("/real_dir/bar.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("/real_dir/foo.h"), nullptr);
  EXPECT_EQ(ret, UINT32_MAX);
}

// No prefixes are configured.
// The support file and the breakpoint file are the same.
// Should find it compatible.
TEST(SupportFileListTest, SameFile) {
  // Prepare support file list
  SupportFileList support_file_list;
  support_file_list.Append(PosixSpec("/real_dir/foo.h"));

  // Test
  size_t ret = support_file_list.FindCompatibleIndex(
      0, PosixSpec("/real_dir/foo.h"), nullptr);
  EXPECT_EQ(ret, (size_t)0);
}