Merge pull request #8068 from woocommerce/update/edit-order-ui-test

Order Editing:  Expand edit order UI test to include checking product and closing edit flow

Author: thehenrybyrd

WooCommerce/UITestsFoundation/Screens/Orders/SingleOrderScreen.swift

@@ -24,7 +24,7 @@ public final class SingleOrderScreen: ScreenObject {
 
     public init(app: XCUIApplication = XCUIApplication()) throws {
         try super.init(
-            expectedElementGetters: [ summaryCellGetter ],
+            expectedElementGetters: [ summaryCellGetter, editOrderButtonGetter ],
             app: app
         )
     }
@@ -58,7 +58,6 @@ public final class SingleOrderScreen: ScreenObject {
         return self
     }
 
-    @discardableResult
     public func tapCollectPaymentButton() throws -> PaymentMethodsScreen {
         let orderDetailTableView = app.tables["order-details-table-view"]
         while !collectPaymentButton.isFullyVisibleOnScreen() {
@@ -68,7 +67,6 @@ public final class SingleOrderScreen: ScreenObject {
         return try PaymentMethodsScreen()
     }
 
-    @discardableResult
     public func goBackToOrdersScreen() throws -> OrdersScreen {
         // Only needed for iPhone because iPad shows both Orders and Single Order screens on the same view
         if XCUIDevice.isPhone {
@@ -77,7 +75,6 @@ public final class SingleOrderScreen: ScreenObject {
         return try OrdersScreen()
     }
 
-    @discardableResult
     public func tapEditOrderButton() throws -> UnifiedOrderScreen {
         editOrderButton.tap()
         return try UnifiedOrderScreen(flow: .editing)

WooCommerce/UITestsFoundation/Screens/Orders/UnifiedOrderScreen.swift

@@ -102,47 +102,41 @@ public final class UnifiedOrderScreen: ScreenObject {
 
     /// Opens the Order Status screen (to set a new order status).
     /// - Returns: Order Status screen object.
-    @discardableResult
     private func openOrderStatusScreen() throws -> OrderStatusScreen {
         orderStatusEditButton.tap()
         return try OrderStatusScreen()
     }
 
     /// Opens the Add Product screen (to add a new product).
     /// - Returns: Add Product screen object.
-    @discardableResult
     private func openAddProductScreen() throws -> AddProductScreen {
         addProductButton.tap()
         return try AddProductScreen()
     }
 
     /// Opens the Customer Details screen.
     /// - Returns: Customer Details screen object.
-    @discardableResult
     public func openCustomerDetailsScreen() throws -> CustomerDetailsScreen {
         addCustomerDetailsButton.tap()
         return try CustomerDetailsScreen()
     }
 
     /// Opens the Add Shipping screen.
     /// - Returns: Add Shipping screen object.
-    @discardableResult
     public func openAddShippingScreen() throws -> AddShippingScreen {
         addShippingButton.tap()
         return try AddShippingScreen()
     }
 
     /// Opens the Add Fee screen.
     /// - Returns: Add Fee screen object.
-    @discardableResult
     public func openAddFeeScreen() throws -> AddFeeScreen {
         addFeeButton.tap()
         return try AddFeeScreen()
     }
 
     /// Opens the Customer Note screen.
     /// - Returns: Customer Note screen object.
-    @discardableResult
     public func openCustomerNoteScreen() throws -> CustomerNoteScreen {
         addNoteButton.tap()
         return try CustomerNoteScreen()
@@ -152,23 +146,20 @@ public final class UnifiedOrderScreen: ScreenObject {
 
     /// Creates a remote order with all of the entered order data.
     /// - Returns: Single Order Detail screen object.
-    @discardableResult
     public func createOrder() throws -> SingleOrderScreen {
         createButton.tap()
         return try SingleOrderScreen()
     }
 
     /// Changes the new order status to the second status in the Order Status list.
     /// - Returns: Unified Order screen object.
-    @discardableResult
     public func editOrderStatus() throws -> UnifiedOrderScreen {
       return try openOrderStatusScreen()
             .selectOrderStatus(atIndex: 1)
     }
 
     /// Select the first product from the addProductScreen
     /// - Returns: Unified Order screen object.
-    @discardableResult
     public func addProduct(byName name: String) throws -> UnifiedOrderScreen {
         return try openAddProductScreen()
             .selectProduct(byName: name)
@@ -214,7 +205,6 @@ public final class UnifiedOrderScreen: ScreenObject {
 
     /// Cancels Order Creation process
     /// - Returns: Orders Screen object.
-    @discardableResult
     public func cancelOrderCreation() throws -> OrdersScreen {
         // This cancel button exists only if the feature flag `.splitViewInOrdersTab` is on.
         // For taking app store screenshot, the beta feature is turned off so we should pop to get out of this screen.
@@ -236,4 +226,25 @@ public final class UnifiedOrderScreen: ScreenObject {
 
         return self
     }
+
+    /// Checks the screen for existence of all products, checking each name.
+    /// - Parameter productNames: Array of product names to check.
+    /// - Returns: Unified Order screen object.
+    @discardableResult
+    public func checkForExistingProducts(byName productNames: [String]) throws -> UnifiedOrderScreen {
+        for productName in productNames {
+            let productNamePredicate = NSPredicate(format: "label MATCHES %@", productName)
+            XCTAssertTrue(app.staticTexts.containing(productNamePredicate).element.exists)
+        }
+
+        return self
+    }
+
+    /// Finishes Order Editing process
+    /// - Returns: Single Order Screen object.
+    public func closeEditingFlow() throws -> SingleOrderScreen {
+        doneButton.tap()
+
+        return try SingleOrderScreen()
+    }
 }

WooCommerce/WooCommerceUITests/Tests/OrdersTests.swift

@@ -40,15 +40,19 @@ final class OrdersTests: XCTestCase {
             .createOrder()
             .verifySingleOrderScreenLoaded()
             .goBackToOrdersScreen()
+            .verifyOrdersScreenLoaded()
     }
 
-    func test_edit_existing_order() throws {
+    func test_load_existing_order() throws {
         let orders = try GetMocks.readOrdersData()
 
         try TabNavComponent().goToOrdersScreen()
             .selectOrder(byOrderNumber: orders[0].number)
             .tapEditOrderButton()
             .checkForExistingOrderTitle(byOrderNumber: orders[0].number)
+            .checkForExistingProducts(byName: orders[0].line_items.map { $0.name })
+            .closeEditingFlow()
+            .verifySingleOrderScreenLoaded()
     }
 
     func test_cancel_order_creation() throws {

docs/UI-TESTS.md

@@ -33,6 +33,13 @@ The following flows are covered/planned to be covered by UI tests. Tests that ar
      - [x] With shipping
      - [x] With a fee
      - [x] With a customer note
+   - [x] Edit an existing order:
+     - [x] Open edit flow
+     - [x] Check existing order number
+     - [x] Check existing product 
+     - [ ] Edit products
+     - [ ] Edit customer details
+     - [x] Order Edit flow can be dismissed
    - [x] Order Creation flow can be dismissed
 4. [Products](../WooCommerce/WooCommerceUITests/Tests/ProductsTests.swift)
     - [x] Products list and single product screens load