1#!/usr/bin/env python
2#
3# Copyright (C) 2017 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#
17"""Installs VNDK snapshot under prebuilts/vndk/v{version}."""
18
19import argparse
20import glob
21import logging
22import os
23import re
24import shutil
25import subprocess
26import sys
27import tempfile
28import textwrap
29
30import utils
31
32from check_gpl_license import GPLChecker
33from gen_buildfiles import GenBuildFile
34
35ANDROID_BUILD_TOP = utils.get_android_build_top()
36PREBUILTS_VNDK_DIR = utils.join_realpath(ANDROID_BUILD_TOP, 'prebuilts/vndk')
37
38
39def start_branch(build):
40    branch_name = 'update-' + (build or 'local')
41    logging.info('Creating branch {branch} in {dir}'.format(
42        branch=branch_name, dir=os.getcwd()))
43    utils.check_call(['repo', 'start', branch_name, '.'])
44
45
46def remove_old_snapshot(install_dir):
47    logging.info('Removing any old files in {}'.format(install_dir))
48    for file in glob.glob('{}/*'.format(install_dir)):
49        try:
50            if os.path.isfile(file):
51                os.unlink(file)
52            elif os.path.isdir(file):
53                shutil.rmtree(file)
54        except Exception as error:
55            logging.error('Error: {}'.format(error))
56            sys.exit(1)
57
58
59def install_snapshot(branch, build, local_dir, install_dir, temp_artifact_dir):
60    """Installs VNDK snapshot build artifacts to prebuilts/vndk/v{version}.
61
62    1) Fetch build artifacts from Android Build server or from local_dir
63    2) Unzip build artifacts
64
65    Args:
66      branch: string or None, branch name of build artifacts
67      build: string or None, build number of build artifacts
68      local_dir: string or None, local dir to pull artifacts from
69      install_dir: string, directory to install VNDK snapshot
70      temp_artifact_dir: string, temp directory to hold build artifacts fetched
71        from Android Build server. For 'local' option, is set to None.
72    """
73    artifact_pattern = 'android-vndk-*.zip'
74
75    if branch and build:
76        artifact_dir = temp_artifact_dir
77        os.chdir(temp_artifact_dir)
78        logging.info('Fetching {pattern} from {branch} (bid: {build})'.format(
79            pattern=artifact_pattern, branch=branch, build=build))
80        utils.fetch_artifact(branch, build, artifact_pattern)
81
82        manifest_pattern = 'manifest_{}.xml'.format(build)
83        logging.info('Fetching {file} from {branch} (bid: {build})'.format(
84            file=manifest_pattern, branch=branch, build=build))
85        utils.fetch_artifact(branch, build, manifest_pattern,
86                             utils.MANIFEST_FILE_NAME)
87
88        os.chdir(install_dir)
89    elif local_dir:
90        logging.info('Fetching local VNDK snapshot from {}'.format(local_dir))
91        artifact_dir = local_dir
92
93    artifacts = glob.glob(os.path.join(artifact_dir, artifact_pattern))
94    for artifact in artifacts:
95        logging.info('Unzipping VNDK snapshot: {}'.format(artifact))
96        utils.check_call(['unzip', '-qn', artifact, '-d', install_dir])
97
98
99def gather_notice_files(install_dir):
100    """Gathers all NOTICE files to a common NOTICE_FILES directory."""
101
102    common_notices_dir = utils.NOTICE_FILES_DIR_PATH
103    logging.info('Creating {} directory to gather all NOTICE files...'.format(
104        common_notices_dir))
105    os.makedirs(common_notices_dir)
106    for arch in utils.get_snapshot_archs(install_dir):
107        notices_dir_per_arch = os.path.join(arch, utils.NOTICE_FILES_DIR_NAME)
108        if os.path.isdir(notices_dir_per_arch):
109            for notice_file in glob.glob(
110                    '{}/*.txt'.format(notices_dir_per_arch)):
111                if not os.path.isfile(
112                        os.path.join(common_notices_dir,
113                                     os.path.basename(notice_file))):
114                    shutil.copy(notice_file, common_notices_dir)
115            shutil.rmtree(notices_dir_per_arch)
116
117
118def post_processe_files_if_needed(vndk_version):
119    """For O-MR1, replaces unversioned VNDK directories with versioned ones.
120    Also, renames ld.config.txt, llndk.libraries.txt and vndksp.libraries.txt
121    files to have version suffix.
122
123    Unversioned VNDK directories: /system/${LIB}/vndk[-sp]
124    Versioned VNDK directories: /system/${LIB}/vndk[-sp]-27
125
126    Args:
127      vndk_version: int, version of VNDK snapshot
128    """
129    def add_version_suffix(file_name):
130        logging.info('Rename {} to have version suffix'.format(vndk_version))
131        target_files = glob.glob(
132            os.path.join(utils.CONFIG_DIR_PATH_PATTERN, file_name))
133        for target_file in target_files:
134            name, ext = os.path.splitext(target_file)
135            os.rename(target_file, name + '.' + str(vndk_version) + ext)
136    if vndk_version == 27:
137        logging.info('Revising ld.config.txt for O-MR1...')
138        re_pattern = '(system\/\${LIB}\/vndk(?:-sp)?)([:/]|$)'
139        VNDK_INSTALL_DIR_RE = re.compile(re_pattern, flags=re.MULTILINE)
140        ld_config_txt_paths = glob.glob(
141            os.path.join(utils.CONFIG_DIR_PATH_PATTERN, 'ld.config*'))
142        for ld_config_file in ld_config_txt_paths:
143            with open(ld_config_file, 'r') as file:
144                revised = VNDK_INSTALL_DIR_RE.sub(r'\1-27\2', file.read())
145            with open(ld_config_file, 'w') as file:
146                file.write(revised)
147
148        files_to_add_version_suffix = ('ld.config.txt',
149                                       'llndk.libraries.txt',
150                                       'vndksp.libraries.txt')
151        for file_to_rename in files_to_add_version_suffix:
152            add_version_suffix(file_to_rename)
153
154    files_to_enforce_version_suffix = ('vndkcore.libraries.txt',
155                                       'vndkprivate.libraries.txt')
156    for file_to_rename in files_to_enforce_version_suffix:
157        add_version_suffix(file_to_rename)
158
159
160def update_buildfiles(buildfile_generator):
161    logging.info('Generating root Android.bp file...')
162    buildfile_generator.generate_root_android_bp()
163
164    logging.info('Generating common/Android.bp file...')
165    buildfile_generator.generate_common_android_bp()
166
167    logging.info('Generating Android.bp files...')
168    buildfile_generator.generate_android_bp()
169
170
171def check_gpl_license(license_checker):
172    try:
173        license_checker.check_gpl_projects()
174    except ValueError as error:
175        logging.error('***CANNOT INSTALL VNDK SNAPSHOT***: {}'.format(error))
176        raise
177
178
179def commit(branch, build, version):
180    logging.info('Making commit...')
181    utils.check_call(['git', 'add', '.'])
182    message = textwrap.dedent("""\
183        Update VNDK snapshot v{version} to build {build}.
184
185        Taken from branch {branch}.""").format(
186        version=version, branch=branch, build=build)
187    utils.check_call(['git', 'commit', '-m', message])
188
189
190def get_args():
191    parser = argparse.ArgumentParser()
192    parser.add_argument(
193        'vndk_version',
194        type=int,
195        help='VNDK snapshot version to install, e.g. "27".')
196    parser.add_argument('-b', '--branch', help='Branch to pull build from.')
197    parser.add_argument('--build', help='Build number to pull.')
198    parser.add_argument(
199        '--local',
200        help=('Fetch local VNDK snapshot artifacts from specified local '
201              'directory instead of Android Build server. '
202              'Example: --local=/path/to/local/dir'))
203    parser.add_argument(
204        '--use-current-branch',
205        action='store_true',
206        help='Perform the update in the current branch. Do not repo start.')
207    parser.add_argument(
208        '--remote',
209        default='aosp',
210        help=('Remote name to fetch and check if the revision of VNDK snapshot '
211              'is included in the source to conform GPL license. default=aosp'))
212    parser.add_argument(
213        '-v',
214        '--verbose',
215        action='count',
216        default=0,
217        help='Increase output verbosity, e.g. "-v", "-vv".')
218    return parser.parse_args()
219
220
221def main():
222    """Program entry point."""
223    args = get_args()
224
225    local = None
226    if args.local:
227        local = os.path.expanduser(args.local)
228
229    if local:
230        if args.build or args.branch:
231            raise ValueError(
232                'When --local option is set, --branch or --build cannot be '
233                'specified.')
234        elif not os.path.isdir(local):
235            raise RuntimeError(
236                'The specified local directory, {}, does not exist.'.format(
237                    local))
238    else:
239        if not (args.build and args.branch):
240            raise ValueError(
241                'Please provide both --branch and --build or set --local '
242                'option.')
243
244    vndk_version = args.vndk_version
245
246    install_dir = os.path.join(PREBUILTS_VNDK_DIR, 'v{}'.format(vndk_version))
247    if not os.path.isdir(install_dir):
248        raise RuntimeError(
249            'The directory for VNDK snapshot version {ver} does not exist.\n'
250            'Please request a new git project for prebuilts/vndk/v{ver} '
251            'before installing new snapshot.'.format(ver=vndk_version))
252
253    utils.set_logging_config(args.verbose)
254
255    os.chdir(install_dir)
256
257    if not args.use_current_branch:
258        start_branch(args.build)
259
260    remove_old_snapshot(install_dir)
261    os.makedirs(utils.COMMON_DIR_PATH)
262
263    temp_artifact_dir = None
264    if not local:
265        temp_artifact_dir = tempfile.mkdtemp()
266
267    try:
268        install_snapshot(args.branch, args.build, local, install_dir,
269                         temp_artifact_dir)
270        gather_notice_files(install_dir)
271        post_processe_files_if_needed(vndk_version)
272
273        buildfile_generator = GenBuildFile(install_dir, vndk_version)
274        update_buildfiles(buildfile_generator)
275
276        if not local:
277            license_checker = GPLChecker(install_dir, ANDROID_BUILD_TOP,
278                                         temp_artifact_dir, args.remote)
279            check_gpl_license(license_checker)
280            logging.info(
281                'Successfully updated VNDK snapshot v{}'.format(vndk_version))
282    except Exception as error:
283        logging.error('FAILED TO INSTALL SNAPSHOT: {}'.format(error))
284        raise
285    finally:
286        if temp_artifact_dir:
287            logging.info(
288                'Deleting temp_artifact_dir: {}'.format(temp_artifact_dir))
289            shutil.rmtree(temp_artifact_dir)
290
291    if not local:
292        commit(args.branch, args.build, vndk_version)
293        logging.info(
294            'Successfully created commit for VNDK snapshot v{}'.format(
295                vndk_version))
296
297    logging.info('Done.')
298
299
300if __name__ == '__main__':
301    main()
302