feat(cli): implement multiple sources (#18)

In #16 we implemented the logic to process multiple source reports. In this PR we add the ability to use it via the CLI.

Issue: #8

Author: Joris Conijn

README.md

@@ -35,15 +35,25 @@ the following command(s):
 report2junit ./sample-reports/cfn-guard.json
 
 # Or if you want to specify the destination:
-report2junit ./sample-reports/cfn-guard.json ./sample-reports/cfn-guard-other-destination.xml
+report2junit ./sample-reports/cfn-guard.json --destination-file ./sample-reports/cfn-guard-other-destination.xml
 ```
 
 Convert an output report from [cfn-nag](https://github.com/stelligent/cfn_nag) using
 the following command(s):
 
 ```bash
-report2juni ./sample-reports/cfn-nag.json
+report2junit ./sample-reports/cfn-nag.json
 
 # Or if you want to specify the destination:
-report2junit ./sample-reports/cfn-nag.json ./sample-reports/cfn-nag-other-destination.xml
+report2junit ./sample-reports/cfn-nag.json --destination-file ./sample-reports/cfn-nag-other-destination.xml
+```
+
+Combine both the [cloudformation-guard](https://github.com/aws-cloudformation/cloudformation-guard) and [cfn-nag](https://github.com/stelligent/cfn_nag)
+reports into a single output report.
+
+```bash
+report2junit ./sample-reports/cfn-nag.json ./sample-reports/cfn-guard.json
+
+# Or if you want to specify the destination:
+report2junit ./sample-reports/cfn-nag.json ./sample-reports/cfn-guard.json --destination-file ./sample-reports/junit-other.xml
 ```

report2junit/__init__.py

@@ -14,25 +14,28 @@
     type=click.Choice(["cfn-guard", "cfn-nag"], case_sensitive=False),
     required=False,
 )
-@click.argument("source-file")
-@click.argument("destination-file", required=False)
+@click.argument("source-files", nargs=-1)
+@click.option("--destination-file", required=False)
 def main(
-    source_file: str, destination_file: Optional[str], source_type: Optional[str] = None
+    source_files: str,
+    destination_file: Optional[str],
+    source_type: Optional[str] = None,
 ):
     """
     Convert2JUnit
 
     This tool allows you to convert various reports into the JUnit format.
     """
-    source_file = os.path.abspath(source_file)
-
     if not destination_file:
-        destination_file = os.path.join(os.path.dirname(source_file), "junit.xml")
+        destination_file = os.path.join(os.path.dirname(source_files[0]), "junit.xml")
 
     report = JUnitOutput(destination_file)
 
-    if not report.apply(source_file):
-        raise click.ClickException("Could not convert the report")
+    for source_file in source_files:
+        source_file = os.path.abspath(source_file)
+
+        if not report.apply(source_file):
+            raise click.ClickException("Could not convert the report")
 
     report.write()
 

tests/test_cli.py

@@ -15,7 +15,7 @@
         "cfn-guard-skipped-only.json",
     ],
 )
-def test_report_conversion(input_file: str, sample_reports_path: str) -> None:
+def test_single_report_conversion(input_file: str, sample_reports_path: str) -> None:
     runner = CliRunner()
     m = mock_open()
 
@@ -44,6 +44,7 @@ def test_cfn_guard_conversion_explicit_destination(sample_reports_path: str) ->
             main,
             [
                 f"{sample_reports_path}/cfn-guard.json",
+                "--destination-file",
                 f"{sample_reports_path}/cfn-guard-specific.xml",
             ],
         )