Merge pull request #74 from kostiakoval/private-dependency

Add Private dependency to Manifest

Documentation/Package.swift.md

@@ -54,6 +54,22 @@ let package = Package(
 )
 ```
 
+A package can require dependencies that are only needed during develop,
+as example for testing purposes. `testDependencies` are only fetched 
+when you build current package. They are not fetched if a package is 
+specified as a dependency in other package.
+
+```swift
+import PackageDescription
+
+let package = Package(
+    name: "Hello",
+    testDependencies: [
+        .Package(url: "ssh://git@example.com/Tester.git", versions: Version(1,0,0)..<Version(2,0,0)),
+    ]
+)
+```
+
 ## Customizing Builds
 
 That the manifest is Swift allows for powerful customization, for example:

Sources/PackageDescription/Package.swift

@@ -56,14 +56,18 @@ public final class Package {
     /// The list of dependencies.
     public var dependencies: [Dependency]
 
+    /// The list of test dependencies. They aren't exposed to a parent Package
+    public var testDependencies: [Dependency]
+
     /// The list of folders to exclude.
     public var exclude: [String]
 
     /// Construct a package.
-    public init(name: String? = nil, targets: [Target] = [], dependencies: [Dependency] = [], exclude: [String] = []) {
+    public init(name: String? = nil, targets: [Target] = [], dependencies: [Dependency] = [], testDependencies: [Dependency] = [], exclude: [String] = []) {
         self.name = name
         self.targets = targets
         self.dependencies = dependencies
+        self.testDependencies = testDependencies
         self.exclude = exclude
 
         // Add custom exit handler to cause package to be dumped at exit, if requested.
@@ -97,6 +101,13 @@ extension Package: TOMLConvertible {
             result += dependency.toTOML()
         }
         result += "]\n"
+
+        result += "testDependencies = ["
+        for dependency in testDependencies {
+            result += dependency.toTOML()
+        }
+        result += "]\n"
+
         for target in targets {
 
             result += "[[package.targets]]\n"

Sources/dep/Manifest.swift

@@ -43,6 +43,14 @@ extension PackageDescription.Package {
             }
         }
 
+        // Parse the test dependencies.
+        var testDependencies: [PackageDescription.Package.Dependency] = []
+        if case .Some(.Array(let array)) = table.items["testDependencies"] {
+            for item in array.items {
+                testDependencies.append(PackageDescription.Package.Dependency.fromTOML(item, baseURL: baseURL))
+            }
+        }
+
         //Parse the exclude folders.
         var exclude: [String] = []
         if case .Some(.Array(let array)) = table.items["exclude"] {
@@ -52,7 +60,7 @@ extension PackageDescription.Package {
             }
         }
 
-        return PackageDescription.Package(name: name, targets: targets, dependencies: dependencies, exclude: exclude)
+        return PackageDescription.Package(name: name, targets: targets, dependencies: dependencies, testDependencies: testDependencies, exclude: exclude)
     }
 }
 

Sources/swift-build/main.swift

@@ -62,6 +62,11 @@ do {
             try llbuild(srcroot: pkg.path, targets: try pkg.targets(), dependencies: dependencies, prefix: builddir, tmpdir: Path.join(builddir, "\(pkg.name).o"), configuration: configuration)
         }
 
+        let testDependencies = try get(manifest.package.testDependencies, prefix: depsdir)
+        for pkg in testDependencies {
+            try llbuild(srcroot: pkg.path, targets: try pkg.targets(), dependencies: testDependencies, prefix: builddir, tmpdir: Path.join(builddir, "\(pkg.name).o"), configuration: configuration)
+        }
+
         do {
             // build the current directory
             try llbuild(srcroot: rootd, targets: targets, dependencies: dependencies, prefix: builddir, tmpdir: Path.join(builddir, "\(pkgname).o"), configuration: configuration)

Tests/PackageDescription/PackageDescriptionTests.swift

@@ -28,6 +28,8 @@ class PackageTests: XCTestCase, XCTestCaseProvider {
         return [
             ("testBasics", testBasics),
             ("testExclude", testExclude),
+            ("testEmptyTestDependencies", testEmptyTestDependencies),
+            ("testTestDependencies", testTestDependencies),
         ]
     }
 
@@ -43,4 +45,16 @@ class PackageTests: XCTestCase, XCTestCaseProvider {
         let pFromTOML = Package.fromTOML(parseTOML(p1.toTOML()))
         XCTAssertEqual(pFromTOML.exclude, exclude)
     }
+
+    func testEmptyTestDependencies() {
+        let p = Package(testDependencies: [])
+        XCTAssertEqual(p.testDependencies, [])
+    }
+
+    func testTestDependencies() {
+        let dependencies = [Package.Dependency.Package(url: "../TestingLib", majorVersion: 1)]
+        let p = Package(testDependencies: dependencies)
+        let pFromTOML = Package.fromTOML(parseTOML(p.toTOML()))
+        XCTAssertEqual(pFromTOML.testDependencies, dependencies)
+    }
 }

Tests/dep/Fixtures/30_test_deps/App/Package.swift

@@ -0,0 +1,11 @@
+import PackageDescription
+
+let package = Package(
+    name: "App",
+    dependencies: [
+        .Package(url: "../Foo", majorVersion: 1)
+    ],
+    testDependencies: [
+        .Package(url: "../TestingLib", majorVersion: 1)
+    ]
+)

Tests/dep/Fixtures/30_test_deps/App/main.swift

@@ -0,0 +1,3 @@
+import Foo
+
+foo()

Tests/dep/Fixtures/30_test_deps/Foo/Foo.swift

@@ -0,0 +1,3 @@
+public func foo() {
+	{}()
+}

Tests/dep/Fixtures/30_test_deps/TestingLib/TestingLib.swift

@@ -0,0 +1,3 @@
+public func testingLib() {
+	{}()
+}

Tests/dep/Fixtures/31_test_deps_in_children/App/Package.swift

@@ -0,0 +1,11 @@
+import PackageDescription
+
+let package = Package(
+    name: "App",
+    dependencies: [
+        .Package(url: "../Foo", majorVersion: 1)
+    ],
+    testDependencies: [
+        .Package(url: "../TestingLib", majorVersion: 1)
+    ]
+)

Tests/dep/Fixtures/31_test_deps_in_children/App/main.swift

@@ -0,0 +1,3 @@
+import Foo
+
+foo()

Tests/dep/Fixtures/31_test_deps_in_children/Foo/Foo.swift

@@ -0,0 +1,4 @@
+public func foo() {
+	{}()
+}
+

Tests/dep/Fixtures/31_test_deps_in_children/Foo/Package.swift

@@ -0,0 +1,8 @@
+import PackageDescription
+
+let package = Package(
+    name: "Foo",
+    testDependencies: [
+        .Package(url: "../TestingFooLib", majorVersion: 1)
+    ]
+)

Tests/dep/Fixtures/31_test_deps_in_children/TestingFooLib/TestingFooLib.swift

@@ -0,0 +1,3 @@
+public func testingFooLib() {
+	{}()
+}

Tests/dep/Fixtures/31_test_deps_in_children/TestingLib/TestingLib.swift

@@ -0,0 +1,3 @@
+public func testingLib() {
+	{}()
+}

Tests/dep/FunctionalBuildTests.swift

@@ -64,6 +64,10 @@ class FunctionalBuildTests: XCTestCase, XCTestCaseProvider {
             ("testSymlinkedSourceDirectoryWorks", testSymlinkedSourceDirectoryWorks),
             ("testSymlinkedNestedSourceDirectoryWorks", testSymlinkedNestedSourceDirectoryWorks),
             ("testPassExactDependenciesToBuildCommand", testPassExactDependenciesToBuildCommand),
+            ("testGetTestDeps", testGetTestDeps),
+            ("testBuildTestDeps", testBuildTestDeps),
+            ("testDontGetChildrenPrivateDeps",testDontGetChildrenPrivateDeps),
+            ("testBuildChildrenPrivateDeps", testBuildChildrenPrivateDeps),
         ]
     }
 
@@ -349,6 +353,44 @@ class FunctionalBuildTests: XCTestCase, XCTestCaseProvider {
         }
     }
 
+    // 30: Test Dependencies
+    func testGetTestDeps() {
+        fixture(name: "30_test_deps") { prefix in
+            let appPath = Path.join(prefix, "App")
+            XCTAssertNotNil(try? executeSwiftBuild(appPath))
+            XCTAssertTrue(Path.join(appPath, "Packages/TestingLib-1.2.3").isDirectory)
+        }
+    }
+
+    func testBuildTestDeps() {
+        let filesToVerify = ["Foo.a", "TestingLib.a"]
+        fixture(name: "30_test_deps") { prefix in
+            let appPath = Path.join(prefix, "App")
+            XCTAssertNotNil(try? executeSwiftBuild(appPath))
+            XCTAssertTrue(self.verifyFilesExist(filesToVerify, fixturePath: appPath))
+        }
+    }
+
+    // 31: Private Dependencies for a Package dependency
+    func testDontGetChildrenPrivateDeps() {
+        fixture(name: "31_test_deps_in_children") { prefix in
+            let appPath = Path.join(prefix, "App")
+            XCTAssertNotNil(try? executeSwiftBuild(appPath))
+            XCTAssertTrue(Path.join(appPath, "Packages/TestingLib-1.2.3").isDirectory)
+            XCTAssertFalse(Path.join(appPath, "Packages/PrivateFooLib-1.2.3").isDirectory)
+        }
+    }
+
+    func testBuildChildrenPrivateDeps() {
+        let filesToVerify = ["Foo.a", "TestingLib.a"]
+        fixture(name: "31_test_deps_in_children") { prefix in
+            let appPath = Path.join(prefix, "App")
+            XCTAssertNotNil(try? executeSwiftBuild(appPath))
+            XCTAssertTrue(self.verifyFilesExist(filesToVerify, fixturePath: appPath))
+            XCTAssertFalse(self.verifyFilesExist(["TestingFooLib.a"], fixturePath: appPath))
+        }
+    }
+
     func test_exdeps() {
         fixture(name: "102_mattts_dealer") { prefix in
             let prefix = Path.join(prefix, "app")