[TEST] Use Git commit message instead

Wei Sun · Wei Sun · commit 7390b4788e84 · 2021-09-08T02:02:42.000+10:00
- update tests
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/BodyEmptyLineCheck.swift b/Sources/DangerSwiftCommitLint/CommitChecker/BodyEmptyLineCheck.swift
@@ -5,7 +5,7 @@ struct BodyEmptyLineCheck: CommitChecker, Hashable {
 
     private let bodyLinesOfText: [String]
 
-    init(_ commitMessage: CommitMessage) {
+    init(_ commitMessage: GitCommitMessage) {
         bodyLinesOfText = commitMessage.bodyLinesOfText
     }
 
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/CommitChecker.swift b/Sources/DangerSwiftCommitLint/CommitChecker/CommitChecker.swift
@@ -5,13 +5,13 @@ public protocol CommitChecker {
 
     var fail: Bool { get }
 
-    init(_ commitMessage: CommitMessage)
+    init(_ commitMessage: GitCommitMessage)
 
-    static func fail(_ commitMessage: CommitMessage) -> Bool
+    static func fail(_ commitMessage: GitCommitMessage) -> Bool
 }
 
 public extension CommitChecker {
-    static func fail(_ commitMessage: CommitMessage) -> Bool {
+    static func fail(_ commitMessage: GitCommitMessage) -> Bool {
         Self(commitMessage).fail
     }
 }
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/GitCommitMessage.swift b/Sources/DangerSwiftCommitLint/CommitChecker/GitCommitMessage.swift
@@ -1,8 +1,8 @@
 import Danger
 import Foundation
 
-/// An abstraction of GitHub commit message.
-public struct CommitMessage: Hashable {
+/// An abstraction of Git commit message for `DangerSwiftCommitLint`.
+public struct GitCommitMessage: Hashable {
     /// First line of the commit message
     public let subject: String
     /// Rest of the commit message
@@ -20,16 +20,7 @@ public struct CommitMessage: Hashable {
         self.sha = sha
     }
 
-    /// Initialize CommitMessage with `Danger.GitHub.Commit.CommitData.message`.
-    /// - Parameter commit: An instance of `GitHub.Commit`
-    public init(_ commit: GitHub.Commit) {
-        let commitMessageLines = commit.commit.message.components(separatedBy: .newlines)
-        subject = commitMessageLines.first ?? ""
-        bodyLinesOfText = Array(commitMessageLines.dropFirst())
-        sha = commit.sha
-    }
-
-    /// Initialize `CommitMessage` with `Danger.Git.Commit.message`
+    /// Initialize `GitCommitMessage` with `Danger.Git.Commit.message`
     /// - Parameter gitCommit: An instance of `Danger.Git.Commit`
     public init(_ gitCommit: Git.Commit) {
         let commitMessageLines = gitCommit.message.components(separatedBy: .newlines)
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/SubjectCapCheck.swift b/Sources/DangerSwiftCommitLint/CommitChecker/SubjectCapCheck.swift
@@ -5,7 +5,7 @@ struct SubjectCapCheck: CommitChecker, Hashable {
 
     private let firstCharacter: Character?
 
-    init(_ commitMessage: CommitMessage) {
+    init(_ commitMessage: GitCommitMessage) {
         firstCharacter = commitMessage.subject.first
     }
 
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/SubjectLengthCheck.swift b/Sources/DangerSwiftCommitLint/CommitChecker/SubjectLengthCheck.swift
@@ -10,7 +10,7 @@ struct SubjectLengthCheck: CommitChecker, Hashable {
 
     private let subject: String
 
-    init(_ commitMessage: CommitMessage) {
+    init(_ commitMessage: GitCommitMessage) {
         subject = commitMessage.subject
     }
 
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/SubjectPeriodCheck.swift b/Sources/DangerSwiftCommitLint/CommitChecker/SubjectPeriodCheck.swift
@@ -5,7 +5,7 @@ struct SubjectPeriodCheck: CommitChecker, Hashable {
 
     private let subject: String
 
-    init(_ commitMessage: CommitMessage) {
+    init(_ commitMessage: GitCommitMessage) {
         subject = commitMessage.subject
     }
 
diff --git a/Sources/DangerSwiftCommitLint/CommitChecker/SubjectWordCheck.swift b/Sources/DangerSwiftCommitLint/CommitChecker/SubjectWordCheck.swift
@@ -5,7 +5,7 @@ struct SubjectWordCheck: CommitChecker, Hashable {
 
     private let subject: String
 
-    init(_ commitMessage: CommitMessage) {
+    init(_ commitMessage: GitCommitMessage) {
         subject = commitMessage.subject
     }
 
diff --git a/Sources/DangerSwiftCommitLint/DangerSwiftCommitLint.swift b/Sources/DangerSwiftCommitLint/DangerSwiftCommitLint.swift
@@ -29,8 +29,8 @@ public final class DangerSwiftCommitLint {
 }
 
 extension DangerSwiftCommitLint {
-    var commitMessages: [CommitMessage] {
-        let messages = danger.git.commits.map { CommitMessage($0) }
+    var commitMessages: [GitCommitMessage] {
+        let messages = danger.git.commits.map { GitCommitMessage($0) }
         guard configuration.limit > 0 else {
             return messages
         }
@@ -58,7 +58,7 @@ extension DangerSwiftCommitLint {
 }
 
 extension Array where Element == CommitChecker.Type {
-    func checkCommitMessages(_ commitMessages: [CommitMessage], checkerResultHanler: (String, [String]) -> Void) {
+    func checkCommitMessages(_ commitMessages: [GitCommitMessage], checkerResultHanler: (String, [String]) -> Void) {
         forEach { checker in
             let shas = commitMessages.compactMap { checker.fail($0) ? $0.sha : nil }
             if shas.isEmpty == false {
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/BodyEmptyLineCheckTests.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/BodyEmptyLineCheckTests.swift
@@ -3,9 +3,9 @@ import Danger
 import XCTest
 
 final class BodyEmptyLineCheckTests: XCTestCase {
-    private let commitSubjectAndBody = CommitMessage(subject: "Title Test", bodyLinesOfText: ["", "Body Test"], sha: "Test SHA")
-    private let commitSubjectOnly = CommitMessage(subject: "Title Test", bodyLinesOfText: [], sha: "Test SHA")
-    private let commitNoNewline = CommitMessage(subject: "Title Test", bodyLinesOfText: ["Body Test"], sha: "Test SHA")
+    private let commitSubjectAndBody = GitCommitMessage(subject: "Title Test", bodyLinesOfText: ["", "Body Test"], sha: "Test SHA")
+    private let commitSubjectOnly = GitCommitMessage(subject: "Title Test", bodyLinesOfText: [], sha: "Test SHA")
+    private let commitNoNewline = GitCommitMessage(subject: "Title Test", bodyLinesOfText: ["Body Test"], sha: "Test SHA")
 
     func testSuccessCommitSubjectAndBody() {
         let testSubject = BodyEmptyLineCheck(commitSubjectAndBody)
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/CommitMessageTests.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/CommitMessageTests.swift
@@ -4,9 +4,9 @@ import XCTest
 
 final class CommitMessageTests: XCTestCase {
     func testInitializeWithDangerGitHubCommit() {
-        let commit = CommitParser.parseCommitJSON(with: commitMessageJSON)
-        let expectedCommitMessage = commit.commit.message.components(separatedBy: .newlines)
-        let testSubject = CommitMessage(commit)
+        let commit = CommitParser.parseCommitJSON(with: gitCommitJSON)
+        let expectedCommitMessage = commit.message.components(separatedBy: .newlines)
+        let testSubject = GitCommitMessage(commit)
         XCTAssertEqual(testSubject.sha, commit.sha)
         XCTAssertEqual(
             [
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/Fixtures/CommitJSONParser.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/Fixtures/CommitJSONParser.swift
@@ -2,10 +2,10 @@ import Danger
 import Foundation
 
 enum CommitParser {
-    static func parseCommitJSON(with commitJSON: String) -> GitHub.Commit {
+    static func parseCommitJSON(with commitJSON: String) -> Git.Commit {
         let data = Data(commitJSON.utf8)
         let decoder = JSONDecoder()
         decoder.dateDecodingStrategy = .custom(DateFormatter.dateFormatterHandler)
-        return try! decoder.decode(GitHub.Commit.self, from: data) // swiftlint:disable:this force_try
+        return try! decoder.decode(Git.Commit.self, from: data) // swiftlint:disable:this force_try
     }
 }
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/Fixtures/CommitMessageJSON.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/Fixtures/CommitMessageJSON.swift
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/Fixtures/GitCommitJSON.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/Fixtures/GitCommitJSON.swift
@@ -0,0 +1,24 @@
+let gitCommitJSON = """
+{
+    "sha": "93ae30cf2aee4241c442fb3242543490998cffdb",
+    "parents": [
+        "68c8db83776c1942145f530159a3fffddb812577"
+    ],
+    "author": {
+        "name": "Ash Furrow",
+        "email": "ash@ashfurrow.com",
+        "date": "2016-07-26T19:54:16Z"
+    },
+    "committer": {
+        "name": "Ash Furrow",
+        "email": "ash@ashfurrow.com",
+        "date": "2016-07-26T19:55:00Z"
+    },
+    "message": "[Xcode] Updates for compatibility with Xcode 7.3.1.\\n\\nTest Body",
+    "tree": {
+        "sha": "fb6bc3fda2456c5ff0a4e8f307f24ee73f281fc1",
+        "url": "https://api.github.com/repos/artsy/eidolon/git/trees/fb6bc3fda2456c5ff0a4e8f307f24ee73f281fc1"
+    },
+    "url": "https://api.github.com/repos/artsy/eidolon/commits/93ae30cf2aee4241c442fb3242543490998cffdb"
+}
+"""
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectCapCheckTests.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectCapCheckTests.swift
@@ -3,29 +3,29 @@ import XCTest
 
 final class SubjectCapCheckTests: XCTestCase {
     func testSuccess() {
-        let commitMessage = CommitMessage(subject: "Subject", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "Subject", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectCapCheck(commitMessage)
         XCTAssertFalse(testSubject.fail)
         XCTAssertFalse(SubjectCapCheck.fail(commitMessage))
     }
 
     func testFailure() {
-        let commitMessage = CommitMessage(subject: "subject", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "subject", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectCapCheck(commitMessage)
         XCTAssertTrue(testSubject.fail)
         XCTAssertTrue(SubjectCapCheck.fail(commitMessage))
     }
 
     func testSuccessWithNonLetterCharacters() {
-        let commitMessage = CommitMessage(subject: "[TEST-123] Subject", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "[TEST-123] Subject", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectCapCheck(commitMessage)
         XCTAssertFalse(testSubject.fail)
         XCTAssertFalse(SubjectCapCheck.fail(commitMessage))
     }
 
     /// Git generally disallows empty commit message, so subject should at least contain non empty text. This test case is only capturing a unlikely edge case.
     func testEdgeCase() {
-        let commitMessage = CommitMessage(subject: "", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectCapCheck(commitMessage)
         XCTAssertFalse(testSubject.fail)
         XCTAssertFalse(SubjectCapCheck.fail(commitMessage))
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectLengthCheckTests.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectLengthCheckTests.swift
@@ -3,14 +3,14 @@ import XCTest
 
 final class SubjectLengthCheckTests: XCTestCase {
     func testSuccess() {
-        let commitMessage = CommitMessage(subject: "Valid title", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "Valid title", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectLengthCheck(commitMessage)
         XCTAssertFalse(testSubject.fail)
         XCTAssertFalse(SubjectLengthCheck.fail(commitMessage))
     }
 
     func testFailure() {
-        let commitMessage = CommitMessage(
+        let commitMessage = GitCommitMessage(
             subject: "This is a long git commit subject for testing purpose.",
             bodyLinesOfText: [],
             sha: "Test SHA"
@@ -21,7 +21,7 @@ final class SubjectLengthCheckTests: XCTestCase {
     }
 
     func testSuccessWithGitHubMergeCommit() {
-        let commitMessage = CommitMessage(
+        let commitMessage = GitCommitMessage(
             subject: "Merge pull request #123 from AppDifferentia/test-branching",
             bodyLinesOfText: [],
             sha: "Test SHA"
@@ -32,7 +32,7 @@ final class SubjectLengthCheckTests: XCTestCase {
     }
 
     func testSuccessWithGitMergeCommit() {
-        let commitMessage = CommitMessage(
+        let commitMessage = GitCommitMessage(
             subject: "Merge branch 'master' into AppDifferentia/test-branching",
             bodyLinesOfText: [],
             sha: "Test SHA"
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectPeriodCheckTests.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectPeriodCheckTests.swift
@@ -3,14 +3,14 @@ import XCTest
 
 final class SubjectPeriodCheckTests: XCTestCase {
     func testSuccess() {
-        let commitMessage = CommitMessage(subject: "Test title without period at the end", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "Test title without period at the end", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectPeriodCheck(commitMessage)
         XCTAssertFalse(testSubject.fail)
         XCTAssertFalse(SubjectPeriodCheck.fail(commitMessage))
     }
 
     func testFailure() {
-        let commitMessage = CommitMessage(subject: "Test title with period at the end.", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "Test title with period at the end.", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectPeriodCheck(commitMessage)
         XCTAssertTrue(testSubject.fail)
         XCTAssertTrue(SubjectPeriodCheck.fail(commitMessage))
diff --git a/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectWorkCheckTests.swift b/Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectWorkCheckTests.swift
@@ -3,14 +3,14 @@ import XCTest
 
 final class SubjectWordCheckTests: XCTestCase {
     func testSuccess() {
-        let commitMessage = CommitMessage(subject: "Test title more than one word", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "Test title more than one word", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectWordCheck(commitMessage)
         XCTAssertFalse(testSubject.fail)
         XCTAssertFalse(SubjectWordCheck.fail(commitMessage))
     }
 
     func testFailure() {
-        let commitMessage = CommitMessage(subject: "Failure", bodyLinesOfText: [], sha: "Test SHA")
+        let commitMessage = GitCommitMessage(subject: "Failure", bodyLinesOfText: [], sha: "Test SHA")
         let testSubject = SubjectWordCheck(commitMessage)
         XCTAssertTrue(testSubject.fail)
         XCTAssertTrue(SubjectWordCheck.fail(commitMessage))
diff --git a/Tests/DangerSwiftCommitLintTests/ConfigurationTests.swift b/Tests/DangerSwiftCommitLintTests/ConfigurationTests.swift
@@ -55,7 +55,7 @@ private struct MockChecker: CommitChecker {
 
     static var checkerMessage = "Test message"
 
-    init(_: CommitMessage) {
+    init(_: GitCommitMessage) {
         // Intentionally left empty
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ struct BodyEmptyLineCheck: CommitChecker, Hashable {`
`5`	`5`
`6`	`6`	`private let bodyLinesOfText: [String]`
`7`	`7`
`8`		`- init(_ commitMessage: CommitMessage) {`
	`8`	`+ init(_ commitMessage: GitCommitMessage) {`
`9`	`9`	`bodyLinesOfText = commitMessage.bodyLinesOfText`
`10`	`10`	`}`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,13 @@ public protocol CommitChecker {`
`5`	`5`
`6`	`6`	`var fail: Bool { get }`
`7`	`7`
`8`		`- init(_ commitMessage: CommitMessage)`
	`8`	`+ init(_ commitMessage: GitCommitMessage)`
`9`	`9`
`10`		`- static func fail(_ commitMessage: CommitMessage) -> Bool`
	`10`	`+ static func fail(_ commitMessage: GitCommitMessage) -> Bool`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`public extension CommitChecker {`
`14`		`- static func fail(_ commitMessage: CommitMessage) -> Bool {`
	`14`	`+ static func fail(_ commitMessage: GitCommitMessage) -> Bool {`
`15`	`15`	`Self(commitMessage).fail`
`16`	`16`	`}`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ struct SubjectCapCheck: CommitChecker, Hashable {`
`5`	`5`
`6`	`6`	`private let firstCharacter: Character?`
`7`	`7`
`8`		`- init(_ commitMessage: CommitMessage) {`
	`8`	`+ init(_ commitMessage: GitCommitMessage) {`
`9`	`9`	`firstCharacter = commitMessage.subject.first`
`10`	`10`	`}`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ struct SubjectLengthCheck: CommitChecker, Hashable {`
`10`	`10`
`11`	`11`	`private let subject: String`
`12`	`12`
`13`		`- init(_ commitMessage: CommitMessage) {`
	`13`	`+ init(_ commitMessage: GitCommitMessage) {`
`14`	`14`	`subject = commitMessage.subject`
`15`	`15`	`}`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ struct SubjectPeriodCheck: CommitChecker, Hashable {`
`5`	`5`
`6`	`6`	`private let subject: String`
`7`	`7`
`8`		`- init(_ commitMessage: CommitMessage) {`
	`8`	`+ init(_ commitMessage: GitCommitMessage) {`
`9`	`9`	`subject = commitMessage.subject`
`10`	`10`	`}`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ struct SubjectWordCheck: CommitChecker, Hashable {`
`5`	`5`
`6`	`6`	`private let subject: String`
`7`	`7`
`8`		`- init(_ commitMessage: CommitMessage) {`
	`8`	`+ init(_ commitMessage: GitCommitMessage) {`
`9`	`9`	`subject = commitMessage.subject`
`10`	`10`	`}`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,8 @@ public final class DangerSwiftCommitLint {`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`extension DangerSwiftCommitLint {`
`32`		`- var commitMessages: [CommitMessage] {`
`33`		`- let messages = danger.git.commits.map { CommitMessage($0) }`
	`32`	`+ var commitMessages: [GitCommitMessage] {`
	`33`	`+ let messages = danger.git.commits.map { GitCommitMessage($0) }`
`34`	`34`	`guard configuration.limit > 0 else {`
`35`	`35`	`return messages`
`36`	`36`	`}`
`@@ -58,7 +58,7 @@ extension DangerSwiftCommitLint {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`extension Array where Element == CommitChecker.Type {`
`61`		`- func checkCommitMessages(_ commitMessages: [CommitMessage], checkerResultHanler: (String, [String]) -> Void) {`
	`61`	`+ func checkCommitMessages(_ commitMessages: [GitCommitMessage], checkerResultHanler: (String, [String]) -> Void) {`
`62`	`62`	`forEach { checker in`
`63`	`63`	`let shas = commitMessages.compactMap { checker.fail($0) ? $0.sha : nil }`
`64`	`64`	`if shas.isEmpty == false {`