Support GH Enterprise (#205)

Add a new input parameter: gh_rest_api_base_url
It defaults to https://api.github.com.
If set, it should include the path `/api/v3` - if not, it will be added.

Use $GITHUB_SERVER_URL otherwise throughout.

Add logging to push-action - it will be streamed to stderr
if `debug` is set (is `true`).

Use function to escape regexp special chars.
Implement function from stackoverflow answer:
https://stackoverflow.com/a/16951928/12404091

README.md

@@ -155,6 +155,7 @@ All input names in **bold** are _required_.
 | `unprotect_reviews` | Momentarily remove pull request review protection from target branch.<br>**Note**: One needs administrative access to the repository to be able to use this feature. This means two things need to match up: The PAT must represent a user with administrative rights, and these rights need to be granted to the usage scope of the PAT. | `False` |
 | `debug` | Set `set -x` in `entrypoint.sh` when running the action. This is for debugging the action. | `False` |
 | `path` | A path to the working directory of the action. This should be relative to the `$GITHUB_WORKSPACE`. | `.` |
+| `gh_rest_api_base_url` | The base URL for the GitHub REST API. This is useful for GitHub Enterprise users.</br>Note, `/api/v3` will be appended to this value if it does not already exist. See the note [here](https://docs.github.com/en/enterprise-server@3.10/rest/quickstart?apiVersion=2022-11-28&tool=curl#using-curl-commands-in-github-actions). | `https://api.github.com` |
 
 ## License
 

action.yml

@@ -48,6 +48,10 @@ inputs:
     description: 'A path to the working directory of the action. This should be relative to the $GITHUB_WORKSPACE.'
     required: false
     default: '.'
+  gh_rest_api_base_url:
+    description: 'The base URL for the GitHub REST API. This is useful for GitHub Enterprise users. Note, `/api/v3` will be appended to this value if it does not already exist. See the note here: https://docs.github.com/en/enterprise-server@3.10/rest/quickstart?apiVersion=2022-11-28&tool=curl#using-curl-commands-in-github-actions.'
+    required: false
+    default: 'https://api.github.com'
 runs:
   using: 'docker'
   image: 'Dockerfile'

entrypoint.sh

@@ -12,6 +12,9 @@ esac
 set -e
 
 # Utility functions
+ere_quote() {
+    sed 's/[][\.|$(){}?+*^]/\\&/g' <<< "$*"
+}
 unprotect () {
     case ${INPUT_UNPROTECT_REVIEWS} in
         y | Y | yes | Yes | YES | true | True | TRUE | on | On | ON)
@@ -102,9 +105,9 @@ git config --global --add safe.directory ${PWD}
 
 # Retrieve target repository
 echo -e "\nFetching the latest information from '${GITHUB_REPOSITORY}' ..."
-git config --local --name-only --get-regexp "http\.https\:\/\/github\.com\/\.extraheader" && git config --local --unset-all "http.https://github.com/.extraheader" || :
-git submodule foreach --recursive 'git config --local --name-only --get-regexp "http\.https\:\/\/github\.com\/\.extraheader" && git config --local --unset-all "http.https://github.com/.extraheader" || :'
-git remote set-url origin https://${GITHUB_ACTOR}:${INPUT_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+git config --local --name-only --get-regexp "http\.$(ere_quote "${GITHUB_SERVER_URL}")/\.extraheader" && git config --local --unset-all "http.${GITHUB_SERVER_URL}/.extraheader" || :
+git submodule foreach --recursive 'git config --local --name-only --get-regexp "http\.$(ere_quote "${GITHUB_SERVER_URL}")/\.extraheader" && git config --local --unset-all "http.${GITHUB_SERVER_URL}/.extraheader" || :'
+git remote set-url origin $(push-action --token "null" --ref "null" --temp-branch "null" -- create_origin_url)
 git fetch --unshallow -tp origin || :
 echo "Fetching the latest information from '${GITHUB_REPOSITORY}' ... DONE!"
 

push_action/__init__.py

@@ -3,6 +3,16 @@
 This Python module is a helper module to interact with the GitHub API.
 It is meant to only be used in the `push-protected` GitHub action.
 """
+import logging
+import os
+import sys
 
 __version__ = "2.14.0"
 __author__ = "Casper Welzel Andersen"
+
+
+LOGGER = logging.getLogger("push_action")
+
+if os.getenv("INPUT_DEBUG", "").lower() in ("true", "1"):
+    LOGGER.setLevel(logging.DEBUG)
+    LOGGER.addHandler(logging.StreamHandler(sys.stderr))

push_action/cache.py

@@ -6,7 +6,7 @@
 """
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from typing import Any, Iterator
 
 

push_action/run.py

@@ -6,16 +6,16 @@
 
 1) Get required statuses for branch (GitHub Actions jobs / third party status checks)
    from:
-   https://api.github.com/repos/:owner/:repo/branches/:branch
+   {input_gh_rest_api_base_url}/repos/:owner/:repo/branches/:branch
    protection -> required_status_checks -> contexts
 
 2) Get GitHub Actions runs for specific workflow:
-   https://api.github.com/repos/:owner/:repo/actions/workflows/:workflow_id/runs
+   {input_gh_rest_api_base_url}/repos/:owner/:repo/actions/workflows/:workflow_id/runs
    :workflow_id can also be :workflow_file_name (e.g., 'main.yml')
    Get :run_id from this
 
 3) Get names and statuses of jobs in specific run:
-   https://api.github.com/repos/:owner/:repo/actions/runs/:run_id/jobs
+   {input_gh_rest_api_base_url}/repos/:owner/:repo/actions/runs/:run_id/jobs
    Match found required GitHub Actions runs found in 1)
 
 4) Wait and do 3) again until required GitHub Actions jobs have "status": "completed"
@@ -25,10 +25,12 @@
 """
 import argparse
 import json
+import logging
 import os
 import sys
 from time import sleep, time
 from typing import TYPE_CHECKING
+from urllib.parse import urlsplit
 
 from push_action.cache import IN_MEMORY_CACHE
 from push_action.utils import (
@@ -40,10 +42,13 @@
     remove_branch,
 )
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from typing import Any, Dict
 
 
+LOGGER = logging.getLogger("push_action.run")
+
+
 def wait() -> None:
     """Wait until status checks have finished"""
     required_statuses = get_branch_statuses(IN_MEMORY_CACHE["args"].ref)
@@ -197,6 +202,45 @@ def protected_branch(branch: str) -> str:
     return "protected" if response["protected"] else ""
 
 
+def compile_origin_url() -> str:
+    """Compile the git remote 'origin' URL for the repository."""
+    compiled_url = ""
+
+    for required_env_vars in [
+        "GITHUB_SERVER_URL",
+        "GITHUB_REPOSITORY",
+        "GITHUB_ACTOR",
+        "INPUT_TOKEN",
+    ]:
+        if required_env_vars not in os.environ:
+            raise RuntimeError(
+                f"Required rnvironment variable {required_env_vars} is not set."
+            )
+
+    base_url = os.getenv("GITHUB_SERVER_URL", "")
+    split_base_url = urlsplit(base_url)
+
+    if not (split_base_url.scheme or split_base_url.netloc):
+        raise RuntimeError(
+            f"Could not determine scheme and netloc from GITHUB_SERVER_URL: {base_url}"
+        )
+
+    # Add scheme
+    compiled_url += f"{split_base_url.scheme}://"
+
+    # Add username and token
+    compiled_url += os.getenv("GITHUB_ACTOR", "")
+    compiled_url += f":{os.getenv('INPUT_TOKEN', '')}"
+
+    # Add netloc
+    compiled_url += f"@{split_base_url.netloc}"
+
+    # Add path (repository)
+    compiled_url += f"/{os.getenv('GITHUB_REPOSITORY', '')}.git"
+
+    return compiled_url
+
+
 def main() -> None:
     """Main function to run this module"""
     # Handle inputs
@@ -247,11 +291,14 @@ def main() -> None:
             "unprotect_reviews",
             "protect_reviews",
             "protected_branch",
+            "create_origin_url",
         ],
     )
 
     IN_MEMORY_CACHE["args"] = parser.parse_args()
 
+    LOGGER.debug("Parsed args: %s", IN_MEMORY_CACHE["args"])
+
     fail = ""
     try:
         if IN_MEMORY_CACHE["args"].ACTION == "wait_for_checks":
@@ -264,6 +311,8 @@ def main() -> None:
             protect_reviews()
         elif IN_MEMORY_CACHE["args"].ACTION == "protected_branch":
             print(protected_branch(IN_MEMORY_CACHE["args"].ref), end="", flush=True)
+        elif IN_MEMORY_CACHE["args"].ACTION == "create_origin_url":
+            print(compile_origin_url(), end="", flush=True)
         else:
             raise RuntimeError(f"Unknown ACTIONS {IN_MEMORY_CACHE['args'].ACTION!r}")
     except Exception as exc:  # pylint: disable=broad-except

push_action/utils.py

@@ -3,6 +3,7 @@
 Utility functions for use in the `push_action.run` module.
 """
 from enum import Enum
+import logging
 import os
 from time import time
 from typing import TYPE_CHECKING
@@ -17,13 +18,18 @@
 import requests
 
 from push_action.cache import IN_MEMORY_CACHE
+from push_action.validate import validate_rest_api_base_url
 
-if TYPE_CHECKING:
-    from typing import Callable, List, Optional, Union
+if TYPE_CHECKING:  # pragma: no cover
+    from typing import Callable, List, Union
+
+
+LOGGER = logging.getLogger("push_action.utils")
 
 
 REQUEST_TIMEOUT = 10  # in seconds
-API_V3_BASE = "https://api.github.com"
+API_V3_BASE = validate_rest_api_base_url(os.getenv("INPUT_GH_REST_API_BASE_URL", ""))
+API_VERSION = "2022-11-28"
 
 
 class RepoRole(Enum):
@@ -73,6 +79,7 @@ def api_request(
             headers={
                 "Authorization": f"Bearer {IN_MEMORY_CACHE['args'].token}",
                 "Accept": "application/vnd.github.v3+json",
+                "X-GitHub-Api-Version": API_VERSION,
             },
             timeout=REQUEST_TIMEOUT,
             **kwargs,
@@ -115,6 +122,12 @@ def api_request(
         except json.JSONDecodeError as exc:
             raise RuntimeError(f"Failed to jsonify response.\n{exc!r}") from exc
 
+    LOGGER.debug(
+        "API Call to: %s\nResponse: %s",
+        url,
+        response.text if isinstance(response, requests.Response) else response,
+    )
+
     return response
 
 
@@ -186,9 +199,9 @@ def get_workflow_runs(workflow_id: int, new_request: bool = False) -> "List[dict
             )
 
         workflow_runs = [
-            _
-            for _ in response.get("workflow_runs", [])
-            if _.get("head_branch", "") == IN_MEMORY_CACHE["args"].temp_branch
+            run
+            for run in response.get("workflow_runs", [])
+            if run.get("head_branch", "") == IN_MEMORY_CACHE["args"].temp_branch
         ]
 
         if cache_name in IN_MEMORY_CACHE:
@@ -247,16 +260,16 @@ def get_required_actions(
                     f"{type(response)}"
                 )
 
-            runs = []
+            runs: "List[dict]" = []
             for workflow in response["workflows"]:
                 runs.extend(get_workflow_runs(workflow["id"]))
 
-            jobs = []
+            jobs: "List[dict]" = []
             for run in runs:
                 jobs.extend(get_workflow_run_jobs(run["id"]))
 
             IN_MEMORY_CACHE[cache_name] = [
-                _ for _ in jobs if _.get("name", "") in statuses
+                job for job in jobs if job.get("name", "") in statuses
             ]
 
     return IN_MEMORY_CACHE[cache_name]

push_action/validate.py

@@ -0,0 +1,40 @@
+"""Validate inputs."""
+from urllib.parse import urlsplit
+
+GITHUB_FREE_REST_API_BASE_URL = "https://api.github.com"
+"""Base URL for GitHub Free API."""
+
+GITHUB_ENTERPRISE_API_PREFIX = "/api/v3"
+"""Prefix for GitHub Enterprise API URLs.
+See the note for more information here:
+https://docs.github.com/en/enterprise-server@3.10/rest/quickstart?apiVersion=2022-11-28&tool=curl#using-curl-commands-in-github-actions.
+"""
+
+
+def validate_rest_api_base_url(base_url: str) -> str:
+    """Validate and parse the `gh_rest_api_base_url` input."""
+    split_base_url = urlsplit(base_url)
+
+    if not split_base_url.scheme or not split_base_url.netloc:
+        raise ValueError(
+            "Invalid URL provided for `gh_rest_api_base_url` input (missing scheme "
+            "and/or netloc)."
+        )
+
+    compiled_url = split_base_url.scheme + "://" + split_base_url.netloc
+
+    if compiled_url == GITHUB_FREE_REST_API_BASE_URL:
+        return compiled_url
+
+    url_path = split_base_url.path.rstrip("/")
+
+    if url_path and not split_base_url.path.endswith(GITHUB_ENTERPRISE_API_PREFIX):
+        raise ValueError(
+            "Invalid URL provided for `gh_rest_api_base_url` input (path must end with "
+            f"{GITHUB_ENTERPRISE_API_PREFIX!r})."
+        )
+
+    if not url_path:
+        compiled_url += GITHUB_ENTERPRISE_API_PREFIX
+
+    return compiled_url