Merge branch 'feature/1256-add-git-bash-shell-plugin'

Author: nerdvegas

.github/docker/rez-win-py/Dockerfile

@@ -17,6 +17,7 @@ SHELL ["powershell.exe", "-NoLogo", "-NoProfile", "-ExecutionPolicy", "ByPass"]
 #
 ARG PYTHON_VERSION
 
+
 # ------------------------------------------------------------------------------------------------------------
 # Python
 #
@@ -32,21 +33,31 @@ RUN ${PYTHON_INSTALL_PATH} = 'C:\Python'; `
         ${INSTALLARGS} = \"'/quiet InstallAllUsers=1 PrependPath=1 TargetDir=`\"\" + ${PYTHON_INSTALL_PATH} + \"`\"'\"; `
     } `
     choco install python${PYTHON_MAJOR_VERSION} --yes --version=\"${ENV:PYTHON_VERSION}\" --override --installargs=${INSTALLARGS}; `
-    if (-not $?) {exit 1};
+    if (-not $?) {exit 1}
 
-# ------------------------------------------------------------------------------------------------------------
-# Verify Python
-#
+# Verify
 RUN $python_relative_ver = (& python --version 2>&1).ToString().Trim().Split(" ")[1]; `
     $python_explicit_ver = (& C:\python\python.exe --version 2>&1).ToString().Trim().Split(" ")[1]; `
     if (-not $?) {exit 1}; `
     $python_relative_ver = (& python --version 2>&1).ToString().Trim().Split(" ")[1]; `
     $python_explicit_ver = (& C:\python\python.exe --version 2>&1).ToString().Trim().Split(" ")[1]; `
-    if (-not ($python_explicit_ver -eq $python_relative_ver -and $python_explicit_ver -eq ${ENV:PYTHON_VERSION})) {exit 1}; `
-    choco install --yes choco-cleaner; `
+    if (-not ($python_explicit_ver -eq $python_relative_ver -and $python_explicit_ver -eq ${ENV:PYTHON_VERSION})) {exit 1}
+
+
+# ------------------------------------------------------------------------------------------------------------
+# Git Bash (git for windows)
+#
+RUN choco install git --yes --params "/GitAndUnixToolsOnPath"
+
+
+# ------------------------------------------------------------------------------------------------------------
+# Cleanup
+#
+RUN choco install --yes choco-cleaner; `
     C:\ProgramData\chocolatey\bin\choco-cleaner.bat; `
     choco uninstall --yes choco-cleaner
 
+
 COPY entrypoint.ps1 /entrypoint.ps1
 
 ENTRYPOINT ["powershell.exe", "-NoLogo", "-ExecutionPolicy", "ByPass", "-File", "/entrypoint.ps1"]

.github/docker/rez-win-py/entrypoint.ps1

@@ -14,23 +14,30 @@ ${ENV:PYTHONIOENCODING} = "UTF-8"
 Write-Output "Using docker image ${ENV:_IMAGE_NAME}"
 
 # Verify Python
-#
+Write-Output "python found at $((Get-Command python).Path)"
 python --version
 if (-not $?) {exit 1}
 
 # Verify cmake
-#
+Write-Output "cmake found at $((Get-Command cmake).Path)"
 cmake.exe --version
 if (-not $?) {exit 1}
 
-#Verify pwsh
+# Verify pwsh
+Write-Output "pwsh found at $((Get-Command pwsh).Path)"
 pwsh --version
 if (-not $?) {exit 1}
 
-#Verify git
+# Verify git
+Write-Output "git found at $((Get-Command git).Path)"
 git --version
 if (-not $?) {exit 1}
 
+# Verify git-bash
+Write-Output "bash (via Git for windows) found at $((Get-Command bash).Path)"
+bash --version
+if (-not $?) {exit 1}
+
 # Install rez
 # Note that the workflow's checkout has been bind mounted to /checkout
 mkdir build
@@ -42,7 +49,6 @@ if (-not $?) {exit 1}
 .\build\Scripts\rez\rez-python -m pip install parameterized
 
 # Run Rez Tests
-#
 .\build\Scripts\rez\rez-selftest.exe -v
 
 # Pass on exit code to runner

.github/workflows/mac.yaml

@@ -57,4 +57,5 @@ jobs:
       - name: Run Rez Tests
         run: |
           ./build/bin/rez/rez-selftest -v
-
+        env:
+          _REZ_ENSURE_TEST_SHELLS: sh,csh,bash,tcsh,zsh,pwsh

.github/workflows/ubuntu.yaml

@@ -74,4 +74,5 @@ jobs:
       - name: Run Rez Tests
         run: |
           ./build/bin/rez/rez-selftest -v
-
+        env:
+          _REZ_ENSURE_TEST_SHELLS: sh,csh,bash,tcsh,zsh,pwsh

.github/workflows/windows.yaml

@@ -203,9 +203,6 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os-version:
-          - '2019'
-
         # The windows version has to match the host system.
         # 1809 -> 10.0.17763.805 -> windows-2019
         # Compare: https://hub.docker.com/_/microsoft-windows-servercore
@@ -378,3 +375,5 @@ jobs:
           docker run `
             --mount type=bind,src=$pwd,dst=C:\checkout,readonly `
             ${{ steps.vars.outputs.docker_image }}
+        env:
+          _REZ_ENSURE_TEST_SHELLS: cmd,pwsh,gitbash

src/rez/build_system.py

@@ -327,6 +327,7 @@ def add_standard_build_actions(cls, executor, context, variant, build_type,
                                    install, build_path, install_path=None):
         """Perform build actions common to every build system.
         """
+
         # set env vars
         cls.set_standard_vars(
             executor=executor,

src/rez/rex.py

@@ -594,6 +594,7 @@ def normalize_path(self, path):
 
     def normalize_paths(self, value):
         """Normalize value if it's a path(s).
+
         Note that `value` may be more than one pathsep-delimited paths.
         """
         paths = value.split(self.pathsep)
@@ -1352,7 +1353,9 @@ def append_rez_path(self):
 
     def normalize_path(self, path):
         """Normalize a path.
+
         Note that in many interpreters this will be unchanged.
+
         Returns:
             str: The normalized path.
         """

src/rez/shells.py

@@ -176,6 +176,16 @@ def find_executable(cls, name, check_syspaths=False):
         Returns:
             str: Full filepath of executable.
         """
+        settings = config.plugins.shell[cls.name()]
+
+        if settings.executable_fullpath:
+            if not os.path.exists(settings.executable_fullpath):
+                raise RuntimeError(
+                    "Couldn't find executable '%s'." % settings.executable_fullpath
+                )
+            else:
+                return settings.executable_fullpath
+
         exe = which(name)
 
         if not exe and check_syspaths:
@@ -475,6 +485,7 @@ def _create_ex():
 
         if shell_command:  # an empty string means 'run no command and exit'
             executor.command(shell_command)
+
         executor.command("exit %s" % self.last_command_status)
 
         code = executor.get_output()

src/rez/tests/test_shells.py

@@ -8,9 +8,10 @@
 from __future__ import print_function
 
 from rez.system import system
-from rez.shells import create_shell
+from rez.shells import create_shell, get_shell_types, get_shell_class
 from rez.resolved_context import ResolvedContext
 from rez.rex import literal, expandable
+from rez.plugin_managers import plugin_manager
 from rez.utils.execution import ExecutableScriptMode, _get_python_script_files
 from rez.tests.util import TestBase, TempdirMixin, per_available_shell, \
     install_dependent
@@ -26,6 +27,10 @@
 
 def _stdout(proc):
     out_, _ = proc.communicate()
+    if proc.returncode:
+        raise RuntimeError(
+            "The subprocess failed with exitcode %d" % proc.returncode
+        )
     return out_.strip()
 
 
@@ -52,6 +57,46 @@ def tearDownClass(cls):
     def _create_context(cls, pkgs):
         return ResolvedContext(pkgs, caching=False)
 
+    def test_aaa_shell_presence(self):
+        """Ensure specific shell types are present as loaded plugins.
+
+        The env var _REZ_ENSURE_TEST_SHELLS should be set by a CI system (such
+        as github actions) to make sure the shells we expect to be installed,
+        are installed, and are getting tested.
+
+        Note 'aaa' forces unittest to run this test first.
+        """
+        shells = os.getenv("_REZ_ENSURE_TEST_SHELLS", "").split(',')
+        shells = set(x for x in shells if x)
+
+        if not shells:
+            self.skipTest("Not ensuring presence of shells from explicit list")
+            return
+
+        # check for missing shells
+        missing_shells = shells - set(get_shell_types())
+        if missing_shells:
+            raise RuntimeError(
+                "The following shells should be available for testing but are "
+                "not present: %r" % list(missing_shells)
+            )
+
+        # check for unavailable shells
+        for shell in shells:
+            if not get_shell_class(shell).is_available():
+                raise RuntimeError(
+                    "The shell %r is not available (executable not found)"
+                    % shell
+                )
+
+        # check for shell plugins that failed to load
+        for (name, reason) in plugin_manager.get_failed_plugins("shell"):
+            if name in shells:
+                raise RuntimeError(
+                    "The shell plugin %r failed to load: %s"
+                    % (name, reason)
+                )
+
     @per_available_shell()
     def test_no_output(self, shell):
         sh = create_shell(shell)
@@ -208,7 +253,7 @@ def _test(txt):
             # how it's been configured
             #
             if sh_out[1]:
-                raise Exception("Command %r failed:\n%s" % (txt, sh_out[1]))
+                raise RuntimeError("Command %r failed:\n%s" % (txt, sh_out[1]))
 
             self.assertEqual(sh_out[0].strip(), txt)
 
@@ -351,6 +396,7 @@ def _print(value):
 
         # Assertions for other environment variable types
         from rez.shells import create_shell
+
         sh = create_shell()
         for token in sh.get_all_key_tokens("WHO"):
             expected_output += [

src/rezplugins/shell/_utils/windows.py

@@ -4,6 +4,8 @@
 
 import os
 import re
+import subprocess
+from rez.utils.execution import Popen
 
 
 _drive_start_regex = re.compile(r"^([A-Za-z]):\\")
@@ -12,6 +14,7 @@
 
 def to_posix_path(path):
     """Convert (eg) "C:\foo" to "/c/foo"
+
     TODO: doesn't take into account escaped bask slashes, which would be
     weird to have in a path, but is possible.
     """
@@ -42,3 +45,66 @@ def to_windows_path(path):
     weird to have in a path, but is possible.
     """
     return path.replace('/', '\\')
+
+
+def get_syspaths_from_registry():
+
+    def gen_expected_regex(parts):
+        whitespace = r"[\s]+"
+        return whitespace.join(parts)
+
+    entries = (
+        # local machine
+        dict(
+            cmd=[
+                "REG",
+                "QUERY",
+                "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment",
+                "/v",
+                "PATH"
+            ],
+            expected=gen_expected_regex([
+                "HKEY_LOCAL_MACHINE\\\\SYSTEM\\\\CurrentControlSet\\\\Control\\\\Session Manager\\\\Environment",
+                "PATH",
+                "REG_(EXPAND_)?SZ",
+                "(.*)"
+            ])
+        ),
+        # current user
+        dict(
+            cmd=[
+                "REG",
+                "QUERY",
+                "HKCU\\Environment",
+                "/v",
+                "PATH"
+            ],
+            expected=gen_expected_regex([
+                "HKEY_CURRENT_USER\\\\Environment",
+                "PATH",
+                "REG_(EXPAND_)?SZ",
+                "(.*)"
+            ])
+        )
+    )
+
+    paths = []
+
+    for entry in entries:
+        p = Popen(
+            entry["cmd"],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            shell=True,
+            text=True
+        )
+
+        out_, _ = p.communicate()
+        out_ = out_.strip()
+
+        if p.returncode == 0:
+            match = re.match(entry["expected"], out_)
+            if match:
+                paths.extend(match.group(2).split(os.pathsep))
+
+    return [x for x in paths if x]