[lit] Print internal env commands

[jdenny]

Summary

Without this patch, the internal env command removes env and its
args from the command line while parsing it. This patch modifies a
copy instead so that the original command line is printed.

[rnk]

Suggestion, but this looks good too.

llvm/utils/lit/lit/TestRunner.py

881

I think it would be clearer to make updateEnv return the new command to run after env instead of modifying cmd.args. We copy cmd.args on line 903 currently anyway.

915

If you take my suggestion, this needs to use args not j.args, since it will refer to "env" and not the real exe for env-prefixed commands.

[jdenny]

Apply rnk's suggestion, and adjust updateEnv to make it clear it only operates on the arguments.

@rnk, @stella.stamenova : thanks.

I'll wait a bit to push in case there are further comments.

[rnk]

lgtm, thanks!

llvm/utils/lit/lit/TestRunner.py

def _executeShCmd(cmd, shenv, results, timeoutHelper):
     builtin_commands = set(['cat'])
     builtin_commands_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "builtin_commands")
     # To avoid deadlock, we use a single stderr stream for piped
     # output. This is null until we have seen some output using
     # stderr.
     for i,j in enumerate(cmd.commands):
         # Reference the global environment by default.
         cmd_shenv = shenv
+        original_args = list(j.args)
         if j.args[0] == 'env':
             # Create a copy of the global environment and modify it for this one
             # command. There might be multiple envs in a pipeline:
             #   env FOO=1 llc < %s | env BAR=2 llvm-mc | FileCheck %s
             cmd_shenv = ShellEnvironment(shenv.cwd, shenv.env)
             updateEnv(cmd_shenv, j)
 
         stdin, stdout, stderr = processRedirects(j, default_stdin, cmd_shenv,
                                                  opened_files)
 
         # If stderr wants to come from stdout, but stdout isn't a pipe, then put
         # stderr on a pipe and treat it as stdout.
         if (stderr == subprocess.STDOUT and stdout != subprocess.PIPE):
             stderr = subprocess.PIPE
for i,j in enumerate(cmd.commands):
             # For paths relative to cwd, use the cwd of the shell environment.
             if args[0].startswith('.'):
                 exe_in_cwd = os.path.join(cmd_shenv.cwd, args[0])
                 if os.path.isfile(exe_in_cwd):
                     executable = exe_in_cwd
             if not executable:
                 executable = lit.util.which(args[0], cmd_shenv.env['PATH'])
             if not executable:
                 raise InternalShellError(j, '%r: command not found' % j.args[0])
 
         # Replace uses of /dev/null with temporary files.
         if kAvoidDevNull:
             # In Python 2.x, basestring is the base class for all string (including unicode)
             # In Python 3.x, basestring no longer exist and str is always unicode
             try:
                 str_type = basestring
             except NameError:
for i,j in enumerate(cmd.commands):
         # Update the current stdin source.
         if stdout == subprocess.PIPE:
             default_stdin = procs[-1].stdout
         elif stderrIsStdout:
             default_stdin = procs[-1].stderr
         else:
             default_stdin = subprocess.PIPE
 
+        # Restore the original args for printing.
+        cmd.commands[i].args = original_args
+
     # Explicitly close any redirected files. We need to do this now because we
     # need to release any handles we may have on the temporary files (important
     # on Win32, for example). Since we have already spawned the subprocess, our
     # handles have already been transferred so we do not need them anymore.
     for (name, mode, f, path) in opened_files:
         f.close()
 
     # FIXME: There is probably still deadlock potential here. Yawn.

llvm/utils/lit/tests/shtest-env.py

 # Check the env command
 #
-# RUN: %{lit} -a -v %{inputs}/shtest-env
+# RUN: %{lit} -j 1 -a -v %{inputs}/shtest-env \
+# RUN: | FileCheck -match-full-lines %s
+#
+# END.
+
+# Make sure env commands are included in printed commands.
+
+# CHECK: PASS: shtest-env :: env-u.txt ({{[^)]*}})
+# CHECK: $ "{{[^"]*}}" "print_environment.py"
+# CHECK: $ "env" "-u" "FOO" "{{[^"]*}}" "print_environment.py"
+# CHECK: $ "env" "-u" "FOO" "-u" "BAR" "{{[^"]*}}" "print_environment.py"
+
+# CHECK: PASS: shtest-env :: env.txt ({{[^)]*}})
+# CHECK: $ "env" "A_FOO=999" "{{[^"]*}}" "print_environment.py"
+# CHECK: $ "env" "A_FOO=1" "B_BAR=2" "C_OOF=3" "{{[^"]*}}" "print_environment.py"
+
+# CHECK: PASS: shtest-env :: mixed.txt ({{[^)]*}})
+# CHECK: $ "env" "A_FOO=999" "-u" "FOO" "{{[^"]*}}" "print_environment.py"
+# CHECK: $ "env" "A_FOO=1" "-u" "FOO" "B_BAR=2" "-u" "BAR" "C_OOF=3" "{{[^"]*}}" "print_environment.py"
+
+# CHECK: Expected Passes : 3