Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42845 from tchaikov/wip-51483
common/options: validate see-also Reviewed-by: Deepika Upadhyay <dupadhya@redhat.com>
- Loading branch information
Showing
3 changed files
with
59 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
#!/usr/bin/env python3 | ||
|
||
import argparse | ||
import fileinput | ||
import sys | ||
import yaml | ||
from typing import Any, Dict | ||
|
||
|
||
class ValidationError(Exception): | ||
pass | ||
|
||
|
||
OptionType = Dict[str, Any] | ||
|
||
|
||
def validate_see_also(opt: OptionType, opts: Dict[str, OptionType]) -> None: | ||
see_also = opt.get('see_also') | ||
if see_also is None: | ||
return | ||
for ref in see_also: | ||
if ref not in opts: | ||
msg = f'see_also contains "{ref}". But it is not found.' | ||
raise ValidationError(msg) | ||
|
||
|
||
def main() -> None: | ||
parser = argparse.ArgumentParser( | ||
formatter_class=argparse.ArgumentDefaultsHelpFormatter) | ||
parser.add_argument('yamls', nargs='*') | ||
opts = parser.parse_args() | ||
options = {} | ||
for yaml_file in opts.yamls: | ||
with open(yaml_file) as f: | ||
yml = yaml.load(f, yaml.SafeLoader) | ||
options.update({opt['name']: opt for opt in yml['options']}) | ||
for name, opt in options.items(): | ||
try: | ||
validate_see_also(opt, options) | ||
except ValidationError as e: | ||
raise Exception(f'failed to validate "{name}": {e}') | ||
|
||
|
||
if __name__ == '__main__': | ||
try: | ||
main() | ||
except Exception as e: | ||
print(e, file=sys.stderr) | ||
sys.exit(1) |