Support SPM coverage

Author: f-meloni

Package.resolved

@@ -159,8 +159,8 @@
         "repositoryURL": "https://github.com/danger/swift.git",
         "state": {
           "branch": null,
-          "revision": "ea843a2df3f17c309767dd9725c82dc1c4e60130",
-          "version": "1.3.1"
+          "revision": "ece72c9bc2d8b0719d74ba0377063288ca625ba7",
+          "version": "1.3.2"
         }
       },
       {
@@ -228,7 +228,7 @@
       },
       {
         "package": "Yams",
-        "repositoryURL": "https://github.com/jpsim/Yams",
+        "repositoryURL": "https://github.com/jpsim/Yams.git",
         "state": {
           "branch": null,
           "revision": "26ab35f50ea891e8edefcc9d975db2f6b67e1d68",

SPMDangerfile.swift

@@ -0,0 +1,5 @@
+import Danger
+import DangerSwiftCoverage
+
+let danger = Danger()
+Coverage.spmCoverage(minimumCoverage: 50)

Sources/DangerSwiftCoverage/DangerSwiftCoverage.swift

@@ -17,13 +17,13 @@ public enum Coverage {
         }
     }
 
-    public static func spmCoverage(spmCoverageFilePath: String = ".build/debug/cov", minimumCoverage: Float) {
-        spmCoverage(spmCoverageFilePath: spmCoverageFilePath, minimumCoverage: minimumCoverage, spmCoverageParser: SPMCoverageParser.self, fileManager: .default, danger: Danger())
+    public static func spmCoverage(spmCoverageFolder: String = ".build/debug/codecov", minimumCoverage: Float) {
+        spmCoverage(spmCoverageFolder: spmCoverageFolder, minimumCoverage: minimumCoverage, spmCoverageParser: SPMCoverageParser.self, fileManager: .default, danger: Danger())
     }
 
-    static func spmCoverage(spmCoverageFilePath: String, minimumCoverage: Float, spmCoverageParser: SPMCoverageParsing.Type, fileManager: FileManager, danger: DangerDSL) {
+    static func spmCoverage(spmCoverageFolder: String, minimumCoverage: Float, spmCoverageParser: SPMCoverageParsing.Type, fileManager: FileManager, danger: DangerDSL) {
         do {
-            let report = try spmCoverageParser.coverage(spmCoverageFilePath: spmCoverageFilePath, files: modifiedFilesAbsolutePaths(fileManager: fileManager, danger: danger))
+            let report = try spmCoverageParser.coverage(spmCoverageFolder: spmCoverageFolder, files: modifiedFilesAbsolutePaths(fileManager: fileManager, danger: danger))
             sendReport(report, minumumCoverage: minimumCoverage, danger: danger)
         } catch {
             danger.fail("Failed to get the coverage - Error: \(error.localizedDescription)")

Sources/DangerSwiftCoverage/SPM/SPMCoverageParser.swift

@@ -1,20 +1,23 @@
 import Foundation
 
 protocol SPMCoverageParsing {
-    static func coverage(spmCoverageFilePath: String, files: [String]) throws -> Report
+    static func coverage(spmCoverageFolder: String, files: [String]) throws -> Report
 }
 
 enum SPMCoverageParser: SPMCoverageParsing {
     enum Errors: Error {
-        case buildFolderNotFound
+        case coverageFileNotFound
     }
 
-    static func coverage(spmCoverageFilePath: String, files: [String]) throws -> Report {
-        return try coverage(spmCoverageFilePath: spmCoverageFilePath, files: files, fileManager: .default)
+    static func coverage(spmCoverageFolder: String, files: [String]) throws -> Report {
+        return try coverage(spmCoverageFolder: spmCoverageFolder, files: files, fileManager: .default)
     }
 
-    static func coverage(spmCoverageFilePath: String, files: [String], fileManager: FileManager) throws -> Report {
-        let url = URL(fileURLWithPath: fileManager.currentDirectoryPath + "/" + spmCoverageFilePath)
+    static func coverage(spmCoverageFolder: String, files: [String], fileManager: FileManager) throws -> Report {
+        guard let jsonFileName = try fileManager.contentsOfDirectory(atPath: spmCoverageFolder).first(where: { $0.split(separator: ".").last == "json" }) else {
+            throw Errors.coverageFileNotFound
+        }
+        let url = URL(fileURLWithPath: fileManager.currentDirectoryPath + "/" + spmCoverageFolder + "/" + jsonFileName)
         let data = try Data(contentsOf: url)
         let coverage = try JSONDecoder().decode(SPMCoverage.self, from: data)
         let filteredCoverage = coverage.filteringFiles(notOn: files)

Tests/DangerSwiftCoverageTests/CoverageTests.swift

@@ -29,7 +29,7 @@ final class CoverageTests: XCTestCase {
 
     func testItSendsAFailMessageIfFailsToParseTheXcodeBuildCoverage() {
         dsl = githubFixtureDSL
-        Coverage.xcodeBuildCoverage(derivedDataFolder: "derived", minimumCoverage: 50, excludedTargets: [], fileManager: FakeCurrentPathProvider(), xcodeBuildCoverageParser: MockXcodeBuildCoverageParser.self, danger: dsl)
+        Coverage.xcodeBuildCoverage(derivedDataFolder: "derived", minimumCoverage: 50, excludedTargets: [], fileManager: StubbedFileManager(), xcodeBuildCoverageParser: MockXcodeBuildCoverageParser.self, danger: dsl)
 
         XCTAssertEqual(dsl.fails.count, 1)
         XCTAssertEqual(dsl.fails[0].message, "Failed to get the coverage - Error: Fake Error")
@@ -38,7 +38,7 @@ final class CoverageTests: XCTestCase {
     func testItSendsTheCorrectParametersToTheXcodeBuildCoverageParser() {
         dsl = githubWithFilesDSL(created: created, modified: modified)
 
-        let currentPathProvider = FakeCurrentPathProvider()
+        let currentPathProvider = StubbedFileManager()
         let excluedTargets = ["TargetA.framework", "TargetB.framework"]
 
         Coverage.xcodeBuildCoverage(derivedDataFolder: "derived", minimumCoverage: 50, excludedTargets: excluedTargets, fileManager: currentPathProvider, xcodeBuildCoverageParser: MockXcodeBuildCoverageParser.self, danger: dsl)
@@ -52,7 +52,7 @@ final class CoverageTests: XCTestCase {
         dsl = githubWithFilesDSL()
         MockXcodeBuildCoverageParser.shouldSucceed = true
 
-        Coverage.xcodeBuildCoverage(derivedDataFolder: "derived", minimumCoverage: 50, excludedTargets: [], fileManager: FakeCurrentPathProvider(), xcodeBuildCoverageParser: MockXcodeBuildCoverageParser.self, danger: dsl)
+        Coverage.xcodeBuildCoverage(derivedDataFolder: "derived", minimumCoverage: 50, excludedTargets: [], fileManager: StubbedFileManager(), xcodeBuildCoverageParser: MockXcodeBuildCoverageParser.self, danger: dsl)
 
         XCTAssertEqual(dsl.messages.map { $0.message }, ["TestMessage1", "TestMessage2"])
 
@@ -77,9 +77,9 @@ final class CoverageTests: XCTestCase {
     func testItSendsTheCorrectParametersToTheSPMCoverageParser() {
         dsl = githubWithFilesDSL(created: created, modified: modified)
 
-        let currentPathProvider = FakeCurrentPathProvider()
+        let currentPathProvider = StubbedFileManager()
 
-        Coverage.spmCoverage(spmCoverageFilePath: ".build/debug", minimumCoverage: 50, spmCoverageParser: MockSPMCoverageParser.self, fileManager: currentPathProvider, danger: dsl)
+        Coverage.spmCoverage(spmCoverageFolder: ".build/debug", minimumCoverage: 50, spmCoverageParser: MockSPMCoverageParser.self, fileManager: currentPathProvider, danger: dsl)
 
         XCTAssertEqual(MockSPMCoverageParser.receivedSPMCoverageFilePath, ".build/debug")
         XCTAssertEqual(MockSPMCoverageParser.receivedFiles, (created + modified).map { currentPathProvider.fakePath + "/" + $0 })
@@ -89,7 +89,7 @@ final class CoverageTests: XCTestCase {
         dsl = githubWithFilesDSL()
         MockSPMCoverageParser.shouldSucceed = true
 
-        Coverage.spmCoverage(spmCoverageFilePath: ".build/debug", minimumCoverage: 50, spmCoverageParser: MockSPMCoverageParser.self, fileManager: FakeCurrentPathProvider(), danger: dsl)
+        Coverage.spmCoverage(spmCoverageFolder: ".build/debug", minimumCoverage: 50, spmCoverageParser: MockSPMCoverageParser.self, fileManager: StubbedFileManager(), danger: dsl)
 
         XCTAssertEqual(dsl.messages.map { $0.message }, [])
 
@@ -127,7 +127,7 @@ private final class MockSPMCoverageParser: SPMCoverageParsing {
                                        ]),
     ])
 
-    static func coverage(spmCoverageFilePath: String, files: [String]) throws -> Report {
+    static func coverage(spmCoverageFolder spmCoverageFilePath: String, files: [String]) throws -> Report {
         receivedSPMCoverageFilePath = spmCoverageFilePath
         receivedFiles = files
 

Tests/DangerSwiftCoverageTests/FakeCurrentPathProvider.swift

@@ -7,10 +7,10 @@ final class SPMCoverageParserTests: XCTestCase {
 
         try spmCoverageJSON.write(toFile: testPath, atomically: false, encoding: .utf8)
 
-        let currentPathProvider = FakeCurrentPathProvider()
+        let fileManager = StubbedFileManager()
 
         var calls = 0
-        currentPathProvider.currentPathBlock = {
+        fileManager.currentPathBlock = {
             let result: String
 
             if calls == 0 {
@@ -24,7 +24,11 @@ final class SPMCoverageParserTests: XCTestCase {
             return result
         }
 
-        let report = try! SPMCoverageParser.coverage(spmCoverageFilePath: testPath, files: ["/Users/franco/Projects/Logger/Sources/Logger/Logger.swift"], fileManager: currentPathProvider)
+        fileManager.stubbedContentOfDirectoryBlock = { _ in
+            [testPath]
+        }
+
+        let report = try! SPMCoverageParser.coverage(spmCoverageFolder: ".", files: ["/Users/franco/Projects/Logger/Sources/Logger/Logger.swift"], fileManager: fileManager)
 
         XCTAssertEqual(report.sections[0].items.count, 1)
         XCTAssertEqual(report.sections[0].items[0].fileName, "Sources/Logger/Logger.swift")

Tests/DangerSwiftCoverageTests/SPMCoverageParserTests.swift

@@ -0,0 +1,22 @@
+import Foundation
+
+final class StubbedFileManager: FileManager {
+    let fakePath = "/usr/franco"
+    lazy var currentPathBlock: () -> String = { [unowned self] in
+        self.fakePath
+    }
+
+    var stubbedContentOfDirectoryBlock: ((String) -> [String])?
+
+    override var currentDirectoryPath: String {
+        return currentPathBlock()
+    }
+
+    override func contentsOfDirectory(atPath path: String) throws -> [String] {
+        if let stubbedContentOfDirectoryBlock = stubbedContentOfDirectoryBlock {
+            return stubbedContentOfDirectoryBlock(path)
+        } else {
+            return try super.contentsOfDirectory(atPath: path)
+        }
+    }
+}

Tests/DangerSwiftCoverageTests/StubbedFileManager.swift

@@ -21,7 +21,7 @@ final class XcodeCoverageFileFinderTests: XCTestCase {
     }
 
     func testItFailsIfTheDirectoryDoesntContainAnXCovFile() {
-        fileManager.contentResult = { fileName in
+        fileManager.stubbedContentOfDirectoryBlock = { fileName in
             fileName == "derived/Logs/Test/" ? ["test.xcresult"] : []
         }
 
@@ -31,18 +31,10 @@ final class XcodeCoverageFileFinderTests: XCTestCase {
     }
 
     func testItReturnsTheCorrectCoverageFile() throws {
-        fileManager.contentResult = { fileName in
+        fileManager.stubbedContentOfDirectoryBlock = { fileName in
             fileName == "derived/Logs/Test/" ? ["test.xcresult"] : (fileName == "derived/Logs/Test/test.xcresult" ? ["1_test"] : ["action.xccovreport"])
         }
 
         XCTAssertEqual(try XcodeCoverageFileFinder.coverageFile(derivedDataFolder: "derived", fileManager: fileManager), "derived/Logs/Test/test.xcresult/1_test/action.xccovreport")
     }
 }
-
-private final class StubbedFileManager: FileManager {
-    fileprivate var contentResult: ((String) -> [String])?
-
-    override func contentsOfDirectory(atPath path: String) throws -> [String] {
-        return contentResult?(path) ?? []
-    }
-}