#5617 Report dependants when a conflict occurs (#5684)

jgsogo · web-flow · commit f495493bf5a2 · 2020-03-05T16:38:31.000+01:00
* #5617 Report dependants when a conflict occurs - Update test to validate all conflict message - Retrieve dependants from previous graph node Signed-off-by: Uilian Ries <uilianries@gmail.com> * #5617 Check for alias before the exception Signed-off-by: Uilian Ries <uilianries@gmail.com> * #5617 Update conflict message Signed-off-by: Uilian Ries <uilianries@gmail.com> * #5617 Fix tests for conflict message Signed-off-by: Uilian Ries <uilianries@gmail.com>
diff --git a/conans/client/graph/graph_builder.py b/conans/client/graph/graph_builder.py
@@ -233,12 +233,12 @@ def _expand_require(self, require, node, graph, check_updates, update, remotes,
         else:  # a public node already exist with this name
             self._resolve_cached_alias([require], graph)
             # As we are closing a diamond, there can be conflicts. This will raise if conflicts
-            conflict = self._conflicting_references(previous.ref, require.ref, node.ref)
+            conflict = self._conflicting_references(previous, require.ref, node.ref)
             if conflict:  # It is possible to get conflict from alias, try to resolve it
                 self._resolve_recipe(node, graph, require, check_updates,
                                      update, remotes, profile_host, graph_lock)
                 # Maybe it was an ALIAS, so we can check conflict again
-                conflict = self._conflicting_references(previous.ref, require.ref, node.ref)
+                conflict = self._conflicting_references(previous, require.ref, node.ref)
                 if conflict:
                     raise ConanException(conflict)
 
@@ -268,18 +268,19 @@ def _expand_require(self, require, node, graph, check_updates, update, remotes,
                                   update, remotes, profile_host, profile_build, graph_lock, context)
 
     @staticmethod
-    def _conflicting_references(previous_ref, new_ref, consumer_ref=None):
-        if previous_ref.copy_clear_rev() != new_ref.copy_clear_rev():
+    def _conflicting_references(previous, new_ref, consumer_ref=None):
+        if previous.ref.copy_clear_rev() != new_ref.copy_clear_rev():
             if consumer_ref:
-                return ("Conflict in %s\n"
-                        "    Requirement %s conflicts with already defined %s\n"
-                        "    To change it, override it in your base requirements"
-                        % (consumer_ref, new_ref, previous_ref))
+                return ("Conflict in %s:\n"
+                       "    '%s' requires '%s' while '%s' requires '%s'.\n"
+                       "    To fix this conflict you need to override the package '%s' in your root package."
+                       % (consumer_ref, consumer_ref, new_ref, next(iter(previous.dependants)).src,
+                          previous.ref, new_ref.name))
             return True
         # Computed node, if is Editable, has revision=None
         # If new_ref.revision is None we cannot assume any conflict, the user hasn't specified
         # a revision, so it's ok any previous_ref
-        if previous_ref.revision and new_ref.revision and previous_ref.revision != new_ref.revision:
+        if previous.ref.revision and new_ref.revision and previous.ref.revision != new_ref.revision:
             if consumer_ref:
                 raise ConanException("Conflict in %s\n"
                                      "    Different revisions of %s has been requested"
@@ -293,7 +294,7 @@ def _recurse(self, closure, new_reqs, new_options, context):
         then, incompatibilities will be raised as usually"""
         for req in new_reqs.values():
             n = closure.get(req.ref.name, context=context)
-            if n and self._conflicting_references(n.ref, req.ref):
+            if n and self._conflicting_references(n, req.ref):
                 return True
         for pkg_name, options_values in new_options.items():
             n = closure.get(pkg_name, context=context)
diff --git a/conans/test/functional/graph/alias_test.py b/conans/test/functional/graph/alias_test.py
@@ -37,7 +37,9 @@ def test_conflicting_alias(self):
         consumer = self.recipe_consumer("app/0.1", ["libb/0.1"], build_requires=["liba/latest"])
 
         with six.assertRaisesRegex(self, ConanException,
-                                   "Requirement liba/0.2 conflicts with already defined liba/0.1"):
+                                   "Conflict in app/0.1:\n"
+                                   "    'app/0.1' requires 'liba/0.2' while 'libb/0.1' requires 'liba/0.1'.\n"
+                                   "    To fix this conflict you need to override the package 'liba' in your root package."):
             self.build_consumer(consumer)
 
     def test_conflicting_not_alias(self):
@@ -50,5 +52,7 @@ def test_conflicting_not_alias(self):
         consumer = self.recipe_consumer("app/0.1", ["libb/0.1"], build_requires=["liba/0.2"])
 
         with six.assertRaisesRegex(self, ConanException,
-                                   "Requirement liba/0.2 conflicts with already defined liba/0.1"):
+                                   "Conflict in app/0.1:\n"
+                                   "    'app/0.1' requires 'liba/0.2' while 'libb/0.1' requires 'liba/0.1'.\n"
+                                   "    To fix this conflict you need to override the package 'liba' in your root package."):
             self.build_consumer(consumer)
diff --git a/conans/test/functional/graph/conflict_diamond_test.py b/conans/test/functional/graph/conflict_diamond_test.py
@@ -40,7 +40,11 @@ def test_conflict(self):
         self._export("Hello3", "0.1", ["Hello1/0.1@lasote/stable", "Hello2/0.1@lasote/stable"],
                      export=False)
         self.client.run("install . --build missing", assert_error=True)
-        self.assertIn("Conflict in Hello2/0.1@lasote/stable", self.client.out)
+        self.assertIn("Conflict in Hello2/0.1@lasote/stable:\n"
+                      "    'Hello2/0.1@lasote/stable' requires 'Hello0/0.2@lasote/stable' "
+                      "while 'Hello1/0.1@lasote/stable' requires 'Hello0/0.1@lasote/stable'.\n"
+                      "    To fix this conflict you need to override the package 'Hello0' in "
+                      "your root package.", self.client.out)
         self.assertNotIn("Generated conaninfo.txt", self.client.out)
 
     def test_override_silent(self):
@@ -93,6 +97,3 @@ def test_override_explicit(self):
             self.assertEqual(hello0["reference"], "Hello0/0.1@lasote/stable")
             self.assertListEqual(sorted(hello0["required_by"]),
                                  sorted(["Hello2/0.1@lasote/stable", "Hello1/0.1@lasote/stable"]))
-
-
-
diff --git a/conans/test/functional/graph/graph_manager_test.py b/conans/test/functional/graph/graph_manager_test.py
@@ -203,7 +203,10 @@ def test_diamond_conflict(self):
 
         consumer = self.recipe_consumer("app/0.1", ["libb/0.1", "libc/0.1"])
 
-        with six.assertRaisesRegex(self, ConanException, "Requirement liba/0.2 conflicts"):
+        with six.assertRaisesRegex(self, ConanException, "Conflict in libc/0.1:\n"
+            "    'libc/0.1' requires 'liba/0.2' while 'libb/0.1' requires 'liba/0.1'.\n"
+            "    To fix this conflict you need to override the package 'liba' in your root "
+            "package."):
             self.build_consumer(consumer)
 
     def test_loop(self):
@@ -344,7 +347,11 @@ def test_conflict_transitive_build_requires(self):
                                                   .with_build_require(gtest_ref))
 
         with six.assertRaisesRegex(self, ConanException,
-                                   "Requirement zlib/0.2@user/testing conflicts"):
+                                   "Conflict in gtest/0.1@user/testing:\n"
+                                   "    'gtest/0.1@user/testing' requires 'zlib/0.2@user/testing' "
+                                   "while 'lib/0.1@user/testing' requires 'zlib/0.1@user/testing'."
+                                   "\n    To fix this conflict you need to override the package "
+                                   "'zlib' in your root package."):
             self.build_graph(GenConanfile().with_name("app").with_version("0.1")
                                            .with_require(lib_ref))
 
@@ -593,7 +600,11 @@ def test_conflict_private(self):
         self._cache_recipe(libc_ref, GenConanfile().with_name("libc").with_version("0.1")
                                                    .with_require(liba_ref2))
         with six.assertRaisesRegex(self, ConanException,
-                                   "Requirement liba/0.2@user/testing conflicts"):
+                                   "Conflict in libc/0.1@user/testing:\n"
+                                   "    'libc/0.1@user/testing' requires 'liba/0.2@user/testing' "
+                                   "while 'libb/0.1@user/testing' requires 'liba/0.1@user/testing'."
+                                   "\n    To fix this conflict you need to override the package "
+                                   "'liba' in your root package."):
             self.build_graph(GenConanfile().with_name("app").with_version("0.1")
                                            .with_require(libb_ref, private=True)
                                            .with_require(libc_ref, private=True))
@@ -659,7 +670,11 @@ def test_transitive_private_conflict(self):
                                                       .with_require(grass01_ref))
 
         with six.assertRaisesRegex(self, ConanException,
-                                   "Requirement grass/0.2@user/testing conflicts"):
+                                   "Conflict in cheetah/0.1:\n"
+            "    'cheetah/0.1' requires 'grass/0.2@user/testing' while 'gazelle/0.1@user/testing'"
+            " requires 'grass/0.1@user/testing'.\n"
+            "    To fix this conflict you need to override the package 'grass' in your root"
+            " package."):
             self.build_graph(GenConanfile().with_name("cheetah").with_version("0.1")
                                            .with_require(gazelle_ref)
                                            .with_require(grass02_ref, private=True))
@@ -678,7 +693,11 @@ def test_build_require_conflict(self):
                                                       .with_require(grass01_ref))
 
         with six.assertRaisesRegex(self, ConanException,
-                                   "Requirement grass/0.2@user/testing conflicts"):
+                                   "Conflict in cheetah/0.1:\n"
+                                   "    'cheetah/0.1' requires 'grass/0.2@user/testing' while "
+                                   "'gazelle/0.1@user/testing' requires 'grass/0.1@user/testing'.\n"
+                                   "    To fix this conflict you need to override the package "
+                                   "'grass' in your root package."):
             self.build_graph(GenConanfile().with_name("cheetah").with_version("0.1")
                                            .with_require(gazelle_ref)
                                            .with_build_require(grass02_ref))
diff --git a/conans/test/functional/graph/require_override_test.py b/conans/test/functional/graph/require_override_test.py
@@ -32,8 +32,11 @@ def test_override(self):
             self.client.run("export . libC/1.0@user/channel")
             self._save(req_method, ["libB/1.0@user/channel", "libC/1.0@user/channel"])
             self.client.run("info .", assert_error=True)
-            self.assertIn("Requirement libA/2.0@user/channel conflicts with "
-                          "already defined libA/1.0@user/channel", self.client.out)
+            self.assertIn("Conflict in libC/1.0@user/channel:\n"
+                "    'libC/1.0@user/channel' requires 'libA/2.0@user/channel' while "
+                "'libB/1.0@user/channel' requires 'libA/1.0@user/channel'.\n"
+                "    To fix this conflict you need to override the package 'libA' in your root"
+                " package.", self.client.out)
 
             self._save(req_method, ["libB/1.0@user/channel", "libC/1.0@user/channel",
                                     ("libA/1.0@user/channel", "override")])
@@ -42,7 +45,7 @@ def test_override(self):
 
     def test_public_deps(self):
         client = TestClient()
-        pkg2 = textwrap.dedent(""" 
+        pkg2 = textwrap.dedent("""
             from conans import ConanFile
             class Pkg(ConanFile):
                 requires = ("pkg/0.1@user/stable", "override"),
@@ -52,7 +55,7 @@ def package_info(self):
         client.save({"conanfile.py": pkg2})
         client.run("create . pkg2/0.1@user/stable")
         self.assertIn("pkg2/0.1@user/stable: PUBLIC PKG2:[]", client.out)
-        pkg3 = textwrap.dedent(""" 
+        pkg3 = textwrap.dedent("""
             from conans import ConanFile
             class Pkg(ConanFile):
                 requires = "pkg2/0.1@user/stable", ("pkg/0.1@user/stable", "override")
diff --git a/conans/test/functional/graph/version_ranges_diamond_test.py b/conans/test/functional/graph/version_ranges_diamond_test.py
@@ -31,7 +31,7 @@ class Boost(ConanFile):
             boost/[>=1.68.0]@lasote/stable
             """)
         client.save({"conanfile.txt": conanfile}, clean_first=True)
-        client.run("install .")   
+        client.run("install .")
         self.assertIn("boost/*@lasote/stable versions found in 'default' remote", client.out)
         self.assertIn("resolved to 'boost/1.70.0@lasote/stable' in remote 'default'", client.out)
         self.assertNotIn("boost/1.69.0", client.out)
@@ -298,8 +298,12 @@ def no_joint_compatibility_resolved_test(self):
         self.client.run("remove '*' -f")
         self.client.run("install Project/1.0.0@lasote/stable --build missing", assert_error=True)
 
-        self.assertIn("Requirement ProblemRequirement/1.0.0@lasote/stable conflicts with "
-                      "already defined ProblemRequirement/1.1.0@lasote/stable", self.client.out)
+        self.assertIn("Conflict in RequirementOne/1.2.3@lasote/stable:\n"
+            "    'RequirementOne/1.2.3@lasote/stable' requires "
+            "'ProblemRequirement/1.0.0@lasote/stable' while 'RequirementTwo/4.5.6@lasote/stable'"
+            " requires 'ProblemRequirement/1.1.0@lasote/stable'.\n"
+            "    To fix this conflict you need to override the package 'ProblemRequirement' in "
+            "your root package.", self.client.out)
 
         # Change the order, now it resolves correctly
         self._export("Project", "1.0.0",
diff --git a/conans/test/unittests/model/transitive_reqs_test.py b/conans/test/unittests/model/transitive_reqs_test.py
@@ -400,7 +400,11 @@ class ChatConan(ConanFile):
         self.retriever.save_recipe(say_ref2, say_content2)
         self.retriever.save_recipe(hello_ref, hello_content)
         self.retriever.save_recipe(bye_ref, bye_content2)
-        with six.assertRaisesRegex(self, ConanException, "Conflict in Bye/0.2@user/testing"):
+        with six.assertRaisesRegex(self, ConanException, "Conflict in Bye/0.2@user/testing:\n"
+                                   "    'Bye/0.2@user/testing' requires 'Say/0.2@user/testing' "
+                                   "while 'Hello/1.2@user/testing' requires 'Say/0.1@user/testing'.\n"
+                                   "    To fix this conflict you need to override the package 'Say'"
+                                   " in your root package."):
             self.build_graph(chat_content)
 
     def test_diamond_conflict(self):
@@ -417,7 +421,11 @@ class ChatConan(ConanFile):
         self.retriever.save_recipe(hello_ref, hello_content)
         self.retriever.save_recipe(bye_ref, bye_content2)
 
-        with six.assertRaisesRegex(self, ConanException, "Conflict in Bye/0.2@user/testing"):
+        with six.assertRaisesRegex(self, ConanException, "Conflict in Bye/0.2@user/testing:\n"
+                                   "    'Bye/0.2@user/testing' requires 'Say/0.2@user/testing'"
+                                   " while 'Hello/1.2@user/testing' requires 'Say/0.1@user/testing'.\n"
+                                   "    To fix this conflict you need to override the package 'Say'"
+                                   " in your root package."):
             self.build_graph(chat_content)
 
     def test_diamond_conflict_solved(self):
@@ -1497,7 +1505,11 @@ class LibDConan(ConanFile):
         libd_ref = ConanFileReference.loads("LibD/0.1@user/testing")
         self.retriever.save_recipe(libd_ref, libd_content)
 
-        with six.assertRaisesRegex(self, ConanException, "Conflict in LibB/0.1@user/testing"):
+        with six.assertRaisesRegex(self, ConanException, "Conflict in LibB/0.1@user/testing:\n"
+                                   "    'LibB/0.1@user/testing' requires 'LibA/0.2@user/testing' "
+                                   "while 'LibB/0.1@user/testing' requires 'LibA/0.1@user/testing'.\n"
+                                   "    To fix this conflict you need to override the package 'LibA' "
+                                   "in your root package."):
             self.build_graph(self.consumer_content)
         self.assertIn("LibB/0.1@user/testing: requirement LibA/0.1@user/testing overridden by "
                       "LibD/0.1@user/testing to LibA/0.2@user/testing", str(self.output))
@@ -1516,7 +1528,11 @@ class LibDConan(ConanFile):
         libd_ref = ConanFileReference.loads("LibD/0.1@user/testing")
         self.retriever.save_recipe(libd_ref, libd_content)
 
-        with six.assertRaisesRegex(self, ConanException, "Conflict in LibB/0.1@user/testing"):
+        with six.assertRaisesRegex(self, ConanException, "Conflict in LibB/0.1@user/testing:\n"
+                                   "    'LibB/0.1@user/testing' requires 'LibA/0.2@user/testing' "
+                                   "while 'LibB/0.1@user/testing' requires 'LibA/0.1@user/testing'.\n"
+                                   "    To fix this conflict you need to override the package 'LibA' in "
+                                   "your root package."):
             self.build_graph(self.consumer_content)
         self.assertEqual(1, str(self.output).count("LibA requirements()"))
         self.assertEqual(1, str(self.output).count("LibA configure()"))
