Package dependency view tests (#1117)

* Remove some ununused private functions

* Integration tests for package dependencies view

Issue: #1113

* Unit tests for converting FileNode and PackageNode to tree items

* Don't run integration tests against 5.6

* Confirmed in swift repo that workspace-state.json was not introduced
until 5.7

* Address review comments

Author: award999

assets/test/dependencies/Package.swift

@@ -0,0 +1,18 @@
+// 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(
+    name: "dependencies",
+    dependencies: [
+        .package(url: "https://github.com/swiftlang/swift-markdown.git", branch: "main"),
+        .package(path: "../defaultPackage"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "dependencies",
+            dependencies: [],
+            path: "Sources"),
+    ]
+)

assets/test/dependencies/Sources/main.swift

@@ -0,0 +1,2 @@
+
+print("dependencies")

src/ui/PackageDependencyProvider.ts

@@ -69,7 +69,7 @@ export class PackageNode {
 /**
  * A file or directory in the Package Dependencies {@link vscode.TreeView TreeView}.
  */
-class FileNode {
+export class FileNode {
     constructor(
         public name: string,
         public path: string,
@@ -257,7 +257,7 @@ export class PackageDependenciesProvider implements vscode.TreeDataProvider<Tree
         const workspacePath = folderContext.folder.fsPath;
 
         const showingDependencies: Set<string> = new Set<string>();
-        const stack: Dependency[] = rootDependencies;
+        const stack: Dependency[] = rootDependencies.slice();
 
         while (stack.length > 0) {
             const top = stack.pop();
@@ -293,77 +293,6 @@ export class PackageDependenciesProvider implements vscode.TreeDataProvider<Tree
         return showingDependencies;
     }
 
-    /**
-     * Returns a {@link PackageNode} for every local dependency
-     * declared in **Package.swift**.
-     */
-    private getLocalDependencies(workspaceState: WorkspaceState | undefined): PackageNode[] {
-        return (
-            workspaceState?.object.dependencies
-                .filter(item => {
-                    // need to check for both "local" and "fileSystem" as swift 5.5 and earlier
-                    // use "local" while 5.6 and later use "fileSystem"
-                    return (
-                        (item.packageRef.kind === "local" ||
-                            item.packageRef.kind === "fileSystem") &&
-                        item.packageRef.location
-                    );
-                })
-                .map(
-                    dependency =>
-                        new PackageNode(
-                            dependency.packageRef.identity,
-                            dependency.packageRef.location,
-                            dependency.packageRef.location,
-                            "local",
-                            "local"
-                        )
-                ) ?? []
-        );
-    }
-
-    /**
-     * Returns a {@link PackageNode} for every remote dependency.
-     */
-    private getRemoteDependencies(folderContext: FolderContext): PackageNode[] {
-        return (
-            folderContext.swiftPackage.resolved?.pins.map(
-                pin =>
-                    new PackageNode(
-                        pin.identity,
-                        pin.location,
-                        pin.location,
-                        pin.state.version ?? pin.state.branch ?? pin.state.revision.substring(0, 7),
-                        "remote"
-                    )
-            ) ?? []
-        );
-    }
-
-    /**
-     * Return list of package dependencies in edit mode
-     * @param folderContext Folder to get edited dependencies for
-     * @returns Array of packages
-     */
-    private getEditedDependencies(workspaceState: WorkspaceState | undefined): PackageNode[] {
-        return (
-            workspaceState?.object.dependencies
-                .filter(item => {
-                    return item.state.name === "edited" && item.state.path;
-                })
-                .map(
-                    item =>
-                        new PackageNode(
-                            item.packageRef.identity,
-                            item.state.path!,
-                            item.state.path!,
-                            "local",
-                            "editing"
-                        )
-                ) ?? []
-        );
-    }
-
     /**
      * Returns a {@link FileNode} for every file or subdirectory
      * in the given directory.

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

@@ -0,0 +1,119 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2024 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import { expect } from "chai";
+import {
+    PackageDependenciesProvider,
+    PackageNode,
+} from "../../../src/ui/PackageDependencyProvider";
+import { folderContextPromise, globalWorkspaceContextPromise } from "../extension.test";
+import { executeTaskAndWaitForResult, waitForNoRunningTasks } from "../../utilities";
+import { getBuildAllTask, SwiftTask } from "../../../src/tasks/SwiftTaskProvider";
+import { testAssetPath } from "../../fixtures";
+import { Version } from "../../../src/utilities/version";
+
+suite("PackageDependencyProvider Test Suite", function () {
+    let treeProvider: PackageDependenciesProvider;
+    this.timeout(2 * 60 * 1000); // Allow up to 2 minutes to build
+
+    suiteSetup(async function () {
+        const workspaceContext = await globalWorkspaceContextPromise;
+        // workspace-state.json was not introduced until swift 5.7
+        if (workspaceContext.toolchain.swiftVersion.isLessThan(new Version(5, 7, 0))) {
+            this.skip();
+        }
+        await waitForNoRunningTasks();
+        const folderContext = await folderContextPromise("dependencies");
+        await executeTaskAndWaitForResult((await getBuildAllTask(folderContext)) as SwiftTask);
+        await workspaceContext.focusFolder(folderContext);
+        treeProvider = new PackageDependenciesProvider(workspaceContext);
+    });
+
+    suiteTeardown(() => {
+        treeProvider?.dispose();
+    });
+
+    test("Includes remote dependency", async () => {
+        const items = await treeProvider.getChildren();
+
+        const dep = items.find(n => n.name === "swift-markdown") as PackageNode;
+        expect(dep).to.not.be.undefined;
+        expect(dep?.location).to.equal("https://github.com/swiftlang/swift-markdown.git");
+        expect(dep?.path).to.equal(
+            `${testAssetPath("dependencies")}/.build/checkouts/swift-markdown`
+        );
+    });
+
+    test("Includes local dependency", async () => {
+        const items = await treeProvider.getChildren();
+
+        const dep = items.find(n => n.name === "defaultpackage") as PackageNode;
+        expect(dep).to.not.be.undefined;
+        expect(dep?.location).to.equal(testAssetPath("defaultPackage"));
+        expect(dep?.path).to.equal(testAssetPath("defaultPackage"));
+    });
+
+    test("Lists local dependency file structure", async () => {
+        const items = await treeProvider.getChildren();
+
+        const dep = items.find(n => n.name === "defaultpackage") as PackageNode;
+        expect(dep).to.not.be.undefined;
+
+        const folders = await treeProvider.getChildren(dep);
+        const folder = folders.find(n => n.name === "Sources");
+        expect(folder).to.not.be.undefined;
+
+        expect(folder?.path).to.equal(`${testAssetPath("defaultPackage")}/Sources`);
+
+        const childFolders = await treeProvider.getChildren(folder);
+        const childFolder = childFolders.find(n => n.name === "PackageExe");
+        expect(childFolder).to.not.be.undefined;
+
+        expect(childFolder?.path).to.equal(`${testAssetPath("defaultPackage")}/Sources/PackageExe`);
+
+        const files = await treeProvider.getChildren(childFolder);
+        const file = files.find(n => n.name === "main.swift");
+        expect(file).to.not.be.undefined;
+
+        expect(file?.path).to.equal(
+            `${testAssetPath("defaultPackage")}/Sources/PackageExe/main.swift`
+        );
+    });
+
+    test("Lists remote dependency file structure", async () => {
+        const items = await treeProvider.getChildren();
+
+        const dep = items.find(n => n.name === "swift-markdown") as PackageNode;
+        expect(dep).to.not.be.undefined;
+
+        const folders = await treeProvider.getChildren(dep);
+        const folder = folders.find(n => n.name === "Sources");
+        expect(folder).to.not.be.undefined;
+
+        const path = `${testAssetPath("dependencies")}/.build/checkouts/swift-markdown`;
+        expect(folder?.path).to.equal(`${path}/Sources`);
+
+        const childFolders = await treeProvider.getChildren(folder);
+        const childFolder = childFolders.find(n => n.name === "CAtomic");
+        expect(childFolder).to.not.be.undefined;
+
+        expect(childFolder?.path).to.equal(`${path}/Sources/CAtomic`);
+
+        const files = await treeProvider.getChildren(childFolder);
+        const file = files.find(n => n.name === "CAtomic.c");
+        expect(file).to.not.be.undefined;
+
+        expect(file?.path).to.equal(`${path}/Sources/CAtomic/CAtomic.c`);
+    });
+});

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

@@ -0,0 +1,62 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2024 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import { expect } from "chai";
+import * as vscode from "vscode";
+import { FileNode, PackageNode } from "../../../src/ui/PackageDependencyProvider";
+
+suite("PackageDependencyProvider Unit Test Suite", function () {
+    suite("FileNode", () => {
+        test("can create a VSCode TreeItem that opens a file", () => {
+            const node = new FileNode("Foo", "/path/to/Foo", false);
+            const item = node.toTreeItem();
+
+            const expectedUri = vscode.Uri.file("/path/to/Foo");
+            expect(item.label).to.equal("Foo");
+            expect(item.resourceUri).to.deep.equal(expectedUri);
+            expect(item.command).to.deep.equal({
+                command: "vscode.open",
+                arguments: [expectedUri],
+                title: "Open File",
+            });
+        });
+
+        test("can create a VSCode TreeItem that represents a directory", () => {
+            const node = new FileNode("Foo", "/path/to/Foo", true);
+            const item = node.toTreeItem();
+
+            const expectedUri = vscode.Uri.file("/path/to/Foo");
+            expect(item.label).to.equal("Foo");
+            expect(item.resourceUri).to.deep.equal(expectedUri);
+            expect(item.command).to.be.undefined;
+        });
+    });
+
+    suite("PackageNode", () => {
+        test("can create a VSCode TreeItem that represents a Swift package", () => {
+            const node = new PackageNode(
+                "SwiftMarkdown",
+                "/path/to/.build/swift-markdown",
+                "https://github.com/swiftlang/swift-markdown.git",
+                "1.2.3",
+                "remote"
+            );
+            const item = node.toTreeItem();
+
+            expect(item.label).to.equal("SwiftMarkdown");
+            expect(item.description).to.deep.equal("1.2.3");
+            expect(item.command).to.be.undefined;
+        });
+    });
+});