tools/run.py

#!/usr/bin/env python3
# Copyright 2025 The Dawn & Tint Authors
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import argparse
import os
import subprocess
import sys

SCRIPT_DIR = os.path.dirname(__file__)
CMD_DIR = os.path.join(SCRIPT_DIR, 'src', 'cmd')
DAWN_ROOT = os.path.realpath(os.path.join(SCRIPT_DIR, '..'))

sys.path.insert(0, DAWN_ROOT)

from tools.python import cipd_deps


def _get_available_tools() -> list[str]:
    return os.listdir(CMD_DIR)


def main() -> int:
    parser = argparse.ArgumentParser(
        description='Builds and runs the specified Go tool in //tools/src/cmd',
        add_help=False)
    parser.add_argument(
        'tool_name',
        help='The name of the tool under //tools/src/cmd to run',
        choices=_get_available_tools())
    args, unknown_args = parser.parse_known_args()

    go_binary = os.path.join(DAWN_ROOT, 'tools', 'golang',
                             cipd_deps.get_cipd_platform(), 'bin', 'go')
    if sys.platform == 'win32':
        go_binary += '.exe'

    tool_dir = os.path.relpath(os.path.join(CMD_DIR, args.tool_name),
                               DAWN_ROOT)
    # Go expects package paths relative to module root to start with './' or
    # '../'. On Windows, absolute paths starting with a drive letter (e.g.,
    # 'C:\') are mistaken by Go for package import paths. Therefore, represent
    # the package path as a relative path starting with './' and using forward
    # slashes.
    tool_dir = './' + tool_dir.replace(os.path.sep, '/')

    cmd = [
        go_binary,
        'run',
        tool_dir,
    ]
    cmd.extend(unknown_args)

    # Disable CGO since it causes problems when cross-compiling (see https://crbug.com/516926043).
    os.environ['CGO_ENABLED'] = '0'
    # Force Go modules to be ON so package imports within the dawn module
    # resolve correctly, overriding any potential system-wide or user-wide
    # environment settings like GO111MODULE=off.
    os.environ['GO111MODULE'] = 'on'

    proc = subprocess.run(cmd, check=False, cwd=DAWN_ROOT)
    return proc.returncode


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