diff --git a/src/tufup/utils/platform_specific.py b/src/tufup/utils/platform_specific.py index 3e5c588..096519c 100644 --- a/src/tufup/utils/platform_specific.py +++ b/src/tufup/utils/platform_specific.py @@ -128,6 +128,7 @@ def _install_update_win( batch_template_extra_kwargs: Optional[dict] = None, log_file_name: Optional[str] = None, robocopy_options_override: Optional[List[str]] = None, + process_creation_flags = None, ): """ Create a batch script that moves files from src to dst, then run the @@ -159,7 +160,14 @@ def _install_update_win( to be overridden completely. It accepts a list of option strings. This will cause the purge arguments to be ignored as well. + The `process_creation_flags` option allows users to override creation flags for + the subprocess call that runs the batch script. For example, one could specify + `subprocess.CREATE_NO_WINDOW` to prevent a window from opening. See [2] and [3] + for details. + [1]: https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/robocopy + [2]: https://docs.python.org/3/library/subprocess.html#windows-constants + [3]: https://learn.microsoft.com/en-us/windows/win32/procthread/process-creation-flags """ if batch_template_extra_kwargs is None: batch_template_extra_kwargs = dict() @@ -206,8 +214,14 @@ def _install_update_win( if as_admin: run_bat_as_admin(file_path=script_path) else: + # by default we create a new console with window, but user can override this + # using the process_creation_flags argument + if process_creation_flags is None: + process_creation_flags = subprocess.CREATE_NEW_CONSOLE + else: + logger.debug('using custom process creation flags') # we use Popen() instead of run(), because the latter blocks execution - subprocess.Popen([script_path], creationflags=subprocess.CREATE_NEW_CONSOLE) + subprocess.Popen([script_path], creationflags=process_creation_flags) logger.debug('exiting') # exit current process sys.exit(0) diff --git a/tests/test_utils_platform_specific.py b/tests/test_utils_platform_specific.py index 1b70216..cbfa04e 100644 --- a/tests/test_utils_platform_specific.py +++ b/tests/test_utils_platform_specific.py @@ -22,6 +22,7 @@ ) DUMMY_APP_CONTENT = f""" +import subprocess import sys sys.path.append('{(BASE_DIR.parent / 'src').as_posix()}') from tufup.utils.platform_specific import install_update @@ -176,6 +177,22 @@ def test_install_update_log_file(self): log_file_content = log_file_path.read_text() self.assertTrue(log_file_content) + @unittest.skipIf( + condition=not ON_WINDOWS, reason='process_creation_flags is for windows only' + ) + def test_install_update_process_creation_flags(self): + # the log file is only used to verify that the batch file has run successfully + log_file_name = 'install.log' + extra_kwargs_strings = [ + 'process_creation_flags=subprocess.CREATE_NO_WINDOW', + f'log_file_name="{log_file_name}"', + ] + # run the dummy app in a separate process + self.run_dummy_app(extra_kwargs_strings=extra_kwargs_strings) + # a log file should exist + log_file_path = self.dst_dir / log_file_name + self.assertTrue(log_file_path.read_text()) + @unittest.skipIf( condition=not ON_WINDOWS, reason='windows batch files are windows only' )