This script will be used to automatically fix wrong dependabot updates
for grouped grpcio*/protobuf dependencies.

These dependencies have 2 parts for API projects, a build-time part and
a run-time part. The build-time dependencies need to be older than the
runtime dependencies, and dependabot only bumps the build-time
dependencies, which leaves repositories in a bad state.

On top of that, runtime dependencies have special compatibility rules
for protobuf. Two consecutive major versions are guaranteed to be
compatible.

This new script bumps the minimum runtime dependencies to match the
dependabot-updated build-time dependencies and make sure the supported
major versions are also bumped appropriately, including the comments.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

This will be used to add some unit tests for the internals of the
script, which can't be easily imported with just "import" because it is
not intended to be used as a module.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

This commit uses the exiting generated API golden tests (cookiecutter
generate templates) to validate the script works on the current
template.

This ensures that things continue to work even if the template
pyproject.toml file is changed and uses a different format to specify
the grpc/protobuf dependencies.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Golden test fixtures for the new dependabot-grpc-fixer.py script will be
stored in tests/cookiecutter/scripts/fixtures/fixer_cases with one
sub-directory per test case, where each test case is composed of the
expected inputs and outputs.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Add many test cases to cover for most happy and error paths.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

All other tests are calling the fixer.main() function (or other internal
functions), but none is really testing the fixer works as a script, and
its arguments work as expected.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

The dependabot-grpc-fixer is meant to be exercised as a script, not
through a dynamically imported module. Run the remaining tests via
runpy so they cover the supported entrypoint instead of the script
internals.

Drop the replace_range() unit test and the shared module loader to
reduce coupling to implementation details while keeping the existing
script-level coverage.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Keep the generic Python version-branch protection usable by non-API
repositories, and add a separate API-specific variant that also requires
the gRPC runtime-floor migration check.

Update the GitHub setup docs to make API repositories import the
API-specific ruleset instead of the generic Python one.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

The 'auto-dependabot' workflow now skips PRs from the three new grpc
groups so they are exclusively handled by the upcoming new migration
workflow.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

The new 'grpc-migration' workflow handles Dependabot PRs from the
three new grpc/protobuf groups by syncing the runtime '>=' floors in
'pyproject.toml' with the new build-time pins.

The workflow is only rendered for API projects (the only template
type that pins grpc/protobuf as build-time dependencies), so the
post-generation hook removes the leftover empty file for the other
project types.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Add a 'migrate_grpc_workflow_setup' step that brings existing API
projects in line with the new grpc/protobuf handling. The step is a
no-op for non-API projects.

For API projects it:

* Updates '.github/dependabot.yml' to use the new
  'grpc-compatible'/'grpcio-major'/'protobuf-major' Dependabot groups,
  replacing any verbatim old 'grpc:' group and inserting the three
  groups otherwise. It also adds the grpc/protobuf packages to the
  'patch' and 'minor' groups' 'exclude-patterns'. Customized 'grpc:'
  groups are left untouched and reported as a manual step.

* Updates '.github/workflows/auto-dependabot.yaml' to skip PRs from
  the three new grpc Dependabot groups.

* Installs (or replaces) '.github/workflows/grpc-migration.yaml'
  with the latest workflow contents. Existing experimental versions
  shipped to some repositories are unconditionally replaced.

* Adds the 'Fix gRPC/protobuf runtime floors' required status check
  to the 'Protect version branches' GitHub ruleset via the 'gh' CLI.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>