Add YAML reporter

cloudselect/cloud.json.dist

@@ -33,7 +33,8 @@
         },
         "report": {
             "json": "cloudselect.report.json",
-            "json_pp": "cloudselect.report.json_pp"
+            "json_pp": "cloudselect.report.json_pp",
+            "yaml": "cloudselect.report.yaml"
         }
     }
 }

cloudselect/report/json.py

@@ -1,11 +1,11 @@
-# Copyright 2019 Alexey Aksenov and individual contributors
+# Copyright 2019-2020 Alexey Aksenov and individual contributors
 # See the LICENSE.txt file at the top-level directory of this distribution.
 #
 # Licensed under the MIT license
 # <LICENSE-MIT or http://opensource.org/licenses/MIT>
 # This file may not be copied, modified, or distributed
 # except according to those terms.
-"""Module that represents list of selected instances as pretty print output."""
+"""Module that represents list of selected instances as JSON output."""
 import json
 
 from cloudselect import Container
@@ -14,10 +14,10 @@
 
 
 class Json(ReportService):
-    """Json reporter implementation."""
+    """JSON reporter implementation."""
 
     def run(self, selected):
-        """Represent instances as pretty print output."""
+        """Represent instances as JSON output."""
         # get first instance
         # assume that all instances match the same group/pattern
         instance = next(iter(selected), None)

cloudselect/report/json_pp.py

@@ -5,7 +5,7 @@
 # <LICENSE-MIT or http://opensource.org/licenses/MIT>
 # This file may not be copied, modified, or distributed
 # except according to those terms.
-"""Module that represents list of selected instances as pretty print output."""
+"""Module that represents list of selected instances as formatted JSON output."""
 import json
 
 from cloudselect import Container
@@ -14,10 +14,10 @@
 
 
 class JsonPP(ReportService):
-    """Json reporter implementation."""
+    """Formatted JSON reporter implementation."""
 
     def run(self, selected):
-        """Represent instances as pretty print output."""
+        """Represent instances as formatted JSON output."""
         # get first instance
         # assume that all instances match the same group/pattern
         instance = next(iter(selected), None)

cloudselect/report/yaml.py

@@ -0,0 +1,26 @@
+# Copyright 2020 Alexey Aksenov and individual contributors
+# See the LICENSE.txt file at the top-level directory of this distribution.
+#
+# Licensed under the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>
+# This file may not be copied, modified, or distributed
+# except according to those terms.
+"""Module that represents list of selected instances as JSON output."""
+from yaml import safe_dump
+
+from cloudselect import Container
+
+from . import ReportService
+
+
+class Yaml(ReportService):
+    """YAML reporter implementation."""
+
+    def run(self, selected):
+        """Represent instances as YAML output."""
+        # get first instance
+        # assume that all instances match the same group/pattern
+        instance = next(iter(selected), None)
+        options = Container.options("option", instance)
+        report = {"instances": [i.to_dict() for i in selected], "option": options}
+        print(safe_dump(report, indent=2))

requirements.txt

@@ -2,3 +2,4 @@ appdirs==1.4.3
 boto3==1.11.14
 chardet==3.0.4
 dependency-injector==3.15.4
+pyyaml==5.2

setup.py

@@ -29,6 +29,7 @@
         "boto3==1.11.14",
         "chardet==3.0.4",
         "dependency-injector==3.15.4",
+        "pyyaml==5.2",
     ],
     include_package_data=True,
     keywords=["Cloud", "CLI", "FZF", "SSH", "SCP", "AWS"],

test/test_cloudselect.py

@@ -114,6 +114,7 @@ def test_cli_configuration_read():
             "report": {
                 "json": "cloudselect.report.json",
                 "json_pp": "cloudselect.report.json_pp",
+                "yaml": "cloudselect.report.yaml",
             },
         },
     }

tox.ini

@@ -18,5 +18,6 @@ deps = codecov
        boto3
        chardet
        dependency_injector
+       pyyaml
 commands = {posargs:py.test}
            codecov: codecov -e TOXENV