Add atomic PR ID job - Python tool POC

.github/jobs-py/.env.example

@@ -0,0 +1 @@
+GITHUB_TOKEN='SECRET'

.github/jobs-py/.gitignore

@@ -0,0 +1 @@
+.env

.github/jobs-py/Pipfile

@@ -0,0 +1,15 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pygithub = "*"
+python-dotenv = "*"
+
+[dev-packages]
+black = "*"
+pytest = "*"
+
+[requires]
+python_version = "3.11"

.github/jobs-py/README.md

@@ -0,0 +1,76 @@
+# Action Jobs - Python Scripts
+
+## Requirements
+- pipenv (with Python 3.11)
+
+## Notes
+If we go with something like this for the initial IDP client tool, something like
+[PyOxidizer](https://gregoryszorc.com/docs/pyoxidizer/main/pyoxidizer_getting_started.html) would be a good for anyone
+that doesn't require custom plugins (if this is something that we would want to support). This would allow us to ship a
+binary (and lessen the CI pipeline impacts of setting up and install all dependencies every time we need a job)
+
+## Development
+### Initial Setup
+```
+cp .env.example .env
+
+# edit .env with a GitHub token with "read public repos" permissions
+```
+
+### MacOS (brew)
+```
+pipenv install
+pipenv shell
+
+pytest
+```
+
+
+### (Nix - jflinn...)
+```
+nix-shell
+pipenv install
+pipenv shell
+
+pytest
+```
+
+
+## Jobs
+### Get PR ID
+
+Get the PR ID number associated with a commit on the default branch or return `None`
+
+**Params:** (string)
+**Return:** (string) int | None
+
+#### Example
+```yaml
+      - name: Sparse Checkout of Jobs dir
+        uses: actions/checkout@v4.1.1
+        with:
+          sparse-checkout: |
+            .github/jobs-py
+
+      - name: Setup Python
+        uses: actions/setup-python@v4.7.1
+        with:
+          python-version: '3.11'
+
+      - name: Install pipenv and setup project
+        run: |
+          pip install pipenv
+          pipenv install
+
+      - name: Assert
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          ID=$(python .github/jobs-py/src/get_pr_id.py "7d46c75af91adbfdfc70689f4d8b3405b26bda6b")
+          if [[ "$ID" != "196" ]]; then
+            exit 1
+          fi
+          exit 0
+```
+
+

.github/jobs-py/shell.nix

@@ -0,0 +1,11 @@
+with import <nixpkgs> {};
+let
+  pythonEnv = python311.withPackages(ps: [
+  ]);
+in mkShell {
+  packages = [
+    pythonEnv
+
+    pipenv
+  ];
+}

.github/jobs-py/src/get_pr_id.py

@@ -0,0 +1,35 @@
+import os
+import re
+import sys
+
+from dotenv import load_dotenv
+from github import Auth
+from github import Github
+from github import GithubException
+
+load_dotenv()
+
+auth = Auth.Token(os.getenv("GITHUB_TOKEN", default=""))
+g = Github(auth=auth)
+repo = g.get_repo("bitwarden/gh-actions")
+
+
+def get_pr_id(commit_sha: str) -> int | None:
+    try:
+        message = repo.get_commit(commit_sha).commit.message
+        result = re.search(r"(\(#[0-9]+\))", message)
+
+        if result:
+            return int(result.group(0)[2:-1])
+        return None
+
+    except GithubException:
+        return None
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print(f"[!] Please pass in commit hash: {sys.argv}")
+        exit(1)
+
+    print(get_pr_id(sys.argv[1]))

.github/jobs-py/tests/e2e/test_get_pr_id.py

@@ -0,0 +1,16 @@
+import subprocess
+
+
+def test_get_pr_id_cmd():
+    inputs = [
+        {"commit": "7d46c75af91adbfdfc70689f4d8b3405b26bda6b", "expected": "196"},
+        {"commit": "f30be53c2a5b3d61928c0f41a2e25605a9901d6a", "expected": "None"},
+        {"commit": "f30be53c2a5b3d61928c0f41a2e25605a9901d6b", "expected": "None"},
+    ]
+
+    for input in inputs:
+        result = subprocess.run(
+            ["python", "src/get_pr_id.py", input["commit"]], stdout=subprocess.PIPE
+        )
+
+        assert result.stdout.decode().strip("\n") == input["expected"]

.github/jobs-py/tests/unit/context.py

@@ -0,0 +1,6 @@
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
+
+import src

.github/jobs-py/tests/unit/test_get_pr_id.py

@@ -0,0 +1,15 @@
+from .context import src
+
+from src.get_pr_id import get_pr_id
+
+
+def test_main_commit():
+    assert get_pr_id("7d46c75af91adbfdfc70689f4d8b3405b26bda6b") == 196
+
+
+def test_feature_commit():
+    assert get_pr_id("f30be53c2a5b3d61928c0f41a2e25605a9901d6a") is None
+
+
+def test_dne_commit():
+    assert get_pr_id("f30be53c2a5b3d61928c0f41a2e25605a9901d6b") is None

.github/workflows/test_jobs_py.yml

@@ -0,0 +1,55 @@
+---
+name: Test Jobs - Python
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - .github/jobs-py/**
+      - .github/workflows/test_jobs_py.yml
+
+
+jobs:
+  test_jobs_py:
+    name: Test Jobs - Python
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Sparse Checkout of Jobs dir
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11  #v4.1.1
+        with:
+          sparse-checkout: |
+            .github/jobs-py
+
+      - name: Setup Python
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236  #v4.7.1
+        with:
+          python-version: '3.11'
+
+      - name: Install Pipenv and Setup Project
+        working-directory: .github/jobs-py
+        run: |
+          mkdir reports
+          pip install pipenv
+          pipenv install --dev
+
+      - name: Run Unit Tests
+        working-directory: .github/jobs-py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pipenv run pytest tests/unit --junit-xml=reports/unit.xml --tb=line
+
+      - name: Run E2E Tests
+        working-directory: .github/jobs-py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pipenv run pytest tests/e2e --junit-xml=reports/e2e.xml --tb=line
+
+      - name: Report test results
+        uses: dorny/test-reporter@afe6793191b75b608954023a46831a3fe10048d4 # v1.7.0
+        if: always()
+        with:
+          name: Test Results
+          path: ".github/jobs-py/reports/*.xml"
+          reporter: java-junit
+          fail-on-error: true