Merge pull request #3876 from woocommerce/fix/select-correct-device-on-circleci

Update CircleCI script to fix wrong iOS sim usage

Author: ealeksandrov

.circleci/config.yml

@@ -6,6 +6,17 @@ orbs:
   git: wordpress-mobile/[email protected]
   slack: circleci/[email protected]
 
+xcode_version: &xcode_version
+  xcode-version: "12.0.0"
+
+iphone_test_device: &iphone_test_device
+  device: iPhone 11
+  ios-version: "14.0"
+
+ipad_test_device: &ipad_test_device
+  device: iPad Air (4th generation)
+  ios-version: "14.0"
+
 commands:
   fix-image:
     steps:
@@ -30,9 +41,16 @@ commands:
 
 jobs:
   Build Tests:
+    parameters:
+      device:
+        type: string
+        description: The device (e.g. "iPhone 11") to use when running unit tests.
+      ios-version:
+        type: string
+        description: The iOS version (e.g. "14.0") of the device used to run tests.
     executor:
       name: ios/default
-      xcode-version: "12.0.0"
+      <<: *xcode_version
     steps:
       - git/shallow-checkout
       - fix-image
@@ -44,51 +62,55 @@ jobs:
           command: bundle exec fastlane run configure_apply
       - run:
           name: Build for Testing
-          command: bundle exec fastlane build_for_testing
+          command: bundle exec fastlane build_for_testing device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
       - persist_to_workspace:
           root: ./
           paths:
             - DerivedData/Build/Products
             - vendor/bundle
 
   Unit Tests:
+    parameters:
+      device:
+        type: string
+        description: The device (e.g. "iPhone 11") to use when running unit tests.
+      ios-version:
+        type: string
+        description: The iOS version (e.g. "14.0") of the device used to run tests.
     executor:
       name: ios/default
-      xcode-version: "12.0.0"
+      <<: *xcode_version
     steps:
       - git/shallow-checkout
       - fix-image
-      - ios/boot-simulator:
-          xcode-version: "12.0.0"
-          device: iPhone 11
       - attach_workspace:
           at: ./
       - run:
           name: Prepare Bundle
           command: bundle --path vendor/bundle
-      - ios/wait-for-simulator
       - run:
           name: Run Unit Tests
-          command: bundle exec fastlane test_without_building name:UnitTests try_count:3
+          command: bundle exec fastlane test_without_building name:UnitTests try_count:3 device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
       - ios/save-xcodebuild-artifacts:
           result-bundle-path: build/results
   UI Tests:
     parameters:
       device:
         type: string
+        description: The device (e.g. "iPhone 11") to use when running unit tests.
+      ios-version:
+        type: string
+        description: The iOS version (e.g. "14.0") of the device used to run tests.
       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: "12.0.0"
+      <<: *xcode_version
     steps:
       - git/shallow-checkout
       - fix-image
-      - ios/boot-simulator:
-          xcode-version: "12.0.0"
-          device: << parameters.device >>
       - attach_workspace:
           at: ./
       - run:
@@ -98,10 +120,9 @@ jobs:
           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 name:UITests
+          command: bundle exec fastlane test_without_building name:UITests device:'<< parameters.device >>' ios-version:'<< parameters.ios-version >>'
       - ios/save-xcodebuild-artifacts:
           result-bundle-path: build/results
       - when:
@@ -111,9 +132,8 @@ jobs:
                 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
+                  # Get the name of the device that is running.
+                  echo "export SLACK_FAILURE_MESSAGE=':red_circle: WooCommerce iOS UI tests failed on << parameters.device >> 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
@@ -122,7 +142,7 @@ jobs:
   Installable Build:
     executor:
       name: ios/default
-      xcode-version: "12.0.0"
+      <<: *xcode_version
     steps:
       - git/shallow-checkout
       - fix-image
@@ -144,9 +164,9 @@ jobs:
           path: Artifacts
           destination: Artifacts
   Release Build:
-    executor: 
+    executor:
       name: ios/default
-      xcode-version: "12.0.0"
+      <<: *xcode_version
     environment:
       HOMEBREW_NO_AUTO_UPDATE: 1
     steps:
@@ -183,13 +203,15 @@ jobs:
 workflows:
   woocommerce_ios:
     jobs:
-      - Build Tests
+      - Build Tests:
+          <<: *iphone_test_device
       - Unit Tests:
+          <<: *iphone_test_device
           requires: [ "Build Tests" ]
       # Always run UI tests on develop and release branches
       - UI Tests:
-          name: UI Tests (iPhone 11)
-          device: iPhone 11
+          name: UI Tests (iPhone)
+          <<: *iphone_test_device
           post-to-slack: true
           requires: [ "Build Tests" ]
           filters:
@@ -198,8 +220,8 @@ workflows:
                 - develop
                 - /^release.*/
       - UI Tests:
-          name: UI Tests (iPad Air 4th generation)
-          device: iPad Air \\(4th generation\\)
+          name: UI Tests (iPad)
+          <<: *ipad_test_device
           post-to-slack: true
           requires: [ "Build Tests" ]
           filters:
@@ -218,14 +240,15 @@ workflows:
                 - develop
                 - /^release.*/
       - Build Tests:
+          <<: *iphone_test_device
           requires: [ "Hold" ]
       - UI Tests:
-          name: Optional UI Tests (iPhone 11)
-          device: iPhone 11
+          name: Optional UI Tests (iPhone)
+          <<: *iphone_test_device
           requires: [ "Build Tests" ]
       - UI Tests:
-          name: Optional UI Tests (iPad Air 4th generation)
-          device: iPad Air \\(4th generation\\)
+          name: Optional UI Tests (iPad)
+          <<: *ipad_test_device
           requires: [ "Build Tests" ]
   Installable Build:
     jobs:

fastlane/Fastfile

@@ -387,6 +387,8 @@ ENV["APP_STORE_STRINGS_FILE_NAME"]="AppStoreStrings.pot"
       scheme: "WooCommerce",
       derived_data_path: "DerivedData",
       build_for_testing: true,
+      device: options[:device],
+      deployment_target_version: options[:ios_version],
     )
   end
 
@@ -754,6 +756,8 @@ end
     multi_scan(
       workspace: "WooCommerce.xcworkspace",
       scheme: "WooCommerce",
+      device: options[:device],
+      deployment_target_version: options[:ios_version],
       test_without_building: true,
       xctestrun: testPlanPath,
       try_count: options[:try_count],