[art:build-info] Add python requires as recipe dependencies in create command (#253)

* add python requires

* fix

* complete test

* fix requestedBy

* revert requestedBy fix and simplify test

* fix test

Author: danimtb

extensions/commands/art/cmd_build_info.py

@@ -173,12 +173,17 @@ def get_artifacts_folder(self, node, artifact_type):
             reference = RecipeReference.loads(node.get("ref"))
             return self._conan_api.cache.export_path(reference)
 
-    def get_artifacts(self, node, artifact_type, is_dependency=False):
+
+    def get_artifacts(self, node, artifact_type, is_dependency=False, requested_by=None):
         """
         Function to get artifact information, those artifacts can be added as artifacts of a
         module or as artifacts from dependencies and depending on that the format is
         different. For artifacts of modules they have the keys 'name' and 'path'. If they come
         from a dependency they have an 'id' instead of 'name' and they don't have 'path'.
+
+        When is_dependency is True, requested_by may be set to a BuildInfo-style list of lists
+        of recipe refs (e.g. for python_requires, which are not graph nodes). Otherwise it is
+        computed from the dependency graph.
         """
 
         origin_repo = self._get_origin_repo(node)
@@ -304,9 +309,9 @@ def _get_remote_artifacts(artifact):
         # complete the information for the artifacts:
 
         if is_dependency:
-            requested_by = _get_requested_by(self._graph["graph"]["nodes"], node.get("id"), artifact_type)
+            req_by = requested_by or _get_requested_by(self._graph["graph"]["nodes"], node.get("id"), artifact_type)
             for artifact in artifacts:
-                artifact.update({"requestedBy": requested_by})
+                artifact.update({"requestedBy": req_by})
 
         return artifacts
 
@@ -320,7 +325,8 @@ def get_modules(self):
         for node in nodes.values():
             ref = node.get("ref")
             if ref:
-                transitive_dependencies = node.get("dependencies").keys() if node.get("dependencies").keys() else []
+                transitive_dependencies = node.get("dependencies").keys() if node.get("dependencies") else []
+                python_requires = node.get("python_requires").keys() if node.get("python_requires") else []
                 binary = node.get("binary")
 
                 if ref and ((binary == "Build") or (binary in ["Cache", "Download", "Update"] and self._add_cached_deps)):
@@ -338,9 +344,13 @@ def get_modules(self):
                             deps_artifacts = self.get_artifacts(nodes.get(require_id), "recipe",
                                                                 is_dependency=True)
                             all_dependencies.extend(deps_artifacts)
-
+                        for pr_ref in python_requires:
+                            owner_recipe_ref = str(node["ref"])
+                            pr_node = {"ref": pr_ref}
+                            pr_artifacts = self.get_artifacts(pr_node, "recipe", is_dependency=True,
+                                                              requested_by=[[owner_recipe_ref]])
+                            all_dependencies.extend(pr_artifacts)
                         module.update({"dependencies": all_dependencies})
-
                     ret.append(module)
 
                     # package module

tests/test_build_info.py

@@ -38,6 +38,10 @@ def _fake_conan_sources(graph):
         if recipe_folder:
             fake_sources_tgz_path = os.path.join(os.path.dirname(node.get("recipe_folder")), "d", "conan_sources.tgz")
             save(fake_sources_tgz_path, "")
+        if node.get("python_requires"):
+            for _, pyreq_info in node.get("python_requires").items():
+                fake_pyreq_tgz_path = os.path.join(os.path.dirname(pyreq_info.get("path")), "d", "conan_sources.tgz")
+                save(fake_pyreq_tgz_path, "")
 
 
 def test_static_library_skip_binaries():
@@ -161,6 +165,62 @@ def package_info(self):
     assert len(build_info["modules"][3]["dependencies"]) == 2
 
 
+def test_python_requires_in_build_info_dependencies():
+    pyreq_cf = textwrap.dedent("""
+        from conan import ConanFile
+
+        class PyreqConan(ConanFile):
+            name = "pyreq"
+            version = "1.0"
+            package_type = "python-require"
+    """)
+    save("conanfile.py", pyreq_cf)
+    run("conan create .")
+
+    app_cf = textwrap.dedent("""
+        from conan import ConanFile
+
+        class AppConan(ConanFile):
+            name = "app"
+            version = "1.0"
+            package_type = "application"
+            python_requires = "pyreq/1.0"
+    """)
+    save("conanfile.py", app_cf)
+    run("conan create . -f json > create.json")
+
+    graph = json.loads(load("create.json"))["graph"]
+    _fake_conan_sources(graph)
+
+    run("conan art:build-info create create.json build_name 1 repo --with-dependencies > bi.json")
+    build_info = json.loads(load("bi.json"))
+
+    modules = build_info["modules"]
+    app_recipe_module = [m for m in modules if m["id"] == "app/1.0#697c25af89f95d7c16b88d97972fb7ad"][0]
+    app_pkg_module = [m for m in modules if
+                      "app/1.0#697c25af89f95d7c16b88d97972fb7ad:19f85b5f0cf7b39158b8bce1a58bcb78449fee9d" in m["id"]][0]
+
+    app_recipe_module_deps = [d["id"] for d in app_recipe_module.get("dependencies")]
+    assert "pyreq/1.0#7ff25468818796e3c188019d6db1ff93 :: conan_sources.tgz" in app_recipe_module_deps
+    assert "pyreq/1.0#7ff25468818796e3c188019d6db1ff93 :: conanfile.py" in app_recipe_module_deps
+    assert "pyreq/1.0#7ff25468818796e3c188019d6db1ff93 :: conanmanifest.txt" in app_recipe_module_deps
+    # assert python require is not a dependency of the package
+    assert len(app_pkg_module.get("dependencies")) == 0
+
+    # Test no python_requires found if --with-dependencies is not used
+    run("conan art:build-info create create.json build_name 1 repo > bi_nodeps.json")
+    build_info = json.loads(load("bi_nodeps.json"))
+
+    modules = build_info["modules"]
+    app_recipe_module = [m for m in modules if m["id"] == "app/1.0#697c25af89f95d7c16b88d97972fb7ad"][0]
+    app_pkg_module = [m for m in modules if
+                      "app/1.0#697c25af89f95d7c16b88d97972fb7ad:19f85b5f0cf7b39158b8bce1a58bcb78449fee9d" in m["id"]][0]
+
+    assert "dependencies" not in app_recipe_module
+    assert "dependencies" not in app_pkg_module
+
+
+
 def test_formatted_time():
     """Compare local timestamp hours from build-info JSON with current timestamp in UTC"""
     run("conan new cmake_lib -d name=lib1 -d version=1.0")

tests/tools.py

@@ -24,10 +24,10 @@ def run(cmd, error=False, *, stdout=subprocess.PIPE, stderr=subprocess.PIPE):
 
 
 def save(f, content):
-    with open(f, "w") as f:
+    with open(f, "w", encoding="utf-8", newline="\n") as f:
         f.write(content)
 
 
 def load(f):
-    with open(f, "r") as f:
+    with open(f, "r", encoding="utf-8") as f:
         return f.read()