bitwarden_workflow_linter 0.12.8__tar.gz → 0.13.0__tar.gz

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/.github/CODEOWNERS

@@ -9,5 +9,5 @@
 
 # AppSec owns default_actions and actionlint_version files
 src/bitwarden_workflow_linter/default_actions.json @bitwarden/team-appsec
-actionlint_version.json @bitwarden/team-appsec
+src/bitwarden_workflow_linter/actionlint_version.yaml @bitwarden/team-appsec
 

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/.github/renovate.json

@@ -23,7 +23,7 @@
   "customManagers": [
     {
       "customType": "regex",
-      "fileMatch": ["^actionlint_version\\.json$"],
+      "fileMatch": ["^actionlint_version\\.yaml$"],
       "matchStrings": [
         "\"actionlint_version\":\\s*\"(?<currentValue>[^\"]+)\""
       ],

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/.github/workflows/ci.yml

@@ -29,6 +29,8 @@ jobs:
           pipenv install --dev
 
       - name: Run pytest
+        env:
+          PYTHONPATH: "${{ github.workspace }}/src"
         run: pipenv run pytest tests --cov=src
 
       - name: Check type hinting

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitwarden_workflow_linter
-Version: 0.12.8
+Version: 0.13.0
 Summary: Custom GitHub Action Workflow Linter
 Project-URL: Homepage, https://github.com/bitwarden/workflow-linter
 Project-URL: Issues, https://github.com/bitwarden/workflow-linter/issues

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/src/bitwarden_workflow_linter/__about__.py

@@ -1,3 +1,3 @@
 """Metadata for Workflow Linter."""
 
-__version__ = "0.12.8"
+__version__ = "0.13.0"

bitwarden_workflow_linter-0.13.0/src/bitwarden_workflow_linter/actionlint_version.yaml

@@ -0,0 +1 @@
+actionlint_version: "1.7.7"

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/src/bitwarden_workflow_linter/rules/run_actionlint.py

@@ -5,21 +5,20 @@ import subprocess
 import platform
 import urllib.request
 import os
-import json
 
 from ..rule import Rule
 from ..models.workflow import Workflow
 from ..utils import LintLevels, Settings
 
 
-def install_actionlint(platform_system: str) -> Tuple[bool, str]:
+def install_actionlint(platform_system: str, version: str) -> Tuple[bool, str]:
     """If actionlint is not installed, detects OS platform
     and installs actionlint"""
 
     error = f"An error occurred when installing Actionlint on {platform_system}"
 
     if platform_system.startswith("Linux"):
-        return install_actionlint_source(error)
+        return install_actionlint_source(error,version)
     elif platform_system == "Darwin":
         try:
             subprocess.run(["brew", "install", "actionlint"], check=True)
@@ -34,20 +33,8 @@ def install_actionlint(platform_system: str) -> Tuple[bool, str]:
             return False, f"{error} : check Choco installation"
     return False, error
 
-# temporarily commenting out this logic to allow time to troubleshoot it running in CI
-# def load_config() -> dict:
-#     """Load configuration from a JSON file."""
-#     config_path = os.path.join(os.path.dirname(__file__), "../../../actionlint_version.json")
-#     if not os.path.exists(config_path):
-#         raise FileNotFoundError(f"Configuration file not found: {config_path}")
-#     with open(config_path, "r") as config_file:
-#         return json.load(config_file)
-
-def install_actionlint_source(error) -> Tuple[bool, str]:
-    #config = load_config()
-    #if "actionlint_version" not in config:
-    #    raise KeyError("The 'actionlint_version' is missing in the configuration file.")
-    version = "1.7.7"
+def install_actionlint_source(error, version) -> Tuple[bool, str]:
+    version = version
     """Install Actionlint Binary from provided script"""
     url = "https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash"
     request = urllib.request.urlopen(url)
@@ -60,7 +47,7 @@ def install_actionlint_source(error) -> Tuple[bool, str]:
         return False, error
 
 
-def check_actionlint(platform_system: str) -> Tuple[bool, str]:
+def check_actionlint(platform_system: str, version: str) -> Tuple[bool, str]:
     """Check if the actionlint is in the system's PATH."""
     try:
         subprocess.run(
@@ -77,7 +64,7 @@ def check_actionlint(platform_system: str) -> Tuple[bool, str]:
 please check your package installer or manually install it",
         )
     except FileNotFoundError:
-        return install_actionlint(platform_system)
+        return install_actionlint(platform_system, version)
 
 
 class RunActionlint(Rule):
@@ -95,7 +82,8 @@ class RunActionlint(Rule):
                 "Running actionlint without a filename is not currently supported"
             )
 
-        installed, location = check_actionlint(platform.system())
+        """Check if Actionlint is alerady installed and if it is installed somewhere not on the PATH (location)"""
+        installed, location = check_actionlint(platform.system(), self.settings.actionlint_version)
         if installed:
             if location:
                 result = subprocess.run(

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/src/bitwarden_workflow_linter/utils.py

@@ -107,17 +107,18 @@ class SettingsError(Exception):
 
 SettingsFromFactory = TypeVar("SettingsFromFactory", bound="Settings")
 
-
 class Settings:
     """Class that contains configuration-as-code for any portion of the app."""
 
     enabled_rules: list[dict[str, str]]
     approved_actions: dict[str, Action]
+    actionlint_version: str
 
     def __init__(
         self,
         enabled_rules: Optional[list[dict[str, str]]] = None,
         approved_actions: Optional[dict[str, dict[str, str]]] = None,
+        actionlint_version: Optional[str] = None,
     ) -> None:
         """Settings object that can be overridden in settings.py.
 
@@ -134,7 +135,11 @@ class Settings:
 
         if approved_actions is None:
             approved_actions = {}
+        
+        if actionlint_version is None:
+            actionlint_version = ""
 
+        self.actionlint_version = actionlint_version
         self.enabled_rules = enabled_rules
         self.approved_actions = {
             name: Action(**action) for name, action in approved_actions.items()
@@ -142,6 +147,7 @@ class Settings:
 
     @staticmethod
     def factory() -> SettingsFromFactory:
+        # load default settings
         with (
             importlib.resources.files("bitwarden_workflow_linter")
             .joinpath("default_settings.yaml")
@@ -149,6 +155,16 @@ class Settings:
         ):
             settings = yaml.load(file)
 
+        # load actionlint version
+        with (
+            importlib.resources.files("bitwarden_workflow_linter")
+            .joinpath("actionlint_version.yaml")
+            .open("r", encoding="utf-8") as version_file
+        ):
+            version_data = yaml.load(version_file)
+            actionlint_version = version_data["actionlint_version"]
+
+        # load override settings
         settings_filename = "settings.yaml"
         local_settings = None
 
@@ -159,6 +175,7 @@ class Settings:
         if local_settings:
             settings.update(local_settings)
 
+        # load approved actions
         if settings["approved_actions_path"] == "default_actions.json":
             with (
                 importlib.resources.files("bitwarden_workflow_linter")
@@ -172,7 +189,9 @@ class Settings:
             ) as action_file:
                 settings["approved_actions"] = json.load(action_file)
 
+        
         return Settings(
             enabled_rules=settings["enabled_rules"],
             approved_actions=settings["approved_actions"],
+            actionlint_version=actionlint_version,
         )

{bitwarden_workflow_linter-0.12.8 → bitwarden_workflow_linter-0.13.0}/tests/rules/test_run_actionlint.py

@@ -5,6 +5,7 @@ import subprocess
 
 from ruamel.yaml import YAML
 
+from src.bitwarden_workflow_linter.utils import Settings
 from src.bitwarden_workflow_linter.load import WorkflowBuilder
 from src.bitwarden_workflow_linter.rules.run_actionlint import (
     RunActionlint,
@@ -14,7 +15,7 @@ from src.bitwarden_workflow_linter.rules.run_actionlint import (
 )
 
 yaml = YAML()
-
+settings = Settings.factory()
 
 @pytest.fixture(name="rule")
 def fixture_rule():
@@ -22,12 +23,14 @@ def fixture_rule():
 
 
 def test_rule_on_correct_workflow(rule):
+    rule.settings = settings
     correct_workflow = WorkflowBuilder.build("tests/fixtures/test_workflow.yaml")
     result, _ = rule.fn(correct_workflow)
     assert result is True
 
 
 def test_rule_on_incorrect_workflow(rule):
+    rule.settings = settings
     incorrect_workflow = WorkflowBuilder.build(
         "tests/fixtures/test_workflow_incorrect.yaml"
     )
@@ -36,7 +39,7 @@ def test_rule_on_incorrect_workflow(rule):
 
 
 def test_pass_install_actionlint_linux():
-    result, _ = install_actionlint("Linux")
+    result, _ = install_actionlint("Linux", settings.actionlint_version)
     assert result is True
 
 
@@ -45,7 +48,7 @@ def test_install_actionlint_darwin(monkeypatch):
         return subprocess.CompletedProcess(args, 0)
 
     monkeypatch.setattr(subprocess, "run", mock_run)
-    result, _ = install_actionlint("Darwin")
+    result, _ = install_actionlint("Darwin", settings.actionlint_version)
     assert result is True
 
 
@@ -54,7 +57,7 @@ def test_failed_install_actionlint_darwin(monkeypatch):
         raise subprocess.CalledProcessError(1, "cmd")
 
     monkeypatch.setattr(subprocess, "run", mock_run)
-    result, error = install_actionlint("Darwin")
+    result, error = install_actionlint("Darwin", settings.actionlint_version)
     assert result is False
     assert "An error occurred" in error
 
@@ -64,7 +67,7 @@ def test_install_actionlint_windows(monkeypatch):
         return subprocess.CompletedProcess(args, 0)
 
     monkeypatch.setattr(subprocess, "run", mock_run)
-    result, _ = install_actionlint("Windows")
+    result, _ = install_actionlint("Windows", settings.actionlint_version)
     assert result is True
 
 
@@ -73,7 +76,7 @@ def test_failed_install_actionlint_windows(monkeypatch):
         raise subprocess.CalledProcessError(1, "cmd")
 
     monkeypatch.setattr(subprocess, "run", mock_run)
-    result, error = install_actionlint("Windows")
+    result, error = install_actionlint("Windows", settings.actionlint_version)
     assert result is False
     assert "An error occurred" in error
 
@@ -84,7 +87,7 @@ def test_install_actionlint_source(monkeypatch):
 
     monkeypatch.setattr(subprocess, "run", mock_run)
 
-    result, _ = install_actionlint_source("An error occurred")
+    result, _ = install_actionlint_source("An error occurred", settings.actionlint_version)
     assert result is True
 
 
@@ -94,7 +97,7 @@ def test_failed_install_actionlint_source(monkeypatch):
 
     monkeypatch.setattr(subprocess, "run", mock_run)
 
-    result, error = install_actionlint_source("An error occurred")
+    result, error = install_actionlint_source("An error occurred", settings.actionlint_version)
     assert result is False
     assert "An error occurred" in error
 
@@ -105,7 +108,7 @@ def test_check_actionlint_installed(monkeypatch):
 
     monkeypatch.setattr(subprocess, "run", mock_run)
 
-    result, _ = check_actionlint("Linux")
+    result, _ = check_actionlint("Linux", settings.actionlint_version)
     assert result is True
 
 
@@ -115,7 +118,7 @@ def test_failed_check_actionlint_installed(monkeypatch):
 
     monkeypatch.setattr(subprocess, "run", mock_run)
 
-    result, _ = check_actionlint("Linux")
+    result, _ = check_actionlint("Linux", settings.actionlint_version)
     assert result is False
 
 
@@ -125,11 +128,13 @@ def test_check_actionlint_not_installed(monkeypatch):
 
     monkeypatch.setattr(subprocess, "run", mock_run)
 
-    result, _ = check_actionlint("Linux")
+    result, _ = check_actionlint("Linux", settings.actionlint_version)
     assert result is False
 
 
 def test_run_actionlint_installed(monkeypatch, rule):
+    rule.settings = settings
+    
     def mock_check_actionlint(*args, **kwargs):
         return True, "/mock/location"
 
@@ -148,6 +153,8 @@ def test_run_actionlint_installed(monkeypatch, rule):
 
 
 def test_run_actionlint_not_installed(monkeypatch, rule):
+    rule.settings = settings
+
     def mock_check_actionlint(*args, **kwargs):
         return False, ""
 
@@ -163,6 +170,8 @@ def test_run_actionlint_not_installed(monkeypatch, rule):
 
 
 def test_run_actionlint_installed_error(monkeypatch, rule):
+    rule.settings = settings
+
     def mock_check_actionlint(*args, **kwargs):
         return True, "/mock/location"