Make proxy steps available for mobile apps (#2256)

Co-authored-by: Vitaliya Piliuhina <vitaliya.piliuhina@epam.com> Co-authored-by: Ivan Kalinin <ivan_kalinin1@epam.com>
vividus-framework · Dec 24, 2021 · 0c7a68f · 0c7a68f
1 parent 8c4c5e7
commit 0c7a68f
Show file tree

Hide file tree

Showing 15 changed files with 433 additions and 325 deletions.
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -293,6 +293,44 @@ jobs:
         name: SauceLabs - System Tests - Allure report - iOS
         path: vividus-tests/output/reports/sl-ios-allure
 
+    - name: SauceLabs - iOS Proxy- Mobile App - Run system tests
+      if: matrix.platform == 'ubuntu-latest'
+      env:
+        SAUCELABS_USER: ${{ secrets.SAUCELABS_USER }}
+        SAUCELABS_KEY: ${{ secrets.SAUCELABS_KEY }}
+      shell: bash
+      run: |
+        if [[ -n $SAUCELABS_USER && -n $SAUCELABS_KEY ]]; then
+            ./gradlew :vividus-tests:debugStories -Pvividus.configuration.environments=system/saucelabs/mobile_app/ios \
+                                                  -Pvividus.configuration.suites= \
+                                                  -Pvividus.configuration.profiles=saucelabs/mobile_app,mobile_app/ios \
+                                                  -Pvividus.bdd.story-loader.batch-1.resource-location=story/system/mobile_app \
+                                                  -Pvividus.bdd.story-loader.batch-1.resource-include-patterns=ProxyMobileStepsTests.story \
+                                                  -Pvividus.selenium.grid.username=${SAUCELABS_USER} \
+                                                  -Pvividus.selenium.grid.password=${SAUCELABS_KEY} \
+                                                  -Pvividus.allure.history-directory=output/history/sl-ios-proxy-system-tests \
+                                                  -Pvividus.allure.report-directory=output/reports/sl-ios-proxy-allure \
+                                                  -Pvividus.allure.executor.name="Github Actions (Vividus)" \
+                                                  -Pvividus.allure.executor.type=github \
+                                                  -Pvividus.allure.executor.url=https://github.com/vividus-framework/vividus/actions \
+                                                  -Pvividus.allure.executor.build-order=${GITHUB_RUN_ID} \
+                                                  -Pvividus.allure.executor.build-name="SauceLabs iOS Proxy Tests ${GITHUB_RUN_ID}" \
+                                                  -Pvividus.allure.executor.build-url=https://github.com/vividus-framework/vividus/actions/runs/${GITHUB_RUN_ID} \
+                                                  -Pvividus.allure.executor.report-url=https://github.com/vividus-framework/vividus/actions/runs/${GITHUB_RUN_ID} \
+                                                  -Pvividus.allure.executor.report-name="SauceLabs iOS Proxy tests report" \
+                                                  -Pvividus.saucelabs.sauce-connect.command-line-arguments="--proxy-localhost --no-ssl-bump-domains example.com" \
+                                                  -Pvividus.bdd.variables.global.app-url=sauce-storage:vividus-test-app-ios.zip
+        else
+            echo No SAUCELABS_USER and/or SAUCELABS_KEY variables, System tests will be skipped
+        fi
+
+    - name: SauceLabs - iOS Proxy - Mobile App - Publish system tests report
+      if: matrix.platform == 'ubuntu-latest' && always()
+      uses: actions/upload-artifact@v2
+      with:
+        name: SauceLabs - System Tests With Proxy- Allure report - iOS
+        path: vividus-tests/output/reports/sl-ios-proxy-allure
+
     - name: SauceLabs - Android - Mobile App - Run system tests
       if: matrix.platform == 'ubuntu-latest'
       env:
@@ -328,6 +366,44 @@ jobs:
         name: SauceLabs - System Tests - Allure report - Android
         path: vividus-tests/output/reports/sl-android-allure
 
+    - name: SauceLabs - Android Proxy- Mobile App - Run system tests
+      if: matrix.platform == 'ubuntu-latest'
+      env:
+        SAUCELABS_USER: ${{ secrets.SAUCELABS_USER }}
+        SAUCELABS_KEY: ${{ secrets.SAUCELABS_KEY }}
+      shell: bash
+      run: |
+        if [[ -n $SAUCELABS_USER && -n $SAUCELABS_KEY ]]; then
+            ./gradlew :vividus-tests:debugStories -Pvividus.configuration.environments=system/saucelabs/mobile_app/android \
+                                                  -Pvividus.configuration.suites= \
+                                                  -Pvividus.configuration.profiles=saucelabs/mobile_app,mobile_app/android \
+                                                  -Pvividus.bdd.story-loader.batch-1.resource-location=story/system/mobile_app \
+                                                  -Pvividus.bdd.story-loader.batch-1.resource-include-patterns=ProxyMobileStepsTests.story \
+                                                  -Pvividus.selenium.grid.username=${SAUCELABS_USER} \
+                                                  -Pvividus.selenium.grid.password=${SAUCELABS_KEY} \
+                                                  -Pvividus.allure.history-directory=output/history/sl-android-proxy-system-tests \
+                                                  -Pvividus.allure.report-directory=output/reports/sl-android-proxy-allure \
+                                                  -Pvividus.allure.executor.name="Github Actions (Vividus)" \
+                                                  -Pvividus.allure.executor.type=github \
+                                                  -Pvividus.allure.executor.url=https://github.com/vividus-framework/vividus/actions \
+                                                  -Pvividus.allure.executor.build-order=${GITHUB_RUN_ID} \
+                                                  -Pvividus.allure.executor.build-name="SauceLabs Android Proxy Tests ${GITHUB_RUN_ID}" \
+                                                  -Pvividus.allure.executor.build-url=https://github.com/vividus-framework/vividus/actions/runs/${GITHUB_RUN_ID} \
+                                                  -Pvividus.allure.executor.report-url=https://github.com/vividus-framework/vividus/actions/runs/${GITHUB_RUN_ID} \
+                                                  -Pvividus.allure.executor.report-name="SauceLabs Android Proxy tests report" \
+                                                  -Pvividus.saucelabs.sauce-connect.command-line-arguments="--proxy-localhost --no-ssl-bump-domains example.com" \
+                                                  -Pvividus.bdd.variables.global.app-url=sauce-storage:vividus-test-app-android.zip
+        else
+            echo No SAUCELABS_USER and/or SAUCELABS_KEY variables, System tests will be skipped
+        fi
+
+    - name: SauceLabs - Android Proxy - Mobile App - Publish system tests report
+      if: matrix.platform == 'ubuntu-latest' && always()
+      uses: actions/upload-artifact@v2
+      with:
+        name: SauceLabs - System Tests With Proxy- Allure report - Android
+        path: vividus-tests/output/reports/sl-android-proxy-allure
+
     - name: BrowserStack - Desktop - Web - System tests
       if: matrix.platform == 'macos-latest'
       env:

diff --git a/docs/modules/plugins/pages/plugin-mobile-app.adoc b/docs/modules/plugins/pages/plugin-mobile-app.adoc
@@ -1,5 +1,6 @@
 :grid-default-hostname: empty
 :keys: https://github.com/appium/appium-xcuitest-driver#mobile-pressbutton[iOS keys] or https://appium.github.io/java-client/io/appium/java_client/android/nativekey/AndroidKey.html[Android keys]
+:given-step: Given I start mobile application
 
 = Mobile Application Plugin
 
@@ -161,9 +162,13 @@ a|Defines a destination folder on a device for a file being uploaded
 !`/sdcard/Pictures`
 
 !===
-
+include::partial$proxy-properties.adoc[]
 |===
 
+include::partial$proxy-meta-tags.adoc[]
+
+IMPORTANT: For device configuration, we need to perform the following steps: install CA certificate(download https://github.com/browserup/browserup-proxy/blob/master/browserup-proxy-core/src/main/resources/sslSupport/ca-certificate-rsa.cer[CA certificate] from a browserup repository), configure device proxy, and configure the test app to allow proxy in cases of necessity.
+
 == Profiles
 
 === iOS
@@ -744,3 +749,5 @@ When I select next value with `0.1` offset in picker wheel located `xpath(//XCUI
 
 
 include::partial$generic-ui-steps.adoc[]
+
+include::partial$proxy-steps.adoc[]