mirror of
https://github.com/pre-commit/pre-commit-hooks.git
synced 2026-04-01 18:56:52 +00:00
f60596972c
This new option for the yaml checker modify ruamel to remove the "!" from the "!vault" tag if it is found. Removing that part allows the file to be parsed correctly, so other errors could be found. fixes: #273
90 lines
2.6 KiB
Python
90 lines
2.6 KiB
Python
from __future__ import annotations
|
|
|
|
import argparse
|
|
from typing import Any
|
|
from typing import Generator
|
|
from typing import NamedTuple
|
|
from typing import Sequence
|
|
|
|
import ruamel.yaml
|
|
|
|
yaml = ruamel.yaml.YAML(typ='safe')
|
|
|
|
|
|
def _exhaust(gen: Generator[str, None, None]) -> None:
|
|
for _ in gen:
|
|
pass
|
|
|
|
|
|
def _parse_unsafe(*args: Any, **kwargs: Any) -> None:
|
|
_exhaust(yaml.parse(*args, **kwargs))
|
|
|
|
|
|
def _load_all(*args: Any, **kwargs: Any) -> None:
|
|
_exhaust(yaml.load_all(*args, **kwargs))
|
|
|
|
|
|
class Key(NamedTuple):
|
|
multi: bool
|
|
unsafe: bool
|
|
|
|
|
|
LOAD_FNS = {
|
|
Key(multi=False, unsafe=False): yaml.load,
|
|
Key(multi=False, unsafe=True): _parse_unsafe,
|
|
Key(multi=True, unsafe=False): _load_all,
|
|
Key(multi=True, unsafe=True): _parse_unsafe,
|
|
}
|
|
|
|
|
|
def main(argv: Sequence[str] | None = None) -> int:
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument(
|
|
'-m', '--multi', '--allow-multiple-documents', action='store_true',
|
|
)
|
|
parser.add_argument(
|
|
'--unsafe', action='store_true',
|
|
help=(
|
|
'Instead of loading the files, simply parse them for syntax. '
|
|
'A syntax-only check enables extensions and unsafe contstructs '
|
|
'which would otherwise be forbidden. Using this option removes '
|
|
'all guarantees of portability to other yaml implementations. '
|
|
'Implies --allow-multiple-documents'
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
'--ignore-ansible-vault', action='store_true',
|
|
help=(
|
|
'Ignore keys that look like ansible vault encrypted values. '
|
|
'This works by removing the "!" from the "!vault" value prefix.'
|
|
),
|
|
)
|
|
parser.add_argument('filenames', nargs='*', help='Filenames to check.')
|
|
args = parser.parse_args(argv)
|
|
|
|
load_fn = LOAD_FNS[Key(multi=args.multi, unsafe=args.unsafe)]
|
|
|
|
if args.ignore_ansible_vault:
|
|
def ignore_ansible_vault(loader: ruamel.yaml.Loader,
|
|
node: ruamel.yaml.Node) -> Any:
|
|
if node.value.startswith('!vault'):
|
|
node.value = node.value[1:]
|
|
return loader.construct_yaml_str(node)
|
|
|
|
ruamel.yaml.add_constructor(u'!vault',
|
|
ignore_ansible_vault,
|
|
constructor=ruamel.yaml.SafeConstructor)
|
|
|
|
retval = 0
|
|
for filename in args.filenames:
|
|
try:
|
|
with open(filename, encoding='UTF-8') as f:
|
|
load_fn(f)
|
|
except ruamel.yaml.YAMLError as exc:
|
|
print(exc)
|
|
retval = 1
|
|
return retval
|
|
|
|
|
|
if __name__ == '__main__':
|
|
raise SystemExit(main())
|