starboard/build/copy_install_content.py

# Copyright 2022 The Cobalt Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# TODO(b/216341587): Refactor install_content to get rid of this file.

# This file is loosely based on starboard/build/copy_data.py
"""Copies all input files to the output directory.

The folder structure of the input files is maintained in the output relative
to the 'base_dir' parameter.

If the parameters `output` and `depfile` are supplied the list of copied files
will be written to `depfile` and an `output` dummy file will be created.
"""

import argparse
import os
import pathlib
import shutil
import sys


class InvalidArgumentException(Exception):
  pass


def validate_args(options):
  if not os.path.exists(options.files_list):
    raise InvalidArgumentException(f'{options.files_list} doesn\'t exist')

  # If either `depfile` and `output` is present the other one must also be.
  if bool(options.depfile) != bool(options.output):
    raise InvalidArgumentException('output and depfile must both be supplied')


def copy_files(files_to_copy, base_dir, output_dir):
  if not os.path.exists(output_dir):
    os.makedirs(output_dir)

  for path in files_to_copy:
    # All input paths must point at files.
    # TODO(b/211909342): Re-enable once lottie test files are listed.
    # if not os.path.isfile(path):
    #   raise InvalidArgumentException(path + ' is not a file.')

    # In certain cases, files would fail to open on windows if relative paths
    # were provided.  Using absolute paths fixes this.
    filename = os.path.abspath(path)

    # Get the path of the file relative to the source base_dir.
    rel_path = os.path.relpath(path, base_dir)
    output_dir = os.path.abspath(output_dir)
    # Use rel_path to preserve the input folder structure in the output.
    output_filename = os.path.abspath(os.path.join(output_dir, rel_path))

    # In cases where a directory has turned into a file or vice versa, delete it
    # before copying it below.
    if os.path.exists(output_dir) and not os.path.isdir(output_dir):
      os.remove(output_dir)
    if os.path.exists(output_filename) and os.path.isdir(output_filename):
      shutil.rmtree(output_filename)

    if not os.path.exists(os.path.dirname(output_filename)):
      os.makedirs(os.path.dirname(output_filename))

    if os.path.isfile(filename):
      shutil.copy(filename, output_filename)
    else:
      # TODO(b/211909342): Remove this branch once lottie files are listed.
      shutil.copytree(filename, output_filename)


def write_outputs(output, depfile, files):
  with open(depfile, 'w', encoding='utf-8') as f:
    f.write('{}: \\\n  {}\n'.format(output, ' \\\n  '.join(sorted(files))))
  # Touch the output file to tell ninja that the script ran successfully.
  pathlib.Path(output).touch()


def main():
  parser = argparse.ArgumentParser()
  parser.add_argument(
      '--output_dir', dest='output_dir', required=True, help='output directory')
  parser.add_argument(
      '--base_dir',
      dest='base_dir',
      required=True,
      help='source base directory')
  parser.add_argument(
      '--files_list',
      dest='files_list',
      required=True,
      help='path to file containing list of input files')
  parser.add_argument('--output', dest='output', help='dummy output file')
  parser.add_argument(
      '--depfile',
      dest='depfile',
      help='depfile to write the list of touched files to')
  options = parser.parse_args()

  validate_args(options)

  # Load file names from the file containing the list of file names.
  # The file name list must be passed in a file to due to command line limits.
  with open(options.files_list, encoding='utf-8') as input_file:
    file_names = [line.strip() for line in input_file]

  copy_files(file_names, options.base_dir, options.output_dir)

  if options.output and options.depfile:
    # If depfile and output are present write the list of files to the depfile.
    write_outputs(options.output, options.depfile, file_names)


if __name__ == '__main__':
  sys.exit(main())