updated test based on custom and no naming of log files

Signed-off-by: Tanishq Chaudhary <[email protected]>

Author: Tanishq30052002

launch/launch/logging/__init__.py

@@ -430,7 +430,8 @@ def _normalize_output_configuration(config):
     return normalized_config
 
 
-def get_output_loggers(process_name, output_config):
+def get_output_loggers(
+        process_name, output_config, main_log_file_name='launch.log'):
     """
     Get the stdout and stderr output loggers for the given process name.
 
@@ -471,6 +472,7 @@ def get_output_loggers(process_name, output_config):
     :param process_name: the process-like action whose outputs want to be logged.
     :param output_config: configuration for the output loggers,
         see above for details.
+    :param main_log_file: the main log file from the ros2launch
     :returns: a tuple with the stdout and stderr output loggers.
     """
     output_config = _normalize_output_configuration(output_config)
@@ -490,6 +492,7 @@ def get_output_loggers(process_name, output_config):
         # If a 'log' output is configured for this source or for
         # 'both' sources, this logger should output to launch main log file.
         if 'log' in (output_config['both'] | output_config[source]):
+            launch_config.log_file_name = main_log_file_name
             launch_log_file_handler = launch_config.get_log_file_handler()
             # Add launch main log file handler if necessary.
             if launch_log_file_handler not in logger.handlers:
@@ -517,8 +520,6 @@ def get_output_loggers(process_name, output_config):
             if combined_log_file_handler not in logger.handlers:
                 logger.addHandler(combined_log_file_handler)
 
-        # Reset log file name since we will iterate over the sources
-        launch_config._log_file_name = None
     # Retrieve both loggers.
     return (
         logging.getLogger(process_name + '-stdout'),

launch/test/launch/test_logging.py

@@ -67,7 +67,7 @@ def test_output_loggers_bad_configuration(log_dir):
         launch.logging.get_output_loggers('some-proc', {'stdout': {'garbage'}})
 
 
-@pytest.mark.parametrize('config,checks', [
+configs = [
     ('screen', {'stdout': {'screen'}, 'stderr': {'screen'}}),
     ('log', {'stdout': {'log'}, 'stderr': {'log', 'screen'}}),
     ('both', {'both': {'log', 'screen'}}),
@@ -88,16 +88,32 @@ def test_output_loggers_bad_configuration(log_dir):
             'stderr': {'own_log'}
         },
     )
-])
-def test_output_loggers_configuration(capsys, log_dir, config, checks, mock_clean_env):
+]
+log_file_names = ['custom-log-name.log', None]
+params = [
+    (config, checks, log_file_name)
+    for (config, checks) in configs
+    for log_file_name in log_file_names
+]
+
+
+@pytest.mark.parametrize('config,checks,main_log_file_name', params)
+def test_output_loggers_configuration(
+    capsys, log_dir, config, checks, main_log_file_name, mock_clean_env
+):
     checks = {'stdout': set(), 'stderr': set(), 'both': set(), **checks}
     launch.logging.reset()
+    if main_log_file_name is None:
+        main_log_file_name = launch.logging.launch_config.log_file_name
+    logger_name = main_log_file_name.removesuffix('.log')
     launch.logging.launch_config.log_dir = log_dir
-    logger = launch.logging.get_logger('some-proc')
+    launch.logging.launch_config.log_file_name = main_log_file_name
+    logger = launch.logging.get_logger(logger_name)
     logger.addHandler(launch.logging.launch_config.get_screen_handler())
     logger.addHandler(launch.logging.launch_config.get_log_file_handler())
     logger.setLevel(logging.ERROR)
-    stdout_logger, stderr_logger = launch.logging.get_output_loggers('some-proc', config)
+    stdout_logger, stderr_logger = launch.logging.get_output_loggers(
+                                    'some-proc', config, main_log_file_name)
 
     logger.debug('oops')
     logger.error('baz')
@@ -106,21 +122,22 @@ def test_output_loggers_configuration(capsys, log_dir, config, checks, mock_clea
 
     capture = capsys.readouterr()
     lines = list(reversed(capture.out.splitlines()))
-    assert '[ERROR] [some-proc]: baz' == lines.pop()
+    assert f'[ERROR] [{logger_name}]: baz' == lines.pop()
     if 'screen' in (checks['stdout'] | checks['both']):
         assert 'foo' == lines.pop()
     if 'screen' in (checks['stderr'] | checks['both']):
         assert 'bar' == lines.pop()
     assert 0 == len(lines)
     assert 0 == len(capture.err)
 
-    launch.logging.launch_config.log_file_name = 'launch.log'
+    launch.logging.launch_config.log_file_name = main_log_file_name
     main_log_path = launch.logging.launch_config.get_log_file_path()
     assert os.path.exists(main_log_path)
     assert 0 != os.stat(main_log_path).st_size
     with open(main_log_path, 'r') as f:
         lines = list(reversed(f.readlines()))
-        assert re.match(r'[0-9]+\.[0-9]+ \[ERROR\] \[some-proc\]: baz', lines.pop()) is not None
+        assert re.match(rf'[0-9]+\.[0-9]+ \[ERROR\] \[{logger_name}\]: baz',
+                        lines.pop()) is not None
         if 'log' in (checks['stdout'] | checks['both']):
             assert re.match(r'[0-9]+\.[0-9]+ foo', lines.pop()) is not None
         if 'log' in (checks['stderr'] | checks['both']):