Merge pull request #6555 from woocommerce/issue/6508-order-creation-yosemite-tests

Order Creation: Add test coverage for order-related gaps in the Yosemite layer

Author: rachelmcr

WooCommerce/Classes/ViewRelated/Orders/Order Creation/Synchronizer/ShippingInputTransformer.swift

@@ -11,7 +11,7 @@ struct ShippingInputTransformer {
         // If input is `nil`, then we remove any existing shipping line.
         // We remove a shipping like by setting its `methodID` to nil.
         guard let input = input else {
-            let linesToRemove = order.shippingLines.map { $0.copy(methodID: .some(nil), total: "0") }
+            let linesToRemove = order.shippingLines.map { OrderFactory.deletedShippingLine($0) }
             return order.copy(shippingTotal: "0", shippingLines: linesToRemove)
         }
 

Yosemite/Yosemite/Stores/Order/OrderFactory.swift

@@ -74,7 +74,7 @@ public enum OrderFactory {
     /// Creates a shipping line suitable to delete a shipping line already saved remotely in an order.
     ///
     public static func deletedShippingLine(_ shippingLine: ShippingLine) -> ShippingLine {
-        shippingLine.copy(methodID: .some(nil))
+        shippingLine.copy(methodID: .some(nil), total: "0")
     }
 
     /// References a new empty order with constants `Date` values.

Yosemite/YosemiteTests/Stores/OrderNoteStoreTests.swift

@@ -232,6 +232,102 @@ class OrderNoteStoreTests: XCTestCase {
         orderNoteStore.onAction(action)
         wait(for: [expectation], timeout: Constants.expectationTimeout)
     }
+
+    /// Verifies that `OrderNoteAction.addOrderNote` returns the expected OrderNote.
+    ///
+    func test_add_order_note_returns_expected_note() {
+        // Given
+        let orderNoteStore = OrderNoteStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
+        network.simulateResponse(requestUrlSuffix: "orders/\(sampleOrderID)/notes", filename: "new-order-note")
+
+        // When
+        let (orderNote, error): (Networking.OrderNote?, Error?) = waitFor { promise in
+            let action = OrderNoteAction.addOrderNote(siteID: self.sampleSiteID,
+                                                      orderID: self.sampleOrderID,
+                                                      isCustomerNote: true,
+                                                      note: "This order would be so much better with ketchup.") { (orderNote, error) in
+                promise((orderNote, error))
+            }
+            orderNoteStore.onAction(action)
+        }
+
+        // Then
+        XCTAssertNotNil(orderNote)
+        XCTAssertEqual(orderNote, self.sampleNewNote())
+        XCTAssertNil(error)
+    }
+
+    /// Verifies that `OrderNoteAction.addOrderNote` effectively persists the new order note.
+    ///
+    func test_add_order_note_effectively_persists_new_order_note() {
+        // Given
+        let orderStore = OrderStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
+        let orderNoteStore = OrderNoteStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
+        orderStore.upsertStoredOrder(readOnlyOrder: sampleOrder(), in: viewStorage)
+        network.simulateResponse(requestUrlSuffix: "orders/\(sampleOrderID)/notes", filename: "new-order-note")
+        XCTAssertEqual(viewStorage.countObjects(ofType: Storage.OrderNote.self), 0)
+
+        // When
+        let (orderNote, error): (Networking.OrderNote?, Error?) = waitFor { promise in
+            let action = OrderNoteAction.addOrderNote(siteID: self.sampleSiteID,
+                                                      orderID: self.sampleOrderID,
+                                                      isCustomerNote: true,
+                                                      note: "") { (orderNote, error) in
+                promise((orderNote, error))
+            }
+            orderNoteStore.onAction(action)
+        }
+
+        // Then
+        XCTAssertNotNil(orderNote)
+        XCTAssertEqual(self.viewStorage.countObjects(ofType: Storage.OrderNote.self), 1)
+        XCTAssertNil(error)
+    }
+
+    /// Verifies that `OrderNoteAction.addOrderNote` returns an error whenever there is an error response from the backend.
+    ///
+    func test_add_order_note_returns_error_upon_response_error() {
+        // Given
+        let orderNoteStore = OrderNoteStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
+        network.simulateResponse(requestUrlSuffix: "orders/\(sampleOrderID)/notes", filename: "generic_error")
+
+        // When
+        let (orderNote, error): (Networking.OrderNote?, Error?) = waitFor { promise in
+            let action = OrderNoteAction.addOrderNote(siteID: self.sampleSiteID,
+                                                      orderID: self.sampleOrderID,
+                                                      isCustomerNote: true,
+                                                      note: "") { (orderNote, error) in
+                promise((orderNote, error))
+            }
+            orderNoteStore.onAction(action)
+        }
+
+        // Then
+        XCTAssertNotNil(error)
+        XCTAssertNil(orderNote)
+    }
+
+    /// Verifies that `OrderNoteAction.addOrderNote` returns an error whenever there is no backend response.
+    ///
+    func test_add_order_note_returns_error_upon_empty_response() {
+        // Given
+        let orderNoteStore = OrderNoteStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
+
+        // When
+        let (orderNote, error): (Networking.OrderNote?, Error?) = waitFor { promise in
+            let action = OrderNoteAction.addOrderNote(siteID: self.sampleSiteID,
+                                                      orderID: self.sampleOrderID,
+                                                      isCustomerNote: true,
+                                                      note: "") { (orderNote, error) in
+                promise((orderNote, error))
+            }
+            orderNoteStore.onAction(action)
+        }
+
+        // Then
+        XCTAssertNotNil(error)
+        XCTAssertNil(orderNote)
+    }
 }
 
 // MARK: - Private Methods
@@ -269,6 +365,14 @@ private extension OrderNoteStoreTests {
                          author: sampleSystemAuthor)
     }
 
+    func sampleNewNote() -> Networking.OrderNote {
+        return OrderNote(noteID: 2235,
+                         dateCreated: date(with: "2018-06-22T15:36:20"),
+                         note: "This order would be so much better with ketchup.",
+                         isCustomerNote: true,
+                         author: sampleAdminAuthor)
+    }
+
     func sampleOrder() -> Networking.Order {
         return Order.fake().copy(siteID: sampleSiteID,
                                  orderID: sampleOrderID,