Merge pull request #1282 from okorach:yaml-export

YAML sonar-config export beta

Author: okorach

.gitignore

@@ -12,6 +12,8 @@ dist/
 tmp/
 .coverage
 *.json
+*.yaml
+*.yml
 .venv/
 .DS_Store
 

cli/config.py

@@ -23,6 +23,7 @@
 """
 import sys
 import json
+import yaml
 
 from cli import options
 from sonar import exceptions, errcodes, utilities
@@ -70,7 +71,7 @@
 def __parse_args(desc):
     parser = options.set_common_args(desc)
     parser = options.set_key_arg(parser)
-    parser = options.set_output_file_args(parser, allowed_formats=("json",))
+    parser = options.set_output_file_args(parser, allowed_formats=("json", "yaml"))
     parser = options.add_thread_arg(parser, "project export")
     parser = options.set_what(parser, what_list=_EVERYTHING, operation="export or import")
     parser = options.add_import_export_arg(parser, "configuration")
@@ -103,6 +104,15 @@ def __parse_args(desc):
     return args
 
 
+def __write_export(config: dict[str, str], file: str, format: str) -> None:
+    """Writes the configuration in file"""
+    with utilities.open_file(file) as fd:
+        if format == "yaml":
+            print(yaml.dump(config), file=fd)
+        else:
+            print(utilities.json_dump(config), file=fd)
+
+
 def __export_config(endpoint: platform.Platform, what: list[str], **kwargs) -> None:
     """Exports a platform configuration in a JSON file"""
     export_settings = {
@@ -118,15 +128,12 @@ def __export_config(endpoint: platform.Platform, what: list[str], **kwargs) -> N
 
     log.info("Exporting configuration from %s", kwargs[options.URL])
     key_list = kwargs[options.KEYS]
-    sq_settings = {}
-    sq_settings[__JSON_KEY_PLATFORM] = endpoint.basics()
+    sq_settings = {__JSON_KEY_PLATFORM: endpoint.basics()}
     if options.WHAT_SETTINGS in what:
         sq_settings[__JSON_KEY_SETTINGS] = endpoint.export(export_settings=export_settings)
-    if options.WHAT_RULES in what:
+    if options.WHAT_RULES in what or options.WHAT_PROFILES in what:
         sq_settings[__JSON_KEY_RULES] = rules.export(endpoint, export_settings=export_settings)
     if options.WHAT_PROFILES in what:
-        if options.WHAT_RULES not in what:
-            sq_settings[__JSON_KEY_RULES] = rules.export(endpoint, export_settings=export_settings)
         sq_settings[__JSON_KEY_PROFILES] = qualityprofiles.export(endpoint, export_settings=export_settings)
     if options.WHAT_GATES in what:
         sq_settings[__JSON_KEY_GATES] = qualitygates.export(endpoint, export_settings=export_settings)
@@ -150,8 +157,7 @@ def __export_config(endpoint: platform.Platform, what: list[str], **kwargs) -> N
     sq_settings = utilities.remove_empties(sq_settings)
     if not kwargs["dontInlineLists"]:
         sq_settings = utilities.inline_lists(sq_settings, exceptions=("conditions",))
-    with utilities.open_file(kwargs["file"]) as fd:
-        print(utilities.json_dump(sq_settings), file=fd)
+    __write_export(sq_settings, kwargs[options.REPORT_FILE], kwargs[options.FORMAT])
     log.info("Exporting configuration from %s completed", kwargs["url"])
 
 
@@ -193,7 +199,7 @@ def __import_config(endpoint: platform.Platform, what: list[str], **kwargs) -> N
     log.info("Importing configuration to %s completed", kwargs[options.URL])
 
 
-def main():
+def main() -> None:
     """Main entry point for sonar-config"""
     start_time = utilities.start_clock()
     try:
@@ -206,6 +212,7 @@ def main():
         utilities.exit_fatal(f"One of --{options.EXPORT} or --{options.IMPORT} option must be chosen", exit_code=errcodes.ARGS_ERROR)
 
     what = utilities.check_what(kwargs.pop(options.WHAT, None), _EVERYTHING, "exported or imported")
+    kwargs[options.FORMAT] = utilities.deduct_format(kwargs[options.FORMAT], kwargs[options.REPORT_FILE], allowed_formats=("json", "yaml"))
     if kwargs[options.EXPORT]:
         try:
             __export_config(endpoint, what, **kwargs)

cli/options.py

@@ -403,7 +403,7 @@ def set_output_file_args(parser: ArgumentParser, help_str: str = None, allowed_f
             choices=allowed_formats,
             required=False,
             default=None,
-            help="Output format for generated report.\nIf not specified, it is the output file extension if json or csv, then csv by default",
+            help="Output format for generated report.\nIf not specified, it is the output file extension if json, csv or yaml, then csv by default",
         )
     if "csv" in allowed_formats:
         parser.add_argument(

sonar/utilities.py

@@ -569,6 +569,8 @@ def deduct_format(fmt: Union[str, None], filename: Union[str, None], allowed_for
     """Deducts output format from CLI format and filename"""
     if fmt is None and filename is not None:
         fmt = filename.split(".").pop(-1).lower()
+        if fmt == "yml":
+            fmt = "yaml"
     if fmt not in allowed_formats:
         fmt = "csv"
     return fmt