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