ppsspp/Tools/adhoc_multi.py

#!/usr/bin/env python3
# Runs a multi-console ad hoc pspautotest on several PPSSPPHeadless instances at once, the way
# tests/net/adhoc/pair/record.py runs it on several PSPs.
#
# A test NAME is a set of programs NAME_host.prx, NAME_client.prx, NAME_client2.prx, ... with an
# .expected each. The host runs as instance 1 with the built-in ad hoc server, each client as the next
# instance, all at PSP speed (--realtime) since they wait for each other over the network. Instance N
# binds to 127.0.0.N, so on macOS the loopback aliases have to exist first:
#   sudo ifconfig lo0 alias 127.0.0.2 up   (and .3, .4, ... for more clients)
#
# With --relay, the instances use the relay in relay mode (on 27313, next to adhocctl on 27312). The host's
# built-in server runs one, unless an aemu_postoffice server is already running on this machine (see
# ext/aemu_postoffice/hosting.md). The relay tells players apart by MAC, so they can all share 127.0.0.1
# and no aliases are needed.
#
# The instances are kept within an emulated millisecond of each other (--sync-file), so one running
# slower than the others on a busy machine holds them back instead of falling behind; --no-sync turns
# that off.
#
# Usage: python3 Tools/adhoc_multi.py [--headless PATH] [--relay] [--no-sync] net/adhoc/pair/basic [more tests...]

import argparse
import os
import random
import re
import socket
import subprocess
import sys
import tempfile
import time

ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
TESTS_DIR = os.path.join(ROOT, "pspautotests", "tests")
TIMEOUT = 120


def find_headless():
	candidates = []
	for d in os.listdir(ROOT):
		for name in ("PPSSPPHeadless", "PPSSPPHeadless.exe"):
			path = os.path.join(ROOT, d, name)
			if d.startswith("build") and os.path.isfile(path):
				candidates.append(path)
	if not candidates:
		sys.exit("No PPSSPPHeadless found in build*/; pass --headless")
	return max(candidates, key=os.path.getmtime)


def roles_of(test):
	base = os.path.join(TESTS_DIR, test)
	roles = ["host", "client"]
	n = 2
	while os.path.exists("%s_client%d.prx" % (base, n)):
		roles.append("client%d" % n)
		n += 1
	for role in roles:
		if not os.path.exists("%s_%s.prx" % (base, role)):
			sys.exit("Missing %s_%s.prx" % (test, role))
	return roles


RELAY_INI = """[Network]
proAdhocServer = 127.0.0.1
AdhocServerRelayMode = 1
"""


def wait_for_server(port=27312, timeout=5.0):
	# The clients log in to the host's built-in ad hoc server as they start, so it has to be listening
	# by then. (Emulated time doesn't need the host to start first: the instance sync holds it back.)
	give_up = time.time() + timeout
	while time.time() < give_up:
		try:
			socket.create_connection(("127.0.0.1", port), timeout=0.1).close()
			return
		except OSError:
			time.sleep(0.01)


def missing_loopback_aliases(count):
	# In P2P mode instance N binds to 127.0.0.N. Linux and Windows route all of 127/8 to the loopback;
	# macOS only has the addresses that were added.
	missing = []
	for n in range(2, count + 1):
		s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
		try:
			s.bind(("127.0.0.%d" % n, 0))
		except OSError:
			missing.append("127.0.0.%d" % n)
		finally:
			s.close()
	return missing


def run_test(headless, test, extra, relay_ini, sync):
	roles = roles_of(test)
	mode = "relay" if relay_ini else "p2p"
	if not relay_ini:
		missing = missing_loopback_aliases(len(roles))
		if missing:
			print("FAIL %s [p2p]: %s missing. Add with: %s" % (test, ", ".join(missing), "; ".join("sudo ifconfig lo0 alias %s up" % a for a in missing)))
			return False
	# A new port offset each run, so a connection a previous run left in TIME_WAIT doesn't get in the way.
	# Below 1700 keeps the tests' ports under Linux's ephemeral range (32768 and up).
	if not any(a.startswith("--port-offset") for a in extra):
		extra = extra + ["--port-offset=%d" % random.randrange(1, 1700)]
	memstick = os.path.join(os.path.dirname(headless), "memstick")
	# A test that hasn't been recorded on PSPs yet has no expected files; then just show what each instance prints.
	compare = all(os.path.exists(os.path.join(TESTS_DIR, "%s_%s.expected" % (test, role))) for role in roles)
	procs = []
	sync_file = None
	if sync:
		# The instances keep in step in emulated time through this file, one slot each (see InitInstanceSync).
		fd, sync_file = tempfile.mkstemp(prefix="ppsspp-sync-")
		os.write(fd, bytes(4096))
		os.close(fd)
	for i, role in enumerate(roles):
		cmd = [headless, "--root", os.path.join(ROOT, "pspautotests") + "/", "--timeout-wall=%d" % TIMEOUT,
			"--graphics=software", "--memstick=" + memstick, "--realtime", "--instance=%d" % (i + 1)]
		if sync_file:
			cmd += ["--sync-file=" + sync_file, "--sync-count=%d" % len(roles)]
		if compare:
			cmd.append("--compare")
		if relay_ini:
			cmd.append("--appendconfig=" + relay_ini)
		if i == 0:
			cmd.append("--adhoc-server")
		if os.environ.get("CI"):
			# Warnings and errors, shown if the test fails: CI runners are the hard place to reproduce one.
			cmd += ["--log", "--loglevel=3"]
		cmd += extra
		cmd.append(os.path.join(TESTS_DIR, "%s_%s.prx" % (test, role)))
		# To a file rather than a pipe: an instance that fills its pipe while we wait on another would stop,
		# and with the instance sync hold up the rest too.
		log = tempfile.TemporaryFile()
		procs.append((role, subprocess.Popen(cmd, stdout=log, stderr=subprocess.STDOUT if compare else subprocess.DEVNULL), log))
		if i == 0:
			wait_for_server()

	passed = True
	for role, proc, log in procs:
		proc.wait(timeout=TIMEOUT + 30)
		log.seek(0)
		out = log.read()
		log.close()
		if not compare:
			print("OUTPUT %s_%s [%s] (no expected file):" % (test, role, mode))
			sys.stdout.write(out.decode("utf-8", "replace"))
			passed = False
			continue
		ok = proc.returncode == 0
		passed = passed and ok
		print("%s %s_%s [%s]" % ("PASS" if ok else "FAIL", test, role, mode))
		if not ok:
			text = out.decode("utf-8", "replace")
			log = [l for l in text.splitlines() if re.search(r"\b[WE]\[", l)]
			sys.stdout.write("\n".join(l for l in text.splitlines() if l not in log) + "\n")
			if log:
				print("  Log (warnings and errors, last %d of %d):" % (min(80, len(log)), len(log)))
				sys.stdout.write("".join("    " + l + "\n" for l in log[-80:]))
	if sync_file:
		os.remove(sync_file)
	return passed


def main():
	parser = argparse.ArgumentParser()
	parser.add_argument("--headless", default=None)
	parser.add_argument("--relay", action="store_true", help="Use a local aemu_postoffice server in relay mode")
	parser.add_argument("--no-sync", action="store_true", help="Let each instance run at its own pace instead of keeping them in step in emulated time")
	parser.add_argument("tests", nargs="+")
	args, extra = parser.parse_known_args()
	headless = args.headless or find_headless()
	relay_ini = None
	if args.relay:
		f = tempfile.NamedTemporaryFile("w", suffix=".ini", delete=False)
		f.write(RELAY_INI)
		f.close()
		relay_ini = f.name
	failed = [t for t in args.tests if not run_test(headless, t, extra, relay_ini, not args.no_sync)]
	print("%d of %d passed" % (len(args.tests) - len(failed), len(args.tests)))
	return 1 if failed else 0


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