Merge pull request #430 from checkout/hotfix/PIMOB-2058-card-validator-improvement

Improve CardValidator test cases

Author: okhan-okbay-cko

Checkout/Checkout/Source/Extension/Foundation+Extensions.swift

@@ -7,6 +7,11 @@
 
 import Foundation
 
-extension Calendar: CalendarProtocol { }
+extension Calendar: CalendarProtocol {
+    func current() -> Date {
+        Date()
+    }
+}
+
 extension JSONEncoder: Encoding { }
 extension JSONDecoder: Decoding { }

Checkout/Checkout/Source/Protocols/CalendarProtocol.swift

@@ -7,7 +7,7 @@
 
 import Foundation
 
-protocol CalendarProtocol {
+protocol CalendarProtocol: DateProviding {
   func date(from components: DateComponents) -> Date?
   func date(byAdding component: Calendar.Component, value: Int, to date: Date, wrappingComponents: Bool) -> Date?
   func component(_ component: Calendar.Component, from date: Date) -> Int

Checkout/Checkout/Source/Validation/Validators/CardValidator.swift

@@ -224,7 +224,7 @@ public class CardValidator: CardValidating {
       return .failure(.invalidMonth)
     }
 
-    let currentDate = Date()
+    let currentDate = calendar.current()
     // using UTC-12 as this is the latest timezone where a card could be valid
     let cardExpiryComponents = DateComponents(
       timeZone: .utcMinus12,

CheckoutTests/Stubs/StubCalendar.swift

@@ -9,12 +9,23 @@ import Foundation
 @testable import Checkout
 
 final class StubCalendar: CalendarProtocol {
+  var currentDateToReturn: Date?
+
+  func current() -> Date {
+    currentDateToReturn ?? Date()
+  }
+
+  var forceToReturnNilComponents: Bool = false
   var dateFromComponentsToReturn: Date?
   private(set) var dateFromComponentsCalledWith: DateComponents?
 
   func date(from components: DateComponents) -> Date? {
     dateFromComponentsCalledWith = components
-    return dateFromComponentsToReturn
+
+    if forceToReturnNilComponents {
+    return nil
+    }
+    return dateFromComponentsToReturn ?? Calendar(identifier: .gregorian).date(from: components)
   }
 
   var dateByAddingOverride = true

CheckoutTests/Validation/CardValidatorTests.swift

@@ -164,33 +164,37 @@ extension CardValidatorTests {
       expiryYear: "2021",
       expectedResult: .success(ExpiryDate(month: 11, year: 2021)))
 
-    let dateComponents2040 = stubCalendar.dateFromComponentsCalledWith
-    XCTAssertEqual(dateComponents2040?.month, 11)
-    XCTAssertEqual(dateComponents2040?.year, 2021)
+    let components = stubCalendar.dateFromComponentsCalledWith
+    XCTAssertEqual(components?.month, 11)
+    XCTAssertEqual(components?.year, 2021)
+  }
 
-    test_validate(
-      expiryMonth: "11",
-      expiryYear: "2021",
-      expectedResult: .success(ExpiryDate(month: 11, year: 2021)))
+  func test_validate_expiryMonthYearString_providedMontInThePast_SameYear_returnsCorrectError() {
+    let formatter = DateFormatter()
+    formatter.dateFormat = "yyyy/MM/dd HH:mm"
 
-    let dateComponents40 = stubCalendar.dateFromComponentsCalledWith
-    XCTAssertEqual(dateComponents40?.month, 11)
-    XCTAssertEqual(dateComponents40?.year, 2021)
+    stubCalendar.currentDateToReturn = formatter.date(from: "2023/06/20 00:00")
+
+    test_validate(
+        expiryMonth: "05",
+        expiryYear: "2023",
+        expectedResult: .failure(.inThePast))
   }
 
   func test_validate_expiryMonthYearString_providedDateInThePast_returnsCorrectError() {
     let formatter = DateFormatter()
     formatter.dateFormat = "yyyy/MM/dd HH:mm"
 
-    stubCalendar.dateFromComponentsToReturn = formatter.date(from: "2020/10/01 00:00")
+    stubCalendar.currentDateToReturn = formatter.date(from: "2023/05/25 00:00")
 
     test_validate(
       expiryMonth: "11",
-      expiryYear: "2040",
+      expiryYear: "2022",
       expectedResult: .failure(.inThePast))
   }
 
   func test_validate_expiryMonthYearString_calendarDateReturnsNil_returnsCorrectError() {
+    stubCalendar.forceToReturnNilComponents = true
     stubCalendar.dateFromComponentsToReturn = nil
     test_validate(
       expiryMonth: "11",
@@ -247,7 +251,7 @@ extension CardValidatorTests {
     let formatter = DateFormatter()
     formatter.dateFormat = "yyyy/MM/dd HH:mm"
 
-    stubCalendar.dateFromComponentsToReturn = formatter.date(from: "2099/10/01 00:00")
+    stubCalendar.currentDateToReturn = formatter.date(from: "2039/10/01 00:00")
 
     test_validate(
       expiryMonth: 11,
@@ -273,7 +277,9 @@ extension CardValidatorTests {
   private func test_validate(
     expiryMonth: String,
     expiryYear: String,
-    expectedResult: Result<ExpiryDate, ValidationError.ExpiryDate>
+    expectedResult: Result<ExpiryDate, ValidationError.ExpiryDate>,
+    file: StaticString = #file,
+    line: UInt = #line
   ) {
     let result = subject.validate(
       expiryMonth: expiryMonth,
@@ -284,18 +290,18 @@ extension CardValidatorTests {
 
       switch expectedResult {
       case .success(let expectedExpiryDate):
-        XCTAssertEqual(expiryDate, expectedExpiryDate)
+        XCTAssertEqual(expiryDate, expectedExpiryDate, file: file, line: line)
       case .failure(let error):
-        XCTFail(error.localizedDescription)
+        XCTFail(error.localizedDescription, file: file, line: line)
       }
 
     case .failure(let error):
 
       switch expectedResult {
       case .success(let expiryDate):
-        XCTFail("Unexpected successful expiry date validation: \(expiryDate).")
+        XCTFail("Unexpected successful expiry date validation: \(expiryDate).", file: file, line: line)
       case .failure(let expectedError):
-        XCTAssertEqual(expectedError, error)
+        XCTAssertEqual(expectedError, error, file: file, line: line)
       }
     }
   }