feat: change configuration file format

This change changes the configuration format to:

```
scopes:
  merge_queue_scope: merge-queue
  source:
    files:
      js:
        include:
          - "**/*.js"
      python:
        include:
          - "**/*.py"
      other:
        include:
          - "**/*"
        exclude:
          - "**/*.py"
          - "**/*.js"
```

Sources will later have value like: `bazel`, `nx`, `turporepo`

We will have something like:
```
scopes:
  merge_queue_scope: merge-queue
  source:
    nx:
      command: ["npx", "nx"]
```

To get the scopes, this will run: `npx nx show projects --affected --base={base} --head={head}"`

Change-Id: I2e4195e7fc8ce38325b618573456d26b05a57b56

Author: sileht

mergify_cli/ci/cli.py

@@ -200,7 +200,7 @@ async def junit_process(  # noqa: PLR0913
     "config_path",
     required=True,
     type=click.Path(exists=True),
-    default=".mergify-ci.yml",
+    default=".mergify.yml",
     help="Path to YAML config file.",
 )
 @click.option(

mergify_cli/ci/scopes/cli.py

@@ -27,21 +27,33 @@ class ConfigInvalidError(exceptions.ScopesError):
     pass
 
 
-class ScopeConfig(pydantic.BaseModel):
-    include: tuple[str, ...] = pydantic.Field(default_factory=tuple)
-    exclude: tuple[str, ...] = pydantic.Field(default_factory=tuple)
-
-
 ScopeName = typing.Annotated[
     str,
     pydantic.StringConstraints(pattern=SCOPE_NAME_RE, min_length=1),
 ]
 
 
-class Config(pydantic.BaseModel):
-    scopes: dict[ScopeName, ScopeConfig]
+class FileFilters(pydantic.BaseModel):
+    include: tuple[str, ...] = pydantic.Field(default_factory=tuple)
+    exclude: tuple[str, ...] = pydantic.Field(default_factory=tuple)
+
+
+class SourceFiles(pydantic.BaseModel):
+    files: dict[ScopeName, FileFilters] = pydantic.Field(default_factory=dict)
+
+
+class ScopesConfig(pydantic.BaseModel):
+    model_config = pydantic.ConfigDict(extra="forbid")
+
+    source: SourceFiles | None = None
     merge_queue_scope: str | None = "merge-queue"
 
+
+class Config(pydantic.BaseModel):
+    model_config = pydantic.ConfigDict(extra="ignore")
+
+    scopes: ScopesConfig
+
     @classmethod
     def from_dict(cls, data: dict[str, typing.Any] | typing.Any) -> Config:  # noqa: ANN401
         try:
@@ -61,15 +73,15 @@ def from_yaml(cls, path: str) -> Config:
 
 
 def match_scopes(
-    config: Config,
     files: abc.Iterable[str],
+    filters: dict[ScopeName, FileFilters],
 ) -> tuple[set[str], dict[str, list[str]]]:
     scopes_hit: set[str] = set()
-    per_scope: dict[str, list[str]] = {s: [] for s in config.scopes}
+    per_scope: dict[str, list[str]] = {s: [] for s in filters}
     for f in files:
         # NOTE(sileht): we use pathlib.full_match to support **, as fnmatch does not
         p = pathlib.PurePosixPath(f)
-        for scope, scope_config in config.scopes.items():
+        for scope, scope_config in filters.items():
             if not scope_config.include and not scope_config.exclude:
                 continue
 
@@ -114,14 +126,23 @@ class DetectedScope:
 def detect(config_path: str) -> DetectedScope:
     cfg = Config.from_yaml(config_path)
     base = base_detector.detect()
+
+    if cfg.scopes.source is None:
+        return DetectedScope(base.ref, set())
+
+    source = next(iter(cfg.scopes.source.__dict__))
+    if source != "files":
+        msg = "Ununsupported source type"
+        raise RuntimeError(msg)
+
     changed = changed_files.git_changed_files(base.ref)
-    scopes_hit, per_scope = match_scopes(cfg, changed)
+    scopes_hit, per_scope = match_scopes(changed, cfg.scopes.source.files)
+    all_scopes = set(cfg.scopes.source.files.keys())
 
-    all_scopes = set(cfg.scopes.keys())
-    if cfg.merge_queue_scope is not None:
-        all_scopes.add(cfg.merge_queue_scope)
+    if cfg.scopes.merge_queue_scope is not None:
+        all_scopes.add(cfg.scopes.merge_queue_scope)
         if base.is_merge_queue:
-            scopes_hit.add(cfg.merge_queue_scope)
+            scopes_hit.add(cfg.scopes.merge_queue_scope)
 
     click.echo(f"Base: {base.ref}")
     if scopes_hit:

mergify_cli/tests/ci/scopes/test_cli.py

@@ -10,34 +10,93 @@
 from mergify_cli.ci.scopes import cli
 
 
+def test_from_yaml_with_extras_ignored(tmp_path: pathlib.Path) -> None:
+    config_file = tmp_path / "config.yml"
+    config_file.write_text(
+        yaml.dump(
+            {
+                "defaults": {},
+                "queue_rules": [],
+                "pull_request_rules": [],
+                "partitions_rules": [],
+                "scopes": {
+                    "source": {
+                        "files": {
+                            "backend": {"include": ["api/**/*.py", "backend/**/*.py"]},
+                            "frontend": {"include": ["ui/**/*.js", "ui/**/*.tsx"]},
+                            "docs": {"include": ["*.md", "docs/**/*"]},
+                        },
+                    },
+                },
+            },
+        ),
+    )
+
+    config = cli.Config.from_yaml(str(config_file))
+    assert config.model_dump() == {
+        "scopes": {
+            "source": {
+                "files": {
+                    "backend": {
+                        "include": ("api/**/*.py", "backend/**/*.py"),
+                        "exclude": (),
+                    },
+                    "frontend": {
+                        "include": ("ui/**/*.js", "ui/**/*.tsx"),
+                        "exclude": (),
+                    },
+                    "docs": {"include": ("*.md", "docs/**/*"), "exclude": ()},
+                },
+            },
+            "merge_queue_scope": "merge-queue",
+        },
+    }
+
+
 def test_from_yaml_valid(tmp_path: pathlib.Path) -> None:
     config_file = tmp_path / "config.yml"
     config_file.write_text(
         yaml.dump(
             {
                 "scopes": {
-                    "backend": {"include": ["api/**/*.py", "backend/**/*.py"]},
-                    "frontend": {"include": ["ui/**/*.js", "ui/**/*.tsx"]},
-                    "docs": {"include": ["*.md", "docs/**/*"]},
+                    "source": {
+                        "files": {
+                            "backend": {"include": ["api/**/*.py", "backend/**/*.py"]},
+                            "frontend": {"include": ["ui/**/*.js", "ui/**/*.tsx"]},
+                            "docs": {"include": ["*.md", "docs/**/*"]},
+                        },
+                    },
                 },
             },
         ),
     )
 
     config = cli.Config.from_yaml(str(config_file))
     assert config.model_dump() == {
-        "merge_queue_scope": "merge-queue",
         "scopes": {
-            "backend": {"include": ("api/**/*.py", "backend/**/*.py"), "exclude": ()},
-            "frontend": {"include": ("ui/**/*.js", "ui/**/*.tsx"), "exclude": ()},
-            "docs": {"include": ("*.md", "docs/**/*"), "exclude": ()},
+            "merge_queue_scope": "merge-queue",
+            "source": {
+                "files": {
+                    "backend": {
+                        "include": ("api/**/*.py", "backend/**/*.py"),
+                        "exclude": (),
+                    },
+                    "frontend": {
+                        "include": ("ui/**/*.js", "ui/**/*.tsx"),
+                        "exclude": (),
+                    },
+                    "docs": {"include": ("*.md", "docs/**/*"), "exclude": ()},
+                },
+            },
         },
     }
 
 
 def test_from_yaml_invalid_config(tmp_path: pathlib.Path) -> None:
     config_file = tmp_path / "config.yml"
-    config_file.write_text(yaml.dump({"scopes": {"Back#end-API": ["api/**/*.py"]}}))
+    config_file.write_text(
+        yaml.dump({"scopes": {"source": {"files": {"Back#end-API": ["api/**/*.py"]}}}}),
+    )
 
     # Bad name and missing dict
     with pytest.raises(cli.ConfigInvalidError, match="2 validation errors"):
@@ -48,15 +107,20 @@ def test_match_scopes_basic() -> None:
     config = cli.Config.from_dict(
         {
             "scopes": {
-                "backend": {"include": ("api/**/*.py", "backend/**/*.py")},
-                "frontend": {"include": ("ui/**/*.js", "ui/**/*.tsx")},
-                "docs": {"include": ("*.md", "docs/**/*")},
+                "source": {
+                    "files": {
+                        "backend": {"include": ("api/**/*.py", "backend/**/*.py")},
+                        "frontend": {"include": ("ui/**/*.js", "ui/**/*.tsx")},
+                        "docs": {"include": ("*.md", "docs/**/*")},
+                    },
+                },
             },
         },
     )
     files = ["api/models.py", "ui/components/Button.tsx", "README.md", "other.txt"]
 
-    scopes_hit, per_scope = cli.match_scopes(config, files)
+    assert config.scopes.source is not None
+    scopes_hit, per_scope = cli.match_scopes(files, config.scopes.source.files)
 
     assert scopes_hit == {"backend", "frontend", "docs"}
     assert per_scope == {
@@ -70,14 +134,19 @@ def test_match_scopes_no_matches() -> None:
     config = cli.Config.from_dict(
         {
             "scopes": {
-                "backend": {"include": ("api/**/*.py",)},
-                "frontend": {"include": ("ui/**/*.js",)},
+                "source": {
+                    "files": {
+                        "backend": {"include": ("api/**/*.py",)},
+                        "frontend": {"include": ("ui/**/*.js",)},
+                    },
+                },
             },
         },
     )
     files = ["other.txt", "unrelated.cpp"]
 
-    scopes_hit, per_scope = cli.match_scopes(config, files)
+    assert config.scopes.source is not None
+    scopes_hit, per_scope = cli.match_scopes(files, config.scopes.source.files)
 
     assert scopes_hit == set()
     assert per_scope == {}
@@ -87,13 +156,18 @@ def test_match_scopes_multiple_include_single_scope() -> None:
     config = cli.Config.from_dict(
         {
             "scopes": {
-                "backend": {"include": ("api/**/*.py", "backend/**/*.py")},
+                "source": {
+                    "files": {
+                        "backend": {"include": ("api/**/*.py", "backend/**/*.py")},
+                    },
+                },
             },
         },
     )
     files = ["api/models.py", "backend/services.py"]
 
-    scopes_hit, per_scope = cli.match_scopes(config, files)
+    assert config.scopes.source is not None
+    scopes_hit, per_scope = cli.match_scopes(files, config.scopes.source.files)
 
     assert scopes_hit == {"backend"}
     assert per_scope == {
@@ -105,13 +179,17 @@ def test_match_scopes_with_negation_include() -> None:
     config = cli.Config.from_dict(
         {
             "scopes": {
-                "backend": {
-                    "include": ("api/**/*.py",),
-                    "exclude": ("api/**/test_*.py",),
-                },
-                "frontend": {
-                    "include": ("ui/**/*.js",),
-                    "exclude": ("ui/**/*.spec.js",),
+                "source": {
+                    "files": {
+                        "backend": {
+                            "include": ("api/**/*.py",),
+                            "exclude": ("api/**/test_*.py",),
+                        },
+                        "frontend": {
+                            "include": ("ui/**/*.js",),
+                            "exclude": ("ui/**/*.spec.js",),
+                        },
+                    },
                 },
             },
         },
@@ -123,7 +201,8 @@ def test_match_scopes_with_negation_include() -> None:
         "ui/components.spec.js",
     ]
 
-    scopes_hit, per_scope = cli.match_scopes(config, files)
+    assert config.scopes.source is not None
+    scopes_hit, per_scope = cli.match_scopes(files, config.scopes.source.files)
 
     assert scopes_hit == {"backend", "frontend"}
     assert per_scope == {
@@ -136,16 +215,21 @@ def test_match_scopes_negation_only() -> None:
     config = cli.Config.from_dict(
         {
             "scopes": {
-                "exclude_images": {
-                    "include": ("**/*",),
-                    "exclude": ("**/*.jpeg", "**/*.png"),
+                "source": {
+                    "files": {
+                        "exclude_images": {
+                            "include": ("**/*",),
+                            "exclude": ("**/*.jpeg", "**/*.png"),
+                        },
+                    },
                 },
             },
         },
     )
     files = ["image.jpeg", "document.txt", "photo.png", "readme.md"]
 
-    scopes_hit, per_scope = cli.match_scopes(config, files)
+    assert config.scopes.source is not None
+    scopes_hit, per_scope = cli.match_scopes(files, config.scopes.source.files)
 
     assert scopes_hit == {"exclude_images"}
     assert per_scope == {
@@ -157,9 +241,13 @@ def test_match_scopes_mixed_with_complex_negation() -> None:
     config = cli.Config.from_dict(
         {
             "scopes": {
-                "backend": {
-                    "include": ("**/*.py",),
-                    "exclude": ("**/test_*.py", "**/*_test.py"),
+                "source": {
+                    "files": {
+                        "backend": {
+                            "include": ("**/*.py",),
+                            "exclude": ("**/test_*.py", "**/*_test.py"),
+                        },
+                    },
                 },
             },
         },
@@ -172,7 +260,8 @@ def test_match_scopes_mixed_with_complex_negation() -> None:
         "main.py",
     ]
 
-    scopes_hit, per_scope = cli.match_scopes(config, files)
+    assert config.scopes.source is not None
+    scopes_hit, per_scope = cli.match_scopes(files, config.scopes.source.files)
 
     assert scopes_hit == {"backend"}
     assert per_scope == {
@@ -219,8 +308,12 @@ def test_detect_with_matches(
     # Setup config file
     config_data = {
         "scopes": {
-            "backend": {"include": ["api/**/*.py"]},
-            "frontend": {"include": ["api/**/*.js"]},
+            "source": {
+                "files": {
+                    "backend": {"include": ["api/**/*.py"]},
+                    "frontend": {"include": ["api/**/*.js"]},
+                },
+            },
         },
     }
     config_file = tmp_path / "mergify-ci.yml"
@@ -260,7 +353,9 @@ def test_detect_no_matches(
     tmp_path: pathlib.Path,
 ) -> None:
     # Setup config file
-    config_data = {"scopes": {"backend": {"include": ["api/**/*.py"]}}}
+    config_data = {
+        "scopes": {"source": {"files": {"backend": {"include": ["api/**/*.py"]}}}},
+    }
     config_file = tmp_path / ".mergify-ci.yml"
     config_file.write_text(yaml.dump(config_data))
 
@@ -292,7 +387,9 @@ def test_detect_debug_output(
     monkeypatch.setenv("ACTIONS_STEP_DEBUG", "true")
 
     # Setup config file
-    config_data = {"scopes": {"backend": {"include": ["api/**/*.py"]}}}
+    config_data = {
+        "scopes": {"source": {"files": {"backend": {"include": ["api/**/*.py"]}}}},
+    }
     config_file = tmp_path / ".mergify-ci.yml"
     config_file.write_text(yaml.dump(config_data))