Skip to content

added warning if mutable rev is used #1715

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
asottile merged 1 commit into from
Dec 18, 2020
+92 −0
Merged

added warning if mutable rev is used #1715

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
28 changes: 28 additions & 0 deletions pre_commit/clientlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import argparse
import functools
import logging
import re
import shlex
import sys
from typing import Any
Expand Down Expand Up @@ -112,6 +113,25 @@ def validate_manifest_main(argv: Optional[Sequence[str]] = None) -> int:
META = 'meta'


# should inherit from cfgv.Conditional if sha support is dropped
class WarnMutableRev(cfgv.ConditionalOptional):
def check(self, dct: Dict[str, Any]) -> None:
super().check(dct)

if self.key in dct:
rev = dct[self.key]

if '.' not in rev and not re.match(r'^[a-fA-F0-9]+$', rev):
logger.warning(
f'The {self.key!r} field of repo {dct["repo"]!r} '
f'appears to be a mutable reference '
f'(moving tag / branch). Mutable references are never '
f'updated after first install and are not supported. '
f'See https://pre-commit.com/#using-the-latest-version-for-a-repository ' # noqa: E501
f'for more details.',
)


class OptionalSensibleRegex(cfgv.OptionalNoDefault):
def check(self, dct: Dict[str, Any]) -> None:
super().check(dct)
Expand Down Expand Up @@ -261,6 +281,14 @@ def warn_unknown_keys_repo(
),

MigrateShaToRev(),
WarnMutableRev(
'rev',
cfgv.check_string,
'',
'repo',
cfgv.NotIn(LOCAL, META),
True,
),
cfgv.WarnAdditionalKeys(('repo', 'rev', 'hooks'), warn_unknown_keys_repo),
)
DEFAULT_LANGUAGE_VERSION = cfgv.Map(
Expand Down
64 changes: 64 additions & 0 deletions tests/clientlib_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,70 @@ def test_ci_key_must_be_map():
cfgv.validate({'ci': 'invalid', 'repos': []}, CONFIG_SCHEMA)


@pytest.mark.parametrize(
'rev',
(
'v0.12.4',
'b27f281',
'b27f281eb9398fc8504415d7fbdabf119ea8c5e1',
'19.10b0',
'4.3.21-2',
),
)
def test_warn_mutable_rev_ok(caplog, rev):
config_obj = {
'repo': 'https://gitlab.com/pycqa/flake8',
'rev': rev,
'hooks': [{'id': 'flake8'}],
}
cfgv.validate(config_obj, CONFIG_REPO_DICT)

assert caplog.record_tuples == []


@pytest.mark.parametrize(
'rev',
(
'',
'HEAD',
'stable',
'master',
'some_branch_name',
),
)
def test_warn_mutable_rev_invalid(caplog, rev):
config_obj = {
'repo': 'https://gitlab.com/pycqa/flake8',
'rev': rev,
'hooks': [{'id': 'flake8'}],
}
cfgv.validate(config_obj, CONFIG_REPO_DICT)

assert caplog.record_tuples == [
(
'pre_commit',
logging.WARNING,
"The 'rev' field of repo 'https://gitlab.com/pycqa/flake8' "
'appears to be a mutable reference (moving tag / branch). '
'Mutable references are never updated after first install and are '
'not supported. '
'See https://pre-commit.com/#using-the-latest-version-for-a-repository ' # noqa: E501
'for more details.',
),
]


def test_warn_mutable_rev_conditional():
config_obj = {
'repo': 'meta',
'rev': '3.7.7',
'hooks': [{'id': 'flake8'}],
}

with pytest.raises(cfgv.ValidationError):
cfgv.validate(config_obj, CONFIG_REPO_DICT)


def test_validate_optional_sensible_regex(caplog):
config_obj = {
'id': 'flake8',
Expand Down