History: Unlock YAML export format

Author: amotl

CHANGES.rst

@@ -11,6 +11,7 @@ in progress
 - History: Stop ``grafana-wtf log <UID>`` acquiring *all* dashboards
 - Refactoring: Move all report renderers to ``grafana_wtf.report``
 - History: Add ``id`` and ``uid`` dashboard attributes to report
+- History: Unlock YAML export format
 
 2023-03-05 0.14.1
 =================

grafana_wtf/commands.py

@@ -1,25 +1,23 @@
 # -*- coding: utf-8 -*-
 # (c) 2019-2021 Andreas Motl <[email protected]>
 # License: GNU Affero General Public License, Version 3
-import json
 import logging
 import os
 from functools import partial
 from operator import itemgetter
-from typing import List
 
 from docopt import DocoptExit, docopt
 
 from grafana_wtf import __appname__, __version__
 from grafana_wtf.core import GrafanaWtf
+from grafana_wtf.report.data import output_results
 from grafana_wtf.report.textual import TextualSearchReport
 from grafana_wtf.report.tabular import TabularSearchReport, get_table_format, TabularEditHistoryReport
 from grafana_wtf.util import (
     configure_http_logging,
     normalize_options,
     read_list,
     setup_logging,
-    yaml_dump,
 )
 
 log = logging.getLogger(__name__)
@@ -229,17 +227,12 @@ def run():
             count = int(options.number)
             entries = entries[:count]
 
-        if output_format == "json":
-            output = json.dumps(entries, indent=4)
-
-        elif output_format.startswith("tabular"):
+        if output_format.startswith("tabular"):
             report = TabularEditHistoryReport(data=entries)
             output = report.render(output_format)
-
+            print(output)
         else:
-            raise ValueError(f'Unknown output format "{output_format}"')
-
-        print(output)
+            output_results(output_format, entries)
 
     if options.explore and options.datasources:
         results = engine.explore_datasources()
@@ -257,16 +250,3 @@ def run():
     if options.info:
         response = engine.info()
         output_results(output_format, response)
-
-
-def output_results(output_format: str, results: List):
-    if output_format == "json":
-        output = json.dumps(results, indent=4)
-
-    elif output_format == "yaml":
-        output = yaml_dump(results)
-
-    else:
-        raise ValueError(f'Unknown output format "{output_format}"')
-
-    print(output)

grafana_wtf/report/data.py

@@ -0,0 +1,17 @@
+import json
+from typing import List
+
+from grafana_wtf.util import yaml_dump
+
+
+def output_results(output_format: str, results: List):
+    if output_format == "json":
+        output = json.dumps(results, indent=4)
+
+    elif output_format == "yaml":
+        output = yaml_dump(results)
+
+    else:
+        raise ValueError(f'Unknown output format "{output_format}"')
+
+    print(output)

tests/test_commands.py

@@ -274,6 +274,21 @@ def test_log_tabular_success(ldi_resources, capsys, caplog):
     assert first_item_normalized == reference
 
 
+def test_log_yaml_success(ldi_resources, capsys, caplog):
+    # Only provision specific dashboard(s).
+    ldi_resources(dashboards=["tests/grafana/dashboards/ldi-v27.json", "tests/grafana/dashboards/ldi-v33.json"])
+
+    # Run command and capture output.
+    set_command("log")
+    with caplog.at_level(logging.DEBUG):
+        grafana_wtf.commands.run()
+    captured = capsys.readouterr()
+
+    data = yaml.safe_load(captured.out)
+
+    assert len(data) == 3
+
+
 def test_explore_datasources_used(create_datasource, create_dashboard, capsys, caplog):
     # Create two data sources and a dashboard which uses them.
     ds_foo = create_datasource(name="foo")