Windows: the config isn't applied correctly

[CuriousStork]

Environment details

• OS: Windows
• Package version: 2.0.0-beta.4

Steps to reproduce

1. Create a configuration file in the project root:

   # See https://linter.aip.dev/configuration and https://linter.aip.dev/rules/
   ---
   - included_paths:
       - '**/*.proto'
     disabled_rules:
       - 'all'
     enabled_rules:
       - 'core::0191::proto-package'
   - included_paths:
     - '**/third_party/**'
     disabled_rules:
       - 'all'

2. Create a file .\third_party\google\type\phone_number.proto in the project. The file contents is a copy of https://github.com/googleapis/googleapis/blob/9070e63a1f574261c153ef6e94afc55677200337/google/type/phone_number.proto

3. Run the console command

   api-linter-newest --config .api-linter.yaml --proto-path=third_party .\third_party\google\type\phone_number.proto 

This returns an error:

- file_path: .\third_party\google\type\phone_number.proto
  problems:
    - message: 'Proto package and directory structure mismatch: The proto package must match the proto directory structure.'
      location:
        start_position:
            line_number: 17
            column_number: 1
        end_position:
            line_number: 17
            column_number: 20
        path: .\third_party\google\type\phone_number.proto
      rule_id: core::0191::proto-package
      rule_doc_uri: https://linter.aip.dev/191/proto-package

however, the rule core::0191::proto-package should be disabled for .\third_party\google\type\phone_number.proto.

This isn't reproduced via WSL + Ubuntu.

Use case details

The problem appears insignificant when using plain CLI with just a couple of .proto to lint.

However, it's more important in CI/CD scenarios. When you run api-linter in CI/CD for a pull request, it can have a lot of changed files. As I see from #1480 and https://linter.aip.dev/ currently there's no way to specify a directory or glob pattern as a linting target. We don't have full control over third_party files, so it's handy to disable all rules for this directory.

I understand that filtering files to lint is a workaround. Windows is also less commonly used in CI/CD. But having it covered via the config file is convenient.

Another use case is IDE. api-linter has plugins for popular IDE's, like:

• https://plugins.jetbrains.com/plugin/16164-aip-linter
• https://marketplace.visualstudio.com/items?itemName=mathematic.mathematic-vscode-api-linter

These plugins respect the config file and don't provide other way to exclude some files/directories from linting.

The main project rules don't necessary work for third_party files, so it's handy to turn off api-linter IDE diagnostics for this directory.

The abovementioned config file purposes

Just for better understanding of the context. The config makes the following:

• Freeze the rule set for the main project, so that new rules form newer api-linter versions don't appear unexpectedly.
• Permanently disable all checks for third_party because the files are just copied there and we don't modify them to comply with the main project's rules.

[quirogas]

@CuriousStork If you have a moment, could you please test #1551 and confirm whether it fixes your specific use case? I tested your example on Windows and it passed, but I'd also like to know if it addresses any broader issues you were experiencing.

[CuriousStork]

@quirogas I've attempted to test, but not sure if the correct binary was installed.

I ran

go install github.com/googleapis/api-linter/v2/cmd/api-linter@latest

The v2 branch is f88bbf9 now.

However, the binary --version output was api-linter 2.0.0-beta.4 so I'm not sure if I get the correct one.

When I tried linting, the issue reproduced:

api-linter.exe --config .api-linter.yaml --proto-path=third_party .\third_party\google\type\phone_number.proto
- file_path: .\third_party\google\type\phone_number.proto
  problems:
    - message: 'Proto package and directory structure mismatch: The proto package must match the proto directory structure.'
      location:
        start_position:
            line_number: 17
            column_number: 1
        end_position:
            line_number: 17
            column_number: 20
        path: .\third_party\google\type\phone_number.proto
      rule_id: core::0191::proto-package
      rule_doc_uri: https://linter.aip.dev/191/proto-package

.api-linter.yaml content:

# See https://linter.aip.dev/configuration and https://linter.aip.dev/rules/
---
- included_paths:
    - '**/*.proto'
  disabled_rules:
    - 'all'
  enabled_rules:
    - 'core::0191::proto-package'
- included_paths:
  - '**/third_party/**'
  disabled_rules:
    - 'all'

Am I doing something wrong?

[quirogas]

@CuriousStork Thank you for testing this. The issue was that we hadn't made a formal release of the fix yet. When you ran:

go install github.com/googleapis/api-linter/v2/cmd/api-linter@latest

you were installing api-linter 2.0.0-beta.4, which still contained the bug. I apologize for not being more explicit about how to test it.

However, we just officially released v2.0.0, so you should now be able to run

go install github.com/googleapis/api-linter/v2/cmd/api-linter@latest

and get the, hopefully, fixed version.

[CuriousStork]

@quirogas I did a very quick test using v2.0.0, and the issue was not reproduced.

Thank you!

I don’t close this issue myself, just like in #1519.