test_pyproject_toml.py

#
# Sonar Scanner Python
# Copyright (C) 2011-2026 SonarSource Sàrl
# mailto:info AT sonarsource DOT com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
#
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
from pathlib import Path
from unittest import mock
from unittest.mock import MagicMock, patch

from pyfakefs.fake_filesystem_unittest import TestCase
from pysonar_scanner.configuration.pyproject_toml import TomlConfigurationLoader


class TestTomlFile(TestCase):
    def setUp(self):
        self.setUpPyfakefs()

    def test_load_toml_file_with_sonarqube_config(self):
        self.fs.create_file(
            "pyproject.toml",
            contents="""
            [tool.sonar]
            projectKey = "my-project"
            projectName = "My Project"
            sources = "src"
            exclusions = "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*"
            some.unknownProperty = "unknown_property_value"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "my-project")
        self.assertEqual(properties.sonar_properties.get("sonar.projectName"), "My Project")
        self.assertEqual(properties.sonar_properties.get("sonar.sources"), "src")
        self.assertEqual(
            properties.sonar_properties.get("sonar.exclusions"), "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*"
        )
        self.assertEqual(properties.sonar_properties.get("sonar.some.unknownProperty"), "unknown_property_value")

    def test_load_toml_file_kebab_case(self):
        self.fs.create_file(
            "pyproject.toml",
            contents="""
            [tool.sonar]
            project-key = "my-project"
            project-name = "My Project"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "my-project")
        self.assertEqual(properties.sonar_properties.get("sonar.projectName"), "My Project")

    @patch("pysonar_scanner.configuration.pyproject_toml.logging")
    def test_load_toml_file_kebab_case_unknown_properties(self, mock_logging):
        self.fs.create_file(
            "pyproject.toml",
            contents="""
            [tool.sonar]
            coverage-report-paths = "coverage.xml"
            some-unknown-property = "some-value"
            nested-property.some-nested-key = "nested-value"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(properties.sonar_properties.get("sonar.coverageReportPaths"), "coverage.xml")
        self.assertEqual(properties.sonar_properties.get("sonar.someUnknownProperty"), "some-value")
        self.assertEqual(properties.sonar_properties.get("sonar.nestedProperty.someNestedKey"), "nested-value")

        mock_logging.debug.assert_any_call(
            "Converting kebab-case property 'sonar.coverage-report-paths' to camelCase: 'sonar.coverageReportPaths'"
        )
        mock_logging.debug.assert_any_call(
            "Converting kebab-case property 'sonar.some-unknown-property' to camelCase: 'sonar.someUnknownProperty'"
        )
        mock_logging.debug.assert_any_call(
            "Converting kebab-case property 'sonar.nested-property.some-nested-key' to camelCase: 'sonar.nestedProperty.someNestedKey'"
        )

    def test_load_toml_file_without_sonar_section(self):
        self.fs.create_file(
            "pyproject.toml",
            contents="""
            [tool.black]
            line-length = 88
            target-version = ["py38"]
            
            [tool.isort]
            profile = "black"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(len(properties.sonar_properties), 0)

    def test_load_missing_file(self):
        properties = TomlConfigurationLoader.load(Path("."))
        self.assertEqual(len(properties.sonar_properties), 0)

    def test_load_empty_file(self):
        self.fs.create_file("pyproject.toml", contents="")
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(len(properties.sonar_properties), 0)

    @patch("pysonar_scanner.configuration.pyproject_toml.logging")
    def test_load_malformed_toml_file(self, mock_logging):
        self.fs.create_file(
            "pyproject.toml",
            contents="""
            [tool.sonar
            sonar.projectKey = "my-project"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(len(properties.sonar_properties), 0)
        mock_logging.warning.assert_called_once_with(
            "There was an error reading the pyproject.toml file. No properties from the TOML file were extracted. Error: Expected ']' at the end of a table declaration (at line 2, column 24)",
        )

    def test_load_toml_with_nested_values(self):
        self.fs.create_file(
            "pyproject.toml",
            contents="""
            [tool.sonar]
            projectKey = "my-project"
            
            [tool.sonar.python]
            version = "3.9,3.10,3.11,3.12,3.13"
            coverage.reportPaths = "coverage.xml"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "my-project")
        self.assertEqual(properties.sonar_properties.get("sonar.python.version"), "3.9,3.10,3.11,3.12,3.13")
        self.assertEqual(properties.sonar_properties.get("sonar.python.coverage.reportPaths"), "coverage.xml")

    def test_load_toml_file_from_custom_dir(self):
        self.fs.create_dir("custom/path")
        self.fs.create_file(
            "custom/path/pyproject.toml",
            contents="""
            [tool.sonar]
            projectKey = "custom-path-project"
            projectName = "Custom Path Project"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("custom/path"))

        self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "custom-path-project")
        self.assertEqual(properties.sonar_properties.get("sonar.projectName"), "Custom Path Project")

    def test_load_toml_file_from_direct_file_path(self):
        self.fs.create_dir("custom/path")
        self.fs.create_file(
            "custom/path/pyproject.toml",
            contents="""
            [tool.sonar]
            projectKey = "direct-file-project"
            projectName = "Direct File Project"
            """,
        )
        properties = TomlConfigurationLoader.load(Path("custom/path/pyproject.toml"))

        self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "direct-file-project")
        self.assertEqual(properties.sonar_properties.get("sonar.projectName"), "Direct File Project")

    def test_load_toml_file_from_direct_file_path_missing(self):
        properties = TomlConfigurationLoader.load(Path("nonexistent/pyproject.toml"))
        self.assertEqual(len(properties.sonar_properties), 0)

    def test_load_toml_file_project_content(self):
        self.fs.create_file(
            "pyproject.toml",
            contents=(
                """
                [project]
                name = "My Overridden Project Name"
                description = "My Project Description"
                requires-python = ["3.6", "3.7", "3.8"]
                [tool.sonar]
                project-key = "my-project"
                project-name = "My Project"
                """
            ),
        )
        properties = TomlConfigurationLoader.load(Path("."))

        self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "my-project")
        self.assertEqual(properties.sonar_properties.get("sonar.projectName"), "My Project")
        self.assertEqual(properties.project_properties.get("sonar.projectName"), "My Overridden Project Name")
        self.assertEqual(properties.project_properties.get("sonar.projectDescription"), "My Project Description")
        self.assertEqual(properties.project_properties.get("sonar.python.version"), "3.6,3.7,3.8")