1#!/usr/bin/env python
2#===----------------------------------------------------------------------===##
3#
4# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5# See https://llvm.org/LICENSE.txt for license information.
6# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7#
8#===----------------------------------------------------------------------===##
9
10"""
11Runs an executable on a remote host.
12
13This is meant to be used as an executor when running the C++ Standard Library
14conformance test suite.
15"""
16
17import argparse
18import os
19import posixpath
20import shlex
21import subprocess
22import sys
23import tarfile
24import tempfile
25
26try:
27   from shlex import quote as cmd_quote
28except ImportError:
29   # for Python 2 compatibility
30   from pipes import quote as cmd_quote
31
32def ssh(args, command):
33    cmd = ['ssh', '-oBatchMode=yes']
34    if args.extra_ssh_args is not None:
35        cmd.extend(shlex.split(args.extra_ssh_args))
36    return cmd + [args.host, command]
37
38
39def scp(args, src, dst):
40    cmd = ['scp', '-q', '-oBatchMode=yes']
41    if args.extra_scp_args is not None:
42        cmd.extend(shlex.split(args.extra_scp_args))
43    return cmd + [src, '{}:{}'.format(args.host, dst)]
44
45
46def main():
47    parser = argparse.ArgumentParser()
48    parser.add_argument('--host', type=str, required=True)
49    parser.add_argument('--execdir', type=str, required=True)
50    parser.add_argument('--tempdir', type=str, required=False, default='/tmp')
51    parser.add_argument('--extra-ssh-args', type=str, required=False)
52    parser.add_argument('--extra-scp-args', type=str, required=False)
53    parser.add_argument('--codesign_identity', type=str, required=False, default=None)
54    parser.add_argument('--env', type=str, nargs='*', required=False, default=dict())
55    parser.add_argument("command", nargs=argparse.ONE_OR_MORE)
56    args = parser.parse_args()
57    commandLine = args.command
58
59    # Create a temporary directory where the test will be run.
60    # That is effectively the value of %T on the remote host.
61    tmp = subprocess.check_output(ssh(args, 'mktemp -d {}/libcxx.XXXXXXXXXX'.format(args.tempdir)), universal_newlines=True).strip()
62
63    # HACK:
64    # If an argument is a file that ends in `.tmp.exe`, assume it is the name
65    # of an executable generated by a test file. We call these test-executables
66    # below. This allows us to do custom processing like codesigning test-executables
67    # and changing their path when running on the remote host. It's also possible
68    # for there to be no such executable, for example in the case of a .sh.cpp
69    # test.
70    isTestExe = lambda exe: exe.endswith('.tmp.exe') and os.path.exists(exe)
71    pathOnRemote = lambda file: posixpath.join(tmp, os.path.basename(file))
72
73    try:
74        # Do any necessary codesigning of test-executables found in the command line.
75        if args.codesign_identity:
76            for exe in filter(isTestExe, commandLine):
77                subprocess.check_call(['xcrun', 'codesign', '-f', '-s', args.codesign_identity, exe], env={})
78
79        # tar up the execution directory (which contains everything that's needed
80        # to run the test), and copy the tarball over to the remote host.
81        try:
82            tmpTar = tempfile.NamedTemporaryFile(suffix='.tar', delete=False)
83            with tarfile.open(fileobj=tmpTar, mode='w') as tarball:
84                tarball.add(args.execdir, arcname=os.path.basename(args.execdir))
85
86            # Make sure we close the file before we scp it, because accessing
87            # the temporary file while still open doesn't work on Windows.
88            tmpTar.close()
89            remoteTarball = pathOnRemote(tmpTar.name)
90            subprocess.check_call(scp(args, tmpTar.name, remoteTarball))
91        finally:
92            # Make sure we close the file in case an exception happens before
93            # we've closed it above -- otherwise close() is idempotent.
94            tmpTar.close()
95            os.remove(tmpTar.name)
96
97        # Untar the dependencies in the temporary directory and remove the tarball.
98        remoteCommands = [
99            'tar -xf {} -C {} --strip-components 1'.format(remoteTarball, tmp),
100            'rm {}'.format(remoteTarball)
101        ]
102
103        # Make sure all test-executables in the remote command line have 'execute'
104        # permissions on the remote host. The host that compiled the test-executable
105        # might not have a notion of 'executable' permissions.
106        for exe in map(pathOnRemote, filter(isTestExe, commandLine)):
107            remoteCommands.append('chmod +x {}'.format(exe))
108
109        # Execute the command through SSH in the temporary directory, with the
110        # correct environment. We tweak the command line to run it on the remote
111        # host by transforming the path of test-executables to their path in the
112        # temporary directory on the remote host.
113        commandLine = (pathOnRemote(x) if isTestExe(x) else x for x in commandLine)
114        remoteCommands.append('cd {}'.format(tmp))
115        if args.env:
116            remoteCommands.append('export {}'.format(cmd_quote(' '.join(args.env))))
117        remoteCommands.append(subprocess.list2cmdline(commandLine))
118
119        # Finally, SSH to the remote host and execute all the commands.
120        rc = subprocess.call(ssh(args, ' && '.join(remoteCommands)))
121        return rc
122
123    finally:
124        # Make sure the temporary directory is removed when we're done.
125        subprocess.check_call(ssh(args, 'rm -r {}'.format(tmp)))
126
127
128if __name__ == '__main__':
129    exit(main())
130