CDPCAM-48, CDPCAM-43: Custom output and links to docs.

.isort.cfg

@@ -1,3 +1,4 @@
 [settings]
 profile=black
 src_paths=cdpctl,tests
+skip=scripts/update_issue_templates.py

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: 20.8b1
     hooks:
       - id: black
-        args: [--safe, --quiet, --target-version, py36]
+        args: [--safe, --quiet, --target-version, py36, --exclude, scripts/update_issue_templates.py]
   - repo: https://github.com/asottile/blacken-docs
     rev: v1.8.0
     hooks:
@@ -20,6 +20,7 @@ repos:
       - id: check-json
         exclude: ^.vscode/
       - id: check-yaml
+        args: [--allow-multiple-documents]
       - id: requirements-txt-fixer
       - id: check-byte-order-marker
       - id: check-case-conflict
@@ -32,10 +33,11 @@ repos:
     rev: v2.7.0
     hooks:
       - id: validate_manifest
-  - repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.5.4
-    hooks:
-      - id: autopep8
+  # - repo: https://github.com/pre-commit/mirrors-autopep8
+  #   rev: v1.5.4
+  #   hooks:
+  #     - id: autopep8
+  #       args: ["--exclude scripts/update_issue_templates.py"]
   - repo: https://github.com/PyCQA/isort
     rev: 5.5.0
     hooks:

.vscode/launch.json

@@ -20,8 +20,24 @@
                 "validate",
                 "infra",
                 "--config_file",
-                "config.yaml"
-            ]
+                "config.yml"
+            ],
+            "justMyCode": false
+        },
+        {
+            "name": "cdpctl validate infra -f json",
+            "type": "python",
+            "request": "launch",
+            "module": "cdpctl",
+            "args": [
+                "validate",
+                "infra",
+                "--config_file",
+                "config.yml",
+                "-f",
+                "json"
+            ],
+            "justMyCode": false
         },
         {
             "name": "cdpctl provision infra",
@@ -32,7 +48,7 @@
                 "provision",
                 "infra",
                 "--config_file",
-                "config.yaml"
+                "config.yml"
             ]
         },
         {
@@ -44,6 +60,14 @@
                 "config",
                 "skeleton"
             ]
+        },
+        {
+            "name": "generate issue templates",
+            "type": "python",
+            "request": "launch",
+            "program": "scripts/update_issue_templates.py",
+            "console": "integratedTerminal"
         }
+
     ]
 }

.yamllint

@@ -34,6 +34,8 @@ rules:
   document-start:
     level: error
     present: false
+    ignore: |
+      **/issue_templates.yml
   empty-lines:
     level: error
     max: 1

cdpctl/cli.py

@@ -50,15 +50,19 @@
 from cdpctl.command.config import render_skeleton
 from cdpctl.command.validate import run_validation
 
+SUPPORTED_OUTPUT_TYPES = ["text", "json"]
+
 
 @click.group(invoke_without_command=True)
+@click.option("-q", "--quiet", is_flag=True, default=False)
 @click.option("--debug/--no-debug", default=False)
 @click.option("-v", "--version", is_flag=True, default=False)
 @click.pass_context
-def _cli(ctx, debug=False, version=False) -> None:
+def _cli(ctx, debug=False, version=False, quiet=False) -> None:
     """Run the cli."""
     ctx.ensure_object(dict)
     ctx.obj["DEBUG"] = debug
+    ctx.obj["QUIET"] = quiet
     if version:
         print_version()
     if ctx.invoked_subcommand is None:
@@ -77,9 +81,31 @@ def _cli(ctx, debug=False, version=False) -> None:
     help="The config file to use. Defaults to config.yml.",
     type=click.Path(exists=False),
 )
-def validate(ctx, target: str, config_file) -> None:  # pylint: disable=unused-argument
+@click.option(
+    "-o",
+    "--output_file",
+    default="-",
+    help="The file to output the results to. Defaults to stdout.",
+    type=click.Path(exists=False),
+)
+@click.option(
+    "-f",
+    "--output_format",
+    default="text",
+    help="The format to output the results as.",
+    type=click.Choice(SUPPORTED_OUTPUT_TYPES, case_sensitive=False),
+)
+def validate(
+    ctx, target: str, config_file, output_file, output_format
+) -> None:  # pylint: disable=unused-argument
     """Run validation checks on provided section."""
-    run_validation(target=target, config_file=config_file, debug=ctx.obj["DEBUG"])
+    run_validation(
+        target=target,
+        config_file=config_file,
+        debug=ctx.obj["DEBUG"],
+        output_format=output_format,
+        output_file=output_file,
+    )
 
 
 @click.group()

cdpctl/command/validate.py

@@ -50,11 +50,18 @@
 import cdpctl.validation as validation
 from cdpctl import SUPPORTED_PLATFORMS
 from cdpctl.utils import load_config
-from cdpctl.validation import UnrecoverableValidationError, conftest
+from cdpctl.validation import UnrecoverableValidationError, conftest, get_issues
 from cdpctl.validation.aws_utils import validate_aws_config
+from cdpctl.validation.renderer import get_renderer
 
 
-def run_validation(target: str, config_file: str, debug: bool = False) -> None:
+def run_validation(
+    target: str,
+    config_file: str,
+    debug: bool = False,
+    output_format: str = "text",
+    output_file: str = "-",
+) -> None:
     """Run the validate command."""
     click.echo(
         f"Targeting {click.style(target, fg='blue')} section with config file "
@@ -113,3 +120,11 @@ def run_validation(target: str, config_file: str, debug: bool = False) -> None:
         options.append("-s")
 
     pytest.main(options)
+
+    renderer = get_renderer(output_format=output_format)
+    renderer.render(get_issues(), output_file)
+    if output_file != "-":
+        click.echo(
+            message=f"Results written to file {click.format_filename(output_file)}.",
+            err=True,
+        )