#!/usr/bin/env python3 """LAN multiplayer end to end: a host opens its world to LAN and a guest joins, both real games. Two Horizon clients run side by side under horizon-ctl, each in its own scratch folder. The host creates a survival world and opens it to LAN with commands allowed; the guest connects to it by address. The script then checks, from both sides, what a guest's game used to get wrong (#366): - tab: the guest's player list holds the host and the guest, under their own names; - self: the guest's own model exists (third person, inventory preview); - armour: each side draws the other player in that player's own armour; - nametags: each side draws the other player's name above them; - chest: a chest the guest opens opens on the guest's screen, its lid opens on both sides and closes on both when the guest closes it; - crafting: the guest crafts planks in the inventory's 2x2 grid and opens a crafting table; - damage: a guest in survival takes fall damage; - mobs: with the host in creative, a zombie and a skeleton go for the guest and hurt them. Each check is reported on its own (a failing one doesn't stop the others) and the screenshots of both sides go to --out (host-*.png, guest-*.png). python3 tools/lan_e2e.py # build with the fast profile, run every check python3 tools/lan_e2e.py --bin-dir target/fast # prebuilt binaries python3 tools/lan_e2e.py --check chest --check tab Needs the prepared resources in .local/horizon-client and, on Linux, vscreen (the desktop); on macOS both games render offscreen. Games started here have no audio (HORIZON_NO_AUDIO=1). """ import argparse import json import os import shutil import subprocess import sys import tempfile import time from pathlib import Path sys.path.insert(0, str(Path(__file__).resolve().parent)) from agent_control_e2e import Cli, Failed, game_env # noqa: E402 ROOT = Path(__file__).resolve().parents[1] GUEST_NAME = 'Guest' CHECKS = ['tab', 'self', 'armour', 'nametags', 'chest', 'crafting', 'damage', 'mobs'] class Game: """One client: its scratch folder, its socket and a CLI driver.""" def __init__(self, name, ctl, resources): self.name = name self.work = Path(tempfile.mkdtemp(prefix=f'hzlan-{name}-')) (self.work / '.local/horizon-client').mkdir(parents=True) os.symlink(resources, self.work / '.local/horizon-client/26.3') self.socket = self.work / 'c.sock' env = game_env(os.environ.get('VSCREEN', 'lan-e2e')) env['HORIZON_HOME'] = str(self.work / 'home') self.d = Cli(ctl, self.socket, self.work, env) self.d.name = name def __call__(self, tool, **args): return self.d(tool, **args) def raw(self, *words): """A game command horizon-ctl has no table entry for (lan, connect): the words as typed.""" result = subprocess.run(self.d.base + [str(w) for w in words], cwd=self.work, env=self.d.env, capture_output=True, text=True, timeout=600) lines = result.stdout.strip().splitlines() reply = json.loads(lines[-1]) if lines else {'error': result.stderr.strip()} print(f'[{self.name}] {list(words)} -> {json.dumps(reply)[:400]}') if result.returncode or 'error' in reply: raise Failed(f'{" ".join(map(str, words))}: {reply}') return reply def shot(self, out, label): path = out / f'{self.name}-{label}.png' self.d('screenshot', path=path) return path def wait(self, ticks): self.d('wait', ticks=ticks) def close(self): try: self.d('quit') except Exception: pass time.sleep(2) log = self.socket.with_suffix('.log') return log.read_text(errors='replace') if log.exists() else '' def remote(guest): """The guest's view of the server (`status`'s server part).""" return guest('status')['server'] def back_to_game(game): """Close whatever screen a failed check left open, without opening the pause menu.""" try: if game('state').get('screen') not in (None, 'playing'): game.raw('key', 'esc', 'tap') game.wait(2) except Failed: pass def pos_of(game): return game('state')['player']['position'] def face_each_other(host, guest): """Put the guest 3 blocks east of the host, both looking at the other's head.""" hx, hy, hz = pos_of(host) guest('command', command=f'tp @s {hx + 3:.2f} {hy:.2f} {hz:.2f}') guest.wait(30) host.raw('look-at', f'{hx + 3:.2f}', f'{hy + 1.6:.2f}', f'{hz:.2f}') guest.raw('look-at', f'{hx:.2f}', f'{hy + 1.6:.2f}', f'{hz:.2f}') host.wait(10) def check_tab(host, guest, out): players = remote(guest)['players'] names = sorted(p['name'] if isinstance(p, dict) else str(p) for p in players) assert names == sorted([host.player, GUEST_NAME]), f'guest tab list: {players}, host {host.player}' guest.raw('key', 'tab', 'down') guest.wait(5) guest.shot(out, 'tab') guest.raw('key', 'tab', 'up') return names def check_self(host, guest, out): guest.raw('key', 'f5', 'tap') guest.wait(10) guest.shot(out, 'self-third-person') status = guest('state') guest.raw('key', 'f5', 'tap') guest.raw('key', 'f5', 'tap') guest.raw('key', 'e', 'tap') guest.raw('wait-for', 'screen', 'inventory') guest.shot(out, 'self-inventory') model = remote(guest).get('player_model') guest.raw('key', 'esc', 'tap') assert model, f'the guest has no player model: {status.get("camera")}' return 'model drawn' def check_armour(host, guest, out): host('command', command='item replace entity @s armor.head with minecraft:golden_helmet') host('command', command='item replace entity @s armor.chest with minecraft:golden_chestplate') guest('command', command='item replace entity @s armor.chest with minecraft:diamond_chestplate') guest('command', command='item replace entity @s armor.legs with minecraft:diamond_leggings') face_each_other(host, guest) host.shot(out, 'armour') guest.shot(out, 'armour') seen = host.raw('lan', 'status')['guests'][0].get('model_armor') assert seen == [None, 'minecraft:diamond_chestplate', 'minecraft:diamond_leggings', None], \ f'the host draws the guest in {seen}' host_gear = [e for e in remote(guest).get('player_equipment', [])] assert any('golden_chestplate' in json.dumps(e) for e in host_gear), f'the guest sees the host in {host_gear}' return 'each in their own' def check_nametags(host, guest, out): face_each_other(host, guest) h = host('status').get('name_tags') or [] g = guest('status').get('name_tags') or [] host.shot(out, 'nametags') guest.shot(out, 'nametags') assert GUEST_NAME in h, f'host draws name tags {h}' assert host.player in g, f'guest draws name tags {g}' return {'host': h, 'guest': g} def lid(game, pos): return game.raw('block', *pos).get('lid', 0.0) def check_chest(host, guest, out): x, y, z = (int(v // 1) for v in pos_of(guest)) chest = (x, y, z + 2) guest('command', command=f'setblock {chest[0]} {chest[1]} {chest[2]} minecraft:chest') guest.wait(10) guest.raw('interact', *chest) screen = guest.raw('wait-for', 'screen', 'container', '--timeout', 10) guest.wait(20) opened = {'guest': lid(guest, chest), 'host': lid(host, chest)} host.raw('look-at', chest[0] + 0.5, chest[1] + 0.5, chest[2] + 0.5) host.wait(2) host.shot(out, 'chest-open') guest.shot(out, 'chest-open') guest.raw('key', 'esc', 'tap') guest.wait(20) closed = {'guest': lid(guest, chest), 'host': lid(host, chest)} host.shot(out, 'chest-closed') assert screen, 'no container screen on the guest' assert opened['guest'] > 0.9 and opened['host'] > 0.9, f'lid while open: {opened}' assert closed['guest'] < 0.1 and closed['host'] < 0.1, f'lid after closing: {closed}' return {'open': opened, 'closed': closed} def check_crafting(host, guest, out): guest('command', command='clear @s') guest('command', command='give @s minecraft:oak_log 1') guest.wait(10) guest.raw('key', 'e', 'tap') guest.raw('wait-for', 'screen', 'inventory') inv = guest('inventory') slot = next(s['slot'] for s in inv['hotbar'] if s and s.get('item') == 'minecraft:oak_log') # Horizon's slot ids (click-slot): the hotbar is 0-8, the grid 100-108, the result 200. guest.raw('click-slot', slot) guest.raw('click-slot', 100) guest.wait(5) result = [s for s in guest('screen').get('slots', []) if s.get('slot') == 200] guest.shot(out, 'crafting-grid') guest.raw('click-slot', 200, 'shift') guest.wait(5) guest.raw('key', 'esc', 'tap') guest.wait(5) planks = guest('inventory')['counts'].get('minecraft:oak_planks', 0) assert planks == 4, f'crafted {planks} planks (result slot: {result})' x, y, z = (int(v // 1) for v in pos_of(guest)) table = (x, y, z - 2) guest('command', command=f'setblock {table[0]} {table[1]} {table[2]} minecraft:crafting_table') guest.wait(10) guest.raw('interact', *table) guest.raw('wait-for', 'screen', 'inventory', '--timeout', 10) size = guest('screen').get('craft_size') assert size == 3, f'the crafting table opened a {size}x{size} grid' # Two planks one above the other in the 3x3 grid: four sticks. slot = next(s['slot'] for s in guest('inventory')['hotbar'] if s and s.get('item') == 'minecraft:oak_planks') guest.raw('click-slot', slot) guest.raw('click-slot', 100, 'right') guest.raw('click-slot', 103, 'right') guest.raw('click-slot', slot) guest.wait(5) guest.shot(out, 'crafting-table') guest.raw('click-slot', 200, 'shift') guest.wait(5) guest.raw('key', 'esc', 'tap') guest.wait(5) counts = guest('inventory')['counts'] assert counts.get('minecraft:stick') == 4 and counts.get('minecraft:oak_planks') == 2, f'after the table: {counts}' return {'planks': planks, 'table': counts} def check_damage(host, guest, out): guest('command', command='gamemode survival') guest.wait(10) before = remote(guest)['health'] x, y, z = pos_of(guest) guest('command', command=f'tp @s {x:.2f} {y + 12:.2f} {z:.2f}') guest.wait(50) after = remote(guest)['health'] guest.shot(out, 'damage') assert after < before, f'health {before} -> {after} after a 12-block fall' # Into water: the fall does no damage. x, y, z = pos_of(guest) guest('command', command=f'setblock {int(x // 1)} {int(y // 1)} {int(z // 1)} minecraft:water') guest('command', command=f'tp @s {x:.2f} {y + 12:.2f} {z:.2f}') guest.wait(50) water = remote(guest)['health'] assert water >= after, f'health {after} -> {water} after falling into water' return {'before': before, 'after': after, 'water': water} def first_hurt(guest, before, ticks): """The guest's health once it drops below `before`, waiting at most `ticks`.""" health = remote(guest)['health'] for _ in range(ticks // 10): if health < before: break guest.wait(10) health = remote(guest)['health'] return health def check_mobs(host, guest, out): host('command', command='gamemode creative') host('command', command='difficulty normal') host('command', command='time set midnight') guest('command', command='gamemode survival') guest.wait(10) hurt = {} try: for mob, distance in (('zombie', 3), ('skeleton', 7)): x, y, z = pos_of(guest) before = remote(guest)['health'] host('command', command=f'summon minecraft:{mob} {x:.2f} {y:.2f} {z + distance:.2f}') low = first_hurt(guest, before, 300) guest.shot(out, f'mobs-{mob}') host.shot(out, f'mobs-{mob}') host('command', command=f'kill @e[type=minecraft:{mob}]') hurt[mob] = (before, low) finally: host('command', command='gamemode survival') host('command', command='time set day') for mob, (before, low) in hurt.items(): assert low < before, f'the {mob} never hurt the guest: health {before} -> {low} (all: {hurt})' return hurt CHECK_FNS = {'tab': check_tab, 'self': check_self, 'armour': check_armour, 'nametags': check_nametags, 'chest': check_chest, 'crafting': check_crafting, 'damage': check_damage, 'mobs': check_mobs} def run(ctl, out, resources, checks): host, guest = Game('host', ctl, resources), Game('guest', ctl, resources) results = {} try: host('launch', wait=False, offscreen=sys.platform == 'darwin') # Guests' commands need the world's Allow Commands as well as the LAN's (#372): a creative # world has them; everyone plays in survival. host.raw('open', 'Lan', 5, 'creative') host('wait_ready', seconds=400) host('command', command='defaultgamemode survival') host('command', command='gamemode survival') host('command', command='time set day') # An open stone floor around the host, so the players see each other and nothing is in the way. host('command', command='fill ~-8 ~-1 ~-8 ~8 ~-1 ~8 minecraft:stone') host('command', command='fill ~-8 ~ ~-8 ~8 ~6 ~8 minecraft:air') host('command', command='gamerule spawn_mobs false') port = host.raw('lan', 'open', 0, 'commands')['port'] host.player = host.raw('lan', 'status').get('host', 'Player') # the host's profile name guest('launch', wait=False, offscreen=sys.platform == 'darwin') guest.raw('connect', f'127.0.0.1:{port}', GUEST_NAME) guest.raw('wait-for', 'loaded', '--timeout', 300) guest.wait(40) face_each_other(host, guest) host.shot(out, 'joined') guest.shot(out, 'joined') for name in checks: try: results[name] = {'pass': True, 'detail': CHECK_FNS[name](host, guest, out)} except (Failed, AssertionError, StopIteration, KeyError) as e: results[name] = {'pass': False, 'detail': repr(e)} for g in (host, guest): back_to_game(g) print(f'[lan] {name}: {"PASS" if results[name]["pass"] else "FAIL"} {results[name]["detail"]}') finally: logs = {g.name: g.close() for g in (guest, host)} for name, text in logs.items(): (out / f'{name}.log').write_text(text) for g in (host, guest): shutil.rmtree(g.work, ignore_errors=True) return results def main(): parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) parser.add_argument('--bin-dir', help='prebuilt horizon-client and horizon-ctl (default: build with the fast profile)') parser.add_argument('--check', action='append', choices=CHECKS, help='run only these checks (repeatable)') parser.add_argument('--out', default=str(ROOT / '.local/lan-e2e'), help='screenshots and game logs go here') args = parser.parse_args() if args.bin_dir: bins = Path(args.bin_dir).resolve() else: subprocess.run(['cargo', 'build', '--locked', '--profile', 'fast', '-p', 'horizon-client', '--bins'], cwd=ROOT, check=True) meta = json.loads(subprocess.run(['cargo', 'metadata', '--format-version', '1', '--no-deps'], cwd=ROOT, capture_output=True, text=True, check=True).stdout) bins = Path(meta['target_directory']) / 'fast' resources = (ROOT / '.local/horizon-client/26.3').resolve() if not (resources / 'horizon-resources.json').exists(): sys.exit(f'no prepared resources in {resources}') out = Path(args.out) out.mkdir(parents=True, exist_ok=True) results = run(bins / 'horizon-ctl', out, resources, args.check or CHECKS) print(json.dumps(results, indent=1)) sys.exit(0 if results and all(r['pass'] for r in results.values()) else 1) if __name__ == '__main__': main()