PYSCAN-4: Add tests for environment (#5)

joke1196 · web-flow · commit 1c1decae73fc · 2023-12-12T14:30:07.000+01:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -20,7 +20,8 @@ classifiers = [
 ]
 
 dependencies = [
-    "toml>=0.10.2",
+  "toml>=0.10.2",
+  "pyfiglet"  
 ]
 
 [project.urls]
diff --git a/src/py_sonar_scanner/environment.py b/src/py_sonar_scanner/environment.py
@@ -20,65 +20,79 @@
 from __future__ import annotations
 import os
 import platform
+import pyfiglet
 import shutil
 import urllib.request
-import zipfile
+from urllib.error import HTTPError
 
+from py_sonar_scanner.logger import ApplicationLogger
 from py_sonar_scanner.configuration import Configuration
+from py_sonar_scanner.utils.binaries_utils import write_binaries, unzip_binaries
 from py_sonar_scanner.scanner import Scanner
 
-systems = {
-    'Darwin': 'macosx',
-    'Windows': 'windows'
-}
+systems = {"Darwin": "macosx", "Windows": "windows"}
 
 
 class Environment:
     cfg: Configuration
 
+    # a full download path for a scanner has the following shape:
+    # https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${version}-${os}.zip
+    scanner_base_url: str = "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli"
+
     def __init__(self, cfg: Configuration):
         self.cfg = cfg
+        self.log = ApplicationLogger.get_logger()
 
     def setup(self):
         self.cleanup()
         if self._is_sonar_scanner_on_path():
-            self.cfg.sonar_scanner_executable_path = 'sonar-scanner'
+            self.cfg.sonar_scanner_executable_path = "sonar-scanner"
         else:
-            system_name = systems.get(platform.uname().system, 'linux')
+            system_name = systems.get(platform.uname().system, "linux")
             self._install_scanner(system_name)
-            sonar_scanner_home = os.path.join(self.cfg.sonar_scanner_path,
-                                              f'sonar-scanner-{self.cfg.sonar_scanner_version}-{system_name}')
-            self.cfg.sonar_scanner_executable_path = os.path.join(sonar_scanner_home, 'bin', 'sonar-scanner')
+            sonar_scanner_home = os.path.join(
+                self.cfg.sonar_scanner_path,
+                f"sonar-scanner-{self.cfg.sonar_scanner_version}-{system_name}",
+            )
+            self.cfg.sonar_scanner_executable_path = os.path.join(sonar_scanner_home, "bin", "sonar-scanner")
 
-        print(self.cfg.sonar_scanner_executable_path)
+        ascii_banner = pyfiglet.figlet_format("Sonar Scanner")
+        self.log.info(ascii_banner)
 
-    def _install_scanner(self, system_name: str):
-        os.mkdir(self.cfg.sonar_scanner_path)
-        # Download the binaries and unzip them
-        # https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${version}-${os}.zip
-        scanner_res = urllib.request.urlopen(
-            f'https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-{self.cfg.sonar_scanner_version}-{system_name}.zip')
-        scanner_zip_path = os.path.join(self.cfg.sonar_scanner_path, 'scanner.zip')
-        with open(scanner_zip_path, 'wb') as output:
-            output.write(scanner_res.read())
-        with zipfile.ZipFile(scanner_zip_path, "r") as zip_ref:
-            zip_ref.extractall(self.cfg.sonar_scanner_path)
-        os.remove(scanner_zip_path)
-        self._change_permissions_recursive(self.cfg.sonar_scanner_path, 0o777)
+    def scanner(self) -> Scanner:
+        return Scanner(self.cfg)
 
     def _is_sonar_scanner_on_path(self) -> bool:
-        return shutil.which('sonar-scanner') is not None
+        return shutil.which("sonar-scanner") is not None
 
     def cleanup(self):
         if os.path.exists(self.cfg.sonar_scanner_path):
             shutil.rmtree(self.cfg.sonar_scanner_path)
 
+    def _install_scanner(self, system_name: str):
+        os.mkdir(self.cfg.sonar_scanner_path)
+        # Download the binaries and unzip them
+        scanner_zip_path = self._download_scanner_binaries(
+            self.cfg.sonar_scanner_path, self.cfg.sonar_scanner_version, system_name
+        )
+        unzip_binaries(scanner_zip_path, self.cfg.sonar_scanner_path)
+        os.remove(scanner_zip_path)
+        self._change_permissions_recursive(self.cfg.sonar_scanner_path, 0o777)
+
     def _change_permissions_recursive(self, path, mode):
         for root, dirs, files in os.walk(path, topdown=False):
             for dir in [os.path.join(root, d) for d in dirs]:
                 os.chmod(dir, mode)
             for file in [os.path.join(root, f) for f in files]:
                 os.chmod(file, mode)
 
-    def scanner(self) -> Scanner:
-        return Scanner(self.cfg)
+    def _download_scanner_binaries(self, destination: str, scanner_version: str, system_name: str) -> str:
+        try:
+            scanner_res = urllib.request.urlopen(f"{self.scanner_base_url}-{scanner_version}-{system_name}.zip")
+            scanner_zip_path = os.path.join(destination, "scanner.zip")
+            write_binaries(scanner_res, scanner_zip_path)
+            return scanner_zip_path
+        except HTTPError as error:
+            self.log.error(f"ERROR: could not download scanner binaries - {error.code} - {error.msg}")
+            raise error
diff --git a/src/py_sonar_scanner/logger.py b/src/py_sonar_scanner/logger.py
@@ -0,0 +1,40 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2023 SonarSource SA.
+# 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.
+#
+import logging
+from logging import Logger
+from typing import Optional
+
+class ApplicationLogger():
+
+    _log: Optional[Logger] = None
+
+    @classmethod
+    def get_logger(cls) -> Logger:
+        if not cls._log:
+            cls._log = logging.getLogger("main")
+            cls._setup_logger(cls._log)
+        return cls._log 
+
+    @staticmethod
+    def _setup_logger(log: Logger):
+        log.setLevel(logging.INFO)
+        handler = logging.StreamHandler()
+        handler.terminator = ""
+        log.addHandler(handler)
diff --git a/src/py_sonar_scanner/utils/__init__.py b/src/py_sonar_scanner/utils/__init__.py
@@ -0,0 +1,19 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2023 SonarSource SA.
+# 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.
+#
diff --git a/src/py_sonar_scanner/utils/binaries_utils.py b/src/py_sonar_scanner/utils/binaries_utils.py
@@ -0,0 +1,28 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2023 SonarSource SA.
+# 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.
+#
+import zipfile
+
+def write_binaries(scanner_res: bytes, destination: str):
+    with open(destination, "wb") as output:
+        output.write(scanner_res.read())
+
+def unzip_binaries(scanner_zip_path: str, destination: str):
+    with zipfile.ZipFile(scanner_zip_path, "r") as zip_ref:
+        zip_ref.extractall(destination)
diff --git a/tests/test_environment.py b/tests/test_environment.py
@@ -0,0 +1,164 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2023 SonarSource SA.
+# 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.
+#
+import unittest
+from unittest.mock import patch, Mock
+from urllib.error import HTTPError
+from py_sonar_scanner.configuration import Configuration
+from py_sonar_scanner.environment import Environment
+
+
+class TestEnvironment(unittest.TestCase):
+
+    @patch("py_sonar_scanner.environment.write_binaries")
+    @patch("py_sonar_scanner.environment.urllib.request.urlopen")
+    def test_download_scanner(self, mock_urlopen, mock_write_binaries):
+        cfg = Configuration()
+        environment = Environment(cfg)
+        environment.scanner_base_url = "http://scanner.com/download"
+        mock_urlopen.return_value = bytes()
+
+        expected_destination = "destination/scanner.zip"
+        destination = environment._download_scanner_binaries("destination", "test_version", "os_name")
+
+        mock_urlopen.assert_called_once_with("http://scanner.com/download-test_version-os_name.zip")
+        mock_write_binaries.assert_called_once_with(bytes(), expected_destination)
+        assert destination == expected_destination
+
+    @patch("py_sonar_scanner.environment.write_binaries")
+    @patch("py_sonar_scanner.environment.urllib.request.urlopen")
+    def test_download_scanner_http_error(self, mock_urlopen, mock_write_binaries):
+        cfg = Configuration()
+        environment = Environment(cfg)
+        environment.scanner_base_url = "http://scanner.com/download"
+        url = "http://scanner.com/download-test_version-os_name.zip"
+        mock_urlopen.side_effect = Mock(side_effect=HTTPError(url, 504, "Test", {}, None))
+
+        with self.assertLogs(environment.log) as log:
+            with self.assertRaises(HTTPError):
+                environment._download_scanner_binaries("destination", "test_version", "os_name")
+            mock_urlopen.assert_called_once_with(url)
+            assert not mock_write_binaries.called
+            expected_error_message = "ERROR: could not download scanner binaries - 504 - Test"
+            assert log.records[0].getMessage() == expected_error_message
+
+    @patch("py_sonar_scanner.environment.unzip_binaries")
+    @patch("py_sonar_scanner.environment.os")
+    def test_install_scanner(self, mock_os, mock_unzip_binaries):
+        cfg = Configuration()
+        scanner_path = "scanner_path"
+        scanner_version = "1"
+        cfg.sonar_scanner_path = scanner_path
+        cfg.sonar_scanner_version = scanner_version
+
+        environment = Environment(cfg)
+        mock_os.remove = Mock()
+        mock_os.mkdir = Mock()
+
+        download_destination = "path"
+        environment._download_scanner_binaries = Mock(return_value=download_destination)
+        environment._change_permissions_recursive = Mock()
+
+        system_name = "test"
+        environment._install_scanner(system_name)
+
+        mock_os.mkdir.assert_called_once_with(scanner_path)
+        environment._download_scanner_binaries.assert_called_once_with(
+            scanner_path, scanner_version, system_name
+        )
+        mock_unzip_binaries.assert_called_once_with(download_destination, scanner_path)
+
+        mock_os.remove.assert_called_once_with(download_destination)
+        environment._change_permissions_recursive.assert_called_once_with(
+           scanner_path, 0o777 
+        )
+
+    def test_setup_when_scanner_is_on_path(self):
+        cfg = Configuration()
+        environment = Environment(cfg)
+        environment.cleanup = Mock()
+        environment._is_sonar_scanner_on_path = Mock(return_value=True)
+        
+        environment.setup()
+
+        environment.cleanup.assert_called_once()
+        assert cfg.sonar_scanner_executable_path == "sonar-scanner"
+
+    @patch("py_sonar_scanner.environment.systems")
+    def test_setup_when_scanner_is_not_on_path(self, mock_systems):
+        cfg = Configuration()
+        cfg.sonar_scanner_path = "path"
+        cfg.sonar_scanner_version = "4.1.2"
+        environment = Environment(cfg)
+        environment.cleanup = Mock()
+        system_name = "test"
+        mock_systems.get = Mock(return_value=system_name)
+        environment._is_sonar_scanner_on_path = Mock(return_value=False)
+        environment._install_scanner = Mock()
+        expected_path = "path/sonar-scanner-4.1.2-test/bin/sonar-scanner"
+
+        environment.setup()
+
+        environment.cleanup.assert_called_once()
+        mock_systems.get.assert_called_once()
+        environment._install_scanner.assert_called_once_with(system_name)
+
+        assert cfg.sonar_scanner_executable_path == expected_path
+
+    @patch("py_sonar_scanner.environment.os.path")
+    @patch("py_sonar_scanner.environment.shutil")
+    def test_cleanup_when_scanner_path_exists(self, mock_shutil, mock_os_path):
+        cfg = Configuration()
+        scanner_path = "path"
+        cfg.sonar_scanner_path = scanner_path
+        environment = Environment(cfg)
+        mock_os_path.exists = Mock(return_value=True)
+        mock_shutil.rmtree = Mock()
+
+        environment.cleanup()
+
+        mock_os_path.exists.assert_called_once_with(scanner_path)
+        mock_shutil.rmtree.assert_called_once_with(scanner_path)
+
+    @patch("py_sonar_scanner.environment.os.path")
+    @patch("py_sonar_scanner.environment.shutil")
+    def test_cleanup_when_scanner_path_does_not_exist(self, mock_shutil, mock_os_path):
+        cfg = Configuration()
+        scanner_path = "path"
+        cfg.sonar_scanner_path = scanner_path
+        environment = Environment(cfg)
+        mock_os_path.exists = Mock(return_value=False)
+        mock_shutil.rmtree = Mock()
+        
+        environment.cleanup()
+
+        mock_os_path.exists.assert_called_once_with(scanner_path)
+        assert not mock_shutil.rmtree.called
+
+    @patch("py_sonar_scanner.environment.shutil")
+    def test_is_sonar_scanner_on_path(self, mock_shutil):
+        cfg = Configuration()
+        scanner_path = "path"
+        cfg.sonar_scanner_path = scanner_path
+        environment = Environment(cfg)
+        mock_shutil.which = Mock()
+        
+        environment._is_sonar_scanner_on_path()
+
+        mock_shutil.which.assert_called_once_with("sonar-scanner")
diff --git a/tests/test_scanner.py b/tests/test_scanner.py
@@ -1,3 +1,22 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2023 SonarSource SA.
+# 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.
+#
 import unittest
 from unittest.mock import Mock
 import threading

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ classifiers = [`
`20`	`20`	`]`
`21`	`21`
`22`	`22`	`dependencies = [`
`23`		`- "toml>=0.10.2",`
	`23`	`+ "toml>=0.10.2",`
	`24`	`+ "pyfiglet"`
`24`	`25`	`]`
`25`	`26`
`26`	`27`	`[project.urls]`