Skip to content

Implement tools for diffing sets of owners of repo paths; update the regex-based CODEOWNERS matching logic #5165

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

Merged
konrad-jamrozik merged 5 commits into from
Jan 23, 2023
Merged

Implement tools for diffing sets of owners of repo paths; update the regex-based CODEOWNERS matching logic #5165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cd6d57e
ongoing
Jan 17, 2023
eec8766
simplify handling of ** when matching CODEOWNERS entries
Jan 19, 2023
f17ba9b
update the regex-based matcher with new logic
Jan 20, 2023
176ffaa
forbid "**" without "/" (i.e. not "/**"); update comments, diag. outp…
Jan 23, 2023
0736967
improve comments a bit more
Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 66 additions & 35 deletions tools/code-owners-parser/Azure.Sdk.Tools.CodeOwnersParser.Tests/CodeownersFileTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public class CodeownersFileTests
new( "/" , "a/" , true , true ),
new( "/" , "/a/" , true , true ),
new( "/" , "/a/b" , true , true ),
new( "/a" , "a" , true , true ),
new( "/a" , "a" , true , true ),
new( "/a" , "A" , true , false ),
new( "/a" , "/a" , true , true ),
new( "/a" , "a/" , true , false ),
Expand All @@ -49,18 +49,20 @@ public class CodeownersFileTests
new( "a" , "/a/b" , true , false ),
new( "a" , "/a/b/" , true , false ),
new( "a" , "/x/a/b" , false , false ),
new( "/a/" , "a" , true , true ),
new( "/a/" , "/a" , true , true ),
new( "/a/" , "a" , true , false ),
new( "/a/" , "/a" , true , false ),
new( "/a/" , "a/" , true , true ),
new( "/a/" , "/a/" , true , true ),
new( "/a/" , "/a/b" , true , true ),
new( "/a/" , "/a\\ b" , true , true ),
new( "/a/" , "/a\\ b" , true , false ),
new( "/a/" , "/a\\ b/" , true , false ),
new( "/a/" , "/a/a\\ b/" , true , true ),
new( "/a/" , "/a/b/" , true , true ),
new( "/a/" , "/A/b/" , true , false ),
new( "/a/" , "/x/a/b" , false , false ),
new( "/a/b/" , "/a" , false , false ),
new( "/a/b/" , "/a/" , false , false ),
new( "/a/b/" , "/a/b" , true , true ),
new( "/a/b/" , "/a/b" , true , false ),
new( "/a/b/" , "/a/b/" , true , true ),
new( "/a/b/" , "/a/b/c" , true , true ),
new( "/a/b/" , "/a/b/c/" , true , true ),
Expand All @@ -86,59 +88,88 @@ public class CodeownersFileTests
new( "/*" , "[" , false , true ),
new( "/*" , "]" , false , true ),
new( "/*" , "!" , false , true ),
new( "/**" , "a" , false , true ),
new( "/**" , "a/" , false , true ),
new( "/**" , "a/b" , false , true ),
new( "/**" , "[" , false , true ),
new( "/**" , "]" , false , true ),
new( "/**" , "!" , false , true ),
new( "/a/*" , "a" , false , false ), // Not sure if this should not match.
new( "/**" , "a" , false , false ),
new( "/**" , "a/" , false , false ),
new( "/**" , "a/b" , false , false ),
new( "/**" , "[" , false , false ),
new( "/**" , "]" , false , false ),
new( "/**" , "!" , false , false ),
new( "/a/**" , "a" , false , false ),
new( "/*/**" , "a" , false , false ),
new( "/*/**" , "a/" , false , false ),
new( "/*/**" , "a/b" , false , false ),
new( "/*/" , "a" , false , false ),
new( "/*/" , "a/" , false , true ),
new( "/*/b" , "a/b" , false , true ),
new( "/**/a" , "a" , false , true ),
new( "/**/a" , "a" , false , true ),
new( "/**/a" , "x/ba" , false , false ),
new( "/**/a" , "x/ba" , false , false ),
new( "/a/*" , "a" , false , false ),
new( "/a/*" , "a/" , false , true ),
new( "/a/*" , "a/b" , false , true ),
new( "/a/*" , "a/b/" , false , false ),
new( "/a/*" , "a/b/c" , false , false ),
new( "/a/**" , "a" , false , true ), // Not sure if this should match.
new( "/a/**" , "a/" , false , true ),
new( "/a/**" , "a/b" , false , true ),
new( "/a/**" , "a/b/" , false , true ),
new( "/a/**" , "a/b/c" , false , true ),
new( "/**/a/" , "a" , false , true ),
new( "/a/*/" , "a" , false , false ),
new( "/a/*/" , "a/" , false , false ),
new( "/a/*/" , "a/b" , false , false ),
new( "/a/*/" , "a/b/" , false , true ),
new( "/a/*/" , "a/b/c" , false , true ),
new( "/a/**" , "a" , false , false ),
new( "/a/**" , "a/" , false , false ),
new( "/a/**" , "a/b" , false , false ),
new( "/a/**" , "a/b/" , false , false ),
new( "/a/**" , "a/b/c" , false , false ),
new( "/a/**/" , "a" , false , false ),
new( "/a/**/" , "a/" , false , false ),
new( "/a/**/" , "a/b" , false , false ),
new( "/a/**/" , "a/b/" , false , false ),
new( "/a/**/" , "a/b/c" , false , false ),
new( "/**/a/" , "a" , false , false ),
new( "/**/a/" , "a/" , false , true ),
new( "/**/a/" , "a/b" , false , true ),
new( "/**/b/" , "a/b" , false , true ),
new( "/**/b/" , "a/c" , false , false ),
new( "/a/*/b/" , "a/b" , false , false ),
new( "/a/*/b/" , "a/x/b" , false , true ),
new( "/**/b/" , "a/b" , false , false ),
new( "/**/b/" , "a/b/" , false , true ),
new( "/**/b/" , "a/c/" , false , false ),
new( "/a/*/b/" , "a/b/" , false , false ),
new( "/a/*/b/" , "a/x/b/" , false , true ),
new( "/a/*/b/" , "a/x/b/c" , false , true ),
new( "/a/*/b/" , "a/x/c" , false , false ),
new( "/a/*/b/" , "a/x/y/b" , false , false ),
new( "/a**b/" , "a/x/y/b" , false , true ),
new( "/a/**/b/" , "a/b" , false , true ),
new( "/a/**/b/" , "a/x/b" , false , true ),
new( "/a/**/b/" , "a/x/y/b" , false , true ),
new( "/a**b/" , "a/x/y/b" , false , false ),
new( "/a/**/b/" , "a/b" , false , false ),
new( "/a/**/b/" , "a/b/" , false , true ),
new( "/a/**/b/" , "a/x/b/" , false , true ),
new( "/a/**/b/" , "a/x/y/b/" , false , true ),
new( "/a/**/b/" , "a/x/y/c" , false , false ),
new( "/a/**/b/" , "a-b/" , false , false ),
new( "a/*/*" , "a/b" , false , false ),
new( "/a/*/*/d" , "a/b/c/d" , false , true ),
new( "/a/*/*/d" , "a/b/x/c/d" , false , false ),
new( "/a/**/*/d" , "a/b/x/c/d" , false , true ),
new( "*/*/b" , "a/b" , false , false ),
new( "/a*/" , "abc" , false , true ),
new( "/*b*/" , "abc" , false , true ),
new( "/*c/" , "abc" , false , true ),
new( "/a*c/" , "abc" , false , true ),
new( "/a*/" , "abc/" , false , true ),
new( "/a*/" , "ab/c/" , false , true ),
new( "/*b*/" , "axbyc/" , false , true ),
new( "/*c/" , "abc/" , false , true ),
new( "/*c/" , "a/abc/" , false , false ),
new( "/a*c/" , "axbyc/" , false , true ),
new( "/a*c/" , "axb/yc/" , false , false ),
new( "/**/*x*/" , "a/b/cxy/d" , false , true ),
new( "/a/*.md" , "a/x.md" , false , true ),
new( "/*/*/*.md" , "a/b/x.md" , false , true ),
new( "**/*.md" , "a/b.md/x.md" , false , true ),
new( "/**/*.md" , "a/b.md/x.md" , false , true ),
new( "**/*.md" , "a/b.md/x.md" , false , false ),
new( "/*.md" , "a/md" , false , false ),
new( "/a.*" , "a.b" , false , true ),
new( "/a.*" , "a.b/" , false , false ),
new( "/a.*" , "x/a.b/" , false , false ),
new( "/a.*/" , "a.b" , false , true ),
new( "/a.*/" , "a.b" , false , false ),
new( "/a.*/" , "a.b/" , false , true ),
new( "/**/*x*/AB/*/CD" , "a/b/cxy/AB/fff/CD" , false, true ),
new( "/**/*x*/AB/*/CD" , "a/b/cxy/AB/ff/ff/CD" , false, false ),
new( "/**/*x*/AB/**/CD/*" , "a/b/cxy/AB/ff/ff/CD" , false, false ),
new( "/**/*x*/AB/**/CD/*" , "a/b/cxy/AB/ff/ff/CD/" , false, true ),
new( "/**/*x*/AB/**/CD/*" , "a/b/cxy/AB/[]/!!/CD/h" , false, true ),

// @formatter:on
Expand All @@ -151,7 +182,7 @@ public class CodeownersFileTests
[TestCaseSource(nameof(testCases))]
public void TestGetMatchingCodeownersEntry(TestCase testCase)
{
List<CodeownersEntry>? codeownersEntries =
List<CodeownersEntry> codeownersEntries =
CodeownersFile.GetCodeownersEntries(testCase.CodeownersPath + "@owner");

VerifyGetMatchingCodeownersEntry(testCase, codeownersEntries, useRegexMatcher: false, testCase.ExpectedLegacyMatch);
Expand All @@ -164,12 +195,12 @@ private static void VerifyGetMatchingCodeownersEntry(
bool useRegexMatcher,
bool expectedMatch)
{
CodeownersEntry? entryLegacy =
CodeownersEntry entry =
// Act
CodeownersFile.GetMatchingCodeownersEntry(testCase.TargetPath,
codeownersEntries, useRegexMatcher);

Assert.That(entryLegacy.Owners, Has.Count.EqualTo(expectedMatch ? 1 : 0));
Assert.That(entry.Owners, Has.Count.EqualTo(expectedMatch ? 1 : 0));
}

public record TestCase(
Expand Down
Loading