PYSCAN-73: Fix download of scanner binaries for arm architecture (#75)

Author: joke1196

.cirrus.yml

@@ -84,8 +84,10 @@ analysis_task:
   name: "SC Analysis"
   analysis_script:
     - poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests
-    - poetry install
-    - poetry run pysonar-scanner -Dsonar.organization=sonarsource -DbuildNumber=${CI_BUILD_NUMBER}
+    - python -m venv .venv
+    - source .venv/bin/activate
+    - pip install . 
+    - pysonar-scanner -Dsonar.organization=sonarsource -DbuildNumber=${CI_BUILD_NUMBER}
   always:
     pytest_artifacts:
       path: "coverage.xml"

src/pysonar_scanner/configuration.py

@@ -41,7 +41,7 @@ class Configuration:
     def __init__(self):
         self.log = ApplicationLogger.get_logger()
         self.sonar_scanner_path = ".scanner"
-        self.sonar_scanner_version = "6.0.0.4432"
+        self.sonar_scanner_version = "6.1.0.4477"
         self.sonar_scanner_executable_path = ""
         self.scan_arguments = []
         self.wrapper_arguments = argparse.Namespace(debug=False, read_project_config=False)

src/pysonar_scanner/environment.py

@@ -37,7 +37,7 @@ 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
+    # https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${version}-${os}-${arch}.zip
     scanner_base_url: str = "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli"
 
     def __init__(self, cfg: Configuration):
@@ -57,16 +57,23 @@ def setup(self):
             self.cfg.sonar_scanner_executable_path = "sonar-scanner"
         else:
             system_name = systems.get(platform.uname().system, "linux")
-            self._install_scanner(system_name)
+            arch_name = self._get_platform_arch()
+            self._install_scanner(system_name, arch_name)
             sonar_scanner_home = os.path.join(
                 self.cfg.sonar_scanner_path,
-                f"sonar-scanner-{self.cfg.sonar_scanner_version}-{system_name}",
+                f"sonar-scanner-{self.cfg.sonar_scanner_version}-{system_name}-{arch_name}",
             )
             self.cfg.sonar_scanner_executable_path = os.path.join(sonar_scanner_home, "bin", "sonar-scanner")
 
         ascii_banner = pyfiglet.figlet_format("Sonar Scanner")
         self.log.info(ascii_banner)
 
+    def _get_release(self) -> str:
+        return platform.uname().release
+
+    def _get_platform_arch(self) -> str:
+        return "x64" if "ARM64" not in self._get_release().upper() else "aarch64"
+
     def scanner(self) -> Scanner:
         return Scanner(self.cfg)
 
@@ -77,11 +84,14 @@ 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):
+    def _install_scanner(self, system_name: str, arch_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
+            self.cfg.sonar_scanner_path,
+            self.cfg.sonar_scanner_version,
+            system_name,
+            arch_name,
         )
         unzip_binaries(scanner_zip_path, self.cfg.sonar_scanner_path)
         os.remove(scanner_zip_path)
@@ -94,9 +104,13 @@ def _change_permissions_recursive(self, path, mode):
             for file in [os.path.join(root, f) for f in files]:
                 os.chmod(file, mode)
 
-    def _download_scanner_binaries(self, destination: str, scanner_version: str, system_name: str) -> str:
+    def _download_scanner_binaries(
+        self, destination: str, scanner_version: str, system_name: str, arch_name: str
+    ) -> str:
         try:
-            scanner_res = urllib.request.urlopen(f"{self.scanner_base_url}-{scanner_version}-{system_name}.zip")
+            scanner_res = urllib.request.urlopen(
+                f"{self.scanner_base_url}-{scanner_version}-{system_name}-{arch_name}.zip"
+            )
             scanner_zip_path = os.path.join(destination, "scanner.zip")
             write_binaries(scanner_res, scanner_zip_path)
             return scanner_zip_path

tests/test_environment.py

@@ -34,9 +34,9 @@ def test_download_scanner(self, mock_urlopen, mock_write_binaries):
         mock_urlopen.return_value = bytes()
 
         expected_destination = "destination/scanner.zip"
-        destination = environment._download_scanner_binaries("destination", "test_version", "os_name")
+        destination = environment._download_scanner_binaries("destination", "test_version", "os_name", "aarch64")
 
-        mock_urlopen.assert_called_once_with("http://scanner.com/download-test_version-os_name.zip")
+        mock_urlopen.assert_called_once_with("http://scanner.com/download-test_version-os_name-aarch64.zip")
         mock_write_binaries.assert_called_once_with(bytes(), expected_destination)
         assert destination == expected_destination
 
@@ -46,12 +46,12 @@ 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"
+        url = "http://scanner.com/download-test_version-os_name-x64.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")
+                environment._download_scanner_binaries("destination", "test_version", "os_name", "x64")
             mock_urlopen.assert_called_once_with(url)
             assert not mock_write_binaries.called
             expected_error_message = "ERROR: could not download scanner binaries - 504 - Test"
@@ -75,10 +75,13 @@ def test_install_scanner(self, mock_os, mock_unzip_binaries):
         environment._change_permissions_recursive = Mock()
 
         system_name = "test"
-        environment._install_scanner(system_name)
+        arch_name = "arch-test"
+        environment._install_scanner(system_name, arch_name)
 
         mock_os.mkdir.assert_called_once_with(scanner_path)
-        environment._download_scanner_binaries.assert_called_once_with(scanner_path, scanner_version, system_name)
+        environment._download_scanner_binaries.assert_called_once_with(
+            scanner_path, scanner_version, system_name, arch_name
+        )
         mock_unzip_binaries.assert_called_once_with(download_destination, scanner_path)
 
         mock_os.remove.assert_called_once_with(download_destination)
@@ -103,16 +106,19 @@ def test_setup_when_scanner_is_not_on_path(self, mock_systems):
         environment = Environment(cfg)
         environment.cleanup = Mock()
         system_name = "test"
+        arch_name = "arch-test"
+        environment._get_platform_arch = Mock(return_value=arch_name)
         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"
+        expected_path = "path/sonar-scanner-4.1.2-test-arch-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)
+        environment._get_platform_arch.assert_called_once()
+        environment._install_scanner.assert_called_once_with(system_name, arch_name)
 
         assert cfg.sonar_scanner_executable_path == expected_path
 
@@ -158,6 +164,21 @@ def test_is_sonar_scanner_on_path(self, mock_shutil):
 
         mock_shutil.which.assert_called_once_with("sonar-scanner")
 
+    def test_get_platform_arch(self):
+        release_names = ["root:test/release_arm64_T8101", "6.0.1-generic", "root:xnu-7195.60.75~1/RELEASE_ARM64_T8101"]
+
+        def releases():
+            return release_names.pop(0)
+
+        cfg = Configuration()
+        cfg.sonar_scanner_path = "path"
+        cfg.sonar_scanner_version = "4.1.2"
+        environment = Environment(cfg)
+        environment._get_release = Mock(side_effect=releases)
+        assert environment._get_platform_arch() == "aarch64"
+        assert environment._get_platform_arch() == "x64"
+        assert environment._get_platform_arch() == "aarch64"
+
     def test_env_scan(self):
         cfg = Configuration()
         environment = Environment(cfg)