Improve TestBlackbox::pathProbe

Add checks for the candidatePaths and the single file API.

Also, this includes a behavior change - if multiple selectors are
present, the filePath/fileName/path probe properties are not set up -
this is because it is not clear how they should be set up in case when
the first file in selectors is found, but the second is not (and thus
probe.found is false). In case of multiple selectors, user should use
probe.allResults but not the single file API.

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

16 files changed, 86 insertions, 13 deletions

diff --git a/share/qbs/imports/qbs/Probes/PathProbe.qbs b/share/qbs/imports/qbs/Probes/PathProbe.qbs
index d0edea682..424a621c6 100644
--- a/share/qbs/imports/qbs/Probes/PathProbe.qbs
+++ b/share/qbs/imports/qbs/Probes/PathProbe.qbs
@@ -70,10 +70,12 @@ Probe {
         found = results.found;
         allResults = results.files;
 
-        var result = allResults[0];
-        candidatePaths = result.candidatePaths;
-        path = result.path;
-        filePath = result.filePath;
-        fileName = result.fileName;
+        if (allResults.length === 1) {
+            var result = allResults[0];
+            candidatePaths = result.candidatePaths;
+            path = result.path;
+            filePath = result.filePath;
+            fileName = result.fileName;
+        }
     }
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/BaseApp.qbs b/tests/auto/blackbox/testdata/path-probe/BaseApp.qbs
index 84c00c240..93172579f 100644
--- a/tests/auto/blackbox/testdata/path-probe/BaseApp.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/BaseApp.qbs
@@ -28,6 +28,7 @@
 **
 ****************************************************************************/
 
+import qbs.FileInfo
 import qbs.Probes
 
 CppApplication {
@@ -40,6 +41,7 @@ CppApplication {
     property var inputCandidateFilter
 
     property stringList outputFilePaths
+    property var outputCandidatePaths
 
     Probes.PathProbe {
         id: probe
@@ -49,6 +51,7 @@ CppApplication {
         nameFilter: inputNameFilter
         candidateFilter: inputCandidateFilter
         searchPaths: inputSearchPaths
+        platformSearchPaths: []
     }
 
     property bool validate: {
@@ -56,19 +59,72 @@ CppApplication {
             if (lhs.length !== rhs.length)
                 return false;
             for (var i = 0; i < lhs.length; ++i) {
-                if (lhs[i] !== rhs[i])
+                if (Array.isArray(lhs[i]) && Array.isArray(rhs[i])) {
+                    if (!compareArrays(lhs[i], rhs[i]))
+                        return false;
+                } else if (lhs[i] !== rhs[i]) {
                     return false;
+                }
             }
             return true;
         };
 
-        if (!probe.found)
+        if (outputCandidatePaths) {
+            var actual = probe.allResults.map(function(file) { return file.candidatePaths; });
+            if (!compareArrays(actual, outputCandidatePaths)) {
+                throw "Invalid canndidatePaths: actual = " + JSON.stringify(actual)
+                        + ", expected = " + JSON.stringify(outputCandidatePaths);
+            }
+        }
+
+        if (!probe.found) {
+            if (probe.filePath) {
+                throw "Invalid filePath: actual = " + JSON.stringify(probe.filePath)
+                        + ", expected = 'undefined'";
+            }
+            if (probe.fileName) {
+                throw "Invalid fileName: actual = " + JSON.stringify(probe.fileName)
+                        + ", expected = 'undefined'";
+            }
+            if (probe.path) {
+                throw "Invalid path: actual = " + JSON.stringify(probe.path)
+                        + ", expected = 'undefined'";
+            }
+
             throw "Probe failed to find files";
+        }
 
         if (outputFilePaths) {
             var actual = probe.allResults.map(function(file) { return file.filePath; });
-            if (!compareArrays(actual, outputFilePaths))
-                throw "Invalid filePaths: actual = " + actual + ", expected = " + outputFilePaths;
+            if (!compareArrays(actual, outputFilePaths)) {
+                throw "Invalid filePaths: actual = " + JSON.stringify(actual)
+                        + ", expected = " + JSON.stringify(outputFilePaths);
+            }
+        }
+
+        if (probe.allResults.length !== 1)
+            return;
+
+        // check that single-file interface matches the first value in allResults
+        var expectedFilePath = probe.allResults[0].filePath;
+        if (probe.filePath !== expectedFilePath) {
+            throw "Invalid filePath: actual = " + probe.filePath
+                    + ", expected = " + expectedFilePath;
+        }
+        var expectedFileName = probe.allResults[0].fileName;
+        if (probe.fileName !== expectedFileName) {
+            throw "Invalid fileName: actual = " + probe.fileName
+                    + ", expected = " + expectedFileName;
+        }
+        var expectedPath = probe.allResults[0].path;
+        if (probe.path !== expectedPath) {
+            throw "Invalid path: actual = " + probe.path
+                    + ", expected = " + expectedPath;
+        }
+        var expectedCandidatePaths = probe.allResults[0].candidatePaths;
+        if (!compareArrays(probe.candidatePaths, expectedCandidatePaths)) {
+            throw "Invalid candidatePaths: actual = " + JSON.stringify(probe.candidatePaths)
+                    + ", expected = " + JSON.stringify(expectedCandidatePaths);
         }
     }
 
diff --git a/tests/auto/blackbox/testdata/path-probe/candidate-filter.qbs b/tests/auto/blackbox/testdata/path-probe/candidate-filter.qbs
index a65256a68..c40f22736 100644
--- a/tests/auto/blackbox/testdata/path-probe/candidate-filter.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/candidate-filter.qbs
@@ -3,10 +3,11 @@ import qbs.FileInfo
 BaseApp {
     inputNames: ["tool.1", "tool.2"]
     inputSearchPaths: "bin"
-    outputFilePaths: ["bin/tool.2"]
     inputCandidateFilter: {
         return function(f) {
             return FileInfo.fileName(f) == "tool.2";
         }
     }
+    outputFilePaths: ["bin/tool.2"]
+    outputCandidatePaths: [["bin/tool.1", "bin/tool.2"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/mult-files-mult-suffixes.qbs b/tests/auto/blackbox/testdata/path-probe/mult-files-mult-suffixes.qbs
index b112db44d..33656d4e6 100644
--- a/tests/auto/blackbox/testdata/path-probe/mult-files-mult-suffixes.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/mult-files-mult-suffixes.qbs
@@ -1,8 +1,9 @@
 BaseApp {
     inputSelectors: [
-        {names : "tool", nameSuffixes: [".1", ".2"]},
+        {names : "tool", nameSuffixes: [".0", ".1", ".2"]},
         {names : "super-tool", nameSuffixes: [".1"]},
     ]
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool.1", "bin/super-tool.1"]
+    outputCandidatePaths: [["bin/tool.0", "bin/tool.1"], ["bin/super-tool.1"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/mult-files-mult-variants.qbs b/tests/auto/blackbox/testdata/path-probe/mult-files-mult-variants.qbs
index 60c56e6b4..dd0b58aa2 100644
--- a/tests/auto/blackbox/testdata/path-probe/mult-files-mult-variants.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/mult-files-mult-variants.qbs
@@ -1,9 +1,10 @@
 BaseApp {
     inputSelectors: [
         "tool",
-        ["tool.1", "tool.2"],
+        ["tool.0", "tool.1", "tool.2"],
         {names : ["tool.3", "tool.4"]},
     ]
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool", "bin/tool.1", "bin/tool.3"]
+    outputCandidatePaths: [["bin/tool"], ["bin/tool.0", "bin/tool.1"], ["bin/tool.3"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/mult-files-suffixes.qbs b/tests/auto/blackbox/testdata/path-probe/mult-files-suffixes.qbs
index 5e4fc27ca..7ae78de24 100644
--- a/tests/auto/blackbox/testdata/path-probe/mult-files-suffixes.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/mult-files-suffixes.qbs
@@ -5,4 +5,5 @@ BaseApp {
     ]
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool.2", "bin/super-tool.1"]
+    outputCandidatePaths: [["bin/tool.2"], ["bin/super-tool.1"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/mult-files.qbs b/tests/auto/blackbox/testdata/path-probe/mult-files.qbs
index 08727ac01..aa08befc8 100644
--- a/tests/auto/blackbox/testdata/path-probe/mult-files.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/mult-files.qbs
@@ -7,4 +7,5 @@ BaseApp {
     ]
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool.1", "bin/tool.2", "bin/tool.3", "bin/tool.4"]
+    outputCandidatePaths: [["bin/tool.1"], ["bin/tool.2"], ["bin/tool.3"], ["bin/tool.4"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/name-filter.qbs b/tests/auto/blackbox/testdata/path-probe/name-filter.qbs
index 406988fed..b2840443b 100644
--- a/tests/auto/blackbox/testdata/path-probe/name-filter.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/name-filter.qbs
@@ -7,4 +7,5 @@ BaseApp {
         };
     }
     outputFilePaths: ["bin/tool.2"]
+    outputCandidatePaths: [["bin/tool.2"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/non-existent-selector.qbs b/tests/auto/blackbox/testdata/path-probe/non-existent-selector.qbs
index aaa27042c..aabb0fe7b 100644
--- a/tests/auto/blackbox/testdata/path-probe/non-existent-selector.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/non-existent-selector.qbs
@@ -5,4 +5,5 @@ BaseApp {
         "tool.2",
     ]
     inputSearchPaths: "bin"
+    outputCandidatePaths: [["bin/tool.1"], ["bin/nonexistent"], ["bin/tool.2"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/non-existent.qbs b/tests/auto/blackbox/testdata/path-probe/non-existent.qbs
index f0c58fa6c..aad01c31b 100644
--- a/tests/auto/blackbox/testdata/path-probe/non-existent.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/non-existent.qbs
@@ -1,4 +1,5 @@
 BaseApp {
     inputNames: "nonexistent"
     inputSearchPaths: "bin"
+    outputCandidatePaths: [["bin/nonexistent"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/single-file-mult-variants.qbs b/tests/auto/blackbox/testdata/path-probe/single-file-mult-variants.qbs
index 992a0bea4..98f5b141a 100644
--- a/tests/auto/blackbox/testdata/path-probe/single-file-mult-variants.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/single-file-mult-variants.qbs
@@ -2,4 +2,5 @@ BaseApp {
     inputNames: ["tool.1", "tool.2"]
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool.1"]
+    outputCandidatePaths: [["bin/tool.1"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/single-file-selector-array.qbs b/tests/auto/blackbox/testdata/path-probe/single-file-selector-array.qbs
index 697665242..292df4add 100644
--- a/tests/auto/blackbox/testdata/path-probe/single-file-selector-array.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/single-file-selector-array.qbs
@@ -2,4 +2,5 @@ BaseApp {
     inputSelectors: ["tool"]
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool"]
+    outputCandidatePaths: [["bin/tool"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/single-file-selector.qbs b/tests/auto/blackbox/testdata/path-probe/single-file-selector.qbs
index d57700baf..cf7cfe436 100644
--- a/tests/auto/blackbox/testdata/path-probe/single-file-selector.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/single-file-selector.qbs
@@ -2,4 +2,5 @@ BaseApp {
     inputSelectors: "tool"
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool"]
+    outputCandidatePaths: [["bin/tool"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/single-file-suffixes.qbs b/tests/auto/blackbox/testdata/path-probe/single-file-suffixes.qbs
index 4442e719a..3436a49c3 100644
--- a/tests/auto/blackbox/testdata/path-probe/single-file-suffixes.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/single-file-suffixes.qbs
@@ -1,6 +1,7 @@
 BaseApp {
     inputNames: "tool"
     inputSearchPaths: "bin"
-    inputNameSuffixes: [".1", ".2"]
+    inputNameSuffixes: [".0", ".1", ".2"]
     outputFilePaths: ["bin/tool.1"]
+    outputCandidatePaths: [["bin/tool.0", "bin/tool.1"]]
 }
diff --git a/tests/auto/blackbox/testdata/path-probe/single-file.qbs b/tests/auto/blackbox/testdata/path-probe/single-file.qbs
index 3590e7664..e22d7ba0d 100644
--- a/tests/auto/blackbox/testdata/path-probe/single-file.qbs
+++ b/tests/auto/blackbox/testdata/path-probe/single-file.qbs
@@ -2,4 +2,5 @@ BaseApp {
     inputNames: "tool"
     inputSearchPaths: "bin"
     outputFilePaths: ["bin/tool"]
+    outputCandidatePaths: [["bin/tool"]]
 }
diff --git a/tests/auto/blackbox/tst_blackbox.cpp b/tests/auto/blackbox/tst_blackbox.cpp
index 3526881d2..63bfc5922 100644
--- a/tests/auto/blackbox/tst_blackbox.cpp
+++ b/tests/auto/blackbox/tst_blackbox.cpp
@@ -2789,6 +2789,8 @@ void TestBlackbox::pathProbe()
     QbsRunParameters buildParams("build", QStringList{"-f", projectFile});
     buildParams.expectFailure = !successExpected;
     QCOMPARE(runQbs(buildParams) == 0, successExpected);
+    if (!successExpected)
+        QVERIFY2(m_qbsStderr.contains("Probe failed to find files"), m_qbsStderr);
 }
 
 void TestBlackbox::pchChangeTracking()