Autolabeler for PRs (#5149)

import os

import re as rgx

from requests import get, post

from requests import Response

from requests.exceptions import HTTPError, RequestException

import sys

# Constants

GITHUB_TOKEN=os.environ["GITHUB_TOKEN"]

GITHUB_API_URL=os.environ["GITHUB_API_URL"]

GITHUB_SHA=os.environ["GITHUB_SHA"]

BASE_URL=f'{GITHUB_API_URL}/repos/DOI_USGS/ISIS3'

PULLS_URL=f'{BASE_URL}/pulls'

COMMITS_URL=f'{BASE_URL}/commits'

ISSUES_URL=f'{BASE_URL}/issues'

HEADERS = {

    "Accept": "application/vnd.github+json",

    "Authorization" : f"Bearer {GITHUB_TOKEN}",

    "X-GitHub-Api-Version": "2022-11-28"

}

def get_prs_associated_with_commit() -> Response:

    """

    Get list of PRs associated with commit.

    """

    try:

        response = get(f'{COMMITS_URL}/{GITHUB_SHA}/pulls', headers=HEADERS)

        response.raise_for_status()

        return response

    except HTTPError as he:

        raise HTTPError("HTTPError in retrieving list of PRs", he) 

    except RequestException as re:

        raise RequestException("Unable to retrieve list of PRs associated with commit.", re)

def get_pr_attributes(response: Response) -> tuple:

    """

    Get necessary PR attributes.

    """

    pull_response_json = response.json()

    if len(pull_response_json) == 0:

        # No PRs attributed to the commit

        print(False)

        sys.exit(0)

    pull_number = pull_response_json[0].get("number")

    pull_body = pull_response_json[0].get("body")

    return (pull_number, pull_body)

def search_for_linked_issues(pull_body: str) -> list:

    """

    Search for linked issues in PR body.

    Regex examples:

    '#1' - matches

    '#123456' - matches

    '# 123' - fails

    '#ABC' - fails

    '## ABC'- fails

    """

    linked_issues = rgx.findall('#[^\D]\d*', pull_body)

    issue_numbers = []

    for linked_issue in linked_issues:

        # Strip linked issue text of '#'

        issue_numbers.append(linked_issue.replace('#',''))

    return issue_numbers

def get_linked_issues(issue_numbers: list) -> list:

    """

    Verify issues exists and has labels.

    """

    response_list = []

    for issue_number in issue_numbers:

        # Get labels from issue

        try:

            response = get(f'{ISSUES_URL}/{issue_number}', headers=HEADERS)

            response.raise_for_status()

            response_list.append(response)

        except HTTPError as he:

            raise HTTPError("HTTPError in retrieving issues", he)

        except RequestException as re:

            raise RequestException("Unable to retrieve issues.", re)

    return response_list

def get_issue_labels(response_list: list) -> list:

    """

    Get labels from all linked issues.

    """

    combined_issue_labels = []

    for response in response_list:

        # Combine labels into a list

        issue_response_json = response.json()

        issue_labels = issue_response_json.get("labels")

        for issue_label in issue_labels:

            # Get name of each label object

            label_name = issue_label.get("name")

            if label_name not in combined_issue_labels:

                # Add label if it does not exist

                combined_issue_labels.append(label_name)

    if not combined_issue_labels:

        # No labels to return

        print(False)

        sys.exit(0)

    return combined_issue_labels

def update_pr_labels(pull_number: str, combined_issue_labels: list):

    """

    Update pull request with labels

    # Source: https://stackoverflow.com/q/68459601

    """

    # Convert label list into JSON-formatted dict

    labels_data = {"labels": combined_issue_labels}

    try:

        response = post(f'{ISSUES_URL}/{pull_number}/labels', json=labels_data, headers=HEADERS)

        response.raise_for_status()

    except HTTPError as he:

        raise HTTPError("HTTPError in updating PR.", he)

    except RequestException as re:

        raise RequestException("Unable to update PR.", re)

def get_pr(pull_number: str) -> Response:

    """

    Get pull request

    """

    try:

        response = get(f'{PULLS_URL}/{pull_number}', headers=HEADERS)

        response.raise_for_status()

        return response

    except HTTPError as he:

        raise HTTPError("HTTPError in retrieving issues", he)

    except RequestException as re:

        raise RequestException("Unable to retrieve issues.", re)

def is_pr_bugfix(response: Response) -> bool:

    """

    Check PR label for 'bug'

    """

    labels = response.json().get("labels")

    for label in labels:

        if label.get("name") == "bug":

            return True

    return False

if __name__ == "__main__":

    try:

        # Update PR labels

        response = get_prs_associated_with_commit()

        pull_number, pull_body = get_pr_attributes(response)

        issue_numbers = search_for_linked_issues(pull_body)

        response_list = get_linked_issues(issue_numbers)

        combined_issue_labels = get_issue_labels(response_list)

        update_pr_labels(pull_number, combined_issue_labels)

        # Check if PR is a bugfix

        response = get_pr(pull_number)

        print(is_pr_bugfix(response))

    except (HTTPError, RequestException):

        raise

requests==2.28.2

 No newline at end of file

  # Check if the PR is a bugfix

  check_labels:

    runs-on: ubuntu-latest

    permissions:

      pull-requests: write

    name: Check PR labels action step

    # Make the output of this job available to other jobs

    outputs: 

      result: ${{steps.check_pr_labels.outputs.result}}

      result: ${{steps.execute_py_script.outputs.result}}

    steps:

    - id: check_pr_labels

      uses: 3pointer/check-pr-labels-on-push-action@v1.0.3

    - name: checkout repo content

      uses: actions/checkout@v2 # checkout the repository content

    - name: setup python

      uses: actions/setup-python@v4

      with:

        github-token: ${{ secrets.GITHUB_TOKEN }}

        labels: '["bug"]'

        python-version: '3.10'

        cache: 'pip'

    - name: install python packages

      run: |

        python -m pip install --upgrade pip

        pip install -r ./.github/requirements.txt

    - name: Set output

      id: execute_py_script

      env:

        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        GITHUB_API_URL: ${{ secrets.GITHUB_API_URL }}

        GITHUB_SHA: ${{ secrets.GITHUB_SHA }}

      run: |

        echo "result=$(python ./.github/pr_label_checker.py)" >> $GITHUB_OUTPUT

    # Print the result to the log

    - name: See result

      run: echo "${{ steps.check_pr_labels.outputs.result }}"

      run: echo "${{ steps.execute_py_script.outputs.result }}"

  release_pull_request:

    needs: check_labels

    # Only run this step if the code was a bugfix