Add tests for swift-script

Author: stevapple

Fixtures/Scripts/EchoArguments/EchoArguments.swift

@@ -0,0 +1,2 @@
+let arguments = CommandLine.arguments.dropFirst()
+print(arguments.map{"\"\($0)\""}.joined(separator: " "))

Fixtures/Scripts/EchoArguments/PackageSyntax.txt

@@ -0,0 +1,6 @@
+{
+  "dependencies" : [
+
+  ],
+  "sourceFile" : "\/Users\/yr.chen\/Developer\/GSoC\/swift-package-manager\/Fixtures\/Scripts\/EchoArguments\/EchoArguments.swift"
+}

Fixtures/Scripts/EchoCWD/EchoCWD.swift

@@ -0,0 +1,4 @@
+@package(name: "CwdDump", path: "cwd-dump")
+import CwdDump
+
+CwdDump.main()

Fixtures/Scripts/EchoCWD/PackageSyntax.txt

@@ -0,0 +1,16 @@
+{
+  "dependencies" : [
+    {
+      "package" : {
+        "raw" : "name:\"CwdDump\",path:\"\/Users\/yr.chen\/Developer\/GSoC\/swift-package-manager\/Fixtures\/Scripts\/EchoCWD\/cwd-dump\"",
+        "path" : "\/Users\/yr.chen\/Developer\/GSoC\/swift-package-manager\/Fixtures\/Scripts\/EchoCWD\/cwd-dump",
+        "name" : "CwdDump"
+      },
+      "modules" : [
+        "CwdDump"
+      ]
+    }
+  ],
+  "sourceFile" : "\/Users\/yr.chen\/Developer\/GSoC\/swift-package-manager\/Fixtures\/Scripts\/EchoCWD\/EchoCWD.swift"
+}
+

Fixtures/Scripts/EchoCWD/cwd-dump/Package.swift

@@ -0,0 +1,19 @@
+// swift-tools-version:5.5
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "CwdDump",
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "CwdDump",
+            targets: ["CwdDump"])
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(name: "CwdDump")
+    ]
+)

Fixtures/Scripts/EchoCWD/cwd-dump/Sources/CwdDump/CwdDump.swift

@@ -0,0 +1,7 @@
+import Foundation
+
+public struct CwdDump {
+    public static func main() {
+        print(FileManager().currentDirectoryPath)
+    }
+}

Sources/SPMTestSupport/SwiftPMProduct.swift

@@ -17,6 +17,7 @@ public enum SwiftPMProduct: Product {
     case SwiftPackage
     case SwiftTest
     case SwiftRun
+    case SwiftScript
     case XCTestHelper
 
     /// Executable name.
@@ -30,6 +31,8 @@ public enum SwiftPMProduct: Product {
             return RelativePath("swift-test")
         case .SwiftRun:
             return RelativePath("swift-run")
+        case .SwiftScript:
+            return RelativePath("swift-script")
         case .XCTestHelper:
             return RelativePath("swiftpm-xctest-helper")
         }

Sources/SPMTestSupport/misc.swift

@@ -62,14 +62,23 @@ public func fixture(
                 return
             }
 
-            // The fixture contains either a checkout or just a Git directory.
+            // The fixture contains either a checkout, a script or just a Git directory.
             if localFileSystem.isFile(fixtureDir.appending(component: "Package.swift")) {
                 // It's a single package, so copy the whole directory as-is.
                 let dstDir = tmpDirPath.appending(component: copyName)
                 try systemQuietly("cp", "-R", "-H", fixtureDir.pathString, dstDir.pathString)
 
                 // Invoke the block, passing it the path of the copied fixture.
                 try body(dstDir)
+            } else if localFileSystem.isFile(fixtureDir.appending(component: "PackageSyntax.txt")) {
+                // It's a directory with scripts, so copy the whole directory as-is.
+                let dstDir = tmpDirPath.appending(component: copyName)
+                try systemQuietly("cp", "-R", "-H", fixtureDir.pathString, dstDir.pathString)
+
+                // Mock package-syntax-parser output with PackageSyntax.txt
+                try withPackageSyntax(from: dstDir.appending(component: "PackageSyntax.txt")) {
+                    try body(dstDir)
+                }
             } else {
                 // Copy each of the package directories and construct a git repo in it.
                 for fileName in try localFileSystem.getDirectoryContents(fixtureDir).sorted() {
@@ -249,3 +258,19 @@ public func loadPackageGraph(
         createREPLProduct: createREPLProduct
     )
 }
+
+private func withPackageSyntax(from file: AbsolutePath, _ body: () throws -> Void) throws -> Void {
+    var pathSuffix = ""
+    if let PATH = ProcessEnv.path {
+        pathSuffix += ":" + PATH
+    }
+    try withTemporaryDirectory { path in
+        let parser = path.appending(component: "package-syntax-parser")
+        try localFileSystem.writeFileContents(parser) {
+            $0.write("cat \(file.toJSON())\n")
+            $0.flush()
+        }
+        try localFileSystem.chmod(.executable, path: parser)
+        try withCustomEnv(["PATH": path.pathString + pathSuffix], body: body)
+    }
+}

Tests/CommandsTests/ScriptToolTests.swift

@@ -0,0 +1,111 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See http://swift.org/LICENSE.txt for license information
+ See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+ */
+
+import XCTest
+
+import SPMTestSupport
+import Commands
+import TSCBasic
+
+final class ScriptToolTests: XCTestCase {
+    private func execute(_ args: [String]) throws -> (stdout: String, stderr: String) {
+        return try SwiftPMProduct.SwiftScript.execute(args)
+    }
+
+    private func build(_ args: String...) throws -> (stdout: String, stderr: String) {
+        return try execute(["build"] + args)
+    }
+
+    private func run(_ args: String...) throws -> (stdout: String, stderr: String) {
+        return try execute(["run"] + args)
+    }
+
+    func testUsage() throws {
+        let stdout = try execute(["-help"]).stdout
+        XCTAssert(stdout.contains("USAGE: swift script <subcommand>"), "got stdout:\n" + stdout)
+    }
+
+    func testSeeAlso() throws {
+        let stdout = try execute(["--help"]).stdout
+        XCTAssert(stdout.contains("SEE ALSO: swift build, swift run, swift package, swift test"), "got stdout:\n" + stdout)
+    }
+
+    func testVersion() throws {
+        let stdout = try execute(["--version"]).stdout
+        XCTAssert(stdout.contains("Swift Package Manager"), "got stdout:\n" + stdout)
+    }
+
+    func testWrongScriptPath() throws {
+        try withTemporaryDirectory { path in
+            let pathString = path.appending(component: "EchoArguments").pathString
+            do {
+                _ = try run(pathString)
+                XCTFail("Unexpected success")
+            } catch SwiftPMProductError.executionFailure(_, _, let stderr) {
+                XCTExpectFailure() // FIXME: Seems an implementation bug of TSC?
+                XCTAssertEqual(stderr, "error: \(pathString) doesn't exist\n")
+            }
+        }
+    }
+
+    func testArgumentPassing() throws {
+        fixture(name: "Scripts/EchoArguments") { path in
+            let result = try run(path.appending(component: "EchoArguments.swift").pathString,
+                                 "1", "--hello", "world")
+
+            // We only expect tool's output on the stdout stream.
+            XCTAssertEqual(result.stdout.trimmingCharacters(in: .whitespacesAndNewlines),
+                           #""1" "--hello" "world""#)
+
+            // swift-build-tool output should go to stderr.
+            XCTAssertMatch(result.stderr, .contains("Using cache: EchoArguments-"))
+            XCTAssertMatch(result.stderr, .contains("Compiling"))
+            XCTAssertMatch(result.stderr, .contains("Linking"))
+        }
+    }
+
+    func testCurrentWorkingDirectoryWithLocalDependency() throws {
+        fixture(name: "Scripts/EchoCWD") { path in
+            let result = try run(path.appending(component: "EchoCWD.swift").pathString)
+
+            XCTAssertEqual(result.stdout.trimmingCharacters(in: .whitespacesAndNewlines),
+                           localFileSystem.currentWorkingDirectory?.pathString)
+        }
+    }
+
+    func testPrebuild() throws {
+        fixture(name: "Scripts/EchoArguments") { path in
+            let result = try build(path.appending(component: "EchoArguments.swift").pathString)
+
+            // swift-build-tool output should go to stderr.
+            XCTAssertMatch(result.stderr, .contains("Using cache: EchoArguments-"))
+            XCTAssertMatch(result.stderr, .contains("Compiling"))
+            XCTAssertMatch(result.stderr, .contains("Linking"))
+        }
+    }
+
+    func testQuietMode() throws {
+        fixture(name: "Scripts/EchoArguments") { path in
+            let result = try run(path.appending(component: "EchoArguments.swift").pathString, "--quiet",
+                                 "1", "--hello", "world")
+
+            // We only expect tool's output on the stdout stream.
+            XCTAssertEqual(result.stdout.trimmingCharacters(in: .whitespacesAndNewlines),
+                           #""1" "--hello" "world""#)
+
+            // swift-build-tool output should be muted.
+            XCTAssertNoMatch(result.stderr, .contains("Using cache: EchoArguments-"))
+            XCTAssertNoMatch(result.stderr, .contains("Compiling"))
+            XCTAssertNoMatch(result.stderr, .contains("Linking"))
+        }
+    }
+
+    // TODO: Tests for other swift-script tools
+}