Continue on missing variant packages

src/rez/config.py

@@ -400,6 +400,7 @@ def _parse_env_var(self, value):
     "alias_back":                                   OptionalStr,
     "package_preprocess_function":                  OptionalStrOrFunction,
     "package_preprocess_mode":                      PreprocessMode_,
+    "error_on_missing_variant_requires":            Bool,
     "context_tracking_host":                        OptionalStr,
     "variant_shortlinks_dirname":                   OptionalStr,
     "build_thread_count":                           BuildThreadCount_,

src/rez/data/tests/solver/packages/missing_variant_requires/1/package.py

@@ -0,0 +1,10 @@
+name = "missing_variant_requires"
+version = "1"
+
+def commands():
+    pass
+
+variants = [
+    ["noexist"],
+    ["nada"]
+]

src/rez/rezconfig.py

@@ -499,6 +499,11 @@
 # this value is False.
 allow_unversioned_packages = True
 
+# Defines whether a resolve should immediately fail if any variants have a required package that can't be found.
+# It is enabled by default.
+# If disabled, it will try other variants before giving up.
+# This can be useful if you have variants that aren't available to all users.
+error_on_missing_variant_requires = True
 
 ###############################################################################
 # Environment Resolution
@@ -657,7 +662,6 @@
 # - "override": Package's preprocess function completely overrides the global preprocess.
 package_preprocess_mode = "override"
 
-
 ###############################################################################
 # Context Tracking
 ###############################################################################

src/rez/solver.py

@@ -1383,10 +1383,14 @@ def _create_phase(status=None):
                                 # Raise with more info when match found
                                 searched = "; ".join(self.solver.package_paths)
                                 requested = ", ".join(requesters)
+
+                                fail_message = ("package family not found: {}, was required by: {} (searched: {})"
+                                                .format(req.name, requested, searched))
+                                if not config.error_on_missing_variant_requires:
+                                    print(fail_message, file=sys.stderr)
+                                    return _create_phase(SolverStatus.failed)
                                 raise PackageFamilyNotFoundError(
-                                    "package family not found: %s, "
-                                    "was required by: %s (searched: %s)"
-                                    % (req.name, requested, searched))
+                                    fail_message)
 
                         scopes.append(scope)
                         if self.pr:
@@ -2398,7 +2402,10 @@ def _get_failed_phase(self, index=None):
         except IndexError:
             raise IndexError("failure index out of range")
 
-        fail_description = phase.failure_reason.description()
+        if phase.failure_reason is None:
+            fail_description = "Solver failed with unknown reason."
+        else:
+            fail_description = phase.failure_reason.description()
         if prepend_abort_reason and self.abort_reason:
             fail_description = "%s:\n%s" % (self.abort_reason, fail_description)
 

src/rez/tests/test_completion.py

@@ -52,7 +52,7 @@ def _eq(prefix, expected_completions):
         _eq("", ["bahish", "nada", "nopy", "pybah", "pydad", "pyfoo", "pymum",
                  "pyodd", "pyson", "pysplit", "python", "pyvariants",
                  "test_variant_split_start", "test_variant_split_mid1",
-                 "test_variant_split_mid2", "test_variant_split_end"])
+                 "test_variant_split_mid2", "test_variant_split_end", "missing_variant_requires"])
         _eq("py", ["pybah", "pydad", "pyfoo", "pymum", "pyodd", "pyson",
             "pysplit", "python", "pyvariants"])
         _eq("pys", ["pyson", "pysplit"])

src/rez/tests/test_packages.py

@@ -57,7 +57,8 @@
     'late_binding-1.0',
     'timestamped-1.0.5', 'timestamped-1.0.6', 'timestamped-1.1.0', 'timestamped-1.1.1',
     'timestamped-1.2.0', 'timestamped-2.0.0', 'timestamped-2.1.0', 'timestamped-2.1.5',
-    'multi-1.0', 'multi-1.1', 'multi-1.2', 'multi-2.0'
+    'multi-1.0', 'multi-1.1', 'multi-1.2', 'multi-2.0',
+    'missing_variant_requires-1'
 ])
 
 

src/rez/tests/test_solver.py

@@ -7,6 +7,7 @@
 """
 from __future__ import print_function
 
+import rez.exceptions
 from rez.vendor.version.requirement import Requirement
 from rez.solver import Solver, Cycle, SolverStatus
 from rez.config import config
@@ -214,6 +215,7 @@ def test_07(self):
 
     def test_08(self):
         """Cyclic failures."""
+
         def _test(*pkgs):
             s = self._fail(*pkgs)
             self.assertTrue(isinstance(s.failure_reason(), Cycle))
@@ -248,6 +250,14 @@ def test_11_variant_splitting(self):
                      "test_variant_split_mid2-2.0[0]",
                      "test_variant_split_start-1.0[1]"])
 
+    def test_12_missing_variant_requires(self):
+        config.override("error_on_missing_variant_requires", True)
+        with self.assertRaises(rez.exceptions.PackageFamilyNotFoundError):
+            self._solve(["missing_variant_requires"], [])
+
+        config.override("error_on_missing_variant_requires", False)
+        self._solve(["missing_variant_requires"], ["nada[]", "missing_variant_requires-1[1]"])
+
 
 if __name__ == '__main__':
     unittest.main()