for-all-repos: Add option to keep current env

Extend support for preserving the current environment to the
for-all-repos plugin with the --preserve-env flag.
This eases the usage of dynamic configuration done via environment
variables within the for-all-repos plugin, e.g. when calling a script.

Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>

kas/libkas.py

@@ -391,3 +391,30 @@ def setup_parser_common_args(parser):
     parser.add_argument('--update', action='store_true',
                         help='Pull new upstream changes to the desired '
                         'refspec even if it is already checked out locally')
+
+
+def setup_parser_preserve_env_arg(parser):
+    parser.add_argument('-E', '--preserve-env',
+                        help='Keep current user enviornment block',
+                        action='store_true')
+
+
+def run_handle_preserve_env_arg(ctx, os, args, SetupHome):
+    if args.preserve_env:
+        # Warn if there's any settings that setup_home would apply
+        # but are now ignored
+        for var in SetupHome.ENV_VARS:
+            if var in os.environ:
+                logging.warning('Environment variable "%s" ignored '
+                                'because user environment is being used',
+                                var)
+
+        if not os.isatty(sys.stdout.fileno()):
+            logging.error("Error: --preserve-env can only be "
+                          "run from a tty")
+            sys.exit(1)
+
+        ctx.environ = os.environ.copy()
+
+        logging.warning("Preserving the current environment block may "
+                        "have unintended side effects on the build.")

kas/plugins/for_all_repos.py

@@ -54,12 +54,15 @@
 """
 
 import logging
+import os
 import subprocess
 import sys
 from kas.context import create_global_context
 from kas.config import Config
-from kas.libcmds import Macro, Command
+from kas.libcmds import Macro, Command, SetupHome
 from kas.libkas import setup_parser_common_args
+from kas.libkas import setup_parser_preserve_env_arg
+from kas.libkas import run_handle_preserve_env_arg
 
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
@@ -74,6 +77,7 @@ class ForAllRepos:
     @classmethod
     def setup_parser(cls, parser):
         setup_parser_common_args(parser)
+        setup_parser_preserve_env_arg(parser)
         parser.add_argument('command',
                             help='Command to be executed as a string.')
 
@@ -81,6 +85,8 @@ class ForAllRepos:
         ctx = create_global_context(args)
         ctx.config = Config(ctx, args.config)
 
+        run_handle_preserve_env_arg(ctx, os, args, SetupHome)
+
         macro = Macro()
         macro.add(ForAllReposCommand(args.command))
         macro.run(ctx, args.skip)

kas/plugins/shell.py

@@ -45,6 +45,8 @@ from kas.context import create_global_context
 from kas.config import Config
 from kas.libcmds import Macro, Command, SetupHome
 from kas.libkas import setup_parser_common_args
+from kas.libkas import setup_parser_preserve_env_arg
+from kas.libkas import run_handle_preserve_env_arg
 
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
@@ -65,15 +67,13 @@ class Shell:
         """
 
         setup_parser_common_args(parser)
+        setup_parser_preserve_env_arg(parser)
         parser.add_argument('-k', '--keep-config-unchanged',
                             help='Skip steps that change the configuration',
                             action='store_true')
         parser.add_argument('-c', '--command',
                             help='Run command',
                             default='')
-        parser.add_argument('-E', '--preserve-env',
-                            help='Keep current user enviornment block',
-                            action='store_true')
 
     def run(self, args):
         """
@@ -83,24 +83,7 @@ class Shell:
         ctx = create_global_context(args)
         ctx.config = Config(ctx, args.config)
 
-        if args.preserve_env:
-            # Warn if there's any settings that setup_home would apply
-            # but are now ignored
-            for var in SetupHome.ENV_VARS:
-                if var in os.environ:
-                    logging.warning('Environment variable "%s" ignored '
-                                    'because user environment is being used',
-                                    var)
-
-            if not os.isatty(sys.stdout.fileno()):
-                logging.error("Error: --preserve-env can only be "
-                              "run from a tty")
-                sys.exit(1)
-
-            ctx.environ = os.environ.copy()
-
-            logging.warning("Preserving the current environment block may "
-                            "have unintended side effects on the build.")
+        run_handle_preserve_env_arg(ctx, os, args, SetupHome)
 
         if args.keep_config_unchanged:
             # Skip the tasks which would change the config of the build