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