Add more e2e shell tests

Signed-off-by: javrin <[email protected]>

Author: Jawabiscuit

src/rez/data/tests/packages/shell/1.0.0/package.py

@@ -5,4 +5,7 @@
 
 
 def commands():
+    import os
+
     env.PATH.append("{root}")
+    env.PYTHONPATH.append(os.path.join("{root}", "src"))

src/rez/data/tests/packages/shell/1.0.0/src/__init__.py

@@ -0,0 +1 @@
+

src/rez/tests/test_e2e_shells.py

@@ -6,10 +6,13 @@
 test shell invocation
 """
 from __future__ import print_function
+import os
 
+from rez.config import config
 from rez.shells import create_shell
 from rez.resolved_context import ResolvedContext
 from rez.tests.util import TestBase, TempdirMixin, per_available_shell
+from rez.utils.filesystem import canonical_path
 import unittest
 import subprocess
 
@@ -38,19 +41,111 @@ def _create_context(cls, pkgs):
 
     @per_available_shell()
     def test_shell_execution(self, shell):
+        """Test that a shell can be invoked."""
         sh = create_shell(shell)
         _, _, _, command = sh.startup_capabilities(command=True)
         if command:
             r = self._create_context(["shell"])
             p = r.execute_shell(command="echo asd", stdout=subprocess.PIPE, text=True)
-            _, _ = p.communicate()
+            stdout, _ = p.communicate()
+
+            self.assertEqual(stdout, "asd\n")
             self.assertEqual(p.returncode, 0)
 
             if p.returncode:
                 raise RuntimeError(
                     "The subprocess failed with exitcode %d" % p.returncode
                 )
 
+    @per_available_shell()
+    def test_shell_root_path_normalization(self, shell):
+        """Test {root} path is normalized to a platform native canonical path."""
+        pkg = "shell"
+        sh = create_shell(shell)
+        _, _, stdin, _ = sh.startup_capabilities(command=None, stdin=True)
+        if stdin:
+            r = self._create_context([pkg])
+            p = r.execute_shell(
+                command="echo $REZ_SHELL_ROOT", stdout=subprocess.PIPE, text=True
+            )
+            stdout, _ = p.communicate()
+            version = str(r.get_key("version")[pkg][-1])
+            expected_result = os.path.join(
+                self.settings.get("packages_path")[0], pkg, version
+            )
+            self.assertEqual(stdout.strip(), canonical_path(expected_result))
+
+    def test_shell_pythonpath_normalization(self, shell="gitbash"):
+        """Test PYTHONPATHs are being normalized by the shell."""
+        config.override("default_shell", shell)
+        config.override("enable_path_normalization", True)
+
+        sh = create_shell(shell)
+        r = self._create_context(["shell"])
+        p = r.execute_shell(
+            command="echo $PYTHONPATH", stdout=subprocess.PIPE, text=True
+        )
+        stdout, _ = p.communicate()
+        env = r.get_environ()
+        self.assertEqual(stdout.strip(), sh.as_shell_path(env["PYTHONPATH"]))
+
+    def test_shell_disabled_normalization(self, shell="gitbash"):
+        """Test disabled normalization."""
+        config.override("default_shell", shell)
+        config.override("enable_path_normalization", False)
+
+        sh = create_shell(shell)
+        r = self._create_context(["shell"])
+        p = r.execute_shell(
+            command="echo $PYTHONPATH", stdout=subprocess.PIPE, text=True
+        )
+        stdout, _ = p.communicate()
+        env = r.get_environ()
+        self.assertEqual(stdout.strip(), sh.as_shell_path(env["PYTHONPATH"]))
+
+        p = r.execute_shell(
+            command="echo $PATH", stdout=subprocess.PIPE, text=True
+        )
+        stdout, _ = p.communicate()
+        self.assertNotEqual(
+            stdout.strip().split(os.pathsep)[0],
+            sh.normalize_path(env["PATH"].split(os.pathsep)[0])
+        )
+
+    @per_available_shell()
+    def test_shell_invoking_script(self, shell):
+        """Test script used to invoke the shell."""
+        sh = create_shell(shell)
+
+        _, _, stdin, _ = sh.startup_capabilities(command=None, stdin=True)
+        if not stdin:
+            return
+
+        r = self._create_context(["shell"])
+        p = r.execute_shell(
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            text=True,
+        )
+        _, stderr = p.communicate()
+        self.assertEqual(p.returncode, 0)
+        assert stderr is None
+
+        exec_script = p.args[-1].split()[-1]
+        lines = []
+        with open(exec_script, "r") as f:
+            lines = f.readlines()
+
+        self.assertNotEqual(lines, [])
+        if sh.name() == "gitbash":
+            self.assertEqual(
+                lines[0].strip(), "#!/usr/bin/env {}".format(sh.executable_name())
+            )
+            assert any(
+                l.strip() == "'{}' {}".format(sh.executable_filepath(), sh.stdin_arg)
+                for l in lines
+            )
+
 
 if __name__ == "__main__":
     unittest.main()