Skip to content

fix: ensure we don't allow extra in scopes config #885

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
mergify merged 1 commit into from
Dec 11, 2025
Merged

fix: ensure we don't allow extra in scopes config #885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions mergify_cli/ci/scopes/config/scopes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@


class FileFilters(pydantic.BaseModel):
model_config = pydantic.ConfigDict(extra="forbid")

include: tuple[str, ...] = pydantic.Field(
default_factory=lambda: ("**/*",),
description=(
Expand All @@ -34,6 +36,8 @@ class FileFilters(pydantic.BaseModel):


class SourceFiles(pydantic.BaseModel):
model_config = pydantic.ConfigDict(extra="forbid")

files: dict[ScopeName, FileFilters] = pydantic.Field(
description=(
"Mapping of scope name to its file filters. "
Expand All @@ -44,6 +48,8 @@ class SourceFiles(pydantic.BaseModel):


class SourceManual(pydantic.BaseModel):
model_config = pydantic.ConfigDict(extra="forbid")

manual: None = pydantic.Field(
description="Scopes are manually sent via API or `mergify scopes-send`",
)
Expand Down
18 changes: 17 additions & 1 deletion mergify_cli/tests/ci/scopes/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def test_from_yaml_invalid_config(tmp_path: pathlib.Path) -> None:
)

# Bad name and missing dict
with pytest.raises(config.ConfigInvalidError, match="3 validation errors"):
with pytest.raises(config.ConfigInvalidError, match="4 validation errors"):
config.Config.from_yaml(str(config_file))


Expand Down Expand Up @@ -481,6 +481,22 @@ def test_detect_no_matches(
assert result.scopes == set()


def test_match_scopes_invalid() -> None:
with pytest.raises(config.ConfigInvalidError, match="4 validation errors"):
config.Config.from_dict(
{
"scopes": {
"source": {
"files": {
"backend": {"includes": ("api/**/*.py",)},
"frontend": {"includes": ("ui/**/*.js",)},
},
},
},
},
)


@mock.patch("mergify_cli.ci.scopes.changed_files.git_changed_files")
def test_detect_debug_output(
mock_git_changed: mock.Mock,
Expand Down