GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/pathspec/pathspec.cc
Date: 2025-12-28 02:35:52
Exec Total Coverage
Lines: 198 207 95.7%
Branches: 120 172 69.8%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "pathspec.h"
6
7 #include <cassert>
8
9 #include "util/logging.h"
10 #include "util/smalloc.h"
11
12 4800 Pathspec::Pathspec(const std::string &spec)
13 4800 : regex_(NULL)
14 4800 , relaxed_regex_(NULL)
15 4800 , prefix_regex_(NULL)
16 4800 , regex_compiled_(false)
17 4800 , relaxed_regex_compiled_(false)
18 4800 , prefix_regex_compiled_(false)
19 4800 , glob_string_compiled_(false)
20 4800 , glob_string_sequence_compiled_(false)
21 4800 , valid_(true)
22 4800 , absolute_(false) {
23
1/2
✓ Branch 1 taken 4800 times.
✗ Branch 2 not taken.
 4800 Parse(spec);
24
2/2
✓ Branch 1 taken 44 times.
✓ Branch 2 taken 4756 times.
 4800 if (patterns_.size() == 0) {
25 44 valid_ = false;
26 }
27
28 4800 ElementPatterns::const_iterator i = patterns_.begin();
29 4800 const ElementPatterns::const_iterator iend = patterns_.end();
30
2/2
✓ Branch 2 taken 10130 times.
✓ Branch 3 taken 4800 times.
 14930 for (; i != iend; ++i) {
31
2/2
✓ Branch 2 taken 57 times.
✓ Branch 3 taken 10073 times.
 10130 if (!i->IsValid()) {
32 57 valid_ = false;
33 }
34 }
35 4800 }
36
37 // Compiled regex structure cannot be duplicated and needs to be re-compiled
38 // Note: the copy-constructed object will perform a lazy evaluation again
39 1278 Pathspec::Pathspec(const Pathspec &other)
40 1278 : patterns_(other.patterns_)
41 1278 , regex_(NULL)
42 1278 , relaxed_regex_(NULL)
43 1278 , prefix_regex_(NULL)
44
1/2
✓ Branch 1 taken 1278 times.
✗ Branch 2 not taken.
 1278 , glob_string_(other.glob_string_)
45
1/2
✓ Branch 1 taken 1278 times.
✗ Branch 2 not taken.
 1278 , glob_string_sequence_(other.glob_string_sequence_)
46 1278 , regex_compiled_(false)
47 1278 , relaxed_regex_compiled_(false)
48 1278 , prefix_regex_compiled_(false)
49 1278 , glob_string_compiled_(other.glob_string_compiled_)
50 1278 , glob_string_sequence_compiled_(other.glob_string_sequence_compiled_)
51 1278 , valid_(other.valid_)
52 1278 , absolute_(other.absolute_) { }
53
54 6075 Pathspec::~Pathspec() { DestroyRegularExpressions(); }
55
56 132 Pathspec &Pathspec::operator=(const Pathspec &other) {
57
1/2
✓ Branch 0 taken 132 times.
✗ Branch 1 not taken.
 132 if (this != &other) {
58 132 DestroyRegularExpressions(); // see: copy c'tor for details
59 132 patterns_ = other.patterns_;
60
61 132 glob_string_compiled_ = other.glob_string_compiled_;
62 132 glob_string_ = other.glob_string_;
63
64 132 glob_string_sequence_compiled_ = other.glob_string_sequence_compiled_;
65 132 glob_string_sequence_ = other.glob_string_sequence_;
66
67 132 valid_ = other.valid_;
68 132 absolute_ = other.absolute_;
69 }
70
71 132 return *this;
72 }
73
74
75 4800 void Pathspec::Parse(const std::string &spec) {
76 // parsing is done using std::string iterators to walk through the entire
77 // pathspec parameter. Thus, all parsing methods receive references to these
78 // iterators and increment itr as they pass along.
79 4800 std::string::const_iterator itr = spec.begin();
80 4800 const std::string::const_iterator end = spec.end();
81
82 4800 absolute_ = (*itr == kSeparator);
83
2/2
✓ Branch 1 taken 18569 times.
✓ Branch 2 taken 4800 times.
 23369 while (itr != end) {
84
2/2
✓ Branch 1 taken 8439 times.
✓ Branch 2 taken 10130 times.
 18569 if (*itr == kSeparator) {
85 8439 ++itr;
86 8439 continue;
87 }
88
1/2
✓ Branch 1 taken 10130 times.
✗ Branch 2 not taken.
 10130 ParsePathElement(end, &itr);
89 }
90 4800 }
91
92 10130 void Pathspec::ParsePathElement(const std::string::const_iterator &end,
93 std::string::const_iterator *itr) {
94 // find the end of the current pattern element (next directory boundary)
95 10130 const std::string::const_iterator begin_element = *itr;
96
6/6
✓ Branch 1 taken 50794 times.
✓ Branch 2 taken 4706 times.
✓ Branch 4 taken 45370 times.
✓ Branch 5 taken 5424 times.
✓ Branch 6 taken 45370 times.
✓ Branch 7 taken 10130 times.
 55500 while (*itr != end && **itr != kSeparator) {
97 45370 ++(*itr);
98 }
99 10130 const std::string::const_iterator end_element = *itr;
100
101 // create a PathspecElementPattern out of this directory description
102
2/4
✓ Branch 1 taken 10130 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 10130 times.
✗ Branch 5 not taken.
 10130 patterns_.push_back(PathspecElementPattern(begin_element, end_element));
103 10130 }
104
105 11063 bool Pathspec::IsMatching(const std::string &query_path) const {
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 11063 times.
 11063 assert(IsValid());
107
108
2/2
✓ Branch 1 taken 193 times.
✓ Branch 2 taken 10870 times.
 11063 if (query_path.empty()) {
109 193 return false;
110 }
111
112 10870 const bool query_is_absolute = (query_path[0] == kSeparator);
113
2/2
✓ Branch 1 taken 6455 times.
✓ Branch 2 taken 578 times.
 7033 return (!query_is_absolute || this->IsAbsolute())
114
4/4
✓ Branch 0 taken 7033 times.
✓ Branch 1 taken 3837 times.
✓ Branch 3 taken 5003 times.
✓ Branch 4 taken 5289 times.
 17903 && IsPathspecMatching(query_path);
115 }
116
117 540 bool Pathspec::IsPrefixMatching(const std::string &query_path) const {
118
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 540 times.
 540 assert(IsValid());
119
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 540 times.
 540 assert(IsAbsolute());
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 540 times.
 540 if (query_path.empty()) {
122 ✗ return false;
123 }
124
125 540 const bool query_is_absolute = (query_path[0] == kSeparator);
126
4/4
✓ Branch 0 taken 495 times.
✓ Branch 1 taken 45 times.
✓ Branch 3 taken 315 times.
✓ Branch 4 taken 180 times.
 540 return (query_is_absolute && IsPathspecPrefixMatching(query_path));
127 }
128
129 3795 bool Pathspec::IsMatchingRelaxed(const std::string &query_path) const {
130
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 3795 times.
 3795 assert(IsValid());
131
132
2/2
✓ Branch 1 taken 36 times.
✓ Branch 2 taken 3759 times.
 3795 if (query_path.empty()) {
133 36 return false;
134 }
135
136 3759 return IsPathspecMatchingRelaxed(query_path);
137 }
138
139 10292 bool Pathspec::IsPathspecMatching(const std::string &query_path) const {
140 10292 return ApplyRegularExpression(query_path, GetRegularExpression());
141 }
142
143 495 bool Pathspec::IsPathspecPrefixMatching(const std::string &query_path) const {
144 495 return ApplyRegularExpression(query_path, GetPrefixRegularExpression());
145 }
146
147 3759 bool Pathspec::IsPathspecMatchingRelaxed(const std::string &query_path) const {
148 3759 return ApplyRegularExpression(query_path, GetRelaxedRegularExpression());
149 }
150
151 14546 bool Pathspec::ApplyRegularExpression(const std::string &query_path,
152 regex_t *regex) const {
153 14546 const char *path = query_path.c_str();
154 14546 const int retval = regexec(regex, path, 0, NULL, 0);
155
156
3/4
✓ Branch 0 taken 7902 times.
✓ Branch 1 taken 6644 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 7902 times.
 14546 if (retval != 0 && retval != REG_NOMATCH) {
157 ✗ PrintRegularExpressionError(retval);
158 }
159
160 14546 return (retval == 0);
161 }
162
163 10292 regex_t *Pathspec::GetRegularExpression() const {
164
2/2
✓ Branch 0 taken 2181 times.
✓ Branch 1 taken 8111 times.
 10292 if (!regex_compiled_) {
165 2181 const bool is_relaxed = false;
166
1/2
✓ Branch 1 taken 2181 times.
✗ Branch 2 not taken.
 2181 const std::string regex = GenerateRegularExpression(is_relaxed);
167
1/2
✓ Branch 2 taken 2181 times.
✗ Branch 3 not taken.
 2181 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
168
169
1/2
✓ Branch 1 taken 2181 times.
✗ Branch 2 not taken.
 2181 regex_ = CompileRegularExpression(regex);
170 2181 regex_compiled_ = true;
171 2181 }
172
173 10292 return regex_;
174 }
175
176 495 regex_t *Pathspec::GetPrefixRegularExpression() const {
177
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 405 times.
 495 if (!prefix_regex_compiled_) {
178 90 const bool is_relaxed = false;
179 90 const bool is_prefix = true;
180
1/2
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
 90 const std::string regex = GenerateRegularExpression(is_relaxed, is_prefix);
181
1/2
✓ Branch 2 taken 90 times.
✗ Branch 3 not taken.
 90 LogCvmfs(kLogPathspec, kLogDebug, "compiled regex: %s", regex.c_str());
182
183
1/2
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
 90 prefix_regex_ = CompileRegularExpression(regex);
184 90 prefix_regex_compiled_ = true;
185 90 }
186
187 495 return prefix_regex_;
188 }
189
190 3759 regex_t *Pathspec::GetRelaxedRegularExpression() const {
191
2/2
✓ Branch 0 taken 557 times.
✓ Branch 1 taken 3202 times.
 3759 if (!relaxed_regex_compiled_) {
192 557 const bool is_relaxed = true;
193
1/2
✓ Branch 1 taken 557 times.
✗ Branch 2 not taken.
 557 const std::string regex = GenerateRegularExpression(is_relaxed);
194
1/2
✓ Branch 2 taken 557 times.
✗ Branch 3 not taken.
 557 LogCvmfs(kLogPathspec, kLogDebug, "compiled relaxed regex: %s",
195 regex.c_str());
196
197
1/2
✓ Branch 1 taken 557 times.
✗ Branch 2 not taken.
 557 relaxed_regex_ = CompileRegularExpression(regex);
198 557 relaxed_regex_compiled_ = true;
199 557 }
200
201 3759 return relaxed_regex_;
202 }
203
204 2828 std::string Pathspec::GenerateRegularExpression(const bool is_relaxed,
205 const bool is_prefix) const {
206 // start matching at the first character
207
1/2
✓ Branch 2 taken 2828 times.
✗ Branch 3 not taken.
 2828 std::string regex = "^";
208
209 // absolute paths require a / in the beginning
210
2/2
✓ Branch 1 taken 2133 times.
✓ Branch 2 taken 695 times.
 2828 if (IsAbsolute()) {
211
1/2
✓ Branch 1 taken 2133 times.
✗ Branch 2 not taken.
 2133 regex += kSeparator;
212 }
213
214 // concatenate the regular expressions of the compiled path elements
215 2828 ElementPatterns::const_iterator i = patterns_.begin();
216 2828 const ElementPatterns::const_iterator iend = patterns_.end();
217
2/2
✓ Branch 2 taken 5921 times.
✓ Branch 3 taken 2828 times.
 8749 for (; i != iend; ++i) {
218
2/4
✓ Branch 2 taken 5921 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 5921 times.
✗ Branch 6 not taken.
 5921 regex += i->GenerateRegularExpression(is_relaxed);
219
2/2
✓ Branch 2 taken 3093 times.
✓ Branch 3 taken 2828 times.
 5921 if (i + 1 != iend) {
220
1/2
✓ Branch 1 taken 3093 times.
✗ Branch 2 not taken.
 3093 regex += kSeparator;
221 }
222 }
223
224
2/2
✓ Branch 0 taken 90 times.
✓ Branch 1 taken 2738 times.
 2828 if (is_prefix) {
225
1/2
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
 90 regex += "($|";
226
1/2
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
 90 regex += kSeparator;
227
1/2
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
 90 regex += ".*$)";
228 } else {
229 // a path might end with a trailing slash
230 // (pathspec does not distinguish files and directories)
231
1/2
✓ Branch 1 taken 2738 times.
✗ Branch 2 not taken.
 2738 regex += kSeparator;
232
1/2
✓ Branch 1 taken 2738 times.
✗ Branch 2 not taken.
 2738 regex += "?$";
233 }
234
235 5656 return regex;
236 }
237
238 2828 regex_t *Pathspec::CompileRegularExpression(const std::string &regex) const {
239 2828 regex_t *result = reinterpret_cast<regex_t *>(smalloc(sizeof(regex_t)));
240 2828 const int flags = REG_NOSUB | REG_NEWLINE | REG_EXTENDED;
241 2828 const int retval = regcomp(result, regex.c_str(), flags);
242
243
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2828 times.
 2828 if (retval != 0) {
244 ✗ PrintRegularExpressionError(retval);
245 ✗ assert(false && "failed to compile regex");
246 }
247
248 2828 return result;
249 }
250
251 6207 void Pathspec::DestroyRegularExpressions() {
252
2/2
✓ Branch 0 taken 2181 times.
✓ Branch 1 taken 4026 times.
 6207 if (regex_compiled_) {
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2181 times.
 2181 assert(regex_ != NULL);
254 2181 regfree(regex_);
255 2181 regex_ = NULL;
256 2181 regex_compiled_ = false;
257 }
258
259
2/2
✓ Branch 0 taken 557 times.
✓ Branch 1 taken 5650 times.
 6207 if (relaxed_regex_compiled_) {
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 557 times.
 557 assert(relaxed_regex_ != NULL);
261 557 regfree(relaxed_regex_);
262 557 relaxed_regex_ = NULL;
263 557 relaxed_regex_compiled_ = false;
264 }
265 6207 }
266
267 1881 bool Pathspec::operator==(const Pathspec &other) const {
268
1/2
✓ Branch 4 taken 1638 times.
✗ Branch 5 not taken.
 3519 if (patterns_.size() != other.patterns_.size() || IsValid() != other.IsValid()
269
6/6
✓ Branch 0 taken 1638 times.
✓ Branch 1 taken 243 times.
✓ Branch 4 taken 81 times.
✓ Branch 5 taken 1557 times.
✓ Branch 6 taken 324 times.
✓ Branch 7 taken 1557 times.
 3519 || IsAbsolute() != other.IsAbsolute()) {
270 324 return false;
271 }
272
273 1557 ElementPatterns::const_iterator i = patterns_.begin();
274 1557 const ElementPatterns::const_iterator iend = patterns_.end();
275 1557 ElementPatterns::const_iterator j = other.patterns_.begin();
276 1557 const ElementPatterns::const_iterator jend = other.patterns_.end();
277
278
5/6
✓ Branch 3 taken 3312 times.
✓ Branch 4 taken 672 times.
✓ Branch 6 taken 3312 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3312 times.
✓ Branch 9 taken 672 times.
 3984 for (; i != iend && j != jend; ++i, ++j) {
279
3/4
✓ Branch 3 taken 3312 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 885 times.
✓ Branch 6 taken 2427 times.
 3312 if (*i != *j) {
280 885 return false;
281 }
282 }
283
284 672 return true;
285 }
286
287 ✗ void Pathspec::PrintRegularExpressionError(const int error_code) const {
288 ✗ assert(regex_compiled_);
289 ✗ const size_t errbuf_size = 1024;
290 char error[errbuf_size];
291 ✗ regerror(error_code, regex_, error, errbuf_size);
292 ✗ LogCvmfs(kLogPathspec, kLogStderr, "RegEx Error: %d - %s", error_code, error);
293 }
294
295 748 const Pathspec::GlobStringSequence &Pathspec::GetGlobStringSequence() const {
296
1/2
✓ Branch 0 taken 748 times.
✗ Branch 1 not taken.
 748 if (!glob_string_sequence_compiled_) {
297 748 GenerateGlobStringSequence();
298 748 glob_string_sequence_compiled_ = true;
299 }
300 748 return glob_string_sequence_;
301 }
302
303
304 748 void Pathspec::GenerateGlobStringSequence() const {
305
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 748 times.
 748 assert(glob_string_sequence_.empty());
306 748 ElementPatterns::const_iterator i = patterns_.begin();
307 748 const ElementPatterns::const_iterator iend = patterns_.end();
308
2/2
✓ Branch 2 taken 1496 times.
✓ Branch 3 taken 748 times.
 2244 for (; i != iend; ++i) {
309
1/2
✓ Branch 2 taken 1496 times.
✗ Branch 3 not taken.
 1496 const std::string glob_string = i->GenerateGlobString();
310
1/2
✓ Branch 1 taken 1496 times.
✗ Branch 2 not taken.
 1496 glob_string_sequence_.push_back(glob_string);
311 1496 }
312 748 }
313
314
315 1012 const std::string &Pathspec::GetGlobString() const {
316
2/2
✓ Branch 0 taken 748 times.
✓ Branch 1 taken 264 times.
 1012 if (!glob_string_compiled_) {
317 748 GenerateGlobString();
318 748 glob_string_compiled_ = true;
319 }
320 1012 return glob_string_;
321 }
322
323
324 748 void Pathspec::GenerateGlobString() const {
325
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 748 times.
 748 assert(glob_string_.empty());
326
327 748 bool is_first = true;
328
1/2
✓ Branch 1 taken 748 times.
✗ Branch 2 not taken.
 748 const GlobStringSequence &seq = GetGlobStringSequence();
329 748 GlobStringSequence::const_iterator i = seq.begin();
330 748 const GlobStringSequence::const_iterator iend = seq.end();
331
2/2
✓ Branch 1 taken 1496 times.
✓ Branch 2 taken 748 times.
 2244 for (; i != iend; ++i) {
332
6/6
✓ Branch 0 taken 748 times.
✓ Branch 1 taken 748 times.
✓ Branch 3 taken 484 times.
✓ Branch 4 taken 264 times.
✓ Branch 5 taken 1232 times.
✓ Branch 6 taken 264 times.
 1496 if (!is_first || IsAbsolute()) {
333
1/2
✓ Branch 1 taken 1232 times.
✗ Branch 2 not taken.
 1232 glob_string_ += kSeparator;
334 }
335
1/2
✓ Branch 2 taken 1496 times.
✗ Branch 3 not taken.
 1496 glob_string_ += *i;
336 1496 is_first = false;
337 }
338 748 }
339