pw_build/py/host_tool.py

# Copyright 2019 The Pigweed Authors
#
# 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
#
#     https://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.
"""Copies built host tools into Pigweed's host_tools directory."""

import argparse
import logging
import os
import shutil
import sys
from typing import Optional

import pw_cli.log

_LOG = logging.getLogger(__name__)


def argument_parser(
    parser: Optional[argparse.ArgumentParser] = None
) -> argparse.ArgumentParser:
    """Registers the script's arguments on an argument parser."""

    if parser is None:
        parser = argparse.ArgumentParser(description=__doc__)

    parser.add_argument('--dst',
                        required=True,
                        help='Path to host tools directory')
    parser.add_argument('--name', help='Name for the installed tool')
    parser.add_argument('--src',
                        required=True,
                        help='Path to host tool executable')

    return parser


def main() -> int:
    args = argument_parser().parse_args()

    if not os.path.isfile(args.src):
        _LOG.error('%s is not a file', args.src)
        return 1

    os.makedirs(args.dst, exist_ok=True)

    if args.name is not None:
        if '/' in args.name:
            _LOG.error('Host tool name cannot contain "/"')
            return 1
        args.dst = os.path.join(args.dst, args.name)

    shutil.copy2(args.src, args.dst)
    return 0


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