Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Wildcard pattern matcher improvement #6919

Merged
merged 4 commits into from Mar 16, 2023
Merged

Wildcard pattern matcher improvement #6919

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8bd1769
Renaming, avoid passing Path.DirectorySeparatorChar and remove non ca…
CristianAmbrosini Mar 14, 2023
bc6adc4
Second round of comments
CristianAmbrosini Mar 15, 2023
8e5d13d
Third round of comments
CristianAmbrosini Mar 15, 2023
c7b457a
Removed Path.DirectorySeparatorChar from the cache keys
CristianAmbrosini Mar 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContextBase.cs
View file
Open in desktop
Expand Up @@ -144,7 +144,7 @@ public bool HasMatchingScope(DiagnosticDescriptor descriptor)
&& !IsExcluded(globalExclusions, filePath);

private static bool IsIncluded(string[] inclusions, string filePath) =>
inclusions is { Length: 0 } || inclusions.Any(x => WildcardPatternMatcher.IsMatch(x, filePath));
inclusions is { Length: 0 } || inclusions.Any(x => WildcardPatternMatcher.IsMatch(x, filePath, true));

private static bool IsExcluded(string[] exclusions, string filePath) =>
exclusions.Any(x => WildcardPatternMatcher.IsMatch(x, filePath));
Expand Down
65 changes: 21 additions & 44 deletions analyzers/src/SonarAnalyzer.Common/Helpers/WildcardPatternMatcher.cs
View file
Open in desktop
Expand Up @@ -25,70 +25,54 @@

namespace SonarAnalyzer.Helpers;

internal static class WildcardPatternMatcher
internal class WildcardPatternMatcher
{
public static bool IsMatch(string pattern, string input) =>
public static bool IsMatch(string pattern, string input, bool timoutFallback = false) =>
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
!(string.IsNullOrWhiteSpace(pattern) || string.IsNullOrWhiteSpace(input))
&& WildcardPattern.Create(pattern).Match(input);
&& WildcardPattern.Create(pattern).Match(input, timoutFallback);

/// <summary>
/// Copied from https://github.com/SonarSource/sonar-plugin-api/blob/a9bd7ff48f0f77811ed909070030678c443c975a/sonar-plugin-api/src/main/java/org/sonar/api/utils/WildcardPattern.java.
/// </summary>
private sealed class WildcardPattern
{
private const string SpecialChars = "()[]^$.{}+|";
private static readonly ConcurrentDictionary<string, WildcardPattern> Cache = new();
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
private readonly Regex pattern;

private WildcardPattern(string pattern, string directorySeparator) =>
this.pattern = new Regex(ToRegexp(pattern, directorySeparator), RegexOptions.Compiled, RegexConstants.DefaultTimeout);
private WildcardPattern(string pattern) =>
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
this.pattern = new Regex(ToRegex(pattern), RegexOptions.None, RegexConstants.DefaultTimeout);

public bool Match(string value)
public bool Match(string value, bool timoutFallback)
{
value = value.TrimStart('/');
value = value.TrimEnd('/');
try
{
return pattern.IsMatch(value);
return pattern.IsMatch(value.Trim('/'));
}
catch (RegexMatchTimeoutException)
{
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
return false;
return timoutFallback;
}
}

public static WildcardPattern Create(string pattern) =>
Create(pattern, Path.DirectorySeparatorChar.ToString());
Cache.GetOrAdd(pattern + Path.DirectorySeparatorChar, _ => new WildcardPattern(pattern));
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved

private static WildcardPattern Create(string pattern, string directorySeparator) =>
Cache.GetOrAdd(pattern + directorySeparator, _ => new WildcardPattern(pattern, directorySeparator));

private static string ToRegexp(string wildcardPattern, string directorySeparator)
private static string ToRegex(string wildcardPattern)
{
var escapedDirectorySeparator = '\\' + directorySeparator;
var sb = new StringBuilder(wildcardPattern.Length);

sb.Append('^');

var i = wildcardPattern.StartsWith("/") || wildcardPattern.StartsWith("\\") ? 1 : 0;
var escapedDirectorySeparator = Regex.Escape(Path.DirectorySeparatorChar.ToString());
var sb = new StringBuilder("^", wildcardPattern.Length);
var i = IsSlash(wildcardPattern[0]) ? 1 : 0;
while (i < wildcardPattern.Length)
{
var ch = wildcardPattern[i];

if (SpecialChars.IndexOf(ch) != -1)
{
// Escape regexp-specific characters
sb.Append('\\').Append(ch);
}
else if (ch == '*')
if (ch == '*')
{
if (i + 1 < wildcardPattern.Length && wildcardPattern[i + 1] == '*')
{
// Double asterisk
// Zero or more directories
// Double asterisk - Zero or more directories
if (i + 2 < wildcardPattern.Length && IsSlash(wildcardPattern[i + 2]))
{
sb.Append("(?:.*").Append(escapedDirectorySeparator).Append("|)");
sb.Append($"(.*{escapedDirectorySeparator}|)");
i += 2;
}
else
Expand All @@ -99,33 +83,26 @@ private static string ToRegexp(string wildcardPattern, string directorySeparator
}
else
{
// Single asterisk
// Zero or more characters excluding directory separator
sb.Append("[^").Append(escapedDirectorySeparator).Append("]*?");
// Single asterisk - Zero or more characters excluding directory separator
sb.Append($"[^{escapedDirectorySeparator}]*?");
}
}
else if (ch == '?')
{
// Any single character excluding directory separator
sb.Append("[^").Append(escapedDirectorySeparator).Append("]");
sb.Append($"[^{escapedDirectorySeparator}]");
}
else if (IsSlash(ch))
{
// Directory separator
sb.Append(escapedDirectorySeparator);
}
else
{
// Single character
sb.Append(ch);
sb.Append(Regex.Escape(ch.ToString()));
}

i++;
}

sb.Append('$');

return sb.ToString();
return sb.Append('$').ToString();
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
}

private static bool IsSlash(char ch) =>
Expand Down
59 changes: 19 additions & 40 deletions analyzers/tests/SonarAnalyzer.UnitTest/Helpers/WildcardPatternMatcherTest.cs
View file
Open in desktop
Expand Up @@ -29,81 +29,60 @@ public class WildcardPatternMatcherTest
/// Based on https://github.com/SonarSource/sonar-plugin-api/blob/master/plugin-api/src/test/java/org/sonar/api/utils/WildcardPatternTest.java.
/// </summary>
[DataTestMethod]

[DataRow("Foo", "Foo", true)]
[DataRow("foo", "FOO", false)]
[DataRow("Foo", "Foot", false)]
[DataRow("Foo", "Bar", false)]

[DataRow("org/T?st.java", "org/Test.java", true)]
[DataRow("org/T?st.java", "org/Tost.java", true)]
[DataRow("org/T?st.java", "org/Teeest.java", false)]

[DataRow("org/*.java", "org/Foo.java", true)]
[DataRow("org/*.java", "org/Bar.java", true)]

[DataRow("org/**", "org/Foo.java", true)]
[DataRow("org/T?st.cs", "org/Test.cs", true)]
[DataRow("org/T?st.cs", "org/Tost.cs", true)]
[DataRow("org/T?st.cs", "org/Teeest.cs", false)]
[DataRow("org/*.cs", "org/Foo.cs", true)]
[DataRow("org/*.cs", "org/Bar.cs", true)]
[DataRow("org/**", "org/Foo.cs", true)]
[DataRow("org/**", "org/foo/bar.jsp", true)]

[DataRow("org/**/Test.java", "org/Test.java", true)]
[DataRow("org/**/Test.java", "org/foo/Test.java", true)]
[DataRow("org/**/Test.java", "org/foo/bar/Test.java", true)]

[DataRow("org/**/*.java", "org/Foo.java", true)]
[DataRow("org/**/*.java", "org/foo/Bar.java", true)]
[DataRow("org/**/*.java", "org/foo/bar/Baz.java", true)]

[DataRow("o?/**/*.java", "org/test.java", false)]
[DataRow("o?/**/*.java", "o/test.java", false)]
[DataRow("o?/**/*.java", "og/test.java", true)]
[DataRow("o?/**/*.java", "og/foo/bar/test.java", true)]
[DataRow("o?/**/*.java", "og/foo/bar/test.jav", false)]

[DataRow("org/**/Test.cs", "org/Test.cs", true)]
[DataRow("org/**/Test.cs", "org/foo/Test.cs", true)]
[DataRow("org/**/Test.cs", "org/foo/bar/Test.cs", true)]
[DataRow("org/**/*.cs", "org/Foo.cs", true)]
[DataRow("org/**/*.cs", "org/foo/Bar.cs", true)]
[DataRow("org/**/*.cs", "org/foo/bar/Baz.cs", true)]
[DataRow("o?/**/*.cs", "org/test.cs", false)]
[DataRow("o?/**/*.cs", "o/test.cs", false)]
[DataRow("o?/**/*.cs", "og/test.cs", true)]
[DataRow("o?/**/*.cs", "og/foo/bar/test.cs", true)]
[DataRow("o?/**/*.cs", "og/foo/bar/test.c", false)]
[DataRow("org/sonar/**", "org/sonar/commons/Foo", true)]
[DataRow("org/sonar/**", "org/sonar/Foo.java", true)]

[DataRow("org/sonar/**", "org/sonar/Foo.cs", true)]
[DataRow("xxx/org/sonar/**", "org/sonar/Foo", false)]

[DataRow("org/sonar/**/**", "org/sonar/commons/Foo", true)]
[DataRow("org/sonar/**/**", "org/sonar/commons/sub/Foo.java", true)]

[DataRow("org/sonar/**/**", "org/sonar/commons/sub/Foo.cs", true)]
[DataRow("org/sonar/**/Foo", "org/sonar/commons/sub/Foo", true)]
[DataRow("org/sonar/**/Foo", "org/sonar/Foo", true)]

[DataRow("*/foo/*", "org/foo/Bar", true)]
[DataRow("*/foo/*", "foo/Bar", false)]
[DataRow("*/foo/*", "foo", false)]
[DataRow("*/foo/*", "org/foo/bar/Hello", false)]

[DataRow("hell?", "hell", false)]
[DataRow("hell?", "hello", true)]
[DataRow("hell?", "helloworld", false)]

[DataRow("**/Reader", "java/io/Reader", true)]
[DataRow("**/Reader", "org/sonar/channel/CodeReader", false)]

[DataRow("**", "java/io/Reader", true)]

[DataRow("**/app/**", "com/app/Utils", true)]
[DataRow("**/app/**", "com/application/MyService", false)]

[DataRow("**/*$*", "foo/bar", false)]
[DataRow("**/*$*", "foo/bar$baz", true)]
[DataRow("a+", "aa", false)]
[DataRow("a+", "a+", true)]
[DataRow("[ab]", "a", false)]
[DataRow("[ab]", "[ab]", true)]

[DataRow("\\n", "\n", false)]
[DataRow("foo\\bar", "foo/bar", true)]

[DataRow("/foo", "foo", true)]
[DataRow("\\foo", "foo", true)]

[DataRow("foo\\bar", "foo\\bar", true)]
[DataRow("foo/bar", "foo\\bar", true)]
[DataRow("foo\\bar/baz", "foo\\bar\\baz", true)]

public void IsMatch_MatchesPatternsAsExpected(string pattern, string input, bool expectedResult)
{
// The test cases are copied from the plugin-api and the directory separators need replacing as Roslyn will not give us the paths with '/'.
Expand Down