Add ConanfileProbe item for querying conan recipe files

Conan is a popular C/C++ package manager. Conan packages including their
configuration and dependencies are usually described as conanfile.txt/.py.
ConanfileProbe runs 'conan install -g json' and parses the resulting
conanbuildinfo.json. The resulting JS object tree contains relevant information
about the dependencies and can be used to set module properties in Product,
Profile or even Module items.

Change-Id: Ied6b917f061dac67fb2260eab099bcce4037750d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>

5 files changed, 107 insertions, 0 deletions

diff --git a/tests/auto/blackbox/testdata/conanfile-probe/testapp/conanfile-probe-project.qbs b/tests/auto/blackbox/testdata/conanfile-probe/testapp/conanfile-probe-project.qbs
new file mode 100644
index 000000000..ab1c68385
--- /dev/null
+++ b/tests/auto/blackbox/testdata/conanfile-probe/testapp/conanfile-probe-project.qbs
@@ -0,0 +1,22 @@
+import qbs.Probes
+import qbs.TextFile
+
+Project {
+
+    Probes.ConanfileProbe {
+        id: conan
+        conanfilePath: path + "/conanfile.py"
+        options: ({opt: "True"})
+        settings: ({os: "AIX"})
+    }
+
+    property var check: {
+        tf = new TextFile(buildDirectory + "/results.json", TextFile.WriteOnly);
+        var o = {
+            json: conan.json.deps_env_info["ENV_VAR"],
+            dependencies: conan.dependencies["testlib"].libs,
+            generatedFilesPath: conan.generatedFilesPath
+        };
+        tf.write(JSON.stringify(o));
+    }
+}
diff --git a/tests/auto/blackbox/testdata/conanfile-probe/testapp/conanfile.py b/tests/auto/blackbox/testdata/conanfile-probe/testapp/conanfile.py
new file mode 100644
index 000000000..630cf0283
--- /dev/null
+++ b/tests/auto/blackbox/testdata/conanfile-probe/testapp/conanfile.py
@@ -0,0 +1,25 @@
+from conans import ConanFile
+
+class TestApp(ConanFile):
+    name = "testapp"
+    description = "Our project package, to be inspected by the Qbs ConanfileProbe"
+    license = "none"
+    version = "6.6.6"
+
+    settings = "os"
+    options = {"opt": [True, False]}
+    default_options = {"opt": False}
+
+    requires = "testlib/1.2.3@qbs/testing"
+
+    def configure(self):
+        self.options["testlib"].opt = self.options.opt
+
+    def source(self):
+        pass
+
+    def build(self):
+        pass
+
+    def package(self):
+        pass
diff --git a/tests/auto/blackbox/testdata/conanfile-probe/testlib/conanfile.py b/tests/auto/blackbox/testdata/conanfile-probe/testlib/conanfile.py
new file mode 100644
index 000000000..983c22599
--- /dev/null
+++ b/tests/auto/blackbox/testdata/conanfile-probe/testlib/conanfile.py
@@ -0,0 +1,25 @@
+from conans import ConanFile
+
+class Testlib(ConanFile):
+    name = "testlib"
+    description = "Represents an arbitrary package, for instance on bintray"
+    license = "none"
+    version = "1.2.3"
+
+    settings = "os"
+    options = {"opt": [True, False]}
+    default_options = {"opt": False}
+
+    def source(self):
+        pass
+
+    def build(self):
+        pass
+
+    def package(self):
+        pass
+
+    def package_info(self):
+        self.cpp_info.libs = ["testlib1","testlib2"]
+        self.env_info.ENV_VAR = "TESTLIB_ENV_VAL"
+        self.user_info.user_var = "testlib_user_val"
diff --git a/tests/auto/blackbox/tst_blackbox.cpp b/tests/auto/blackbox/tst_blackbox.cpp
index 121f60dd8..a30d57be9 100644
--- a/tests/auto/blackbox/tst_blackbox.cpp
+++ b/tests/auto/blackbox/tst_blackbox.cpp
@@ -1737,6 +1737,40 @@ void TestBlackbox::cxxLanguageVersion_data()
                             std::make_pair(QString("msvc-new"), QString("/std:"))});
 }
 
+void TestBlackbox::conanfileProbe()
+{
+    QString executable = findExecutable({"conan"});
+    if (executable.isEmpty())
+        QSKIP("conan is not installed or not available in PATH.");
+
+    // We first build a dummy package testlib and use that as dependency
+    // in the testapp package.
+    QDir::setCurrent(testDataDir + "/conanfile-probe/testlib");
+    QStringList arguments { "create", "-o", "opt=True", "-s", "os=AIX", ".",
+                            "testlib/1.2.3@qbs/testing" };
+    QProcess conan;
+    conan.start(executable, arguments);
+    QVERIFY(waitForProcessSuccess(conan));
+
+    QDir::setCurrent(testDataDir + "/conanfile-probe/testapp");
+    QCOMPARE(runQbs(QbsRunParameters("resolve", {"--force-probe-execution"})), 0);
+
+    QFile file(relativeBuildDir() + "/results.json");
+    QVERIFY(file.open(QIODevice::ReadOnly));
+    QVariantMap actualResults = QJsonDocument::fromJson(file.readAll()).toVariant().toMap();
+    const auto generatedFilesPath = actualResults.take("generatedFilesPath").toString();
+    // We want to make sure that generatedFilesPath is under the project directory,
+    // but we don't care about the actual name.
+    QVERIFY(directoryExists(relativeBuildDir() + "/genconan/"
+                            + QFileInfo(generatedFilesPath).baseName()));
+
+    const QVariantMap expectedResults = {
+        { "json", "TESTLIB_ENV_VAL" },
+        { "dependencies", QVariantList{"testlib1", "testlib2"} },
+    };
+    QCOMPARE(actualResults, expectedResults);
+}
+
 void TestBlackbox::cpuFeatures()
 {
     QDir::setCurrent(testDataDir + "/cpu-features");
diff --git a/tests/auto/blackbox/tst_blackbox.h b/tests/auto/blackbox/tst_blackbox.h
index 2b83b14e3..c1b20956d 100644
--- a/tests/auto/blackbox/tst_blackbox.h
+++ b/tests/auto/blackbox/tst_blackbox.h
@@ -83,6 +83,7 @@ private slots:
     void conflictingArtifacts();
     void cxxLanguageVersion();
     void cxxLanguageVersion_data();
+    void conanfileProbe();
     void cpuFeatures();
     void dependenciesProperty();
     void deprecatedProperty();