Improve the debugging on expect statement in test (#1239)

* Improve the debugging on expect statement in test
- This is true especially on flaky test, sometimes we check for the
exit code but not print out the output from the command on failure.
- Fix it for a bunch of asserts where sporadic failures were observed
to better understand what went wrong.

* Address some expected failure and added comment where applicable

* Rebase main and resolve conflict

Author: michael-weng

test/integration-tests/DiagnosticsManager.test.ts

@@ -211,6 +211,8 @@ suite("DiagnosticsManager Test Suite", async function () {
             suiteSetup(async function () {
                 this.timeout(2 * 60 * 1000); // Allow 2 minutes to build
                 const task = createBuildAllTask(folderContext);
+                // This return exit code and output for the task but we will omit it here
+                // because the failures are expected and we just want the task to build
                 await executeTaskAndWaitForResult(task);
             });
 

test/integration-tests/commands/dependency.test.ts

@@ -89,7 +89,7 @@ suite("Dependency Commmands Test Suite", function () {
 
                 tasks = (await getBuildAllTask(folderContext)) as SwiftTask;
                 const { exitCode, output } = await executeTaskAndWaitForResult(tasks);
-                expect(exitCode).to.not.equal(0);
+                expect(exitCode, `${output}`).to.not.equal(0);
                 expect(output).to.include("PackageLib");
                 expect(output).to.include("required");
 
@@ -125,7 +125,7 @@ suite("Dependency Commmands Test Suite", function () {
         async function assertDependencyNoLongerExists() {
             // Expect to fail again now dependency is missing
             const { exitCode, output } = await executeTaskAndWaitForResult(tasks);
-            expect(exitCode).to.not.equal(0);
+            expect(exitCode, `${output}`).to.not.equal(0);
             expect(output).to.include("PackageLib");
             expect(output).to.include("required");
         }

test/integration-tests/tasks/SwiftPluginTaskProvider.test.ts

@@ -69,8 +69,8 @@ suite("SwiftPluginTaskProvider Test Suite", () => {
                 }
             );
             mutable(task.execution).command = "/definitely/not/swift";
-            const { exitCode } = await executeTaskAndWaitForResult(task);
-            expect(exitCode).to.not.equal(0);
+            const { exitCode, output } = await executeTaskAndWaitForResult(task);
+            expect(exitCode, `${output}`).to.not.equal(0);
         }).timeout(10000);
     });
 

test/integration-tests/ui/PackageDependencyProvider.test.ts

@@ -47,7 +47,7 @@ suite("PackageDependencyProvider Test Suite", function () {
         const items = await treeProvider.getChildren();
 
         const dep = items.find(n => n.name === "swift-markdown") as PackageNode;
-        expect(dep).to.not.be.undefined;
+        expect(dep, `${JSON.stringify(items, null, 2)}`).to.not.be.undefined;
         expect(dep?.location).to.equal("https://github.com/swiftlang/swift-markdown.git");
         assertPathsEqual(
             dep?.path,
@@ -105,7 +105,7 @@ suite("PackageDependencyProvider Test Suite", function () {
         const items = await treeProvider.getChildren();
 
         const dep = items.find(n => n.name === "swift-markdown") as PackageNode;
-        expect(dep).to.not.be.undefined;
+        expect(dep, `${JSON.stringify(items, null, 2)}`).to.not.be.undefined;
 
         const folders = await treeProvider.getChildren(dep);
         const folder = folders.find(n => n.name === "Sources");