ansible-doctor/ansibledoctor/cli.py

108 lines
3.2 KiB
Python
Raw Normal View History

2019-10-07 06:52:00 +00:00
#!/usr/bin/env python3
2019-10-08 09:44:35 +00:00
"""Entrypoint and CLI handler."""
2019-10-07 06:52:00 +00:00
import argparse
import ansibledoctor.exception
2019-10-07 06:52:00 +00:00
from ansibledoctor import __version__
from ansibledoctor.config import SingleConfig
from ansibledoctor.doc_generator import Generator
from ansibledoctor.doc_parser import Parser
from ansibledoctor.utils import SingleLog
2019-10-07 06:52:00 +00:00
class AnsibleDoctor:
2020-04-05 21:16:53 +00:00
"""Main doctor object."""
2019-10-07 06:52:00 +00:00
def __init__(self):
self.log = SingleLog()
self.logger = self.log.logger
self.args = self._cli_args()
self.config = self._get_config()
2019-10-07 06:52:00 +00:00
doc_parser = Parser()
doc_generator = Generator(doc_parser)
doc_generator.render()
def _cli_args(self):
"""
Use argparse for parsing CLI arguments.
:return: args objec
"""
2019-10-08 22:56:39 +00:00
# TODO: add function to print to stdout instead of file
2019-10-07 06:52:00 +00:00
parser = argparse.ArgumentParser(
2020-04-05 21:16:53 +00:00
description="Generate documentation from annotated Ansible roles using templates"
)
parser.add_argument(
"role_dir", nargs="?", help="role directory (default: current working dir)"
)
parser.add_argument(
"-c", "--config", dest="config_file", help="location of configuration file"
)
parser.add_argument(
"-o", "--output", dest="output_dir", action="store", help="output base dir"
)
parser.add_argument(
"-f",
"--force",
dest="force_overwrite",
action="store_true",
default=None,
help="force overwrite output file"
)
parser.add_argument(
"-d",
"--dry-run",
dest="dry_run",
action="store_true",
default=None,
help="dry run without writing"
)
2021-07-27 20:01:56 +00:00
parser.add_argument(
"-n",
"--no-role-detection",
dest="role_detection",
action="store_false",
default=None,
help="disable automatic role detection"
)
2020-04-05 21:16:53 +00:00
parser.add_argument(
"-v", dest="logging.level", action="append_const", const=-1, help="increase log level"
)
parser.add_argument(
"-q", dest="logging.level", action="append_const", const=1, help="decrease log level"
)
parser.add_argument(
"--version", action="version", version="%(prog)s {}".format(__version__)
)
2019-10-07 06:52:00 +00:00
return parser.parse_args().__dict__
2019-10-07 06:52:00 +00:00
def _get_config(self):
2019-10-08 09:30:31 +00:00
try:
config = SingleConfig(args=self.args)
except ansibledoctor.exception.ConfigError as e:
2019-10-08 09:30:31 +00:00
self.log.sysexit_with_message(e)
2019-10-09 21:21:45 +00:00
try:
self.log.set_level(config.config["logging"]["level"])
except ValueError as e:
self.log.sysexit_with_message("Can not set log level.\n{}".format(str(e)))
2019-10-08 09:43:55 +00:00
2021-07-27 20:01:56 +00:00
if config.config["role_detection"]:
if config.is_role:
self.logger.info("Ansible role detected")
else:
self.log.sysexit_with_message("No Ansible role detected")
2019-10-07 06:52:00 +00:00
else:
self.logger.info("Ansible role detection disabled")
2019-10-08 09:30:31 +00:00
self.logger.info("Using config file {}".format(config.config_file))
return config
2020-12-31 13:16:00 +00:00
def main():
AnsibleDoctor()