Alan Wake 2 Initial

First build of Alan Wake 2 harness

alanwake2/README.md

@@ -0,0 +1,21 @@
+# Rocket League
+
+This test launches a replay of Rocket League. The replay is from RLCS Season 9 NA Playoffs Series 4 [game of NRG vs G2](https://ballchasing.com/replay/bd63746b-cbe7-4d29-8f84-c8da3c4c1703?g=series-4-g2-esports-4-3-nrg-espo-qe6nf31lzt).
+
+## Prerequisites
+
+- Python 3.10+
+- Rocket league installed
+- Keras OCR service
+
+## Options
+
+- `kerasHost`: string representing the IP address of the Keras service. e.x. `0.0.0.0` 
+- `kerasPort`: string representing the port of the Keras service. e.x. `8080`
+
+## Output
+
+report.json
+- `resolution`: string representing the resolution the test was run at, formatted as "[width]x[height]", e.x. `1920x1080`
+- `start_time`: number representing a timestamp of the test's start time in milliseconds
+- `end_time`: number representing a timestamp of the test's end time in milliseconds

alanwake2/alanwake2.py

@@ -0,0 +1,169 @@
+import logging
+import os
+import time
+from subprocess import Popen
+import pydirectinput as user
+import sys
+from utils import get_resolution, find_epic_executable, get_args, copy_save
+
+sys.path.insert(1, os.path.join(sys.path[0], '..'))
+#pylint: disable=wrong-import-position
+from harness_utils.output import (
+    setup_log_directory, write_report_json, DEFAULT_LOGGING_FORMAT, DEFAULT_DATE_FORMAT)
+from harness_utils.process import terminate_processes
+from harness_utils.keras_service import KerasService
+from harness_utils.artifacts import ArtifactManager, ArtifactType
+from harness_utils.misc import press_n_times
+
+LOCALAPPDATA = os.getenv("LOCALAPPDATA")
+config_path = f"{LOCALAPPDATA}\\Remedy\\AlanWake2\\renderer.ini"
+SCRIPT_DIRECTORY = os.path.dirname(os.path.realpath(__file__))
+LOG_DIRECTORY = os.path.join(SCRIPT_DIRECTORY, "run")
+PROCESS_NAME = "alanwake2.exe"
+EXECUTABLE_PATH = find_epic_executable()
+GAME_ID = "c4763f236d08423eb47b4c3008779c84%3A93f2a8c3547846eda966cb3c152a026e%3Adc9d2e595d0e4650b35d659f90d41059?action=launch&silent=true"
+
+setup_log_directory(LOG_DIRECTORY)
+
+logging.basicConfig(filename=f'{LOG_DIRECTORY}/harness.log',
+                    format=DEFAULT_LOGGING_FORMAT,
+                    datefmt=DEFAULT_DATE_FORMAT,
+                    level=logging.DEBUG)
+console = logging.StreamHandler()
+formatter = logging.Formatter(DEFAULT_LOGGING_FORMAT)
+console.setFormatter(formatter)
+logging.getLogger('').addHandler(console)
+
+args = get_args()
+kerasService = KerasService(args.keras_host, args.keras_port, os.path.join(
+    LOG_DIRECTORY, "screenshot.jpg"))
+
+def get_run_game_id_command(game_id: int) -> str:
+    """Build string to launch game"""
+    return "com.epicgames.launcher://apps/" + str(game_id)
+
+def start_game():
+    """Start the game"""
+    cmd_string = get_run_game_id_command(GAME_ID)
+    logging.info("%s %s", EXECUTABLE_PATH, cmd_string)
+    return Popen([EXECUTABLE_PATH, cmd_string])
+
+def run_benchmark():
+    """Run the test!"""
+    am = ArtifactManager(LOG_DIRECTORY)
+    copy_save()
+    setup_start_time = time.time()
+    start_game()
+    time.sleep(10)  # wait for game to load into main menu
+
+    if kerasService.wait_for_word(word="saving", timeout=30, interval=1) is None:
+        logging.error("Game didn't start in time. Check settings and try again.")
+        sys.exit(1)
+
+    user.press("enter")
+
+    if kerasService.wait_for_word(word="warning", timeout=30, interval=1) is None:
+        logging.error("Game didn't start in time. Check settings and try again.")
+        sys.exit(1)
+
+    user.press("enter")
+
+    if kerasService.wait_for_word(word="continue", timeout=30, interval=1) is None:
+        logging.error("Game didn't start in time. Check settings and try again.")
+        sys.exit(1)
+
+    user.press("enter")
+
+    if kerasService.wait_for_word(word="house", timeout=10, interval=0.5):
+        user.press("esc")
+
+    #Navigating main menu:
+    is_load_present = kerasService.look_for_word("load", interval=1, attempts=5)
+    if is_load_present:
+        logging.info("Navigating to options to get some screenshots")
+        press_n_times("down", 4, 0.2)
+        user.press("enter")
+        time.sleep(0.2)
+        if kerasService.wait_for_word(word="graphics", timeout=60, interval=0.5) is None:
+            logging.error("Graphics options not available. Did it navigate to the options correctly?")
+            sys.exit(1)
+        press_n_times("e", 2, 0.2)
+        if kerasService.wait_for_word(word="quality", timeout=60, interval=0.5) is None:
+            logging.error("Did not see quality preset. Did it navigate to graphics correctly?")
+            sys.exit(1)
+        am.take_screenshot("graphics1.png", ArtifactType.CONFIG_IMAGE, "first screenshot of graphics settings")
+        time.sleep(0.2)
+        press_n_times("down", 18, 0.2)
+        if kerasService.wait_for_word(word="terrain", timeout=60, interval=0.5) is None:
+            logging.error("Did not see Terrain Quality. Did it navigate to graphics correctly?")
+            sys.exit(1)
+        am.take_screenshot("graphics2.png", ArtifactType.CONFIG_IMAGE, "second screenshot of graphics settings")
+        press_n_times("down", 10, 0.2)
+        if kerasService.wait_for_word(word="transparency", timeout=60, interval=0.5) is None:
+            logging.error("Did not see Transparency. Did it navigate to graphics correctly?")
+            sys.exit(1)
+        am.take_screenshot("graphics3.png", ArtifactType.CONFIG_IMAGE, "third screenshot of graphics settings")
+        time.sleep(0.2)
+        user.press("esc")
+    else:
+        logging.error("Load game option does not exist. Did the save get copied correctly?")
+        sys.exit(1)
+
+    if is_load_present:
+        logging.info("Seen the main menu. Loading benchmark.")
+        press_n_times("up", 3, 0.2)
+        user.press("enter")
+        time.sleep(2)
+    else:
+        logging.error("Load game option does not exist. Did the save get copied correctly?")
+        sys.exit(1)
+
+    #Loading the save
+    if kerasService.wait_for_word(word="heart", timeout=60, interval=0.5) is None:
+        logging.error("Heart not showing in loadable games. Did the save get copied correctly?")
+        sys.exit(1)
+
+    press_n_times("right", 3, 0.2)
+    user.press("enter")
+    time.sleep(0.2)
+    setup_end_time = time.time()
+    elapsed_setup_time = round(setup_end_time - setup_start_time, 2)
+    logging.info("Harness setup took %f seconds", elapsed_setup_time)
+
+    #Starting the benchmark:
+    if kerasService.wait_for_word(word="recap", timeout=60, interval=0.5) is None:
+        logging.error("Didn't see the word recap. Did the save game load?")
+        sys.exit(1)
+
+    test_start_time = time.time()
+
+    # wait for benchmark to complete
+    time.sleep(170)
+
+    if kerasService.wait_for_word(word="insane", timeout=60, interval=0.5) is None:
+        logging.error("Didn't see the word insane. Did the game crash?")
+        sys.exit(1)
+    test_end_time = time.time()
+    time.sleep(2)
+    logging.info("Run completed. Closing game.")
+    am.copy_file(config_path, ArtifactType.CONFIG_TEXT, "renderer.ini")
+    elapsed_test_time = round((test_end_time - test_start_time), 2)
+    logging.info("Benchmark took %f seconds", elapsed_test_time)
+    terminate_processes(PROCESS_NAME)
+    return test_start_time, test_end_time
+
+try:
+    start_time, end_time = run_benchmark()
+    height, width = get_resolution()
+    report = {
+        "resolution": f"{width}x{height}",
+        "start_time": round((start_time * 1000)),
+        "end_time": round((end_time * 1000))
+    }
+
+    write_report_json(LOG_DIRECTORY, "report.json", report)
+except Exception as e:
+    logging.error("Something went wrong running the benchmark!")
+    logging.exception(e)
+    terminate_processes(PROCESS_NAME)
+    sys.exit(1)

alanwake2/aw2-savegame-slot-03/--containerDisplayName.chunk

@@ -0,0 +1 @@
+Quick Save 1

alanwake2/manifest.yaml

@@ -0,0 +1,9 @@
+friendly_name: "Alan Wake 2"
+executable: "alanwake2.py"
+process_name: "AlanWake2.exe"
+output_dir: "run"
+options:
+  - name: kerasHost
+    type: input
+  - name: kerasPort
+    type: input

alanwake2/utils.py

@@ -0,0 +1,88 @@
+"""Rocket League test utils"""
+from argparse import ArgumentParser
+import winreg
+import os
+import logging
+import re
+import shutil
+from pathlib import Path
+
+LOCALAPPDATA = os.getenv("LOCALAPPDATA")
+SCRIPT_DIRECTORY = os.path.dirname(os.path.realpath(__file__))
+AW2_SAVE = os.path.join(SCRIPT_DIRECTORY, "aw2-savegame-slot-03")
+config_path = f"{LOCALAPPDATA}\\Remedy\\AlanWake2\\renderer.ini"
+DEFAULT_EXECUTABLE_NAME = "EpicGamesLauncher.exe"
+
+def AccountId() -> any:
+    reg_path = r'Software\Epic Games\Unreal Engine\Identifiers'
+    try:
+        registry_key = winreg.OpenKey(winreg.HKEY_CURRENT_USER, reg_path, 0,
+                                      winreg.KEY_READ)
+        value, _ = winreg.QueryValueEx(registry_key, "AccountId")
+        winreg.CloseKey(registry_key)
+        return value
+    except WindowsError:
+        return None
+    
+SAVE_LOCATION = f"{LOCALAPPDATA}\\Remedy\\AlanWake2\\{AccountId()}\\"
+
+def get_args() -> any:
+    """Returns command line arg values"""
+    parser = ArgumentParser()
+    parser.add_argument("--kerasHost", dest="keras_host",
+                        help="Host for Keras OCR service", required=True)
+    parser.add_argument("--kerasPort", dest="keras_port",
+                        help="Port for Keras OCR service", required=True)
+    return parser.parse_args()
+
+def get_resolution():
+    """Get current resolution from settings file"""
+    height_pattern = re.compile(r"\"m_iOutputResolutionY\": (\d+),")
+    width_pattern = re.compile(r"\"m_iOutputResolutionX\": (\d+),")
+    cfg = f"{config_path}"
+    height = 0
+    width = 0
+    with open(cfg, encoding="utf-8") as f:
+        lines = f.readlines()
+        for line in lines:
+            height_match = height_pattern.search(line)
+            width_match = width_pattern.search(line)
+            if height_match is not None:
+                height = height_match.group(1)
+            if width_match is not None:
+                width = width_match.group(1)
+            if height != 0 and width !=0: 
+                return (height, width)
+    return (height, width)
+
+def copy_save() -> None:
+    is_valid_benchmark = os.path.isdir(AW2_SAVE)
+
+    if not is_valid_benchmark:
+        raise Exception(f"Can't find the benchmark folder: {AW2_SAVE}")
+
+    # Validate/create path to directory where we will copy benchmark to
+    try:
+        Path(SAVE_LOCATION).mkdir(parents=True, exist_ok=True)
+    except FileExistsError as e:
+        logging.error("Could not copy files - likely due to non-directory file existing at path.")
+        raise e
+    
+    # Copy the benchmark over
+    logging.info("Copying benchmark to install folder")
+    destination_folder = os.path.join(SAVE_LOCATION, os.path.basename(AW2_SAVE))
+    logging.info(F"Copying: {AW2_SAVE} -> {destination_folder}")
+    shutil.copytree(AW2_SAVE, destination_folder, dirs_exist_ok = True)
+
+def find_epic_executable() -> any:
+    """Get path to Epic Games Executable"""
+    reg_path = r'Software\Epic Games\EOS'
+    try:
+        registry_key = winreg.OpenKey(winreg.HKEY_CURRENT_USER, reg_path, 0,
+                                      winreg.KEY_READ)
+        value, _ = winreg.QueryValueEx(registry_key, "ModSdkCommand")
+        winreg.CloseKey(registry_key)
+        return value
+    # pylint:disable=undefined-variable
+    except WindowsError:
+        return None