]> git.ozlabs.org Git - next-scripts/blob - check_fixes
check_fixes: try harder to find a valid SHA1
[next-scripts] / check_fixes
1 #!/bin/bash
2
3 if [ "$#" -lt 1 ]; then
4         printf 'Usage: %s <commit range>\n', "$0" 1>&2
5         exit 1
6 fi
7
8 commits=$(git rev-list --no-merges -i --grep='^[[:space:]]*Fixes:' "$@")
9 if [ -z "$commits" ]; then
10         exit 0
11 fi
12
13 # This should be a git tree that contains *only* Linus' tree
14 Linus_tree="${HOME}/kernels/linus.git"
15 split_re1='^([[:xdigit:]]{5,})[[:space:]]+(.*)$'
16 split_re2='^([[:xdigit:]]{5,})[[:space:]]*(.*)$'
17 split_re3='^([Cc][Oo][Mm][Mm][Ii][Tt])[[:space:]]*([[:xdigit:]]{5,})[[:space:]]*(.*)$'
18 nl=$'\n'
19
20 # Strip the leading and training spaces from a string
21 strip_spaces()
22 {
23         [[ "$1" =~ ^[[:space:]]*(.*[^[:space:]])[[:space:]]*$ ]]
24         echo "${BASH_REMATCH[1]}"
25 }
26
27 for c in $commits; do
28
29         commit_log=$(git log -1 --format='%h ("%s")' "$c")
30         commit_msg="In commit
31
32   $commit_log
33
34 "
35
36         fixes_lines=$(git log -1 --format='%B' "$c" |
37                         grep -i '^[[:space:]]*Fixes:')
38
39         while read -r fline; do
40                 [[ "$fline" =~ ^[[:space:]]*[Ff][Ii][Xx][Ee][Ss]:[[:space:]]*(.*)$ ]]
41                 f="${BASH_REMATCH[1]}"
42                 fixes_msg="Fixes tag
43
44   $fline
45
46 has these problem(s):
47
48 "
49                 sha=
50                 subject=
51                 msg=
52                 [[ "$f" =~ $split_re1 ]]
53                 sha="${BASH_REMATCH[1]}"
54                 subject="${BASH_REMATCH[2]}"
55
56                 if [ -z "$sha" ]; then
57                         [[ "$f" =~ $split_re2 ]]
58                         sha="${BASH_REMATCH[1]}"
59                         subject="${BASH_REMATCH[2]}"
60                         if [ -z "$sha" ]; then
61                                 [[ "$f" =~ $split_re3 ]]
62                                 sha="${BASH_REMATCH[2]}"
63                                 subject="${BASH_REMATCH[3]}"
64                                 msg="${msg:+${msg}${nl}}  - leading word '${BASH_REMATCH[1]}' unexpected"
65                         fi
66                 fi
67                 if [ -z "$sha" ]; then
68                         printf '%s%s  - %s\n' "$commit_msg" "$fixes_msg" 'No SHA1 recognised'
69                         commit_msg=''
70                         continue
71                 fi
72                 if ! git rev-parse -q --verify "$sha" >/dev/null; then
73                         printf '%s%s  - %s\n' "$commit_msg" "$fixes_msg" 'Target SHA1 does not exist'
74                         commit_msg=''
75                         continue
76                 fi
77
78                 if [ "${#sha}" -lt 12 ]; then
79                         msg="${msg:+${msg}${nl}}  - SHA1 should be at least 12 digits long"
80                 fi
81                 # reduce the subject to the part between () if there
82                 if [[ "$subject" =~ ^\((.*)\) ]]; then
83                         subject="${BASH_REMATCH[1]}"
84                 elif [[ "$subject" =~ ^\((.*) ]]; then
85                         subject="${BASH_REMATCH[1]}"
86                         msg="${msg:+${msg}${nl}}  - Subject has leading but no trailing parentheses"
87                 fi
88
89                 # strip matching quotes at the start and end of the subject
90                 # the unicode characters in the classes are
91                 # U+201C LEFT DOUBLE QUOTATION MARK
92                 # U+201D RIGHT DOUBLE QUOTATION MARK
93                 # U+2018 LEFT SINGLE QUOTATION MARK
94                 # U+2019 RIGHT SINGLE QUOTATION MARK
95                 re1=$'^[\"\u201C](.*)[\"\u201D]$'
96                 re2=$'^[\'\u2018](.*)[\'\u2019]$'
97                 re3=$'^[\"\'\u201C\u2018](.*)$'
98                 if [[ "$subject" =~ $re1 ]]; then
99                         subject="${BASH_REMATCH[1]}"
100                 elif [[ "$subject" =~ $re2 ]]; then
101                         subject="${BASH_REMATCH[1]}"
102                 elif [[ "$subject" =~ $re3 ]]; then
103                         subject="${BASH_REMATCH[1]}"
104                         msg="${msg:+${msg}${nl}}  - Subject has leading but no trailing quotes"
105                 fi
106
107                 subject=$(strip_spaces "$subject")
108
109                 target_subject=$(git log -1 --format='%s' "$sha")
110                 target_subject=$(strip_spaces "$target_subject")
111
112                 # match with ellipses
113                 case "$subject" in
114                 *...)   subject="${subject%...}"
115                         target_subject="${target_subject:0:${#subject}}"
116                         ;;
117                 ...*)   subject="${subject#...}"
118                         target_subject="${target_subject: -${#subject}}"
119                         ;;
120                 *\ ...\ *)
121                         s1="${subject% ... *}"
122                         s2="${subject#* ... }"
123                         subject="$s1 $s2"
124                         t1="${target_subject:0:${#s1}}"
125                         t2="${target_subject: -${#s2}}"
126                         target_subject="$t1 $t2"
127                         ;;
128                 esac
129                 subject=$(strip_spaces "$subject")
130                 target_subject=$(strip_spaces "$target_subject")
131
132                 if [ "$subject" != "${target_subject:0:${#subject}}" ]; then
133                         msg="${msg:+${msg}${nl}}  - Subject does not match target commit subject"
134                 fi
135                 lsha=$(cd "$Linus_tree" && git rev-parse -q --verify "$sha")
136                 if [ -z "$lsha" ]; then
137                         count=$(git rev-list --count "$sha".."$c")
138                         if [ "$count" -eq 0 ]; then
139                                 msg="${msg:+${msg}${nl}}  - Target is not an ancestor of this commit"
140                         fi
141                 fi
142                 if [ "$msg" ]; then
143                         printf '%s%s%s\n' "$commit_msg" "$fixes_msg" "$msg"
144                         commit_msg=''
145                 fi
146         done <<< "$fixes_lines"
147 done
148
149 exit 0