xref: /llvm-project/libcxx/utils/ssh.py (revision 07e462526d0cbae40b320e1a4307ce11e197fb0a)
1#===----------------------------------------------------------------------===##
2#
3# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4# See https://llvm.org/LICENSE.txt for license information.
5# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6#
7#===----------------------------------------------------------------------===##
8
9"""
10Runs an executable on a remote host.
11
12This is meant to be used as an executor when running the C++ Standard Library
13conformance test suite.
14"""
15
16import argparse
17import os
18import subprocess
19import sys
20
21
22def main():
23    parser = argparse.ArgumentParser()
24    parser.add_argument('--host', type=str, required=True)
25    parser.add_argument('--codesign_identity', type=str, required=False)
26    parser.add_argument('--dependencies', type=str, nargs='*', required=True)
27    parser.add_argument('--env', type=str, nargs='*', required=True)
28    (args, remaining) = parser.parse_known_args(sys.argv[1:])
29
30    if len(remaining) < 2:
31        sys.stderr.write('Missing actual commands to run')
32        exit(1)
33    remaining = remaining[1:] # Skip the '--'
34
35    # HACK:
36    # If the first argument is a file that ends in `.tmp.exe`, assume it is
37    # the name of an executable generated by a test file. This allows us to
38    # do custom processing like codesigning the executable and changing its
39    # path when running on the remote host. It's possible for there to be no
40    # such executable, for example in the case of a .sh.cpp test.
41    exe = None
42    if os.path.exists(remaining[0]) and remaining[0].endswith('.tmp.exe'):
43        exe = remaining.pop(0)
44
45    # If there's an executable, do any necessary codesigning.
46    if exe and args.codesign_identity:
47        rc = subprocess.call(['xcrun', 'codesign', '-f', '-s', args.codesign_identity, exe], env={})
48        if rc != 0:
49            sys.stderr.write('Failed to codesign: {}'.format(exe))
50            return rc
51
52    ssh = lambda command: ['ssh', '-oBatchMode=yes', args.host, command]
53    scp = lambda src, dst: ['scp', '-oBatchMode=yes', '-r', src, '{}:{}'.format(args.host, dst)]
54
55    # Create a temporary directory where the test will be run
56    tmp = subprocess.check_output(ssh('mktemp -d /tmp/libcxx.XXXXXXXXXX')).strip()
57
58    # Ensure the test dependencies exist and scp them to the temporary directory.
59    # Test dependencies can be either files or directories, so the `scp` command
60    # needs to use `-r`.
61    for dep in args.dependencies:
62        if not os.path.exists(dep):
63            sys.stderr.write('Missing file or directory {} marked as a dependency of a test'.format(dep))
64            exit(1)
65        subprocess.call(scp(dep, tmp))
66
67    # If there's an executable, change its path to be in the temporary directory.
68    # We know it has been copied to the remote host when we handled the test
69    # dependencies above.
70    if exe:
71        exe = os.path.join(tmp, os.path.basename(exe))
72
73    # If there's an executable, make sure it has 'execute' permissions on the
74    # remote host. The host that compiled the executable might not have a notion
75    # of 'executable' permissions.
76    if exe:
77        subprocess.call(ssh('chmod +x {}'.format(exe)))
78
79    # Execute the command through SSH in the temporary directory, with the
80    # correct environment.
81    command = [exe] + remaining if exe else remaining
82    res = subprocess.call(ssh('cd {} && env -i {} {}'.format(tmp, ' '.join(args.env), ' '.join(command))))
83
84    # Remove the temporary directory when we're done.
85    subprocess.call(ssh('rm -r {}'.format(tmp)))
86
87    return res
88
89if __name__ == '__main__':
90    exit(main())
91