• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/python3
2
3#  Copyright (C) 2022 The Android Open Source Project
4#
5#  Licensed under the Apache License, Version 2.0 (the "License");
6#  you may not use this file except in compliance with the License.
7#  You may obtain a copy of the License at
8#
9#       http://www.apache.org/licenses/LICENSE-2.0
10#
11#  Unless required by applicable law or agreed to in writing, software
12#  distributed under the License is distributed on an "AS IS" BASIS,
13#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14#  See the License for the specific language governing permissions and
15#  limitations under the License.
16
17from __future__ import print_function
18
19from argparse import ArgumentParser
20import subprocess
21import sys
22
23def is_commit_msg_valid(commit_msg):
24    for line in commit_msg.splitlines():
25        line = line.strip().lower()
26        if line.startswith('updated-overlayable'):
27            return True
28
29    return False
30
31def is_in_aosp():
32    branches = subprocess.check_output(['git', 'branch', '-vv']).splitlines()
33
34    for branch in branches:
35        # current branch starts with a '*'
36        if branch.startswith(b'*'):
37            return b'[aosp/' in branch
38
39    # otherwise assume in AOSP
40    return True
41
42def get_changed_resource_file(base_dir, commit_files):
43    config_file = base_dir + "values/config.xml"
44    string_file = base_dir + "values/strings.xml"
45    styles_file = base_dir + "values/styles.xml"
46    drawable_dir = base_dir + "drawable/"
47    layout_dir = base_dir + "layout/"
48
49    for commit_file in commit_files:
50        if commit_file == config_file:
51            return commit_file
52        if commit_file == string_file:
53            return commit_file
54        if commit_file == styles_file:
55            return commit_file
56        if commit_file.startswith(drawable_dir):
57            return commit_file
58        if commit_file.startswith(layout_dir):
59            return commit_file
60    return None
61
62
63
64
65def main():
66    parser = ArgumentParser(description='Check if the overlayable file has been updated')
67    parser.add_argument('commit_msg', type=str, help='commit message')
68    parser.add_argument('commit_files', type=str, nargs='*', help='files changed in the commit')
69    args = parser.parse_args()
70
71    base_dir = "service/ServiceWifiResources/res/"
72    overlay_file = base_dir + "values/overlayable.xml"
73    commit_msg = args.commit_msg
74    commit_files = args.commit_files
75
76    if is_in_aosp():
77        return 0
78
79    changed_file = get_changed_resource_file(base_dir, commit_files)
80
81    if not changed_file:
82        return 0
83
84    if is_commit_msg_valid(commit_msg):
85        return 0
86
87    print('This commit has changed: "{changed_file}".'.format(changed_file=changed_file))
88    print()
89    print('If this change added/changed/removed overlayable resources used by the Wifi Module, ')
90    print('please update the "{overlay_file}".'.format(overlay_file=overlay_file))
91    print('and acknowledge you have done so by adding this line to your commit message:')
92    print()
93    print('Updated-Overlayable: TRUE')
94    print()
95    print('Otherwise, please explain why the Overlayable does not need to be updated:')
96    print()
97    print('Updated-Overlayable: Not applicable - changing default value')
98    print()
99    return 1
100
101
102if __name__ == '__main__':
103    exit_code = main()
104    sys.exit(exit_code)