feat: adding optional directory command for init, scan, and update (#147

)

This will add the ability to the 3 commands `init` `scan` `update` with
`--directory`
example:

`secureli scan -m all-files --directory ~/src/testrepo`

secureli/abstractions/pre_commit.py

@@ -189,29 +189,28 @@ def secret_detection_hook_id(self, language: str) -> Optional[str]:
 
         return None
 
-    def install(self, language: str) -> InstallResult:
+    def install(self, folder_path: Path, language: str) -> InstallResult:
         """
         Identifies the template we hold for the specified language, writes it, installs it, and cleans up
         :param language: The language to identify a template for
         :raises LanguageNotSupportedError if a pre-commit template cannot be found for the specified language
         :raises InstallFailedError if the template was found, but an error occurred installing it
         """
-
-        path_to_pre_commit_file = Path(".pre-commit-config.yaml")
+        path_to_pre_commit_file = Path(folder_path / ".pre-commit-config.yaml")
 
         # Raises a LanguageNotSupportedError if language doesn't resolve to a yaml file
         language_config = self._get_language_config(language)
 
         with open(path_to_pre_commit_file, "w") as f:
             f.write(language_config.config_data)
 
-        completed_process = subprocess.run(["pre-commit", "install"])
+        completed_process = subprocess.run(["pre-commit", "install"], cwd=folder_path)
         if completed_process.returncode != 0:
             raise InstallFailedError(
                 f"Installing the pre-commit script for {language} failed"
             )
 
-        install_configs_result = self._install_pre_commit_configs(language)
+        install_configs_result = self._install_pre_commit_configs(folder_path, language)
 
         return InstallResult(
             successful=True,
@@ -327,13 +326,15 @@ def execute_hooks(
 
     def autoupdate_hooks(
         self,
+        folder_path: Path,
         bleeding_edge: bool = False,
         freeze: bool = False,
         repos: Optional[list] = None,
     ) -> ExecuteResult:
         """
         Updates the precommit hooks but executing precommit's autoupdate command.  Additional info at
         https://pre-commit.com/#pre-commit-autoupdate
+        :param folder path: specified full path directory (default to current directory)
         :param bleeding edge: True if updating to the bleeding edge of the default branch instead of
         the latest tagged version (which is the default behavior)
         :param freeze: Set to True to store "frozen" hashes in rev instead of tag names.
@@ -367,7 +368,9 @@ def autoupdate_hooks(
 
             subprocess_args.extend(repo_args)
 
-        completed_process = subprocess.run(subprocess_args, stdout=subprocess.PIPE)
+        completed_process = subprocess.run(
+            subprocess_args, cwd=folder_path, stdout=subprocess.PIPE
+        )
         output = (
             completed_process.stdout.decode("utf8") if completed_process.stdout else ""
         )
@@ -376,14 +379,16 @@ def autoupdate_hooks(
         else:
             return ExecuteResult(successful=True, output=output)
 
-    def update(self) -> ExecuteResult:
+    def update(self, folder_path: Path) -> ExecuteResult:
         """
         Installs the hooks defined in pre-commit-config.yml.
         :return: ExecuteResult, indicating success or failure.
         """
         subprocess_args = ["pre-commit", "install-hooks", "--color", "always"]
 
-        completed_process = subprocess.run(subprocess_args, stdout=subprocess.PIPE)
+        completed_process = subprocess.run(
+            subprocess_args, cwd=folder_path, stdout=subprocess.PIPE
+        )
         output = (
             completed_process.stdout.decode("utf8") if completed_process.stdout else ""
         )
@@ -392,7 +397,7 @@ def update(self) -> ExecuteResult:
         else:
             return ExecuteResult(successful=True, output=output)
 
-    def remove_unused_hooks(self) -> ExecuteResult:
+    def remove_unused_hooks(self, folder_path: Path) -> ExecuteResult:
         """
         Removes unused hook repos from the cache.  Pre-commit determines which flags are "unused" by comparing
         the repos to the pre-commit-config.yaml file.  Any cached hook repos that are not in the config file
@@ -401,7 +406,9 @@ def remove_unused_hooks(self) -> ExecuteResult:
         """
         subprocess_args = ["pre-commit", "gc", "--color", "always"]
 
-        completed_process = subprocess.run(subprocess_args, stdout=subprocess.PIPE)
+        completed_process = subprocess.run(
+            subprocess_args, cwd=folder_path, stdout=subprocess.PIPE
+        )
         output = (
             completed_process.stdout.decode("utf8") if completed_process.stdout else ""
         )
@@ -819,7 +826,7 @@ def _load_language_config_file(self, language: str) -> LoadLanguageConfigsResult
         return LoadLanguageConfigsResult(success=False, config_data=list())
 
     def _install_pre_commit_configs(
-        self, language: str
+        self, folder_path: Path, language: str
     ) -> LanguagePreCommitConfigInstallResult:
         """
         Install any config files for given language to support any pre-commit commands.
@@ -841,13 +848,13 @@ def _install_pre_commit_configs(
                 try:
                     for key in config:
                         config_name = f"{slugify(language)}.{key}.yaml"
-                        path_to_config_file = Path(f".secureli/{config_name}")
+                        path_to_config_file = folder_path / f".secureli/{config_name}"
 
                         with open(path_to_config_file, "w") as f:
                             f.write(yaml.dump(config[key]))
 
                         completed_process = subprocess.run(
-                            ["pre-commit", "install-language-config"]
+                            ["pre-commit", "install-language-config"], cwd=folder_path
                         )
 
                         if completed_process.returncode != 0:

secureli/actions/action.py

@@ -87,7 +87,11 @@ def verify_install(
         :param always_yes: Assume "Yes" to all prompts
         """
 
-        config = SecureliConfig() if reset else self.action_deps.secureli_config.load()
+        config = (
+            SecureliConfig()
+            if reset
+            else self.action_deps.secureli_config.load(folder_path=folder_path)
+        )
 
         if not config.overall_language or not config.version_installed:
             return self._install_secureli(folder_path, always_yes)
@@ -98,7 +102,9 @@ def verify_install(
 
             # Check for a new version and prompt for upgrade if available
             if available_version != config.version_installed:
-                return self._upgrade_secureli(config, available_version, always_yes)
+                return self._upgrade_secureli(
+                    folder_path, config, available_version, always_yes
+                )
 
             # Validates the current .pre-commit-config.yaml against the generated config
             config_validation_result = self.action_deps.pre_commit.validate_config(
@@ -108,7 +114,7 @@ def verify_install(
             # If config mismatch between available version and current version prompt for upgrade
             if not config_validation_result.successful:
                 self.action_deps.echo.print(config_validation_result.output)
-                return self._update_secureli(always_yes)
+                return self._update_secureli(folder_path, always_yes)
 
             self.action_deps.echo.print(
                 f"SeCureLI is installed and up-to-date (language = {config.overall_language})"
@@ -119,7 +125,11 @@ def verify_install(
             )
 
     def _upgrade_secureli(
-        self, config: SecureliConfig, available_version: str, always_yes: bool
+        self,
+        folder_path: Path,
+        config: SecureliConfig,
+        available_version: str,
+        always_yes: bool,
     ) -> VerifyResult:
         """
         Installs SeCureLI into the given folder path and returns the new configuration
@@ -144,12 +154,12 @@ def _upgrade_secureli(
 
         try:
             metadata = self.action_deps.language_support.apply_support(
-                config.overall_language
+                folder_path, config.overall_language
             )
 
             # Update config with new version installed and save it
             config.version_installed = metadata.version
-            self.action_deps.secureli_config.save(config)
+            self.action_deps.secureli_config.save(folder_path, config)
             self.action_deps.echo.print("SeCureLI has been upgraded successfully")
             return VerifyResult(
                 outcome=VerifyOutcome.UPGRADE_SUCCEEDED,
@@ -205,7 +215,9 @@ def _install_secureli(self, folder_path: Path, always_yes: bool) -> VerifyResult
                 f"Overall Detected Language: {overall_language}"
             )
 
-            metadata = self.action_deps.language_support.apply_support(overall_language)
+            metadata = self.action_deps.language_support.apply_support(
+                folder_path, overall_language
+            )
 
         except (ValueError, LanguageNotSupportedError, InstallFailedError) as e:
             self.action_deps.echo.error(
@@ -219,7 +231,7 @@ def _install_secureli(self, folder_path: Path, always_yes: bool) -> VerifyResult
             overall_language=overall_language,
             version_installed=metadata.version,
         )
-        self.action_deps.secureli_config.save(config)
+        self.action_deps.secureli_config.save(folder_path, config)
 
         if secret_test_id := metadata.security_hook_id:
             self.action_deps.echo.print(
@@ -243,7 +255,7 @@ def _install_secureli(self, folder_path: Path, always_yes: bool) -> VerifyResult
             analyze_result=analyze_result,
         )
 
-    def _update_secureli(self, always_yes: bool):
+    def _update_secureli(self, folder_path: Path, always_yes: bool):
         """
         Prompts the user to update to the latest secureli install.
         :param always_yes: Assume "Yes" to all prompts
@@ -260,7 +272,7 @@ def _update_secureli(self, always_yes: bool):
             self.action_deps.echo.print("\nUpdate declined.\n")
             return VerifyResult(outcome=VerifyOutcome.UPDATE_CANCELED)
 
-        update_result = self.action_deps.updater.update()
+        update_result = self.action_deps.updater.update(folder_path)
         details = update_result.output
         self.action_deps.echo.print(details)
 

secureli/actions/build.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from secureli.abstractions.echo import EchoAbstraction, Color
 from secureli.services.logging import LoggingService, LogAction
 
@@ -20,4 +21,4 @@ def print_build(self, color: Color):
         """
         self.echo.print(self.build_data, color=color, bold=True)
 
-        self.logging.success(LogAction.build)
+        self.logging.success(Path("."), LogAction.build)

secureli/actions/initializer.py

@@ -25,6 +25,6 @@ def initialize_repo(self, folder_path: Path, reset: bool, always_yes: bool):
         """
         verify_result = self.verify_install(folder_path, reset, always_yes)
         if verify_result.outcome in ScanAction.halting_outcomes:
-            self.logging.failure(LogAction.init, verify_result.outcome)
+            self.logging.failure(folder_path, LogAction.init, verify_result.outcome)
         else:
-            self.logging.success(LogAction.init)
+            self.logging.success(folder_path, LogAction.init)

secureli/actions/scan.py

@@ -85,6 +85,7 @@ def scan_repo(
 
         if not scan_result.successful:
             log_data = self.logging.failure(
+                folder_path,
                 LogAction.scan,
                 scan_result_failures_json_string,
                 failure_count,
@@ -94,7 +95,7 @@ def scan_repo(
             post_log(log_data.json(exclude_none=True))
         else:
             self.echo.print("Scan executed successfully and detected no issues!")
-            log_data = self.logging.success(LogAction.scan)
+            log_data = self.logging.success(folder_path, LogAction.scan)
 
             post_log(log_data.json(exclude_none=True))
 

secureli/actions/update.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+from pathlib import Path
 from secureli.abstractions.echo import EchoAbstraction
 from secureli.services.logging import LoggingService, LogAction
 from secureli.services.updater import UpdaterService
@@ -19,7 +20,7 @@ def __init__(
         self.logging = logging
         self.updater = updater
 
-    def update_hooks(self, latest: Optional[bool] = False):
+    def update_hooks(self, folder_path: Path, latest: Optional[bool] = False):
         """
         Installs the hooks defined in pre-commit-config.yml.
         :param latest: Indicates whether you want to update to the latest versions
@@ -28,26 +29,26 @@ def update_hooks(self, latest: Optional[bool] = False):
         """
         if latest:
             self.echo.print("Updating hooks to the latest version...")
-            update_result = self.updater.update_hooks()
+            update_result = self.updater.update_hooks(folder_path)
             details = (
                 update_result.output
                 or "Unknown output while updating hooks to latest version"
             )
             self.echo.print(details)
             if not update_result.successful:
                 self.echo.print(details)
-                self.logging.failure(LogAction.update, details)
+                self.logging.failure(folder_path, LogAction.update, details)
             else:
                 self.echo.print("Hooks successfully updated to latest version")
-                self.logging.success(LogAction.update)
+                self.logging.success(folder_path, LogAction.update)
         else:
             self.echo.print("Beginning update...")
-            install_result = self.updater.update()
+            install_result = self.updater.update(folder_path)
             details = install_result.output or "Unknown output during hook installation"
             self.echo.print(details)
             if not install_result.successful:
                 self.echo.print(details)
-                self.logging.failure(LogAction.update, details)
+                self.logging.failure(folder_path, LogAction.update, details)
             else:
                 self.echo.print("Update executed successfully.")
-                self.logging.success(LogAction.update)
+                self.logging.success(folder_path, LogAction.update)

secureli/main.py

@@ -48,11 +48,17 @@ def init(
         "-y",
         help="Say 'yes' to every prompt automatically without input",
     ),
+    directory: Optional[str] = Option(
+        ".",
+        "--directory",
+        "-d",
+        help="Run seCureLI on specified full path directory (default to current directory)",
+    ),
 ):
     """
     Detect languages and initialize pre-commit hooks and linters for the project
     """
-    container.initializer_action().initialize_repo(Path("."), reset, yes)
+    container.initializer_action().initialize_repo(Path(directory), reset, yes)
 
 
 @app.command()
@@ -75,11 +81,17 @@ def scan(
         "-t",
         help="Limit the scan to a specific hook ID from your pre-commit config",
     ),
+    directory: Optional[str] = Option(
+        ".",
+        "--directory",
+        "-d",
+        help="Run seCureLI on specified full path directory (default to current directory)",
+    ),
 ):
     """
     Performs an explicit check of the repository to detect security issues without remote logging.
     """
-    container.scan_action().scan_repo(Path("."), mode, yes, specific_test)
+    container.scan_action().scan_repo(Path(directory), mode, yes, specific_test)
 
 
 @app.command(hidden=True)
@@ -97,12 +109,18 @@ def update(
         "--latest",
         "-l",
         help="Update the installed pre-commit hooks to their latest versions",
-    )
+    ),
+    directory: Optional[str] = Option(
+        ".",
+        "--directory",
+        "-d",
+        help="Run seCureLI on specified full path directory (default to current directory)",
+    ),
 ):
     """
     Update linters, configuration, and all else needed to maintain a secure repository.
     """
-    container.update_action().update_hooks(latest)
+    container.update_action().update_hooks(Path(directory), latest)
 
 
 if __name__ == "__main__":