summaryrefslogtreecommitdiff
path: root/scripts/check-pr-title-and-commit-messages.py
blob: 8fe3ca791cfc5b238f686193aa7b8ed217c44aae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#!/usr/bin/env python3

import re
import sys
import time

import requests

# Use the same regex for PR title and commit messages for now
title_regex = r'^(([a-zA-Z\-_.]+:\s)?)T\d+:\s+[^\s]+.*'
commit_regex = title_regex


def check_pr_title(title):
    if not re.match(title_regex, title):
        print(f"PR title '{title}' does not match the required format!")
        print("Valid title example: T99999: make IPsec secure")
        sys.exit(1)


def check_commit_message(title):
    if not re.match(commit_regex, title):
        print("Commit title '{title}' does not match the required format!")
        print("Valid title example: T99999: make IPsec secure")
        sys.exit(1)


if __name__ == '__main__':
    if len(sys.argv) < 2:
        print("Please specify pull request URL!")
        sys.exit(1)

    # There seems to be a race condition that causes this scripts to receive
    # an incomplete PR object that is missing certain fields,
    # which causes temporary CI failures that require re-running the script
    #
    # It's probably better to add a small delay to prevent that
    time.sleep(5)

    # Get the pull request object
    pr = requests.get(sys.argv[1]).json()
    if "title" not in pr:
        print("The PR object does not have a title field!")
        print("Did not receive a valid pull request object, please check the URL!")
        sys.exit(1)

    check_pr_title(pr["title"])

    # Get the list of commits
    commits = requests.get(pr["commits_url"]).json()
    for c in commits:
        # Retrieve every individual commit and check its title
        co = requests.get(c["url"]).json()
        check_commit_message(co["commit"]["message"])