refactor(main): refactor the code to be simpler to test

Author: amilcarlucas

ardupilot_methodic_configurator/__main__.py

@@ -91,9 +91,20 @@ def create_argument_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def setup_logging_and_check_updates(state: ApplicationState) -> bool:
+def setup_logging(state: ApplicationState) -> None:
     """
-    Set up logging and check for software updates.
+    Set up logging.
+
+    Args:
+        state: Application state containing parsed arguments
+
+    """
+    logging_basicConfig(level=logging_getLevelName(state.args.loglevel), format="%(asctime)s - %(levelname)s - %(message)s")
+
+
+def check_updates(state: ApplicationState) -> bool:
+    """
+    Check for software updates.
 
     Args:
         state: Application state containing parsed arguments
@@ -102,8 +113,6 @@ def setup_logging_and_check_updates(state: ApplicationState) -> bool:
         True if the application should exit due to updates, False otherwise
 
     """
-    logging_basicConfig(level=logging_getLevelName(state.args.loglevel), format="%(asctime)s - %(levelname)s - %(message)s")
-
     if not state.args.skip_check_for_updates and check_for_software_updates():
         logging_info(_("Will now exit the old software version."))
         return True
@@ -448,18 +457,18 @@ def main() -> None:
     Orchestrates the entire application startup process by calling specialized functions
     for each major step.
     """
-    # Parse arguments and create application state
     args = create_argument_parser().parse_args()
+
     state = ApplicationState(args)
 
-    # Set up logging and check for updates
-    if setup_logging_and_check_updates(state):
-        sys_exit(0)
+    setup_logging(state)
+
+    # Check for software updates
+    if check_updates(state):
+        sys_exit(0)  # user asked to update, exit the old version
 
-    # Handle auto-opening documentation
     display_first_use_documentation()
 
-    # Initialize flight controller and filesystem
     initialize_flight_controller_and_filesystem(state)
 
     # Handle vehicle directory selection if needed

tests/test__main__.py

@@ -20,6 +20,7 @@
 from ardupilot_methodic_configurator.__main__ import (
     ApplicationState,
     backup_fc_parameters,
+    check_updates,
     component_editor,
     connect_to_fc_and_set_vehicle_type,
     create_and_configure_component_editor,
@@ -29,7 +30,6 @@
     open_firmware_documentation,
     parameter_editor_and_uploader,
     process_component_editor_results,
-    setup_logging_and_check_updates,
     should_open_firmware_documentation,
     vehicle_directory_selection,
     write_parameter_defaults_if_dirty,
@@ -145,15 +145,13 @@ def test_user_can_start_application_with_updates_disabled(self, application_stat
         application_state.args.skip_check_for_updates = True
 
         with (
-            patch("ardupilot_methodic_configurator.__main__.logging_basicConfig") as mock_logging,
             patch("ardupilot_methodic_configurator.__main__.check_for_software_updates") as mock_check,
         ):
             # Act: User starts application
-            should_exit = setup_logging_and_check_updates(application_state)
+            should_exit = check_updates(application_state)
 
             # Assert: Application continues normally
             assert should_exit is False
-            mock_logging.assert_called_once()
             mock_check.assert_not_called()
 
     def test_user_receives_update_notification_when_new_version_available(self, application_state: ApplicationState) -> None:
@@ -170,14 +168,12 @@ def test_user_receives_update_notification_when_new_version_available(self, appl
         with (
             patch("ardupilot_methodic_configurator.__main__.logging_basicConfig"),
             patch("ardupilot_methodic_configurator.__main__.check_for_software_updates", return_value=True),
-            patch("ardupilot_methodic_configurator.__main__.logging_info") as mock_log,
         ):
             # Act: User starts outdated application
-            should_exit = setup_logging_and_check_updates(application_state)
+            should_exit = check_updates(application_state)
 
             # Assert: User informed and application exits
             assert should_exit is True
-            mock_log.assert_called_once()
 
     def test_user_proceeds_normally_when_application_is_current(self, application_state: ApplicationState) -> None:
         """
@@ -191,11 +187,10 @@ def test_user_proceeds_normally_when_application_is_current(self, application_st
         application_state.args.skip_check_for_updates = False
 
         with (
-            patch("ardupilot_methodic_configurator.__main__.logging_basicConfig"),
             patch("ardupilot_methodic_configurator.__main__.check_for_software_updates", return_value=False),
         ):
             # Act: User starts current application
-            should_exit = setup_logging_and_check_updates(application_state)
+            should_exit = check_updates(application_state)
 
             # Assert: Application continues normally
             assert should_exit is False
@@ -461,7 +456,6 @@ def test_user_can_complete_standard_startup_workflow(self, mock_args: MagicMock)
         mock_args.skip_check_for_updates = True  # Skip for test efficiency
 
         with (
-            patch("ardupilot_methodic_configurator.__main__.logging_basicConfig"),
             patch("ardupilot_methodic_configurator.__main__.ProgramSettings.get_setting", return_value=False),
             patch("ardupilot_methodic_configurator.__main__.connect_to_fc_and_set_vehicle_type") as mock_connect,
             patch("ardupilot_methodic_configurator.__main__.FlightControllerInfoWindow"),
@@ -479,7 +473,7 @@ def test_user_can_complete_standard_startup_workflow(self, mock_args: MagicMock)
             # Act: Execute complete startup workflow
             state = ApplicationState(mock_args)
 
-            should_exit = setup_logging_and_check_updates(state)
+            should_exit = check_updates(state)
             assert should_exit is False
 
             display_first_use_documentation()  # Should complete without issues