Add dataclasses for the default environment variables

github_action_utils.py

@@ -5,8 +5,11 @@
 import uuid
 from contextlib import contextmanager
 from functools import lru_cache
-from typing import Any, Dict, Generator, Union
+from typing import Any, Dict, Generator, Literal, Optional, Union
 from warnings import warn
+from dataclasses import dataclass
+from pathlib import Path
+from urllib.parse import urlparse, ParseResult, ParseResultBytes
 
 if sys.version_info >= (3, 8):
     from typing import Literal
@@ -31,7 +34,8 @@
 ACTION_ENV_DELIMITER: str = "__ENV_DELIMITER__"
 COMMAND_MARKER: str = "::"
 
-COMMANDS_USE_SUBPROCESS: bool = bool(os.environ.get("COMMANDS_USE_SUBPROCESS", False))
+COMMANDS_USE_SUBPROCESS: bool = bool(
+    os.environ.get("COMMANDS_USE_SUBPROCESS", False))
 
 
 def _print_command(
@@ -88,7 +92,8 @@ def _escape_data(data: Any) -> str:
     :returns: string after escaping
     """
     return (
-        _make_string(data).replace("%", "%25").replace("\r", "%0D").replace("\n", "%0A")
+        _make_string(data).replace("%", "%25").replace(
+            "\r", "%0D").replace("\n", "%0A")
     )
 
 
@@ -377,7 +382,8 @@ def start_group(title: str, use_subprocess: bool = False) -> None:
     :param use_subprocess: use subprocess module to echo command
     :returns: None
     """
-    _print_command("group", title, use_subprocess=use_subprocess, escape_message=False)
+    _print_command("group", title, use_subprocess=use_subprocess,
+                   escape_message=False)
 
 
 def end_group(use_subprocess: bool = False) -> None:
@@ -479,7 +485,8 @@ def stop_commands(
     :param use_subprocess: use subprocess module to echo command
     :returns: None
     """
-    stop_token = begin_stop_commands(token=token, use_subprocess=use_subprocess)
+    stop_token = begin_stop_commands(
+        token=token, use_subprocess=use_subprocess)
     yield
     end_stop_commands(stop_token, use_subprocess=use_subprocess)
 
@@ -505,6 +512,9 @@ def get_workflow_environment_variables() -> Dict[str, Any]:
     environment_variable_dict = {}
     marker = f"<<{ACTION_ENV_DELIMITER}"
 
+    if "GITHUB_ENV" not in os.environ:
+        return environment_variable_dict
+
     with open(os.environ["GITHUB_ENV"], "rb") as file:
         for line in file:
             decoded_line: str = line.decode("utf-8")
@@ -585,3 +595,110 @@ def event_payload() -> Dict[str, Any]:
     with open(os.environ["GITHUB_EVENT_PATH"]) as f:
         data: Dict[str, Any] = json.load(f)
     return data
+
+
+@dataclass(frozen=True)
+class variables():
+    """All the default defined variables.
+    See https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables for all of them.
+    """
+
+    ci: bool = True
+    """Always True"""
+
+    @dataclass(frozen=True)
+    class github():
+        """Various information about the environment.
+        See https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables for a list of all available options.
+        """
+        action: Optional[str] = get_env("GITHUB_ACTION")
+        """The name of the action currently running, or the `id` of a step."""
+        action_path: Path = Path(get_env("GITHUB_ACTION_PATH") or "")
+        """The path where an action is located. This property is only supported in composite actions. You can use this path to access files located in the same repository as the action."""
+        action_repository: Optional[str] = get_env("GITHUB_ACTION_REPOSITORY")
+        """For a step executing an action, this is the owner and repository name of the action."""
+        actions: bool = True if get_env("GITHUB_ACTIONS") == "true" else False
+        """Always set to `true` when GitHub Actions is running the workflow. You can use this variable to differentiate when tests are being run locally or by GitHub Actions."""
+        actor: Optional[str] = get_env("GITHUB_ACTOR")
+        """The name of the person or app that initiated the workflow."""
+        actor_id: Optional[str] = get_env("GITHUB_ACTOR_ID")
+        """The account ID of the person or app that triggered the initial workflow run."""
+        api_url: Union[ParseResult, ParseResultBytes] = urlparse(
+            get_env("GITHUB_API_URL"))
+        """Returns the API URL."""
+        base_ref: Optional[str] = get_env("GITHUB_BASE_REF")
+        """The name of the base ref or target branch of the pull request in a workflow run. This is only set when the event that triggers a workflow run is either `pull_request` or `pull_request_target`."""
+        env: Path = Path(get_env("GITHUB_ENV") or "")
+        """The path on the runner to the file that sets variables from workflow commands. This file is unique to the current step and changes for each step in a job."""
+        event_name: Optional[str] = get_env("GITHUB_EVENT_NAME")
+        """The name of the event that triggered the workflow."""
+        event_path: Path = Path(get_env("GITHUB_EVENT_PATH") or "")
+        """The path to the file on the runner that contains the full event webhook payload."""
+        graphql_url: Union[ParseResult, ParseResultBytes] = urlparse(
+            get_env("GITHUB_GRAPHQL_URL"))
+        """Returns the GraphQL API URL."""
+        head_ref: Optional[str] = get_env("GITHUB_HEAD_REF")
+        """The head ref or source branch of the pull request in a workflow run. This property is only set when the event that triggers a workflow run is either `pull_request` or `pull_request_target`."""
+        job: Optional[str] = get_env("GITHUB_JOB")
+        """The job_id of the current job."""
+        path: Path = Path(get_env("GITHUB_PATH") or "")
+        """The path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and changes for each step in a job. """
+        ref: Optional[str] = get_env("GITHUB_REF")
+        """The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by `push`, this is the branch or tag ref that was pushed. For workflows triggered by `pull_request`, this is the pull request merge branch. For workflows triggered by `release`, this is the release tag created. For other triggers, this is the branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event type. The ref given is fully-formed, meaning that for branches the format is `refs/heads/<branch_name>`, for pull requests it is `refs/pull/<pr_number>/merge`, and for tags it is `refs/tags/<tag_name>`."""
+        ref_name: Optional[str] = get_env("GITHUB_REF_NAME")
+        """The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag name shown on GitHub."""
+        ref_protected: bool = True if get_env(
+            "GITHUB_REF_PROTECTED") == "true" else False
+        """`true` if branch protections are configured for the ref that triggered the workflow run."""
+        ref_type: Optional[Literal["branch", "tag"]
+                           ] = get_env("GITHUB_REF_TYPE")
+        """The type of ref that triggered the workflow run. Valid values are `branch` or `tag`."""
+        repository: Optional[str] = get_env("GITHUB_REPOSITORY")
+        """The owner and repository name."""
+        repository_id: Optional[str] = get_env("GITHUB_REPOSITORY_ID")
+        """The ID of the repository."""
+        repository_owner: Optional[str] = get_env("GITHUB_REPOSITORY_OWNER")
+        """The repository owner's name."""
+        repository_owner_id: Optional[str] = get_env(
+            "GITHUB_REPOSITORY_OWNER_ID")
+        """The repository owner's account ID."""
+        retention_days: Optional[int] = int(
+            get_env("GITHUB_RETENTION_DAYS") or -1)
+        """The number of days that workflow run logs and artifacts are kept."""
+        run_attempt: Optional[int] = int(get_env("GITHUB_RUN_ATTEMPT") or -1)
+        """A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run."""
+        run_id: Optional[int] = int(get_env("GITHUB_RUN_ID") or -1)
+        """A unique number for each workflow run within a repository. This number does not change if you re-run the workflow run."""
+        run_number: Optional[int] = int(get_env("GITHUB_RUN_NUMBER") or -1)
+        """A unique number for each run of a particular workflow in a repository. This number begins at 1 for the workflow's first run, and increments with each new run. This number does not change if you re-run the workflow run."""
+        server_url: Union[ParseResult, ParseResultBytes] = urlparse(
+            get_env("GITHUB_SERVER_URL"))
+        """The URL of the GitHub server."""
+        sha: Optional[str] = get_env("GITHUB_SHA")
+        """The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see "Events that trigger workflows.\""""
+        step_summary: Optional[str] = get_env("GITHUB_STEP_SUMMARY")
+        """The path on the runner to the file that contains job summaries from workflow commands. This file is unique to the current step and changes for each step in a job."""
+        workflow: Optional[str] = get_env("GITHUB_WORKFLOW")
+        """The name of the workflow."""
+        workflow_ref: Optional[str] = get_env("GITHUB_WORKFLOW_REF")
+        """The ref path to the workflow."""
+        workflow_sha: Optional[str] = get_env("GITHUB_WORKFLOW_SHA")
+        """The commit SHA for the workflow file."""
+        workspace: Optional[str] = get_env("GITHUB_WORKSPACE")
+        """The default working directory on the runner for steps, and the default location of your repository when using the `checkout` action."""
+
+    @dataclass(frozen=True)
+    class runner():
+        """Various information about the runner executing the job."""
+        arch: Optional[Literal["X86", "X64", "ARM", "ARM64"]
+                       ] = get_env("RUNNER_ARCH")
+        """The architecture of the runner executing the job. Possible values are `X86`, `X64`, `ARM`, or `ARM64`."""
+        debug: Optional[int] = int(get_env("RUNNER_DEBUG") or -1)
+        """This is set only if debug logging is enabled, and always has the value of `1`. It can be useful as an indicator to enable additional debugging or verbose logging in your own job steps."""
+        name: Optional[str] = get_env("RUNNER_NAME")
+        """The name of the runner executing the job."""
+        os: Optional[Literal["Linux", "Windows", "macOS"]
+                     ] = get_env("RUNNER_OS")
+        """The operating system of the runner executing the job. Possible values are `Linux`, `Windows`, or `macOS`."""
+        temp: Path = Path(get_env("RUNNER_TEMP") or "")
+        """The path to a temporary directory on the runner. This directory is emptied at the beginning and end of each job. Note that files will not be removed if the runner's user account does not have permission to delete them."""