bitwarden_workflow_linter 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

bitwarden_workflow_linter/__about__.py

@@ -1,3 +1,3 @@
 """Metadata for Workflow Linter."""
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"

bitwarden_workflow_linter/actions.py

@@ -11,13 +11,11 @@ from typing import Optional, Union
 
 from .utils import Colors, Settings, Action
 
-
 class GitHubApiSchemaError(Exception):
     """A generic Exception to catch redefinitions of GitHub Api Schema changes."""
 
     pass
 
-
 class ActionsCmd:
     """Command to manage the pre-approved list of Actions
 

bitwarden_workflow_linter/cli.py

@@ -9,10 +9,8 @@ from .actions import ActionsCmd
 from .lint import LinterCmd
 from .utils import Settings
 
-
 local_settings = Settings.factory()
 
-
 def main(input_args: Optional[List[str]] = None) -> int:
     """CLI utility to lint GitHub Action Workflows.
 
@@ -50,6 +48,5 @@ def main(input_args: Optional[List[str]] = None) -> int:
 
     return -1
 
-
 if __name__ == "__main__":
     sys.exit(main())

bitwarden_workflow_linter/default_settings.yaml

@@ -4,5 +4,6 @@ enabled_rules:
   - bitwarden_workflow_linter.rules.pinned_job_runner.RuleJobRunnerVersionPinned
   - bitwarden_workflow_linter.rules.job_environment_prefix.RuleJobEnvironmentPrefix
   - bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
+  - bitwarden_workflow_linter.rules.underscore_outputs.RuleUnderscoreOutputs
 
 approved_actions_path: default_actions.json

bitwarden_workflow_linter/lint.py

@@ -10,7 +10,6 @@ from typing import Optional
 from .load import WorkflowBuilder, Rules
 from .utils import LintFinding, Settings
 
-
 class LinterCmd:
     """Command to lint GitHub Action Workflow files
 

bitwarden_workflow_linter/load.py

@@ -13,16 +13,13 @@ from .models.workflow import Workflow
 from .rule import Rule
 from .utils import Settings
 
-
 yaml = YAML()
 
-
 class WorkflowBuilderError(Exception):
     """Exception to indicate an error with the WorkflowBuilder."""
 
     pass
 
-
 class WorkflowBuilder:
     """Collection of methods to build Workflow objects."""
 
@@ -85,13 +82,11 @@ class WorkflowBuilder:
             "The workflow must either be built from a file or from a CommentedMap"
         )
 
-
 class LoadRulesError(Exception):
     """Exception to indicate an error with loading rules."""
 
     pass
 
-
 class Rules:
     """A collection of all of the types of rules.
 

bitwarden_workflow_linter/models/job.py

@@ -30,6 +30,7 @@ class Job:
     uses_with: Optional[CommentedMap] = field(
         metadata=config(field_name="with"), default=None
     )
+    outputs: Optional[CommentedMap] = None
 
     @classmethod
     def init(cls: Self, key: str, data: CommentedMap) -> Self:
@@ -39,6 +40,7 @@ class Job:
             "name": data["name"] if "name" in data else None,
             "runs-on": data["runs-on"] if "runs-on" in data else None,
             "env": data["env"] if "env" in data else None,
+            "outputs": data["outputs"] if "outputs" in data else None,
         }
 
         new_job = cls.from_dict(init_data)

bitwarden_workflow_linter/rule.py

@@ -7,13 +7,11 @@ from .models.job import Job
 from .models.step import Step
 from .utils import LintFinding, LintLevels, Settings
 
-
 class RuleExecutionException(Exception):
     """Exception for the Base Rule class."""
 
     pass
 
-
 class Rule:
     """Base class of a Rule to extend to create a linting Rule."""
 

bitwarden_workflow_linter/rules/underscore_outputs.py

@@ -0,0 +1,111 @@
+import re
+
+from typing import Optional, Union, Tuple
+
+from ..models.job import Job
+from ..rule import Rule
+from ..models.workflow import Workflow
+from ..models.step import Step
+from ..utils import LintLevels, Settings
+
+
+class RuleUnderscoreOutputs(Rule):
+    """Rule to enforce all GitHub 'outputs' more than one words contain an underscore.
+
+    A simple standard to ensure uniformity in naming.
+    """
+
+    def __init__(self, settings: Optional[Settings] = None) -> None:
+        """Constructor for RuleUnderscoreOutputs to override the Rule class.
+
+        Args:
+          settings:
+            A Settings object that contains any default, overridden, or custom settings
+            required anywhere in the application.
+        """
+        self.message = "outputs with more than one word must use an underscore"
+        self.on_fail = LintLevels.WARNING
+        self.compatibility = [Workflow, Job, Step]
+        self.settings = settings
+
+    def fn(self, obj: Union[Workflow, Job, Step]) -> Tuple[bool, str]:
+        """Enforces all outputs to have an underscore in the key name.
+
+        This Rule checks all outputs in a Workflow, Job, or Step to ensure that
+        the key name contains an underscore. This is to ensure that the naming
+        convention is consistent across all outputs in the workflow configuration
+
+        Example:
+        ---
+        on:
+          workflow_dispatch:
+            outputs:
+              registry:
+                value: 'Test Value'
+              some_registry:
+                value: 'Test Value'
+          workflow_call:
+            outputs:
+              registry:
+                value: 'Test Value'
+              some_registry:
+                value: 'Test Value'
+        jobs:
+          job-key:
+            runs-on: ubuntu-22.04
+            outputs:
+              test_key_job: ${{ steps.test_output_1.outputs.test_key }}
+            steps:
+              - name: Test output in one-line run step
+                id: test_output_1
+                run: echo "test_key_1=Test-Value1" >> $GITHUB_OUTPUT
+
+              - name: Test output in multi-line run step
+                id: test_output_2
+                run: |
+                  echo
+                  fake-command=Test-Value2
+                  echo "test_key_2=$REF" >> $GITHUB_OUTPUT
+                  echo "deployed_ref=$DEPLOYED_REF" >> $GITHUB_OUTPUT
+
+              - name: Test step with no run
+                id: test_output_3
+                uses: actions/checkout@v2
+                with:
+                  ref: ${{ github.ref }}
+                  fetch-depth: 0
+
+        In this example, in workflow level 'registry' and 'some_registry' are outputs
+        that satisfy the rule in both 'workflow_dispatch' and 'workflow_call' events.
+        In job level 'test_key_job' satisfies the rule.
+        In step level 'test_key_1', 'test_key_2', and 'deployed_ref' satisfy the rule.
+
+        See tests/rules/test_underscore_outputs.py for incorrect examples.
+        """
+
+        outputs = []
+
+        if isinstance(obj, Workflow):
+            if obj.on.get("workflow_dispatch"):
+                outputs.extend(obj.on["workflow_dispatch"]["outputs"].keys())
+
+            if obj.on.get("workflow_call"):
+                outputs.extend(obj.on["workflow_call"]["outputs"].keys())
+
+        if isinstance(obj, Job):
+            if obj.outputs:
+                outputs.extend(obj.outputs.keys())
+
+        if isinstance(obj, Step):
+            if obj.run:
+                outputs.extend(re.findall(
+                    r"\b([a-zA-Z0-9_-]+)\s*=\s*[^=]*>>\s*\$GITHUB_OUTPUT",
+                    obj.run))
+
+        for output_name in outputs:
+            if "-" in output_name:
+                return False, (
+                    f"Hyphen found in {obj.__class__.__name__} output: {output_name}"
+                )
+
+        return True, ""

bitwarden_workflow_linter/utils.py

@@ -10,10 +10,8 @@ from typing import Optional, Self, TypeVar
 
 from ruamel.yaml import YAML
 
-
 yaml = YAML()
 
-
 @dataclass
 class Colors:
     """Class containing color codes for printing strings to output."""
@@ -27,7 +25,6 @@ class Colors:
     cyan = "36m"
     white = "37m"
 
-
 @dataclass
 class LintLevel:
     """Class to contain the numeric level and color of linting."""
@@ -35,7 +32,6 @@ class LintLevel:
     code: int
     color: Colors
 
-
 class LintLevels(LintLevel, Enum):
     """Collection of the different types of LintLevels available."""
 
@@ -43,7 +39,6 @@ class LintLevels(LintLevel, Enum):
     WARNING = 1, Colors.yellow
     ERROR = 2, Colors.red
 
-
 class LintFinding:
     """Represents a problem detected by linting."""
 
@@ -62,7 +57,6 @@ class LintFinding:
             f"{self.description}"
         )
 
-
 @dataclass
 class Action:
     """Collection of the metadata associated with a GitHub Action."""
@@ -99,16 +93,13 @@ class Action:
         """
         return not self.__eq__(other)
 
-
 class SettingsError(Exception):
     """Custom Exception to indicate an error with loading Settings."""
 
     pass
 
-
 SettingsFromFactory = TypeVar("SettingsFromFactory", bound="Settings")
 
-
 class Settings:
     """Class that contains configuration-as-code for any portion of the app."""
 

{bitwarden_workflow_linter-0.0.3.dist-info → bitwarden_workflow_linter-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bitwarden_workflow_linter
-Version: 0.0.3
+Version: 0.0.4
 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
@@ -66,6 +66,7 @@ enabled_rules:
     - bitwarden_workflow_linter.rules.pinned_job_runner.RuleJobRunnerVersionPinned
     - bitwarden_workflow_linter.rules.job_environment_prefix.RuleJobEnvironmentPrefix
     - bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
+    - bitwarden_workflow_linter.rules.underscore_outputs.RuleUnderscoreOutputs
 
 approved_actions_path: default_actions.json
 ```
@@ -177,6 +178,9 @@ By default, a new Rule needs five things:
 not support Rules that check against multiple objects at a time OR file level formatting (one empty between each step or
 two empty lines between each job)
 
+To activate a rule after implementing it, add it to `settings.yaml` in the project's base folder
+and `src/bitwarden_workflow_linter/default_settings.yaml` to make the rule default
+
 ### ToDo
 
 -   [ ] Add Rule to assert correct format for single line run

{bitwarden_workflow_linter-0.0.3.dist-info → bitwarden_workflow_linter-0.0.4.dist-info}/RECORD

@@ -1,15 +1,15 @@
-bitwarden_workflow_linter/__about__.py,sha256=KbbxYy_rLR2HkiKmhQYMcL4RRAhh7MG3ylAz_mbGpQo,59
+bitwarden_workflow_linter/__about__.py,sha256=9USIJuK96UM5d4t_Q91z8UWTAv7q9jr2VgVwol4KYx4,59
 bitwarden_workflow_linter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bitwarden_workflow_linter/actions.py,sha256=daob3be2Y22gfsAmGhTgBRCgGk18mlGduqc5Zn1Onz4,7897
-bitwarden_workflow_linter/cli.py,sha256=oM3Cjo2y5NrzN1BfqGRiOhOC6IzPDEnEh14v3bsiqak,1700
+bitwarden_workflow_linter/actions.py,sha256=bjuFAP72QHXlDTmMBZffNmSCjZDzyNHGzqEC78ABAgg,7895
+bitwarden_workflow_linter/cli.py,sha256=GABKYWYmcKl4LrA-cgo4ME0mWD4xaO4AgZHBeCCDMy4,1697
 bitwarden_workflow_linter/default_actions.json,sha256=BeFllnAu9v6cX6eeGeNoQf3rXs7ZOjAtjTNBQuAZ8-k,8087
-bitwarden_workflow_linter/default_settings.yaml,sha256=yRvAt06Hupv7mSrSGGdWKJruecvEO55CazIbxP34plg,428
-bitwarden_workflow_linter/lint.py,sha256=z83h7XOnULngPqTwlo5LKCK2ciUu4oalwixKVcFLWac,5461
-bitwarden_workflow_linter/load.py,sha256=FYbSKgjVCleqiYKR_dB92C3EcP89knNMkxVr2yZZO9o,4473
-bitwarden_workflow_linter/rule.py,sha256=Qb60JiUDAWN3ayrMGoSbbDCSFmw-ql8djzAkxISaob4,3250
-bitwarden_workflow_linter/utils.py,sha256=IN_jSZQXRwutgFQ6n7xtD1OrTpx9YS_cHLZKDOEUhfc,4696
+bitwarden_workflow_linter/default_settings.yaml,sha256=EMKRFPFlbgkWtZGUA10Y758RJfAjuI8IUDeqRnRTTs8,505
+bitwarden_workflow_linter/lint.py,sha256=Ftz9I3hZS0Vbpn-zk3XKp35Cth3eEo9yf-25rZHrY4k,5460
+bitwarden_workflow_linter/load.py,sha256=E3DPC66rObcmktOKGu3YkGAzWPZLVgSLdZr59DQzz5w,4468
+bitwarden_workflow_linter/rule.py,sha256=H1uwzxck849gh7-kigBgu9RgpJ3lCu3hizQWtZupRJE,3248
+bitwarden_workflow_linter/utils.py,sha256=IyPnxgb91XKXqCifRR5RWEfmZv5F2G9qvwVQVLZd-Bs,4687
 bitwarden_workflow_linter/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bitwarden_workflow_linter/models/job.py,sha256=YXzs5CIIM1WEtzAk918QfIioqLcdr4vCOr3fs0uVEu0,1929
+bitwarden_workflow_linter/models/job.py,sha256=nBK7_VYu6RRST7WLtdLsoRErl5j4Er8W9hCw9XlSECk,2043
 bitwarden_workflow_linter/models/step.py,sha256=1bKAtKZmHcO8O1e_HuoXxR1bwHDEXUssYo7EHOjY7QI,1711
 bitwarden_workflow_linter/models/workflow.py,sha256=MkqvIY4JX2eWFODNTodS_l4I8uUq08WCHy3C4kYcL0s,1395
 bitwarden_workflow_linter/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -19,8 +19,9 @@ bitwarden_workflow_linter/rules/name_exists.py,sha256=MxcaNQz64JXeHRPiOip9BxJNgP
 bitwarden_workflow_linter/rules/pinned_job_runner.py,sha256=Dm6_sdPX0yFMji_y2LMFj4gWFaToEgauyBVpNRP2qiI,1606
 bitwarden_workflow_linter/rules/step_approved.py,sha256=UIi9_z9j75SpQUmo29MLDhjLklqd4h0D-UYqkdcaju0,3307
 bitwarden_workflow_linter/rules/step_pinned.py,sha256=JSdKW-2Z8_ozQ3aAU7oYYt2ym3GLEilMfXBVqj1QU_E,3286
-bitwarden_workflow_linter-0.0.3.dist-info/METADATA,sha256=5Wg-TjUZxbvnihnAX8HkbsEVEh_30-hJxnslx-pujTE,5912
-bitwarden_workflow_linter-0.0.3.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bitwarden_workflow_linter-0.0.3.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
-bitwarden_workflow_linter-0.0.3.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
-bitwarden_workflow_linter-0.0.3.dist-info/RECORD,,
+bitwarden_workflow_linter/rules/underscore_outputs.py,sha256=CQbxQc-LI7H6Ihv4JrXJFFUiiQ5lDUjm4jIPdiNmNgE,3843
+bitwarden_workflow_linter-0.0.4.dist-info/METADATA,sha256=FnWnF5oy4sR6O4xVLAVu4GIr6rgDsfop6SXs7kUBRv8,6172
+bitwarden_workflow_linter-0.0.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bitwarden_workflow_linter-0.0.4.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
+bitwarden_workflow_linter-0.0.4.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
+bitwarden_workflow_linter-0.0.4.dist-info/RECORD,,