PYSCAN-41 Implement and test handling of duplicate arguments (#26)

Author: guillaume-dequenne

src/py_sonar_scanner/configuration.py

@@ -50,8 +50,10 @@ def setup(self) -> None:
         """This is executed when run from the command line"""
         self._read_wrapper_arguments()
         ApplicationLogger.set_debug(self.is_debug())
-        self.scan_arguments = sys.argv[1:]
-        self.scan_arguments.extend(self._read_toml_args())
+        self.scan_arguments = self._read_toml_args()
+        # If duplicate properties are provided, newer values will override older ones.
+        # We therefore read CLI arguments last so that they have priority over toml configuration.
+        self.scan_arguments.extend(sys.argv[1:])
 
     def _read_wrapper_arguments(self):
         argument_parser = argparse.ArgumentParser()

tests/test_configuration.py

@@ -24,6 +24,8 @@
 from py_sonar_scanner.logger import ApplicationLogger
 
 CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
+TEST_TOML_FILE = "test_toml_file.toml"
+SAMPLE_SCANNER_PATH = "path/to/scanner/py-sonar-scanner"
 
 
 class TestConfiguration(unittest.TestCase):
@@ -32,16 +34,16 @@ def test_argument_parsing(self, mock_sys):
         configuration = Configuration()
         self.assertFalse(configuration.is_debug())
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH]
         configuration.setup()
         self.assertListEqual(configuration.scan_arguments, [])
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-DSomeJVMArg"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, "-DSomeJVMArg"]
         configuration.setup()
         self.assertListEqual(configuration.scan_arguments, ["-DSomeJVMArg"])
 
         mock_sys.argv = [
-            "path/to/scanner/py-sonar-scanner",
+            SAMPLE_SCANNER_PATH,
             "-DSomeJVMArg",
             "-DAnotherJVMArg",
             "-dNotAJVMArg",
@@ -52,35 +54,35 @@ def test_argument_parsing(self, mock_sys):
             configuration.scan_arguments, ["-DSomeJVMArg", "-DAnotherJVMArg", "-dNotAJVMArg", "-SomeNonsense"]
         )
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", f"-Dtoml.path={CURRENT_DIR}/resources/pyproject.toml"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, f"-Dtoml.path={CURRENT_DIR}/resources/pyproject.toml"]
         configuration.setup()
         self.assertListEqual(
             configuration.scan_arguments,
-            [f"-Dtoml.path={CURRENT_DIR}/resources/pyproject.toml", "-Dsonar.a=b", "-Dsonar.c=d"],
+            ["-Dsonar.a=b", "-Dsonar.c=d", f"-Dtoml.path={CURRENT_DIR}/resources/pyproject.toml"],
         )
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", f"-Dproject.home={CURRENT_DIR}/resources/"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, f"-Dproject.home={CURRENT_DIR}/resources/"]
         configuration.setup()
         self.assertListEqual(
-            configuration.scan_arguments, [f"-Dproject.home={CURRENT_DIR}/resources/", "-Dsonar.a=b", "-Dsonar.c=d"]
+            configuration.scan_arguments, ["-Dsonar.a=b", "-Dsonar.c=d", f"-Dproject.home={CURRENT_DIR}/resources/"]
         )
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dproject.home=tests2"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, "-Dproject.home=tests2"]
         configuration.setup()
         self.assertListEqual(configuration.scan_arguments, ["-Dproject.home=tests2"])
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dproject.home=tests=2"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, "-Dproject.home=tests=2"]
         configuration.setup()
         self.assertListEqual(configuration.scan_arguments, ["-Dproject.home=tests=2"])
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-X"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, "-X"]
         configuration.setup()
         self.assertTrue(configuration.is_debug())
 
     @patch("py_sonar_scanner.configuration.sys")
     def test_dict_with_no_valid_values(self, mock_sys):
         configuration = Configuration()
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH]
 
         test_dict = {}
         configuration._read_toml_file = Mock(return_value=test_dict)
@@ -100,7 +102,7 @@ def test_dict_with_no_valid_values(self, mock_sys):
     @patch("py_sonar_scanner.configuration.sys")
     def test_dict_with_valid_values(self, mock_sys):
         configuration = Configuration()
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner"]
+        mock_sys.argv = [SAMPLE_SCANNER_PATH]
 
         test_dict = {"tool": {"sonar": {"property1": "value1"}}}
         configuration._read_toml_file = Mock(return_value=test_dict)
@@ -127,23 +129,40 @@ def test_dict_with_valid_values(self, mock_sys):
     @patch("py_sonar_scanner.configuration.sys")
     def test_toml_with_valid_values(self, mock_sys):
         configuration = Configuration()
-        toml_file_path = os.path.join(CURRENT_DIR, "resources", "test_toml_file.toml")
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", f"-Dtoml.path={toml_file_path}"]
+        toml_file_path = os.path.join(CURRENT_DIR, "resources", TEST_TOML_FILE)
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, f"-Dtoml.path={toml_file_path}"]
         configuration.setup()
         self.assertListEqual(
             configuration.scan_arguments,
             [
+                "-Dsonar.property1=value1",
+                "-Dsonar.property2=value2",
+                "-Dsonar.property_class.property1=value1",
                 f"-Dtoml.path={CURRENT_DIR}/resources/test_toml_file.toml",
+            ],
+        )
+
+    @patch("py_sonar_scanner.configuration.sys")
+    def test_duplicate_values_toml_cli(self, mock_sys):
+        configuration = Configuration()
+        toml_file_path = os.path.join(CURRENT_DIR, "resources", TEST_TOML_FILE)
+        mock_sys.argv = [SAMPLE_SCANNER_PATH, f"-Dtoml.path={toml_file_path}", "-Dsonar.property1=value1"]
+        configuration.setup()
+        self.assertListEqual(
+            configuration.scan_arguments,
+            [
                 "-Dsonar.property1=value1",
                 "-Dsonar.property2=value2",
                 "-Dsonar.property_class.property1=value1",
+                f"-Dtoml.path={CURRENT_DIR}/resources/test_toml_file.toml",
+                "-Dsonar.property1=value1",
             ],
         )
 
     @patch("builtins.open")
     @patch("py_sonar_scanner.configuration.sys")
     def test_error_while_reading_toml_file(self, mock_sys, mock_open):
-        toml_file_path = os.path.join(CURRENT_DIR, "resources", "test_toml_file.toml")
+        toml_file_path = os.path.join(CURRENT_DIR, "resources", TEST_TOML_FILE)
         mock_sys.argv = ["path/to/scanner/py-sonar-scanner", f"-Dtoml.path={toml_file_path}"]
 
         mock_open.side_effect = OSError("Test error while opening file.")