Replace Custom Subprocess Wrapper

Obfuscates the functionality of the built-in library

Author: Behemyth

cppython/plugins/vcpkg/plugin.py

@@ -1,5 +1,6 @@
 """The vcpkg provider implementation"""
 
+import subprocess
 from logging import getLogger
 from os import name as system_name
 from pathlib import Path, PosixPath, WindowsPath
@@ -16,8 +17,7 @@
 from cppython.plugins.cmake.schema import CMakeSyncData
 from cppython.plugins.vcpkg.resolution import generate_manifest, resolve_vcpkg_data
 from cppython.plugins.vcpkg.schema import VcpkgData
-from cppython.utility.exception import NotSupportedError, ProcessError
-from cppython.utility.subprocess import invoke as subprocess_call
+from cppython.utility.exception import NotSupportedError
 from cppython.utility.utility import TypeName
 
 
@@ -76,19 +76,25 @@ def _update_provider(cls, path: Path) -> None:
 
         try:
             if system_name == 'nt':
-                subprocess_call(
-                    str(WindowsPath('bootstrap-vcpkg.bat')), ['-disableMetrics'], logger=logger, cwd=path, shell=True
+                subprocess.run(
+                    [str(WindowsPath('bootstrap-vcpkg.bat')), '-disableMetrics'],
+                    cwd=path,
+                    shell=True,
+                    check=True,
+                    capture_output=True,
                 )
             elif system_name == 'posix':
-                subprocess_call(
-                    './' + str(PosixPath('bootstrap-vcpkg.sh')),
-                    ['-disableMetrics'],
-                    logger=logger,
+                subprocess.run(
+                    ['./' + str(PosixPath('bootstrap-vcpkg.sh')), '-disableMetrics'],
                     cwd=path,
                     shell=True,
+                    check=True,
+                    capture_output=True,
                 )
-        except ProcessError:
-            logger.error('Unable to bootstrap the vcpkg repository', exc_info=True)
+        except subprocess.CalledProcessError as e:
+            logger.error(
+                'Unable to bootstrap the vcpkg repository: %s', e.stderr.decode() if e.stderr else str(e), exc_info=True
+            )
             raise
 
     def sync_data(self, consumer: SyncConsumer) -> SyncData:
@@ -119,25 +125,17 @@ def tooling_downloaded(cls, path: Path) -> bool:
         Args:
             path: The directory to check for downloaded tooling
 
-        Raises:
-            ProcessError: Failed vcpkg calls
-
         Returns:
             Whether the tooling has been downloaded or not
         """
-        logger = getLogger('cppython.vcpkg')
-
         try:
-            # Hide output, given an error output is a logic conditional
-            subprocess_call(
-                'git',
-                ['rev-parse', '--is-inside-work-tree'],
-                logger=logger,
-                suppress=True,
+            subprocess.run(
+                ['git', 'rev-parse', '--is-inside-work-tree'],
                 cwd=path,
+                check=True,
+                capture_output=True,
             )
-
-        except ProcessError:
+        except subprocess.CalledProcessError:
             return False
 
         return True
@@ -148,9 +146,6 @@ async def download_tooling(cls, directory: Path) -> None:
 
         Args:
             directory: The directory to download any extra tooling to
-
-        Raises:
-            ProcessError: Failed vcpkg calls
         """
         logger = getLogger('cppython.vcpkg')
 
@@ -159,35 +154,41 @@ async def download_tooling(cls, directory: Path) -> None:
                 logger.debug("Updating the vcpkg repository at '%s'", directory.absolute())
 
                 # The entire history is need for vcpkg 'baseline' information
-                subprocess_call('git', ['fetch', 'origin'], logger=logger, cwd=directory)
-                subprocess_call('git', ['pull'], logger=logger, cwd=directory)
-            except ProcessError:
-                logger.exception('Unable to update the vcpkg repository')
+                subprocess.run(
+                    ['git', 'fetch', 'origin'],
+                    cwd=directory,
+                    check=True,
+                    capture_output=True,
+                )
+                subprocess.run(
+                    ['git', 'pull'],
+                    cwd=directory,
+                    check=True,
+                    capture_output=True,
+                )
+            except subprocess.CalledProcessError as e:
+                logger.exception('Unable to update the vcpkg repository: %s', e.stderr.decode() if e.stderr else str(e))
                 raise
         else:
             try:
                 logger.debug("Cloning the vcpkg repository to '%s'", directory.absolute())
 
                 # The entire history is need for vcpkg 'baseline' information
-                subprocess_call(
-                    'git',
-                    ['clone', 'https://github.com/microsoft/vcpkg', '.'],
-                    logger=logger,
+                subprocess.run(
+                    ['git', 'clone', 'https://github.com/microsoft/vcpkg', '.'],
                     cwd=directory,
+                    check=True,
+                    capture_output=True,
                 )
 
-            except ProcessError:
-                logger.exception('Unable to clone the vcpkg repository')
+            except subprocess.CalledProcessError as e:
+                logger.exception('Unable to clone the vcpkg repository: %s', e.stderr.decode() if e.stderr else str(e))
                 raise
 
         cls._update_provider(directory)
 
     def install(self) -> None:
-        """Called when dependencies need to be installed from a lock file.
-
-        Raises:
-            ProcessError: Failed vcpkg calls
-        """
+        """Called when dependencies need to be installed from a lock file."""
         manifest_directory = self.core_data.project_data.project_root
         manifest = generate_manifest(self.core_data, self.data)
 
@@ -199,25 +200,18 @@ def install(self) -> None:
         executable = self.core_data.cppython_data.install_path / 'vcpkg'
         logger = getLogger('cppython.vcpkg')
         try:
-            subprocess_call(
-                executable,
-                [
-                    'install',
-                    f'--x-install-root={self.data.install_directory}',
-                ],
-                logger=logger,
+            subprocess.run(
+                [str(executable), 'install', f'--x-install-root={self.data.install_directory}'],
                 cwd=self.core_data.cppython_data.build_path,
+                check=True,
+                capture_output=True,
             )
-        except ProcessError:
-            logger.exception('Unable to install project dependencies')
+        except subprocess.CalledProcessError as e:
+            logger.exception('Unable to install project dependencies: %s', e.stderr.decode() if e.stderr else str(e))
             raise
 
     def update(self) -> None:
-        """Called when dependencies need to be updated and written to the lock file.
-
-        Raises:
-            ProcessError: Failed vcpkg calls
-        """
+        """Called when dependencies need to be updated and written to the lock file."""
         manifest_directory = self.core_data.project_data.project_root
 
         manifest = generate_manifest(self.core_data, self.data)
@@ -230,15 +224,12 @@ def update(self) -> None:
         executable = self.core_data.cppython_data.install_path / 'vcpkg'
         logger = getLogger('cppython.vcpkg')
         try:
-            subprocess_call(
-                executable,
-                [
-                    'install',
-                    f'--x-install-root={self.data.install_directory}',
-                ],
-                logger=logger,
+            subprocess.run(
+                [str(executable), 'install', f'--x-install-root={self.data.install_directory}'],
                 cwd=self.core_data.cppython_data.build_path,
+                check=True,
+                capture_output=True,
             )
-        except ProcessError:
-            logger.exception('Unable to install project dependencies')
+        except subprocess.CalledProcessError as e:
+            logger.exception('Unable to install project dependencies: %s', e.stderr.decode() if e.stderr else str(e))
             raise

cppython/project.py

@@ -9,7 +9,6 @@
 from cppython.core.resolution import resolve_model
 from cppython.core.schema import Interface, ProjectConfiguration, PyProject
 from cppython.schema import API
-from cppython.utility.exception import ProcessError
 
 
 class Project(API):
@@ -71,9 +70,6 @@ def install(self) -> None:
 
         try:
             self._data.plugins.provider.install()
-        except ProcessError as error:
-            self.logger.error('Installation failed: %s', error.error)
-            raise SystemExit('Error: Provider installation failed. Please check the logs.') from None
         except Exception as exception:
             self.logger.error('Unexpected error during installation: %s', str(exception))
             raise SystemExit('Error: An unexpected error occurred during installation.') from None
@@ -98,9 +94,6 @@ def update(self) -> None:
 
         try:
             self._data.plugins.provider.update()
-        except ProcessError as error:
-            self.logger.error('Update failed: %s', error.error)
-            raise SystemExit('Error: Provider update failed. Please check the logs.') from None
         except Exception as exception:
             self.logger.error('Unexpected error during update: %s', str(exception))
             raise SystemExit('Error: An unexpected error occurred during update.') from None

cppython/utility/exception.py

@@ -1,29 +1,6 @@
 """Exception definitions"""
 
 
-class ProcessError(Exception):
-    """Raised when there is a configuration error"""
-
-    def __init__(self, error: str) -> None:
-        """Initializes the error
-
-        Args:
-            error: The error message
-        """
-        self._error = error
-
-        super().__init__(error)
-
-    @property
-    def error(self) -> str:
-        """Returns the underlying error
-
-        Returns:
-            str -- The underlying error
-        """
-        return self._error
-
-
 class PluginError(Exception):
     """Raised when there is a plugin error"""