Add integration tests for package dependencies (#1144)

* Add integration tests for package dependencies

- Verify various contract calls with spm
- Exercises use local version workflow

Issue: #1052

* - Split the original test case into smaller test cases
- Switch to assert directly on executeCommand return

* - Update enum name to match convention
- Move tests to a more appropriate location under integration-tests/commands

* Remove forgotten return statement

* - Fix extra command constant that's not correctly mapped
- Rename to CONSTANT_CASE for module level enums' value

* - Adjust Swift version for the Swift-Markdown package used by the test
to match up.

* - Shift test order for spm update as the return code is different
between toolchains above 5.9 and 5.9 + below.
- Move to a spot where spm update is guranteed to return 0, after
local dependency is fully set up.

* - Add some debug lines to see which part failed in CI
- Unified return for the dependencies command to return boolean

* - Re-enable logToConsole behaviour, Paul's patch will give us the
desired behaviour.

* - Set the timeout to be more reasonable for running in CI

* - Disable flaky test and add comment on subsequent action

* - Maintain original register command ordering

Author: michael-weng

assets/test/Swift-Markdown/Package.swift

@@ -0,0 +1,24 @@
+// swift-tools-version:5.6
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    // FIXME: Can be changed back to Swift-Markdown when
+    // https://github.com/swiftlang/swift-package-manager/issues/7931
+    // is released in the toolchain
+    // NB: The name here needs to match the name of the dependencies under assets/test/dependencies/Package.swift
+    name: "swift-markdown",
+    products: [
+        // Products define the executables and libraries a package produces, making them visible to other packages.
+        .library(
+            name: "PackageLib",
+            targets: ["PackageLib"]),
+    ],
+    targets: [
+        .target(
+            name: "PackageLib",
+            dependencies: []
+        ),
+    ]
+)

assets/test/Swift-Markdown/Sources/PackageLib/PackageLib.swift

@@ -0,0 +1 @@
+public let a = "B"

assets/test/dependencies/Package.swift

@@ -12,7 +12,7 @@ let package = Package(
     targets: [
         .executableTarget(
             name: "dependencies",
-            dependencies: [],
+            dependencies: [.product(name: "PackageLib", package: "Swift-Markdown")],
             path: "Sources"),
     ]
 )

assets/test/dependencies/Sources/main.swift

@@ -1,2 +1,4 @@
+import PackageLib
 
-print("dependencies")
+print("Test Asset:(dependencies)")
+print(a)

src/commands.ts

@@ -68,6 +68,12 @@ export enum Commands {
     RUN = "swift.run",
     DEBUG = "swift.debug",
     CLEAN_BUILD = "swift.cleanBuild",
+    RESOLVE_DEPENDENCIES = "swift.resolveDependencies",
+    UPDATE_DEPENDENCIES = "swift.updateDependencies",
+    RUN_TESTS_MULTIPLE_TIMES = "swift.runTestsMultipleTimes",
+    RESET_PACKAGE = "swift.resetPackage",
+    USE_LOCAL_DEPENDENCY = "swift.useLocalDependency",
+    UNEDIT_DEPENDENCY = "swift.uneditDependency",
 }
 
 /**
@@ -76,14 +82,16 @@ export enum Commands {
 export function register(ctx: WorkspaceContext): vscode.Disposable[] {
     return [
         vscode.commands.registerCommand("swift.newFile", uri => newSwiftFile(uri)),
-        vscode.commands.registerCommand("swift.resolveDependencies", () =>
+        vscode.commands.registerCommand(Commands.RESOLVE_DEPENDENCIES, () =>
             resolveDependencies(ctx)
         ),
-        vscode.commands.registerCommand("swift.updateDependencies", () => updateDependencies(ctx)),
+        vscode.commands.registerCommand(Commands.UPDATE_DEPENDENCIES, () =>
+            updateDependencies(ctx)
+        ),
         vscode.commands.registerCommand(Commands.RUN, () => runBuild(ctx)),
         vscode.commands.registerCommand(Commands.DEBUG, () => debugBuild(ctx)),
         vscode.commands.registerCommand(Commands.CLEAN_BUILD, () => cleanBuild(ctx)),
-        vscode.commands.registerCommand("swift.runTestsMultipleTimes", item => {
+        vscode.commands.registerCommand(Commands.RUN_TESTS_MULTIPLE_TIMES, item => {
             if (ctx.currentFolder) {
                 return runTestMultipleTimes(ctx.currentFolder, item, false);
             }
@@ -95,7 +103,7 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
         }),
         // Note: This is only available on macOS (gated in `package.json`) because its the only OS that has the iOS SDK available.
         vscode.commands.registerCommand("swift.switchPlatform", () => switchPlatform()),
-        vscode.commands.registerCommand("swift.resetPackage", () => resetPackage(ctx)),
+        vscode.commands.registerCommand(Commands.RESET_PACKAGE, () => resetPackage(ctx)),
         vscode.commands.registerCommand("swift.runScript", () => runSwiftScript(ctx)),
         vscode.commands.registerCommand("swift.openPackage", () => {
             if (ctx.currentFolder) {
@@ -112,7 +120,7 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
         vscode.commands.registerCommand("swift.insertFunctionComment", () =>
             insertFunctionComment(ctx)
         ),
-        vscode.commands.registerCommand("swift.useLocalDependency", item => {
+        vscode.commands.registerCommand(Commands.USE_LOCAL_DEPENDENCY, item => {
             if (item instanceof PackageNode) {
                 return useLocalDependency(item.name, ctx);
             }
@@ -122,7 +130,7 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
                 return editDependency(item.name, ctx);
             }
         }),
-        vscode.commands.registerCommand("swift.uneditDependency", item => {
+        vscode.commands.registerCommand(Commands.UNEDIT_DEPENDENCY, item => {
             if (item instanceof PackageNode) {
                 return uneditDependency(item.name, ctx);
             }

src/commands/build.ts

@@ -68,7 +68,10 @@ export async function folderCleanBuild(folderContext: FolderContext) {
 /**
  * Executes a {@link vscode.Task task} to debug swift target.
  */
-async function debugBuildWithOptions(ctx: WorkspaceContext, options: vscode.DebugSessionOptions) {
+export async function debugBuildWithOptions(
+    ctx: WorkspaceContext,
+    options: vscode.DebugSessionOptions
+) {
     const current = ctx.currentFolder;
     if (!current) {
         return;

src/commands/dependencies/resolve.ts

@@ -24,9 +24,10 @@ import { executeTaskWithUI, updateAfterError } from "../utilities";
 export async function resolveDependencies(ctx: WorkspaceContext) {
     const current = ctx.currentFolder;
     if (!current) {
-        return;
+        ctx.outputChannel.log("currentFolder is not set.");
+        return false;
     }
-    await resolveFolderDependencies(current);
+    return await resolveFolderDependencies(current);
 }
 
 /**
@@ -57,4 +58,5 @@ export async function resolveFolderDependencies(
         checkAlreadyRunning
     );
     updateAfterError(success, folderContext);
+    return success;
 }

src/commands/dependencies/unedit.ts

@@ -26,12 +26,13 @@ import { FolderContext } from "../../FolderContext";
 export async function uneditDependency(identifier: string, ctx: WorkspaceContext) {
     const currentFolder = ctx.currentFolder;
     if (!currentFolder) {
-        return;
+        ctx.outputChannel.log("currentFolder is not set.");
+        return false;
     }
     ctx.outputChannel.log(`unedit dependency ${identifier}`, currentFolder.name);
     const status = `Reverting edited dependency ${identifier} (${currentFolder.name})`;
-    ctx.statusItem.showStatusWhileRunning(status, async () => {
-        await uneditFolderDependency(currentFolder, identifier, ctx);
+    return await ctx.statusItem.showStatusWhileRunning(status, async () => {
+        return await uneditFolderDependency(currentFolder, identifier, ctx);
     });
 }
 
@@ -67,6 +68,7 @@ async function uneditFolderDependency(
                 vscode.workspace.updateWorkspaceFolders(folderIndex, 1);
             }
         }
+        return true;
     } catch (error) {
         const execError = error as { stderr: string };
         // if error contains "has uncommited changes" then ask if user wants to force the unedit
@@ -79,12 +81,13 @@ async function uneditFolderDependency(
 
             if (result === "No") {
                 ctx.outputChannel.log(execError.stderr, folder.name);
-                return;
+                return false;
             }
             await uneditFolderDependency(folder, identifier, ctx, ["--force"]);
         } else {
             ctx.outputChannel.log(execError.stderr, folder.name);
             vscode.window.showErrorMessage(`${execError.stderr}`);
         }
+        return false;
     }
 }

src/commands/dependencies/update.ts

@@ -24,9 +24,10 @@ import { executeTaskWithUI, updateAfterError } from "./../utilities";
 export async function updateDependencies(ctx: WorkspaceContext) {
     const current = ctx.currentFolder;
     if (!current) {
-        return;
+        ctx.outputChannel.log("currentFolder is not set.");
+        return false;
     }
-    await updateFolderDependencies(current);
+    return await updateFolderDependencies(current);
 }
 
 /**
@@ -46,7 +47,7 @@ export async function updateFolderDependencies(folderContext: FolderContext) {
         folderContext.workspaceContext.toolchain
     );
 
-    await executeTaskWithUI(task, "Updating Dependencies", folderContext).then(result => {
-        updateAfterError(result, folderContext);
-    });
+    const result = await executeTaskWithUI(task, "Updating Dependencies", folderContext);
+    updateAfterError(result, folderContext);
+    return result;
 }

src/commands/dependencies/useLocal.ts

@@ -24,10 +24,14 @@ import { executeTaskWithUI } from "../utilities";
  * @param identifier Identifier for dependency
  * @param ctx workspace context
  */
-export async function useLocalDependency(identifier: string, ctx: WorkspaceContext) {
+export async function useLocalDependency(
+    identifier: string,
+    ctx: WorkspaceContext
+): Promise<boolean> {
     const currentFolder = ctx.currentFolder;
     if (!currentFolder) {
-        return;
+        ctx.outputChannel.log("currentFolder is not set.");
+        return false;
     }
     const folders = await vscode.window.showOpenDialog({
         canSelectFiles: false,
@@ -39,7 +43,7 @@ export async function useLocalDependency(identifier: string, ctx: WorkspaceConte
     });
 
     if (!folders) {
-        return;
+        return false;
     }
     const folder = folders[0];
     const task = createSwiftTask(
@@ -62,4 +66,5 @@ export async function useLocalDependency(identifier: string, ctx: WorkspaceConte
     if (success) {
         ctx.fireEvent(currentFolder, FolderOperation.resolvedUpdated);
     }
+    return success;
 }