From 6d2b69c964b7c0e411427f1ef6492eadbd13e947 Mon Sep 17 00:00:00 2001 From: tmpz23 <28760271+tmpz23@users.noreply.github.com> Date: Mon, 11 Apr 2022 20:34:27 +0200 Subject: [PATCH] Create gcmtest.py --- gcmtool/gcmtest.py | 213 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 gcmtool/gcmtest.py diff --git a/gcmtool/gcmtest.py b/gcmtool/gcmtest.py new file mode 100644 index 0000000..636ebf7 --- /dev/null +++ b/gcmtool/gcmtest.py @@ -0,0 +1,213 @@ +#!/usr/bin/env python3 +from pathlib import Path +import os +import shutil +from time import time + + +__version__ = "0.0.7" +__author__ = "rigodron, algoflash, GGLinnk" +__license__ = "MIT" +__status__ = "developpement" + + +################################################## +# Set roms_path with your ROMs (at the root of the ROM folder) +# Extract all files from file system using dolphin emu - put it in f"{dolphin_unpack_path}/root/" +# Extract boot.dol and apploader.img using dolphin emu - put it in f"{dolphin_unpack_path}/sys/" +################################################## +roms_path = Path("../ROM") +dolphin_unpack_path = Path("dolphin_unpack") + +# Created tmp paths +unpack_path = Path("unpack") +unpack2_path = Path("unpack2") +repack_path = Path("repack") +# if there is a way to create symlinks on GCM filesystem, it could create strange situations + + +def test_storage(): + total, used, free = shutil.disk_usage("/") + if free - 10**10 < 3 * sum(path.stat().st_size for path in roms_path.glob('*') if path.is_file()): + raise Exception("Error - Not enought free space on the disk to run tests.") + + +def print_paths_differences(folder1_paths:list, folder2_paths:list): + backup_paths = folder2_paths.copy() + for path in folder1_paths: + if path in folder2_paths: + folder2_paths.remove(path) + for path in backup_paths: + if path in folder1_paths: + folder1_paths.remove(path) + print("folder1 diff:") + for path in folder1_paths: + print(path) + print("folder2 diff:") + for path in folder2_paths: + print(path) + + +# compare two files +def compare_files(file1_path:Path, file2_path:Path): + CLUSTER_LEN = 131072 + with file1_path.open("rb") as file1, file2_path.open("rb") as file2: + # Init + bytes1 = file1.read(CLUSTER_LEN) + bytes2 = file2.read(CLUSTER_LEN) + while bytes1 or bytes2: # continue if bytes1 and bytes2 have a len > 0 + if bytes1 != bytes2: + return False + bytes1 = file1.read(CLUSTER_LEN) + bytes2 = file2.read(CLUSTER_LEN) + return True + + +# compare two GCM +# -> raise an exception if there is a difference +def compare_GCM(folder1: Path, folder2: Path): + folder1_root_paths = list((folder1 / "root").glob("**/*")) + folder1_file_count = len(folder1_root_paths) + print(f"compare \"{folder1}\" - \"{folder2}\" ({folder1_file_count} files)") + if folder1_file_count == 0: + raise Exception(f"Error - Empty folder: {folder1}") + + len1 = len(folder1.parts) + len2 = len(folder2.parts) + # 1. Compare names of filesystems + folder1_paths = [Path(*path.parts[len1:]) for path in folder1_root_paths] + folder2_paths = [Path(*path.parts[len2:]) for path in (folder2 / "root").glob('**/*')] + if folder1_paths != folder2_paths: + print_paths_differences(folder1_paths, folder2_paths) + raise Exception(f"Error - Folders \"{folder1}\" and \"{folder2}\" are different (not the same folders or files names).") + # 2. Compare sys files content + if not compare_files(folder1 / "sys" / "apploader.img", folder2 / "sys" / "apploader.img"): + raise Exception(f"Error - \"{folder1 / 'sys/apploader.bin'}\" and \"{folder2 / 'sys/apploader.bin'}\" are different.") + if not compare_files(folder1 / "sys" / "boot.dol", folder2 / "sys" / "boot.dol"): + raise Exception(f"Error - \"{folder1 / 'sys/boot.bin'}\" and \"{folder2 / 'sys/boot.bin'}\" are different.") + + for path1 in folder1_root_paths: + if path1.is_file(): + path2 = folder2/Path(*path1.parts[len1:]) + if not compare_files(path1, path2): + raise Exception(f"Error - \"{path1}\" and \"{path2}\" are different.") + + +################################################## +# gcmtool.py commands wrappers +################################################## +def gcmtool_unpack(iso_path:Path, folder_path:Path): + if os.system(f"python gcmtool.py -u \"{iso_path}\" \"{folder_path}\"") != 0: + raise Exception("Error while unpacking GCM.") +def gcmtool_pack(folder_path:Path, iso_path:Path): + if os.system(f"python gcmtool.py -p \"{folder_path}\" \"{iso_path}\"") != 0: + raise Exception("Error while packing GCM.") +def gcmtool_rebuild_fst(folder_path:Path): + if os.system(f"python gcmtool.py -r \"{folder_path}\"") != 0: + raise Exception("Error while rebuilding FST.") +def gcmtool_stats(path:Path): + if os.system(f"python gcmtool.py -s \"{path}\" > NUL") != 0: + raise Exception("Error while getting stats.") + + +TEST_COUNT = 4 + +start = time() +print("###############################################################################") +print("# Checking tests folder") +print("###############################################################################") +# Check if tests folders exist +if unpack_path.is_dir() or unpack2_path.is_dir() or repack_path.is_dir(): + raise Exception(f"Error - Please remove:\n-{unpack_path}\n-{unpack2_path}\n-{repack_path}") + +test_storage() + +print("###############################################################################") +print(f"# TEST 1/{TEST_COUNT}") +print("# Comparing roms_path->unpack->[unpack_path] ROMs with [dolphin_unpack_path]") +print("###############################################################################") +# unpack ROM in unpack_path +unpack_path.mkdir(parents=True) +for iso_path in roms_path.glob("*"): + if iso_path.is_file(): + gcmtool_unpack(iso_path, unpack_path / iso_path.name) + +# compare unpack_path dolphin_unpack_path +for folder_path in unpack_path.glob("*"): + compare_GCM(folder_path, dolphin_unpack_path / folder_path.name) + +print("###############################################################################") +print(f"# TEST 2/{TEST_COUNT}") +print("# Testing stats on folders & isos") +print("###############################################################################") + +for iso_path in roms_path.glob("*"): + if iso_path.is_file(): + gcmtool_stats(iso_path) + +for folder_path in unpack_path.glob("*"): + gcmtool_stats(folder_path) + +print("###############################################################################") +print(f"# TEST 3/{TEST_COUNT}") +print("# Comparing [unpack_path]->pack->unpack->[unpack2_path]") +print("###############################################################################") +# repack unpack_path repack_path +repack_path.mkdir() +unpack_paths = list(unpack_path.glob("*")) +for folder_path in unpack_paths: + gcmtool_pack(folder_path, repack_path / folder_path.name) + +# unpack repack_path unpack2_path +unpack2_path.mkdir() +for iso_path in repack_path.glob("*"): + gcmtool_unpack(iso_path, unpack2_path / iso_path.name) + +# remove repack_path +shutil.rmtree(repack_path) + +# compare unpack_path unpack2_path +for folder_path in unpack_paths: + compare_GCM(folder_path, unpack2_path / folder_path.name) + +# remove unpack2_path +shutil.rmtree(unpack2_path) + +print("###############################################################################") +print(f"# TEST 4/{TEST_COUNT}") +print("# Comparing [unpack_path]->rebuild_fst->repack->unpack->[unpack2_path]") +print("###############################################################################") +# rebuild unpack_path FSTs +unpack_paths = list(unpack_path.glob("*")) +for folder_path in unpack_paths: + gcmtool_rebuild_fst(folder_path) + +# repack unpack_path repack_path +repack_path.mkdir() +for folder_path in unpack_paths: + gcmtool_pack(folder_path, repack_path / folder_path.name) + +# unpack repack_path unpack2_path +unpack2_path.mkdir() +for iso_path in repack_path.glob("*"): + gcmtool_unpack(iso_path, unpack2_path / iso_path.name) + +# remove repack_path +shutil.rmtree(repack_path) + +# compare unpack_path unpack2_path +for folder_path in unpack_path.glob("*"): + compare_GCM(folder_path, unpack2_path / folder_path.name) + + +# Remove tests folders +print("###############################################################################") +print(f"# Cleaning test folders.") +print("###############################################################################") +shutil.rmtree(unpack_path) +shutil.rmtree(unpack2_path) + +end = time() +print("###############################################################################") +print(f"# All tests are OK - elapsed time: {end - start}") +print("###############################################################################")