Added FPGA-ID support to RetroAccount.

Improved launcher and its log to be a bit more resilient.

Author: theypsilon

.github/build_new_db.py

@@ -130,6 +130,7 @@ def fetch_file(path: str, url: str, auth_token: str = None) -> None:
 
 fetch_file('update_all_latest_log.sh', 'https://raw.githubusercontent.com/theypsilon/Update_All_MiSTer/refs/heads/master/src/update_all_latest_log.sh')
 fetch_file('update_all_timeline.sh', 'https://raw.githubusercontent.com/theypsilon/Update_All_MiSTer/refs/heads/master/src/update_all_timeline.sh')
+fetch_file('Linker.rbf', 'https://raw.githubusercontent.com/theypsilon/Update_All_MiSTer/refs/heads/bin/Linker.rbf')
 
 save_json(generate_pocket_firmware_details(), 'pocket_firmware_details.json')
 
@@ -142,7 +143,7 @@ def fetch_file(path: str, url: str, auth_token: str = None) -> None:
 
 subprocess.run(['zip', 'update_all.zip', 'update_all.sh'], check=True)
 
-subprocess.run(['git', 'add', 'update_all.pyz', 'update_all.pyz.sha256', 'update_all.sh', 'update_all_latest_log.sh', 'update_all_timeline.sh', 'update_all.zip', 'mad_db.json.zip', 'pocket_firmware_details.json', 'timeline_plus.enc', 'timeline.json'], check=True)
+subprocess.run(['git', 'add', 'update_all.pyz', 'update_all.pyz.sha256', 'update_all.sh', 'update_all_latest_log.sh', 'update_all_timeline.sh', 'Linker.rbf', 'update_all.zip', 'mad_db.json.zip', 'pocket_firmware_details.json', 'timeline_plus.enc', 'timeline.json'], check=True)
 subprocess.run(['git', 'commit', '-m', '-'], check=True)
 
 new_db['files'] = {
@@ -171,6 +172,11 @@ def fetch_file(path: str, url: str, auth_token: str = None) -> None:
         'hash': hash_file('timeline.json'),
         'tags': [2, 1]
     },
+    'Scripts/.config/update_all/Linker.rbf': {
+        'size': os.path.getsize('Linker.rbf'),
+        'hash': hash_file('Linker.rbf'),
+        'tags': [2],
+    },
     'Scripts/update_all.sh': {
         'size': os.path.getsize('update_all.sh'),
         'hash': hash_file('update_all.sh'),

src/debug.py

@@ -28,6 +28,9 @@ def run_launcher(**kwargs): send_build(**kwargs), exec_ssh(f'/media/fat/Scripts/
 def store_push(**kwargs): scp_file('update_all.json', '/media/fat/Scripts/.config/update_all/update_all.json', **kwargs)
 def store_pull(**kwargs): scp_file('/media/fat/Scripts/.config/update_all/update_all.json', 'update_all.json', **kwargs)
 def log_pull(**kwargs): scp_file('/media/fat/Scripts/.config/update_all/update_all.log', 'update_all.log', **kwargs)
+def send_linker(**kwargs):
+    exec_ssh('mkdir -p /media/fat/Scripts/.config/update_all', **kwargs)
+    scp_file('Linker.rbf', '/media/fat/Scripts/.config/update_all/Linker.rbf', **kwargs)
 
 def send_build(env=None, build_target=None, launcher_target=None, debug=None, **kwargs):
     env = {'DEBUG': debug or 'true', **os.environ.copy(), **(env or {}), 'MISTER': 'true'}
@@ -48,7 +51,9 @@ def operations_dict(env=None, retries=False):
         'build': lambda: [send_build(env=env, retries=retries), print('OK')],
         'run': lambda: run_build(env=env, retries=retries),
         'launcher': lambda: run_launcher(env=env, retries=retries),
+        'send_linker': lambda: [send_linker(retries=retries), print('OK')],
         'copy': lambda: scp_file(sys.argv[2], f'/media/fat/{sys.argv[2]}'),
+        'rcopy': lambda: [scp_file(f'/media/fat/{sys.argv[2]}', Path(sys.argv[2]).name), print('OK')],
         'local_run': lambda: local_run(env=env),
         'local_run_tiny': lambda: local_run_tiny(),
         'local_run_small': lambda: local_run_small(),

src/test/integration/test_environment_setup.py

@@ -20,7 +20,8 @@
 from test.ini_assertions import testableIni
 from test.testing_objects import downloader_ini, update_all_ini, update_jtcores_ini, update_names_txt_ini
 from update_all.config import Config
-from update_all.constants import KENV_DEBUG, KENV_LOCATION_STR, FILE_update_all_storage, KENV_TRANSITION_SERVICE_ONLY
+from update_all.constants import KENV_DEBUG, KENV_LOCATION_STR, FILE_update_all_storage, KENV_TRANSITION_SERVICE_ONLY, \
+    KENV_UPDATE_ALL_CHIP_ID_RESULT
 from update_all.databases import DB_ID_NAMES_TXT, AllDBs, DB_ID_ARCADE_NAMES_TXT, all_dbs
 from update_all.environment_setup import EnvironmentSetupResult
 from update_all.local_store import LocalStore
@@ -87,6 +88,17 @@ def test_setup___with_empty_downloader_ini_and_debug_env___returns_config_with_v
             expected_config=Config(verbose=True, databases={all_dbs('').UPDATE_ALL_MISTER.db_id})
         )
 
+    def test_setup___with_chip_id_result_env___stores_chip_id_result_in_config(self):
+        self.assertSetup(
+            files={downloader_ini: ''},
+            expected_files={downloader_ini: Path('test/fixtures/downloader_ini/downloader_ini_empty_but_update_all.ini').read_text()},
+            env={KENV_UPDATE_ALL_CHIP_ID_RESULT: '0123456789abcdef'},
+            expected_config=Config(
+                databases={all_dbs('').UPDATE_ALL_MISTER.db_id},
+                chip_id_result='0123456789abcdef'
+            )
+        )
+
     def test_setup___with_default_downloader_ini_and_update_all_ini_with_disabled_arcade_organizer___returns_config_with_default_databases_and_disabled_ao(self):
         self.assertSetup(files={
             downloader_ini: Path('test/fixtures/downloader_ini/default_downloader.ini').read_text(),

src/test/integration/test_update_all_service.py

@@ -15,8 +15,11 @@
 
 # You can download the latest version of this tool from:
 # https://github.com/theypsilon/Update_All_MiSTer
+import unittest
+from unittest.mock import MagicMock
+
 from update_all.config import Config
-from update_all.constants import FILE_mister_downloader_needs_reboot, EXIT_CODE_REQUIRES_EARLY_EXIT
+from update_all.constants import FILE_mister_downloader_needs_reboot, EXIT_CODE_REQUIRES_EARLY_EXIT, COMMAND_SHOW_CHIP_ID_RESULT
 from update_all.environment_setup import EnvironmentSetupResult
 from update_all.local_store import LocalStore
 from update_all.other import GenericProvider
@@ -25,10 +28,10 @@
 from test.file_system_tester_state import FileSystemState
 from test.update_all_service_tester import UpdateAllServiceFactoryTester, UpdateAllServiceTester, \
     default_env, EnvironmentSetupStub, default_databases, local_store
-import unittest
 
 
-def tester(files=None, folders=None, config: Config = None, store: LocalStore = None, env_stub: EnvironmentSetupStub = None):
+def tester(files=None, folders=None, config: Config = None, store: LocalStore = None, env_stub: EnvironmentSetupStub = None,
+           settings_screen=None):
     state = FileSystemState(files=files, folders=folders)
     config_provider = GenericProvider[Config]()
     config_provider.initialize(config or Config(databases=default_databases()))
@@ -39,7 +42,8 @@ def tester(files=None, folders=None, config: Config = None, store: LocalStore =
         environment_setup=env_stub or EnvironmentSetupStub(),
         file_system=FileSystemFactory(state=state, config_provider=config_provider).create_for_system_scope(),
         config_provider=config_provider,
-        store_provider=store_provider
+        store_provider=store_provider,
+        settings_screen=settings_screen,
     ), state
 
 
@@ -89,3 +93,41 @@ def test_full_run___when_env_setup_requires_early_exit___returns_exit_code_requi
         stub = EnvironmentSetupStub(EnvironmentSetupResult(requires_early_exit=True))
         sut, _ = tester(config=Config(databases=default_databases(), transition_service_only=True), env_stub=stub)
         self.assertEqual(EXIT_CODE_REQUIRES_EARLY_EXIT, sut.full_run(UpdateAllServicePass.NewRun))
+
+    def test_full_run___with_show_chip_id_result_command___opens_chip_id_result_menu_and_returns_without_update_flow(self):
+        events = []
+        settings_screen = MagicMock()
+        settings_screen.load_chip_id_result_menu.side_effect = lambda: events.append('menu')
+        sut, _ = tester(
+            config=Config(databases=default_databases(), command=COMMAND_SHOW_CHIP_ID_RESULT),
+            settings_screen=settings_screen,
+        )
+        sut._start_background_jobs = MagicMock(side_effect=lambda: events.append('start_background_jobs'))
+        sut._hard_wait_background_jobs = MagicMock(side_effect=lambda: events.append('hard_wait_background_jobs'))
+
+        result = sut.full_run(UpdateAllServicePass.NewRun)
+
+        self.assertEqual(0, result)
+        self.assertEqual(['menu'], events)
+        sut._start_background_jobs.assert_not_called()
+        settings_screen.load_chip_id_result_menu.assert_called_once_with()
+        sut._hard_wait_background_jobs.assert_not_called()
+
+    def test_full_run___with_show_chip_id_result_command_and_menu_failure___returns_without_update_flow(self):
+        events = []
+        settings_screen = MagicMock()
+        settings_screen.load_chip_id_result_menu.side_effect = RuntimeError('boom')
+        sut, _ = tester(
+            config=Config(databases=default_databases(), command=COMMAND_SHOW_CHIP_ID_RESULT),
+            settings_screen=settings_screen,
+        )
+        sut._start_background_jobs = MagicMock(side_effect=lambda: events.append('start_background_jobs'))
+        sut._hard_wait_background_jobs = MagicMock(side_effect=lambda: events.append('hard_wait_background_jobs'))
+
+        result = sut.full_run(UpdateAllServicePass.NewRun)
+
+        self.assertEqual(0, result)
+        self.assertEqual([], events)
+        sut._start_background_jobs.assert_not_called()
+        settings_screen.load_chip_id_result_menu.assert_called_once_with()
+        sut._hard_wait_background_jobs.assert_not_called()

src/test/unit/test_countdown.py

@@ -22,8 +22,6 @@
 
 from update_all.countdown import _countdown_left_padding, _countdown_status_line
 from update_all.logger import FileLoggerDecorator, PrintLogger
-from update_all.other import GenericProvider
-
 
 class TestCountdown(unittest.TestCase):
     def test_countdown_status_line___adds_clear_carriage_return_and_left_padding(self):
@@ -32,6 +30,6 @@ def test_countdown_status_line___adds_clear_carriage_return_and_left_padding(sel
     def test_countdown_left_padding___unwraps_decorated_print_logger(self):
         inner_logger = PrintLogger()
         inner_logger._overscan = 4
-        logger = FileLoggerDecorator(inner_logger, GenericProvider())
+        logger = FileLoggerDecorator(inner_logger, '/tmp/update_all_test.log')
 
         self.assertEqual(4, _countdown_left_padding(logger))

src/test/unit/test_other.py

@@ -16,9 +16,14 @@
 # You can download the latest version of this tool from:
 # https://github.com/theypsilon/Update_All_MiSTer
 
+import os
+import tempfile
 import unittest
+import zipfile
+from unittest.mock import patch
 
-from update_all.other import any_to_bool, any_to_nonfalsy_str, calculate_overscan, TerminalSize, OverscanDim, calculate_outer_box
+from update_all.other import any_to_bool, any_to_nonfalsy_str, calculate_overscan, TerminalSize, OverscanDim, calculate_outer_box, \
+    current_update_all_archive_path, is_mister_scripts_menu_fb_launch
 
 
 class TestOther(unittest.TestCase):
@@ -47,6 +52,28 @@ def test_any_to_nonfalsy_str(self):
             with self.subTest(value=value, expected=expected):
                 self.assertEqual(expected, any_to_nonfalsy_str(value))
 
+    def test_current_update_all_archive_path___when_argv0_is_zipapp_with_any_extension___returns_path(self):
+        path = _temp_zipapp_with_suffix('.sh')
+        try:
+            with patch('update_all.other.sys.argv', [path]):
+                self.assertEqual(path, current_update_all_archive_path())
+        finally:
+            _remove(path)
+
+    def test_current_update_all_archive_path___when_argv0_is_not_zipapp___returns_none(self):
+        with tempfile.NamedTemporaryFile(delete=False) as file:
+            path = file.name
+            file.write(b'#!/bin/bash\n')
+        try:
+            with patch('update_all.other.sys.argv', [path]):
+                self.assertIsNone(current_update_all_archive_path())
+        finally:
+            _remove(path)
+
+    def test_current_update_all_archive_path___when_argv0_is_missing___returns_none(self):
+        with patch('update_all.other.sys.argv', ['/tmp/missing_update_all']):
+            self.assertIsNone(current_update_all_archive_path())
+
     def test_calculate_overscan(self):
         def _size(columns=100, lines=50):
             return TerminalSize(columns=columns, lines=lines)
@@ -85,8 +112,47 @@ def test_calculate_outer_box___keeps_zero_line_overscan_outside_screen(self):
         screen_dims = _ScreenDims(TerminalSize(columns=80, lines=40), OverscanDim(cols=1, lines=0))
         self.assertEqual((-1, 40, 0, 79), calculate_outer_box(screen_dims))
 
+    def test_is_mister_scripts_menu_fb_launch___when_tty2_with_script_wrapper_and_mister_ancestor___returns_true(self):
+        with patch('update_all.other._current_tty', return_value='/dev/tty2'), \
+                patch('update_all.other._ancestor_process_descriptions', return_value=[
+                    ('bash', '/bin/bash /tmp/script'),
+                    ('agetty', '/sbin/agetty -l /tmp/script tty2'),
+                    ('MiSTer', '/media/fat/MiSTer'),
+                ]):
+            self.assertTrue(is_mister_scripts_menu_fb_launch())
+
+    def test_is_mister_scripts_menu_fb_launch___when_tty2_without_mister_ancestor___returns_false(self):
+        with patch('update_all.other._current_tty', return_value='/dev/tty2'), \
+                patch('update_all.other._ancestor_process_descriptions', return_value=[
+                    ('bash', '/bin/bash /tmp/script'),
+                    ('agetty', '/sbin/agetty -l /tmp/script tty2'),
+                ]):
+            self.assertFalse(is_mister_scripts_menu_fb_launch())
+
+    def test_is_mister_scripts_menu_fb_launch___when_not_tty2___returns_false(self):
+        with patch('update_all.other._current_tty', return_value='/dev/pts/0'), \
+                patch('update_all.other._ancestor_process_descriptions') as ancestors:
+            self.assertFalse(is_mister_scripts_menu_fb_launch())
+            ancestors.assert_not_called()
+
 
 class _ScreenDims:
     def __init__(self, term_size: TerminalSize, overscan_dim: OverscanDim):
         self.term_size = term_size
         self.overscan_dim = overscan_dim
+
+
+def _temp_zipapp_with_suffix(suffix: str) -> str:
+    with tempfile.NamedTemporaryFile(delete=False, suffix=suffix) as file:
+        path = file.name
+    with zipfile.ZipFile(path, 'w') as archive:
+        archive.writestr('__main__.py', '')
+    return path
+
+
+def _remove(*paths: str) -> None:
+    for path in paths:
+        try:
+            os.remove(path)
+        except FileNotFoundError:
+            pass