Merge branch 'develop' into issue/2003-remove-showLoginMethods

mindgraffiti · mindgraffiti · commit e4be046ebc17 · 2020-05-08T12:43:07.000-05:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -4,6 +4,7 @@ orbs:
   # Using 1.0 of the Orbs means it will use the latest 1.0.x version from https://github.com/wordpress-mobile/circleci-orbs
   ios: wordpress-mobile/ios@1.0
   git: wordpress-mobile/git@1.0
+  slack: circleci/slack@3.4.2
 
 commands:
   fix-circleci:
@@ -32,22 +33,80 @@ jobs:
           root: ./
           paths:
             - DerivedData/Build/Products
+            - vendor/bundle
   
   Unit Tests:
     executor:
       name: ios/default
       xcode-version: "11.2.1"
     steps:
+      - git/shallow-checkout
       - ios/boot-simulator:
           xcode-version: "11.2.1"
           device: iPhone 11
       - attach_workspace:
           at: ./
+      - run:
+          name: Prepare Bundle
+          command: bundle --path vendor/bundle
       - ios/wait-for-simulator
-      - ios/xcodebuild:
-          command: test-without-building
-          arguments: -xctestrun DerivedData/Build/Products/WooCommerce_UnitTests_iphonesimulator13.2-x86_64.xctestrun -destination "platform=iOS Simulator,id=$SIMULATOR_UDID"
-      - ios/save-xcodebuild-artifacts
+      - run:
+          name: Run Unit Tests
+          command: >
+            bundle exec fastlane test_without_building
+            xctestrun:DerivedData/Build/Products/WooCommerce_UnitTests_iphonesimulator13.2-x86_64.xctestrun
+            destination:"platform=iOS Simulator,id=$SIMULATOR_UDID" try_count:3
+      - ios/save-xcodebuild-artifacts:
+          result-bundle-path: build/results
+  UI Tests:
+    parameters:
+      device:
+        type: string
+      post-to-slack:
+        description: Post to Slack when tests fail. SLACK_WEBHOOK ENV variable must be set.
+        type: boolean
+        default: false
+    executor:
+      name: ios/default
+      xcode-version: "11.2.1"
+    steps:
+      - git/shallow-checkout
+      - ios/boot-simulator:
+          xcode-version: "11.2.1"
+          device: << parameters.device >>
+      - attach_workspace:
+          at: ./
+      - run:
+          name: Prepare Bundle
+          command: bundle --path vendor/bundle
+      - run:
+          name: Run mocks
+          command: ./WooCommerce/WooCommerceUITests/Mocks/scripts/start.sh 8282
+          background: true
+      - ios/wait-for-simulator
+      - run:
+          name: Run UI Tests
+          command: >
+            bundle exec fastlane test_without_building
+            xctestrun:DerivedData/Build/Products/WooCommerce_UITests_iphonesimulator13.2-x86_64.xctestrun
+            destination:"platform=iOS Simulator,id=$SIMULATOR_UDID" try_count:3
+      - ios/save-xcodebuild-artifacts:
+          result-bundle-path: build/results
+      - when:
+          condition: << parameters.post-to-slack >>
+          steps:
+            - run:
+                name: Prepare Slack message
+                when: always
+                command: |
+                  # Get the name of the device that is running. Using "<< parameters.device >>" can cause slack formatting errors.
+                  DEVICE_NAME=$(xcrun simctl list -j | jq -r --arg UDID $SIMULATOR_UDID '.devices[] | .[] | select(.udid == "\($UDID)") | .name')
+                  echo "export SLACK_FAILURE_MESSAGE=':red_circle: WooCommerce iOS UI tests failed on ${DEVICE_NAME} in \`${CIRCLE_BRANCH}\` branch by ${CIRCLE_USERNAME}.\n\nPlease reach out in #platform9 if you think this failure is not caused by your changes, so we can investigate.'" >> $BASH_ENV
+            - slack/status:
+                fail_only: true
+                include_job_number_field: false
+                include_project_field: false
+                failure_message: '${SLACK_FAILURE_MESSAGE}'
   Installable Build:
     executor:
       name: ios/default
@@ -105,6 +164,47 @@ workflows:
       - Build Tests
       - Unit Tests:
           requires: [ "Build Tests" ]
+      # Always run UI tests on develop and release branches
+      - UI Tests:
+          name: UI Tests (iPhone 11)
+          device: iPhone 11
+          post-to-slack: true
+          requires: [ "Build Tests" ]
+          filters:
+            branches:
+              only:
+                - develop
+                - /^release.*/
+      - UI Tests:
+          name: UI Tests (iPad Air 3rd generation)
+          device: iPad Air \\(3rd generation\\)
+          post-to-slack: true
+          requires: [ "Build Tests" ]
+          filters:
+            branches:
+              only:
+                - develop
+                - /^release.*/
+  #Optionally run UI tests on PRs
+  Optional Tests:
+    jobs:
+      - Hold:
+          type: approval
+          filters:
+            branches:
+              ignore:
+                - develop
+                - /^release.*/
+      - Build Tests:
+          requires: [ "Hold" ]
+      - UI Tests:
+          name: Optional UI Tests (iPhone 11)
+          device: iPhone 11
+          requires: [ "Build Tests" ]
+      - UI Tests:
+          name: Optional UI Tests (iPad Air 3rd generation)
+          device: iPad Air \\(3rd generation\\)
+          requires: [ "Build Tests" ]
   Installable Build:
     jobs:
       - Hold:
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -73,6 +73,7 @@ GEM
     cocoapods-try (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
+    colorize (0.8.1)
     commander-fastlane (4.4.6)
       highline (~> 1.7.2)
     concurrent-ruby (1.1.5)
@@ -135,6 +136,12 @@ GEM
       xcpretty-travis-formatter (>= 0.0.3)
     fastlane-plugin-appcenter (1.6.0)
     fastlane-plugin-sentry (1.6.0)
+    fastlane-plugin-test_center (3.10.2)
+      colorize
+      json
+      plist
+      xcodeproj
+      xctest_list (>= 1.1.8)
     ffi (1.12.2)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
@@ -262,6 +269,7 @@ GEM
       rouge (~> 2.0.7)
     xcpretty-travis-formatter (1.0.0)
       xcpretty (~> 0.2, >= 0.0.7)
+    xctest_list (1.1.8)
 
 PLATFORMS
   ruby
@@ -272,6 +280,7 @@ DEPENDENCIES
   fastlane (~> 2)!
   fastlane-plugin-appcenter (= 1.6.0)
   fastlane-plugin-sentry
+  fastlane-plugin-test_center
   fastlane-plugin-wpmreleasetoolkit!
   rake!
   rmagick (~> 3.2.0)
diff --git a/WooCommerce/Classes/ViewRelated/Keyboard/KeyboardFrameObserver.swift b/WooCommerce/Classes/ViewRelated/Keyboard/KeyboardFrameObserver.swift
@@ -1,7 +1,7 @@
 import UIKit
 
 /// Observes the keyboard frame and notifies its subscriber.
-struct KeyboardFrameObserver {
+final class KeyboardFrameObserver {
     private let onKeyboardFrameUpdate: OnKeyboardFrameUpdate
 
     /// Provides the last known keyboard state.
@@ -36,19 +36,16 @@ struct KeyboardFrameObserver {
     ///
     /// - Parameter sendInitialEvent: If true, the subscriber will be immediately notified
     ///                               using the last known keyboard frame.
-    mutating func startObservingKeyboardFrame(sendInitialEvent: Bool = false) {
-        var observer = self
-        notificationCenter.addObserver(forName: UIResponder.keyboardWillShowNotification,
-                                       object: nil,
-                                       queue: nil) { notification in
-                                        observer.keyboardWillShow(notification)
-        }
+    func startObservingKeyboardFrame(sendInitialEvent: Bool = false) {
+        notificationCenter.addObserver(self,
+                                       selector: #selector(keyboardWillShow(_:)),
+                                       name: UIResponder.keyboardWillShowNotification,
+                                       object: nil)
 
-        notificationCenter.addObserver(forName: UIResponder.keyboardWillHideNotification,
-                                       object: nil,
-                                       queue: nil) { notification in
-                                        observer.keyboardWillHide(notification)
-        }
+        notificationCenter.addObserver(self,
+                                       selector: #selector(keyboardWillHide(_:)),
+                                       name: UIResponder.keyboardWillHideNotification,
+                                       object: nil)
 
         if sendInitialEvent {
             keyboardFrame = keyboardStateProvider.state.frameEnd
@@ -57,14 +54,14 @@ struct KeyboardFrameObserver {
 }
 
 private extension KeyboardFrameObserver {
-    mutating func keyboardWillShow(_ notification: Foundation.Notification) {
+    @objc func keyboardWillShow(_ notification: Foundation.Notification) {
         guard let keyboardFrame = keyboardRect(from: notification) else {
             return
         }
         self.keyboardFrame = keyboardFrame
     }
 
-    mutating func keyboardWillHide(_ notification: Foundation.Notification) {
+    @objc func keyboardWillHide(_ notification: Foundation.Notification) {
         self.keyboardFrame = .zero
     }
 }
diff --git a/WooCommerce/Resources/AppStoreStrings.pot b/WooCommerce/Resources/AppStoreStrings.pot
@@ -47,9 +47,10 @@ msgctxt "app_store_promo_text"
 msgid "Run your store wherever you are. The WooCommerce app makes it easy to manage orders and inventory, track sales, and monitor store activity like new orders and reviews."
 msgstr ""
 
-msgctxt "v4.1-whats-new"
+msgctxt "v4.2-whats-new"
 msgid ""
-"* We fixed an impolite bug that would sometimes crash the app while you were downloading Orders. Download away, we say!\n"
+"* Easier product description editing: Tap anywhere on a product cell to start editing. Need the keyboard? It pops up automatically. And while we were at it, we fixed a couple of bugs.\n"
+"* Up-to-the-minute order reporting: The Order list refreshes automatically every time you open the app or get a new order, and the Processing Orders list now shows upcoming future orders.\n"
 msgstr ""
 
 #. translators: This is a promo message that will be attached on top of a screenshot in the App Store.
diff --git a/WooCommerce/Resources/release_notes.txt b/WooCommerce/Resources/release_notes.txt
@@ -1 +1,2 @@
-* We fixed an impolite bug that would sometimes crash the app while you were downloading Orders. Download away, we say!
+* Easier product description editing: Tap anywhere on a product cell to start editing. Need the keyboard? It pops up automatically. And while we were at it, we fixed a couple of bugs.
+* Up-to-the-minute order reporting: The Order list refreshes automatically every time you open the app or get a new order, and the Processing Orders list now shows upcoming future orders.
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Keyboard/KeyboardFrameObserverTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Keyboard/KeyboardFrameObserverTests.swift
@@ -16,7 +16,7 @@ final class KeyboardFrameObserverTests: XCTestCase {
 
         var actualFrames = [CGRect]()
 
-        var keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
+        let keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
             actualFrames.append(keyboardFrame)
             if actualFrames.count >= expectedFrames.count {
                 XCTAssertEqual(actualFrames, expectedFrames)
@@ -47,7 +47,7 @@ final class KeyboardFrameObserverTests: XCTestCase {
 
         var actualFrames = [CGRect]()
 
-        var keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
+        let keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
             actualFrames.append(keyboardFrame)
             if actualFrames.count >= expectedFrames.count {
                 XCTAssertEqual(actualFrames, expectedFrames)
@@ -70,7 +70,7 @@ final class KeyboardFrameObserverTests: XCTestCase {
 
         let expectationForKeyboardFrame = expectation(description: "Wait for keyboard frame updates")
 
-        var keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
+        let keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
             expectationForKeyboardFrame.fulfill()
         }
         keyboardFrameObserver.startObservingKeyboardFrame()
@@ -88,7 +88,7 @@ final class KeyboardFrameObserverTests: XCTestCase {
 
         let expectationForKeyboardFrame = expectation(description: "Wait for keyboard frame updates")
 
-        var keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
+        let keyboardFrameObserver = KeyboardFrameObserver(notificationCenter: notificationCenter) { (keyboardFrame: CGRect) in
             expectationForKeyboardFrame.fulfill()
         }
         keyboardFrameObserver.startObservingKeyboardFrame()
@@ -101,6 +101,31 @@ final class KeyboardFrameObserverTests: XCTestCase {
         waitForExpectations(timeout: 0.1)
     }
 
+    func testItWillNotEmitNewEventsWhenItIsDeallocated() {
+        // Arrange
+        let notificationCenter = NotificationCenter()
+
+        var eventsLogged = 0
+        var keyboardFrameObserver: KeyboardFrameObserver? = KeyboardFrameObserver(notificationCenter: notificationCenter) { _ in
+            eventsLogged += 1
+        }
+
+        keyboardFrameObserver?.startObservingKeyboardFrame()
+
+        // These should be logged
+        notificationCenter.postKeyboardWillShowNotification(keyboardFrame: CGRect(x: 1, y: 1, width: 1, height: 1))
+        notificationCenter.postKeyboardWillShowNotification(keyboardFrame: CGRect(x: 2, y: 2, width: 2, height: 2))
+
+        // Act
+        keyboardFrameObserver = nil
+
+        // This should not be logged anymore
+        notificationCenter.postKeyboardWillShowNotification(keyboardFrame: CGRect(x: 3, y: 3, width: 3, height: 3))
+
+        // Assert
+        XCTAssertEqual(eventsLogged, 2)
+    }
+
     func testItCanSendInitialEvents() {
         // Arrange
         let expectedKeyboardState = KeyboardState(
@@ -110,7 +135,7 @@ final class KeyboardFrameObserverTests: XCTestCase {
         let keyboardStateProvider = MockKeyboardStateProvider(state: expectedKeyboardState)
 
         var actualKeyboardFrame: CGRect = .zero
-        var keyboardFrameObserver = KeyboardFrameObserver(keyboardStateProvider: keyboardStateProvider) { frame in
+        let keyboardFrameObserver = KeyboardFrameObserver(keyboardStateProvider: keyboardStateProvider) { frame in
             actualKeyboardFrame = frame
         }
 
diff --git a/fastlane/Fastfile b/fastlane/Fastfile
@@ -13,7 +13,10 @@ def get_required_env(key)
   ENV[key]
 end
 
-before_all do
+before_all do |lane|
+  # Skip these checks/steps for test lane (not needed for testing)
+  next if lane == :test_without_building
+
   # Check that the env files exist
   unless is_ci || File.file?(USER_ENV_FILE_PATH)
     UI.user_error!("~/.wcios-env.default not found: Please copy env/user.env-example to #{USER_ENV_FILE_PATH} and fill in the values")
@@ -646,4 +649,33 @@ end
 
   def simulator_version()
     return '13.3'
+  end
+
+########################################################################
+# Test Lanes
+########################################################################
+  #####################################################################################
+  # test_without_building
+  # -----------------------------------------------------------------------------------
+  # This lane runs tests without building the app.
+  # It requires a prebuilt xctestrun file and simulator destination where the tests will be run.
+  # -----------------------------------------------------------------------------------
+  # Usage:
+  # bundle exec fastlane test_without_building [xctestrun:<Path to xctestrun file>] [destination:<Simulator>] [try_count:<Number of times to try tests>]
+  #
+  # Example:
+  # bundle exec fastlane test_without_building xctestrun:WooCommerce_UITests_iphonesimulator13.2-x86_64.xctestrun destination:"platform=iOS Simulator,id=$SIMULATOR_UDID" try_count:3
+  #####################################################################################
+  desc "Run tests without building"
+  lane :test_without_building do | options |
+    multi_scan(
+      workspace: "WooCommerce.xcworkspace",
+      scheme: "WooCommerce",
+      test_without_building: true,
+      xctestrun: "#{options[:xctestrun]}",
+      destination: options[:destination],
+      try_count: options[:try_count],
+      output_directory: "build/results",
+      result_bundle: true
+    )
   end
diff --git a/fastlane/Pluginfile b/fastlane/Pluginfile
@@ -9,3 +9,4 @@ end
 gem 'fastlane-plugin-wpmreleasetoolkit', git: 'https://github.com/wordpress-mobile/release-toolkit', tag: '0.9.2'
 gem 'fastlane-plugin-sentry'
 gem 'fastlane-plugin-appcenter', '1.6.0'
+gem 'fastlane-plugin-test_center'

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-* We fixed an impolite bug that would sometimes crash the app while you were downloading Orders. Download away, we say!`
	`1`	`+* Easier product description editing: Tap anywhere on a product cell to start editing. Need the keyboard? It pops up automatically. And while we were at it, we fixed a couple of bugs.`
	`2`	`+* Up-to-the-minute order reporting: The Order list refreshes automatically every time you open the app or get a new order, and the Processing Orders list now shows upcoming future orders.`