Apply minor updates to address feedback

Distro A; OPSEC #4584

Signed-off-by: Roger Strain <[email protected]>

Author: Roger Strain

launch/launch/actions/execute_local.py

@@ -507,17 +507,6 @@ def on_stdout_received(self, data: bytes) -> None:
         def on_stderr_received(self, data: bytes) -> None:
             self.__context.emit_event_sync(ProcessStderr(text=data, **self.__process_event_args))
 
-    def __expand_substitutions(self, context):
-        # store packed kwargs for all ProcessEvent based events
-        self.__process_event_args = {
-            'action': self,
-            'name': self.__process_description.final_name,
-            'cmd': self.__process_description.final_cmd,
-            'cwd': self.__process_description.final_cwd,
-            'env': self.__process_description.final_env,
-            # pid is added to the dictionary in the connection_made() method of the protocol.
-        }
-
     async def __execute_process(self, context: LaunchContext) -> None:
         process_event_args = self.__process_event_args
         if process_event_args is None:
@@ -589,8 +578,17 @@ async def __execute_process(self, context: LaunchContext) -> None:
 
     def prepare(self, context: LaunchContext):
         """Prepare the action for execution."""
-        self.__process_description.apply_context(context)
-        self.__expand_substitutions(context)
+        self.__process_description.prepare(self, context)
+
+        # store packed kwargs for all ProcessEvent based events
+        self.__process_event_args = {
+            'action': self,
+            'name': self.__process_description.final_name,
+            'cmd': self.__process_description.final_cmd,
+            'cwd': self.__process_description.final_cwd,
+            'env': self.__process_description.final_env,
+            # pid is added to the dictionary in the connection_made() method of the protocol.
+        }
 
     def execute(self, context: LaunchContext) -> Optional[List[LaunchDescriptionEntity]]:
         """

launch/launch/descriptions/executable.py

@@ -148,16 +148,16 @@ def final_env(self):
         """Getter for final_env."""
         return self.__final_env
 
-    def apply_context(self, context: LaunchContext):
+    def prepare(self, action: Action, context: LaunchContext):
         """
         Prepare an executable description for execution in a given environment.
 
         This does the following:
         - performs substitutions on various properties
-        """
-        self.__expand_substitutions(context)
 
-    def __expand_substitutions(self, context):
+        Note that 'action' is not used at this level; it is provided for use
+        by subclasses which may override this method.
+        """
         # expand substitutions in arguments to async_execute_process()
         cmd = [perform_substitutions(context, x) for x in self.__cmd]
         cmd = shlex.split(perform_substitutions(context, self.__prefix)) + cmd

launch/test/launch/test_executable.py

@@ -34,45 +34,47 @@ def test_executable():
 
 def test_cmd_string_in_list():
     exe = Executable(cmd=['ls "my/subdir/with spaces/"'])
-    exe.apply_context(LaunchContext())
+    exe.prepare(None, LaunchContext())
     assert all(a == b for a, b in zip(exe.final_cmd, ['ls "my/subdir/with spaces/"']))
 
 
 def test_cmd_strings_in_list():
     exe = Executable(cmd=['ls', '"my/subdir/with spaces/"'])
-    exe.apply_context(LaunchContext())
+    exe.prepare(None, LaunchContext())
     assert all(a == b for a, b in zip(exe.final_cmd, ['ls', '"my/subdir/with spaces/"']))
 
 
 def test_cmd_multiple_arguments_in_string():
     exe = Executable(cmd=['ls', '-opt1', '-opt2', '-opt3'])
-    exe.apply_context(LaunchContext())
+    exe.prepare(None, LaunchContext())
     assert all(a == b for a, b in zip(exe.final_cmd, ['ls', '-opt1', '-opt2', '-opt3']))
 
+
 def test_passthrough_properties():
     name = 'name'
     cwd = 'cwd'
     env = {'a': '1'}
     exe = Executable(cmd=['test'], name=name, cwd=cwd, env=env)
-    exe.apply_context(LaunchContext())
+    exe.prepare(None, LaunchContext())
     assert exe.final_name.startswith(name)
     assert exe.final_cwd == cwd
     assert exe.final_env == env
-    
+
+
 def test_substituted_properties():
-    os.environ['EXECUTABLE_TEST_NAME'] = 'name'
-    os.environ['EXECUTABLE_TEST_CWD'] = 'cwd'
-    os.environ['EXECUTABLE_TEST_ENVVAR'] = 'var'
-    os.environ['EXECUTABLE_TEST_ENVVAL'] = 'value'
-    name = EnvironmentVariable('EXECUTABLE_TEST_NAME')
-    cwd = EnvironmentVariable('EXECUTABLE_TEST_CWD')
-    env = {EnvironmentVariable('EXECUTABLE_TEST_ENVVAR'): EnvironmentVariable('EXECUTABLE_TEST_ENVVAL')}
+    os.environ['EXECUTABLE_NAME'] = 'name'
+    os.environ['EXECUTABLE_CWD'] = 'cwd'
+    os.environ['EXECUTABLE_ENVVAR'] = 'var'
+    os.environ['EXECUTABLE_ENVVAL'] = 'value'
+    name = EnvironmentVariable('EXECUTABLE_NAME')
+    cwd = EnvironmentVariable('EXECUTABLE_CWD')
+    env = {EnvironmentVariable('EXECUTABLE_EV'): EnvironmentVariable('EXECUTABLE_ENVVAL')}
     exe = Executable(cmd=['test'], name=name, cwd=cwd, env=env)
-    exe.apply_context(LaunchContext())
+    exe.prepare(None, LaunchContext())
     assert exe.final_name.startswith('name')
     assert exe.final_cwd == 'cwd'
     assert exe.final_env == {'var': 'value'}
-    del os.environ['EXECUTABLE_TEST_NAME']
-    del os.environ['EXECUTABLE_TEST_CWD']
-    del os.environ['EXECUTABLE_TEST_ENVVAR']
-    del os.environ['EXECUTABLE_TEST_ENVVAL']
+    del os.environ['EXECUTABLE_NAME']
+    del os.environ['EXECUTABLE_CWD']
+    del os.environ['EXECUTABLE_ENVVAR']
+    del os.environ['EXECUTABLE_ENVVAL']

launch/test/launch/test_execute_local.py

@@ -35,6 +35,7 @@
 
 import pytest
 
+
 @pytest.mark.parametrize('test_input,expected', [
     (None, [True, False]),
     ({'TEST_NEW_ENV': '2'}, [False, True])