PYSCAN-3 Add tests for pyproject.toml file parsing. (#19)

Author: Jeremi Do Dinh

src/py_sonar_scanner/configuration.py

@@ -20,20 +20,26 @@
 from __future__ import annotations
 import os
 import sys
+from logging import Logger
+
 import toml
 
+from py_sonar_scanner.logger import ApplicationLogger
+
 
 class Configuration:
     sonar_scanner_executable_path: str
     sonar_scanner_path: str
     sonar_scanner_version: str
     scan_arguments: list[str]
+    log: Logger
 
     def __init__(self):
         self.sonar_scanner_path = ".scanner"
         self.sonar_scanner_version = "4.6.2.2472"
         self.sonar_scanner_executable_path = ""
         self.scan_arguments = []
+        self.log = ApplicationLogger.get_logger()
 
     def setup(self) -> None:
         """This is executed when run from the command line"""
@@ -42,18 +48,25 @@ def setup(self) -> None:
 
     def _read_toml_args(self) -> list[str]:
         scan_arguments: list[str] = []
+        toml_data: dict = {}
         try:
-            parsed_data = self._read_toml_file()
-            if ("tool" not in parsed_data) or ("sonar" not in parsed_data["tool"]):
-                return scan_arguments
-            sonar_properties = parsed_data["tool"]["sonar"]
-            for key, value in sonar_properties.items():
-                self._add_parameter_to_scanner_args(scan_arguments, key, value)
-        except BaseException as e:
-            print(e)
-            raise e
+            toml_data = self._read_toml_file()
+        except OSError:
+            self.log.error("Test error while opening file.")
+        sonar_properties = self._extract_sonar_properties(toml_data)
+        for key, value in sonar_properties.items():
+            self._add_parameter_to_scanner_args(scan_arguments, key, value)
         return scan_arguments
 
+    def _extract_sonar_properties(self, toml_properties):
+        if "tool" not in toml_properties.keys():
+            return {}
+        tool_data = toml_properties["tool"]
+        if not isinstance(tool_data, dict) or "sonar" not in tool_data.keys():
+            return {}
+        sonar_properties = tool_data["sonar"]
+        return sonar_properties if isinstance(sonar_properties, dict) else {}
+
     def _add_parameter_to_scanner_args(self, scan_arguments: list[str], key: str, value: Union[str, dict]):
         if isinstance(value, str):
             scan_arguments.append(f"-Dsonar.{key}={value}")

tests/resources/test_toml_file.toml

@@ -0,0 +1,10 @@
+[tool]
+ignored_property="something"
+
+[tool.sonar]
+property1="value1"
+property2="value2"
+
+[tool.sonar.property_class]
+property1="value1"
+

tests/test_configuration.py

@@ -17,10 +17,13 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
+import os
 import unittest
-from unittest.mock import patch
+from unittest.mock import patch, Mock
 from py_sonar_scanner.configuration import Configuration
 
+CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
+
 
 class TestConfiguration(unittest.TestCase):
     @patch("py_sonar_scanner.configuration.sys")
@@ -47,16 +50,17 @@ def test_argument_parsing(self, mock_sys):
             configuration.scan_arguments, ["-DSomeJVMArg", "-DAnotherJVMArg", "-dNotAJVMArg", "-SomeNonsense"]
         )
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dtoml.path=tests/resources/pyproject.toml"]
+        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", f"-Dtoml.path={CURRENT_DIR}/resources/pyproject.toml"]
         configuration.setup()
         self.assertListEqual(
-            configuration.scan_arguments, ["-Dtoml.path=tests/resources/pyproject.toml", "-Dsonar.a=b", "-Dsonar.c=d"]
+            configuration.scan_arguments,
+            [f"-Dtoml.path={CURRENT_DIR}/resources/pyproject.toml", "-Dsonar.a=b", "-Dsonar.c=d"],
         )
 
-        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dproject.home=tests/resources/"]
+        mock_sys.argv = ["path/to/scanner/py-sonar-scanner", f"-Dproject.home={CURRENT_DIR}/resources/"]
         configuration.setup()
         self.assertListEqual(
-            configuration.scan_arguments, ["-Dproject.home=tests/resources/", "-Dsonar.a=b", "-Dsonar.c=d"]
+            configuration.scan_arguments, [f"-Dproject.home={CURRENT_DIR}/resources/", "-Dsonar.a=b", "-Dsonar.c=d"]
         )
 
         mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dproject.home=tests2"]
@@ -66,3 +70,90 @@ def test_argument_parsing(self, mock_sys):
         mock_sys.argv = ["path/to/scanner/py-sonar-scanner", "-Dproject.home=tests=2"]
         configuration.setup()
         self.assertListEqual(configuration.scan_arguments, ["-Dproject.home=tests=2"])
+
+    @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"]
+
+        test_dict = {}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, [])
+
+        test_dict = {"tool": "some_property"}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, [])
+
+        test_dict = {"tool": {"sonar": "some_property"}}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, [])
+
+    @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"]
+
+        test_dict = {"tool": {"sonar": {"property1": "value1"}}}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, ["-Dsonar.property1=value1"])
+
+        test_dict = {"tool": {"sonar": {"property1": "value1", "property2": "value2"}}}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, ["-Dsonar.property1=value1", "-Dsonar.property2=value2"])
+
+        test_dict = {"tool": {"sonar": {"property_class": {"property1": "value1"}}}}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(configuration.scan_arguments, ["-Dsonar.property_class.property1=value1"])
+
+        test_dict = {"tool": {"sonar": {"property1": "value1", "property_class": {"sub_property": "sub_value"}}}}
+        configuration._read_toml_file = Mock(return_value=test_dict)
+        configuration.setup()
+        self.assertListEqual(
+            configuration.scan_arguments, ["-Dsonar.property1=value1", "-Dsonar.property_class.sub_property=sub_value"]
+        )
+
+    @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}"]
+        configuration.setup()
+        self.assertListEqual(
+            configuration.scan_arguments,
+            [
+                f"-Dtoml.path={CURRENT_DIR}/resources/test_toml_file.toml",
+                "-Dsonar.property1=value1",
+                "-Dsonar.property2=value2",
+                "-Dsonar.property_class.property1=value1",
+            ],
+        )
+
+    @patch("py_sonar_scanner.configuration.ApplicationLogger.get_logger")
+    @patch("builtins.open")
+    @patch("py_sonar_scanner.configuration.sys")
+    def test_error_while_reading_toml_file(self, mock_sys, mock_open, mock_logger):
+        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}"]
+
+        mock_open.side_effect = OSError("Test error while opening file.")
+
+        mock_logger_instance = Mock()
+        mock_logger_instance.error = Mock()
+        mock_logger.return_value = mock_logger_instance
+
+        configuration = Configuration()
+        configuration.setup()
+
+        self.assertListEqual(
+            configuration.scan_arguments,
+            [
+                f"-Dtoml.path={CURRENT_DIR}/resources/test_toml_file.toml",
+            ],
+        )
+        mock_logger_instance.error.assert_called_once_with("Test error while opening file.")