ansible-doctor/ansibledoctor/DocumentationParser.py

114 lines
4.8 KiB
Python
Raw Normal View History

2019-10-07 06:52:00 +00:00
#!/usr/bin/env python3
2019-10-08 09:39:27 +00:00
"""Parse static files."""
2019-10-07 06:52:00 +00:00
import fnmatch
from collections import defaultdict
import anyconfig
import ruamel.yaml
from nested_lookup import nested_lookup
2019-10-07 06:52:00 +00:00
from ansibledoctor.Annotation import Annotation
from ansibledoctor.Config import SingleConfig
from ansibledoctor.Contstants import YAML_EXTENSIONS
from ansibledoctor.FileRegistry import Registry
from ansibledoctor.Utils import SingleLog
from ansibledoctor.Utils import UnsafeTag
2019-10-07 06:52:00 +00:00
class Parser:
2020-04-05 21:16:53 +00:00
"""Parse yaml files."""
2019-10-07 06:52:00 +00:00
def __init__(self):
self._annotation_objs = {}
self._data = defaultdict(dict)
self.config = SingleConfig()
self.log = SingleLog()
self.logger = SingleLog().logger
2019-10-07 06:52:00 +00:00
self._files_registry = Registry()
self._parse_meta_file()
self._parse_var_files()
# self._parse_task_tags()
2019-10-07 06:52:00 +00:00
self._populate_doc_data()
def _parse_var_files(self):
2019-10-07 06:52:00 +00:00
for rfile in self._files_registry.get_files():
if any(fnmatch.fnmatch(rfile, "*/defaults/*." + ext) for ext in YAML_EXTENSIONS):
2019-10-07 06:52:00 +00:00
with open(rfile, "r", encoding="utf8") as yaml_file:
try:
2020-04-05 21:16:53 +00:00
ruamel.yaml.add_constructor(
UnsafeTag.yaml_tag,
UnsafeTag.yaml_constructor,
constructor=ruamel.yaml.SafeConstructor
)
2020-01-27 10:03:37 +00:00
data = defaultdict(dict, (ruamel.yaml.safe_load(yaml_file) or {}))
2019-10-07 06:52:00 +00:00
for key, value in data.items():
self._data["var"][key] = {"value": {key: value}}
2020-04-05 21:16:53 +00:00
except (
ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError
) as e:
message = "{} {}".format(e.context, e.problem)
2020-04-05 21:16:53 +00:00
self.log.sysexit_with_message(
"Unable to read yaml file {}\n{}".format(rfile, message)
)
2019-10-07 06:52:00 +00:00
def _parse_meta_file(self):
for rfile in self._files_registry.get_files():
if any("meta/main." + ext in rfile for ext in YAML_EXTENSIONS):
2019-10-07 06:52:00 +00:00
with open(rfile, "r", encoding="utf8") as yaml_file:
try:
data = defaultdict(dict, ruamel.yaml.safe_load(yaml_file))
2019-10-07 06:52:00 +00:00
if data.get("galaxy_info"):
for key, value in data.get("galaxy_info").items():
self._data["meta"][key] = {"value": value}
2019-10-08 09:30:31 +00:00
if data.get("dependencies") is not None:
2020-04-05 21:16:53 +00:00
self._data["meta"]["dependencies"] = {
"value": data.get("dependencies")
}
2019-11-07 08:10:20 +00:00
2020-01-22 12:07:05 +00:00
self._data["meta"]["name"] = {"value": self.config.config["role_name"]}
2020-04-05 21:16:53 +00:00
except (
ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError
) as e:
message = "{} {}".format(e.context, e.problem)
2020-04-05 21:16:53 +00:00
self.log.sysexit_with_message(
"Unable to read yaml file {}\n{}".format(rfile, message)
)
2019-11-07 08:13:39 +00:00
def _parse_task_tags(self):
for rfile in self._files_registry.get_files():
if any(fnmatch.fnmatch(rfile, "*/tasks/*." + ext) for ext in YAML_EXTENSIONS):
with open(rfile, "r", encoding="utf8") as yaml_file:
try:
data = ruamel.yaml.safe_load(yaml_file)
2020-04-05 21:16:53 +00:00
except (
ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError
) as e:
message = "{} {}".format(e.context, e.problem)
2020-04-05 21:16:53 +00:00
self.log.sysexit_with_message(
"Unable to read yaml file {}\n{}".format(rfile, message)
)
2019-10-07 06:52:00 +00:00
tags_found = nested_lookup("tags", data)
for tag in tags_found:
self._data["tags"][tag] = {}
2019-10-07 06:52:00 +00:00
def _populate_doc_data(self):
"""Generate the documentation data object."""
tags = defaultdict(dict)
for annotaion in self.config.get_annotations_names(automatic=True):
self.logger.info("Finding annotations for: @" + annotaion)
2020-04-05 21:16:53 +00:00
self._annotation_objs[annotaion] = Annotation(
name=annotaion, files_registry=self._files_registry
)
2019-10-07 06:52:00 +00:00
tags[annotaion] = self._annotation_objs[annotaion].get_details()
try:
anyconfig.merge(self._data, tags, ac_merge=anyconfig.MS_DICTS)
except ValueError as e:
self.log.sysexit_with_message("Unable to merge annotation values:\n{}".format(e))
2019-10-07 06:52:00 +00:00
def get_data(self):
return self._data