PYSCAN-9 Add search for config files (#20)

Author: maksim-grebeniuk-sonarsource

src/py_sonar_scanner/configuration.py

@@ -37,10 +37,8 @@ def __init__(self):
 
     def setup(self) -> None:
         """This is executed when run from the command line"""
-        scan_arguments = sys.argv[1:]
-        scan_arguments.extend(self._read_toml_args())
-
-        self.scan_arguments = scan_arguments
+        self.scan_arguments = sys.argv[1:]
+        self.scan_arguments.extend(self._read_toml_args())
 
     def _read_toml_args(self) -> list[str]:
         scan_arguments: list[str] = []
@@ -64,9 +62,39 @@ def _add_parameter_to_scanner_args(self, scan_arguments: list[str], key: str, va
                 self._add_parameter_to_scanner_args(scan_arguments, f"{key}.{k}", v)
 
     def _read_toml_file(self) -> dict:
-        if not os.path.isfile("pyproject.toml"):
+        toml_file_path = self._get_toml_file_path()
+        if not os.path.isfile(toml_file_path):
             return {}
-        with open("pyproject.toml", "r") as file:
+        with open(toml_file_path, "r") as file:
             # TODO: actually search for pyproject.toml
             toml_data = file.read()
             return toml.loads(toml_data)
+
+    def _get_toml_file_path(self) -> str:
+        args = self._get_arguments_dict()
+        if "-Dtoml.path" in args:
+            return args["-Dtoml.path"]
+        elif "-Dproject.home" in args:
+            return os.path.join(args["-Dproject.home"], "pyproject.toml")
+        else:
+            return os.path.join(os.curdir, "pyproject.toml")
+
+    def _get_arguments_dict(self):
+        args = self.scan_arguments
+        arguments_dict = {}
+        i = 0
+        while i < len(args):
+            current_arg = args[i]
+
+            if "=" in current_arg:
+                arg_parts = current_arg.split("=", 1)
+                arguments_dict[arg_parts[0]] = arg_parts[1]
+            else:
+                if i + 1 < len(args) and "=" not in args[i + 1]:
+                    arguments_dict[current_arg] = args[i + 1]
+                    i += 1
+                else:
+                    arguments_dict[current_arg] = None
+
+            i += 1
+        return arguments_dict

tests/resources/pyproject.toml

@@ -0,0 +1,3 @@
+[tool.sonar]
+a="b"
+c="d"

tests/test_configuration.py

@@ -18,15 +18,14 @@
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 import unittest
-from unittest.mock import patch, Mock
+from unittest.mock import patch
 from py_sonar_scanner.configuration import Configuration
 
 
 class TestConfiguration(unittest.TestCase):
     @patch("py_sonar_scanner.configuration.sys")
-    def test_argument_parsing_empty_toml(self, mock_sys):
+    def test_argument_parsing(self, mock_sys):
         configuration = Configuration()
-        configuration._read_toml_args = Mock(return_value=[])
 
         mock_sys.argv = ["path/to/scanner/py-sonar-scanner"]
         configuration.setup()
@@ -47,3 +46,23 @@ def test_argument_parsing_empty_toml(self, mock_sys):
         self.assertListEqual(
             configuration.scan_arguments, ["-DSomeJVMArg", "-DAnotherJVMArg", "-dNotAJVMArg", "-SomeNonsense"]
         )
+
+        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dtoml.path=tests/resources/pyproject.toml"]
+        configuration.setup()
+        self.assertListEqual(
+            configuration.scan_arguments, ["-Dtoml.path=tests/resources/pyproject.toml", "-Dsonar.a=b", "-Dsonar.c=d"]
+        )
+
+        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dproject.home=tests/resources/"]
+        configuration.setup()
+        self.assertListEqual(
+            configuration.scan_arguments, ["-Dproject.home=tests/resources/", "-Dsonar.a=b", "-Dsonar.c=d"]
+        )
+
+        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-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"]
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, ["-Dproject.home=tests=2"])