[dduugg]

Summary

Globs built from package, .codeowner, annotated-file, team-file and vendored-gem paths now escape glob metacharacters. A package or .codeowner at the project root now gets **/**, written to CODEOWNERS as /**/**. With the issue's project, for-file, for-file --from-codeowners and validate now agree on all eight files, and crosscheck-owners passes.

Fixes #146.

Why

These globs are matched by validate and written to CODEOWNERS, where for-file --from-codeowners, validate <files> and the gem's CodeOwnership.for_file match them again with fast_glob. The names went in unescaped:

• packs/[ab] claimed packs/a.
• {legacy} meant legacy.
• In validate, a top-level !legacy was a negated glob that gave its team every file outside legacy.
• At the root, the glob was /**/** (CODEOWNERS //**/**), which matches nothing.

Changes

• escaper::escape_glob replaces escape_brackets. It puts a \ before \ * ? [ ] { } !, one character at a time. Letters are never escaped, since fast_glob reads \b, \n, \r, \t as control characters.

• escaper::directory_glob gives <escaped dir>/**/**, or **/** for the root.

• Where they're used:

  • the package mappers (entries, matchers, and the glob shown in Source::Package)
  • the .codeowner mapper
  • annotated-file entries
  • team-file entries
  • vendored-gem entries and matchers
  • the package glob for-file shows

  User-written owned_globs are untouched.

• Fixes at the root, now that a root .codeowner matches:

  • Source::len counts components, so the root ranks below app/.codeowner. Before, they tied, and validate picked whichever the parallel walk found first.
  • The root's source displays as `.codeowner` rather than `/.codeowner`.
  • An invalid .codeowner under it says it inherits "from the project root" rather than from an empty name.
  • A test pins that a root package encloses nested packages in validate, as any outer package does.

• OwnerLookup (from Add optionally_owned_globs to permit files with no owner #135) no longer special-cases .codeowner files naming unknown teams with a path-prefix match. The directory mapper's own matchers are now correct, so it uses them. This doesn't change behavior. An empty .codeowner still counts as naming an owner, and a new test pins that.

• A team now counts once in validate, whichever way it's named (separate commit). validate groups a file's owners by the team name each matcher reports. The team-glob mapper reported the GitHub team, and the .codeowner mapper the text as written, while every other mapper reports team.name. So one team reaching a file two ways counted as two owners.

  This already happens on main: frontend/apps/public/index.tsx in the javascript_only_project fixture is reported with owners @DesignTeam and Design. With the root fixed, it would also have failed any repo with a root .codeowner or package and an owned glob of the same team. Both mappers now report team.name, and keep an unknown name as written. Happy to split this into its own PR if you'd rather.

Release notes

• Repos with glob metacharacters in such paths, or a .codeowner or package at the root, get a different CODEOWNERS. validate reports it out of date until they run generate. Escaped names also sort differently (/app/\{old\} now comes before /app/old).
• A root .codeowner or package now owns files in validate and CODEOWNERS, as for-file already reported. So a file that another mechanism gives a different team is reported as having more than one owner. With a root package, that includes annotations or .codeowner files naming a nested package's own team, since validate folds nested packages into the outer one.
• validate no longer reports one team reached two ways as two owners, and multiple-owner reports name a team glob's team by its name.
• Some descriptions change in for-file, in validate messages and in the gem's for_file reasons:
  • a root .codeowner shows as `.codeowner`
  • a root package's glob shows as **/**
  • a package path with metacharacters shows its escaped glob

How GitHub reads \-escaped characters and a /**/** line isn't verified here. \[ has been emitted since #37. codeowners-rs and the gem match these lines correctly.

Test plan

• cargo fmt --all -- --check, cargo clippy --all-targets --all-features -- -D warnings and cargo test pass (281 passed, the 3 existing ignores).
• New tests/path_globs_test.rs (11 tests, temp repos via the tests/common helpers):
  • the issue's project: the expected CODEOWNERS lines, for-file and --from-codeowners for all eight files, exact validate and validate <files> output, and crosscheck-owners success
  • a top-level !legacy
  • a root .codeowner, and a root package.yml
  • a root .codeowner overridden by app/.codeowner
  • a root package with a nested one
  • one team reached two ways
  • the "inheriting its owner from the project root" message
• Unit tests:
  • escaper: each metacharacter, a backslash escaped once, letters untouched, and for 11 tricky names, matching their own directory and not the siblings the unescaped glob matches
  • each mapper, with braces, brackets, !, * and the root
  • the overrider's root ranking, in both orders
  • nearest_package_owner's display glob, Ruby and JS, including a root package.json
• Mutation-checked: reverting each mapper's escaping, the root glob, Source::len, the display fixes and the team-name keying fails at least one test.
• Generated CODEOWNERS and for-file output are byte-identical to main's for every fixture under tests/fixtures. validate differs only where the same-team false positives are gone.
• Manually reran the issue's reproduction, including the root project, with main's binary (reproduces) and this branch's (fixed).

Follow-ups (not in this PR)

• Paths with spaces: entries keep the space, and the CODEOWNERS lookup splits each line at the first space. With a root .codeowner, such a file now falls through to the root's team in --from-codeowners.
• When the checkout path contains glob metacharacters, team files aren't found, because load_teams and Parser::absolute_team_files_globs join the unescaped root (pre-existing).
• An enclosing package.json (now including a root one) overrides nested package.yml lines in CODEOWNERS, while for-file picks the nearest package (pre-existing for non-root nesting; validate reports it).
• tests/path_globs_test.rs has its own codeowners helper. Normalize the paths validate, gv and for-file are given #148 moves the equivalent one into tests/common, so whichever lands second can share it.