mirror of
https://github.com/thegeeklab/ansible-doctor.git
synced 2024-11-18 11:10:39 +00:00
73 lines
2.7 KiB
Python
73 lines
2.7 KiB
Python
#!/usr/bin/env python3
|
|
"""Entrypoint and CLI handler."""
|
|
|
|
import argparse
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
import ansibledoctor.Exception
|
|
from ansibledoctor import __version__
|
|
from ansibledoctor.Config import SingleConfig
|
|
from ansibledoctor.DocumentationGenerator import Generator
|
|
from ansibledoctor.DocumentationParser import Parser
|
|
from ansibledoctor.Utils import SingleLog
|
|
|
|
|
|
class AnsibleDoctor:
|
|
|
|
def __init__(self):
|
|
self.log = SingleLog()
|
|
self.logger = self.log.logger
|
|
self.args = self._cli_args()
|
|
self.config = self._get_config()
|
|
|
|
doc_parser = Parser()
|
|
doc_generator = Generator(doc_parser)
|
|
doc_generator.render()
|
|
|
|
def _cli_args(self):
|
|
"""
|
|
Use argparse for parsing CLI arguments.
|
|
|
|
:return: args objec
|
|
"""
|
|
# TODO: add function to print to stdout instead of file
|
|
parser = argparse.ArgumentParser(
|
|
description="Generate documentation from annotated Ansible roles using templates")
|
|
parser.add_argument("role_dir", 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")
|
|
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__))
|
|
|
|
return parser.parse_args().__dict__
|
|
|
|
def _get_config(self):
|
|
try:
|
|
config = SingleConfig(args=self.args)
|
|
except ansibledoctor.Exception.ConfigError as e:
|
|
self.log.sysexit_with_message(e)
|
|
|
|
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)))
|
|
|
|
if config.is_role:
|
|
self.logger.info("Ansible role detected")
|
|
else:
|
|
self.log.sysexit_with_message("No Ansible role detected")
|
|
|
|
self.logger.info("Using config file {}".format(config.config_file))
|
|
|
|
return config
|