bitwarden_workflow_linter 0.4.3__tar.gz → 0.4.5__tar.gz

{bitwarden_workflow_linter-0.4.3 → bitwarden_workflow_linter-0.4.5}/.github/workflows/cd.yml

@@ -17,6 +17,7 @@ jobs:
 
   version-bump:
     name: Version bump
+    if: needs.version-type.outputs.version_bump_type != 'skip'
     runs-on: ubuntu-24.04
     needs: version-type
     outputs:

{bitwarden_workflow_linter-0.4.3 → bitwarden_workflow_linter-0.4.5}/.github/workflows/enforce-labels.yml

@@ -9,7 +9,7 @@ jobs:
     uses: bitwarden/gh-actions/.github/workflows/_enforce-labels.yml@main
 
   enforce-version-label:
-    if: "!(contains(github.event.pull_request.labels.*.name, 'version:major') || contains(github.event.pull_request.labels.*.name, 'version:minor') || contains(github.event.pull_request.labels.*.name, 'version:patch'))"
+    if: "!(contains(github.event.pull_request.labels.*.name, 'version:major') || contains(github.event.pull_request.labels.*.name, 'version:minor') || contains(github.event.pull_request.labels.*.name, 'version:patch')) || contains(github.event.pull_request.labels.*.name, 'version:skip')"
     name: Enforce version label
     runs-on: ubuntu-22.04
 

{bitwarden_workflow_linter-0.4.3 → bitwarden_workflow_linter-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitwarden_workflow_linter
-Version: 0.4.3
+Version: 0.4.5
 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.4.3 → bitwarden_workflow_linter-0.4.5}/src/bitwarden_workflow_linter/__about__.py

@@ -1,3 +1,3 @@
 """Metadata for Workflow Linter."""
 
-__version__ = "0.4.3"
+__version__ = "0.4.5"

{bitwarden_workflow_linter-0.4.3 → bitwarden_workflow_linter-0.4.5}/src/bitwarden_workflow_linter/models/step.py

@@ -39,10 +39,13 @@ class Step:
         new_step.key = idx
         new_step.job = job
 
-        if "uses" in data.ca.items and data.ca.items["uses"][2]:
-            new_step.uses_comment = data.ca.items["uses"][2].value.replace("\n", "")
+        if new_step.uses:
+            if "uses" in data.ca.items and data.ca.items["uses"][2]:
+                new_step.uses_comment = data.ca.items["uses"][2].value.replace("\n", "")
+                new_step.uses_version = new_step.uses_comment.split(" ")[-1]
             if "@" in new_step.uses:
                 new_step.uses_path, new_step.uses_ref = new_step.uses.split("@")
-                new_step.uses_version = new_step.uses_comment.split(" ")[-1]
+            else:
+                new_step.uses_path = new_step.uses
 
         return new_step

{bitwarden_workflow_linter-0.4.3 → bitwarden_workflow_linter-0.4.5}/tests/rules/test_step_approved.py

@@ -70,6 +70,11 @@ jobs:
       - name: Checkout Branch
         uses: joseph-flinn/action-DNE@main
 
+      - name: Checkout Branch with Ref
+        uses: notbitwarden/subfolder/action-DNE@main
+        with:
+            ref: main
+
 """
     return WorkflowBuilder.build(workflow=yaml.load(workflow), from_file=False)
 
@@ -98,6 +103,10 @@ def test_rule_on_incorrect_workflow(rule, incorrect_workflow):
     assert result is False
     assert "New Action detected" in message
 
+    result, message = rule.fn(incorrect_workflow.jobs["job-key"].steps[1])
+    assert result is False
+    assert "New Action detected" in message
+
 
 def test_fail_compatibility(rule, correct_workflow):
     finding = rule.execute(correct_workflow)

bitwarden_workflow_linter-0.4.5/tests/test_step.py

@@ -0,0 +1,144 @@
+"""Test src/bitwarden_workflow_linter/models/step.py."""
+
+import json
+import pytest
+
+from ruamel.yaml import YAML
+
+from src.bitwarden_workflow_linter.models.step import Step
+
+
+@pytest.fixture(name="default_step")
+def fixture_default_step():
+    step_str = """\
+name: Default Step
+run: echo "test"
+"""
+    yaml = YAML()
+    step_yaml = yaml.load(step_str)
+    return Step.init(0, "default", step_yaml)
+
+
+@pytest.fixture(name="uses_step")
+def fixture_uses_step():
+    step_str = """\
+name: Download Artifacts
+uses: bitwarden/download-artifacts@main # v1.0.0
+with:
+    workflow: upload-test-artifacts.yml
+    artifacts: artifact
+    path: artifact
+    branch: main
+
+"""
+    yaml = YAML()
+    step_yaml = yaml.load(step_str)
+    return Step.init(0, "default", step_yaml)
+
+
+@pytest.fixture(name="uses_step_no_comments")
+def fixture_uses_step_no_comments():
+    step_str = """\
+name: Download Artifacts
+uses: bitwarden/download-artifacts@main
+with:
+    workflow: upload-test-artifacts.yml
+    artifacts: artifact
+    path: artifact
+    branch: main
+
+"""
+    yaml = YAML()
+    step_yaml = yaml.load(step_str)
+    return Step.init(0, "default", step_yaml)
+
+
+@pytest.fixture(name="uses_step_no_ref")
+def fixture_uses_step_no_ref():
+    step_str = """\
+name: Run Local Workflow
+uses: ./.github/workflows/_local.yml
+"""
+    yaml = YAML()
+    step_yaml = yaml.load(step_str)
+    return Step.init(0, "default", step_yaml)
+
+
+@pytest.fixture(name="uses_step_no_ref_with_comments")
+def fixture_uses_step_no_ref_with_comments():
+    step_str = """\
+name: Run Local Workflow
+uses: ./.github/workflows/_local.yml # A comment
+"""
+    yaml = YAML()
+    step_yaml = yaml.load(step_str)
+    return Step.init(0, "default", step_yaml)
+
+
+def test_step_default(default_step):
+    assert default_step.key == 0
+    assert default_step.job == "default"
+    assert default_step.name == "Default Step"
+    assert default_step.env is None
+    assert default_step.uses is None
+    assert default_step.uses_with is None
+    assert default_step.run == 'echo "test"'
+
+
+def test_step_no_keyword_field(default_step):
+    assert default_step.uses_with is None
+    assert "uses_with" not in default_step.to_json()
+
+
+def test_step_extra_kwargs(default_step):
+    with pytest.raises(Exception):
+        assert default_step.extra == "test"
+
+
+def test_step_keyword_field(uses_step):
+    expected_response = {
+        "workflow": "upload-test-artifacts.yml",
+        "artifacts": "artifact",
+        "path": "artifact",
+        "branch": "main",
+    }
+
+    step_json = uses_step.to_json()
+    assert uses_step.key == 0
+    assert "uses_with" not in step_json
+    assert "with" in step_json
+    assert json.loads(uses_step.to_json())["with"] == expected_response
+
+
+def test_step_comment(uses_step):
+    assert uses_step.key == 0
+    assert uses_step.job == "default"
+    assert uses_step.uses_ref == "main"
+    assert uses_step.uses_version == "v1.0.0"
+    assert uses_step.uses_comment == "# v1.0.0"
+
+
+def test_step_no_comments(uses_step_no_comments):
+    assert uses_step_no_comments.key == 0
+    assert uses_step_no_comments.job == "default"
+    assert uses_step_no_comments.uses_ref == "main"
+    assert uses_step_no_comments.uses_version is None
+    assert uses_step_no_comments.uses_comment is None
+
+
+def test_step_no_ref(uses_step_no_ref):
+    assert uses_step_no_ref.key == 0
+    assert uses_step_no_ref.job == "default"
+    assert uses_step_no_ref.uses_ref is None
+    assert uses_step_no_ref.uses_version is None
+    assert uses_step_no_ref.uses_comment is None
+
+
+def test_step_no_ref_with_comments(uses_step_no_ref_with_comments):
+    assert uses_step_no_ref_with_comments.key == 0
+    assert uses_step_no_ref_with_comments.job == "default"
+    assert uses_step_no_ref_with_comments.uses_ref is None
+    assert (
+        uses_step_no_ref_with_comments.uses_version == "comment"
+    )  # We are not currently validating the version matches a specific format
+    assert uses_step_no_ref_with_comments.uses_comment == "# A comment"

bitwarden_workflow_linter-0.4.3/tests/test_step.py

@@ -1,78 +0,0 @@
-"""Test src/bitwarden_workflow_linter/models/step.py."""
-
-import json
-import pytest
-
-from ruamel.yaml import YAML
-
-from src.bitwarden_workflow_linter.models.step import Step
-
-
-@pytest.fixture(name="default_step")
-def fixture_default_step():
-    step_str = """\
-name: Default Step
-run: echo "test"
-"""
-    yaml = YAML()
-    step_yaml = yaml.load(step_str)
-    return Step.init(0, "default", step_yaml)
-
-
-@pytest.fixture(name="uses_step")
-def fixture_uses_step():
-    step_str = """\
-name: Download Artifacts
-uses: bitwarden/download-artifacts@main # v1.0.0
-with:
-    workflow: upload-test-artifacts.yml
-    artifacts: artifact
-    path: artifact
-    branch: main
-
-"""
-    yaml = YAML()
-    step_yaml = yaml.load(step_str)
-    return Step.init(0, "default", step_yaml)
-
-
-def test_step_default(default_step):
-    assert default_step.key == 0
-    assert default_step.job == "default"
-    assert default_step.name == "Default Step"
-    assert default_step.env is None
-    assert default_step.uses is None
-    assert default_step.uses_with is None
-    assert default_step.run == 'echo "test"'
-
-
-def test_step_no_keyword_field(default_step):
-    assert default_step.uses_with is None
-    assert "uses_with" not in default_step.to_json()
-
-
-def test_step_extra_kwargs(default_step):
-    with pytest.raises(Exception):
-        assert default_step.extra == "test"
-
-
-def test_step_keyword_field(uses_step):
-    expected_response = {
-        "workflow": "upload-test-artifacts.yml",
-        "artifacts": "artifact",
-        "path": "artifact",
-        "branch": "main",
-    }
-
-    step_json = uses_step.to_json()
-    assert uses_step.key == 0
-    assert "uses_with" not in step_json
-    assert "with" in step_json
-    assert json.loads(uses_step.to_json())["with"] == expected_response
-
-
-def test_step_comment(uses_step):
-    assert uses_step.key == 0
-    assert uses_step.job == "default"
-    assert uses_step.uses_comment is not None
-    assert uses_step.uses_comment == "# v1.0.0"