Skip to main content

Bitrise integrate Browserstack to Run XCUITest

Image
By

Bitrise is one of the best solutions for mobile application development. It gives us many mobile app-related steps to create CI/CD (continuous integration / continuous deployment) pipelines (or workflows as in the Bitrise). Around the mobile application development ecosystem, we have many cloud solutions to make quick and reliable development processes. Browserstack is also one of them, it is widely used in web development and testing but also it also has nice features like 'App Live' and 'App Automate' for mobile app testing.

In this post, I want to share how we can integrate Browserstack to Bitrise to run XCUITest.

Run XCUITest on Browserstack via Bitrise

If you want to run XCUITest on a real device then you must build the for generic iOS devices. Building for generic iOS devices requires provisioning so you should ensure that you added the provisioning step to the workflow. Also to be able to run an iOS build on a real device, the device should be registered to the Apple console. This is required by Apple security concerns. However, device farms Firebase Test Lab and Browserstack handle this issue, so no need to be concerned about the limit of registered devices.


In this example, we are using a script to handle all the staff for us. So it does the followings: 
  1. Create a .ipa file from the derived artifact
  2. ZIP the test file - UITests-Runner.app to UITests-Runner.zip
  3. Upload the app - .ipa created at Step-1
  4. Upload the test file - .zip file created at Step-2
  5. Trigger test with uploaded files and desired devices and test options
  6. Wait until tests to finish and evaluate the result
For the script, all the required files are created by the step "Xcode Build for testing for iOS" so this step be set up correctly. We are using file under "$BITRISE_TEST_DIR_PATH"

See the script to run XCUITest on Browserstack
#!/usr/bin/env bash
# Author: Mesut Güneş
set -e
cd $BITRISE_TEST_DIR_PATH
#-1 creating IPA
rm -rf Payload
mkdir Payload
cp -rf projectX.app Payload/
zip -r Payload.zip Payload/
mv Payload.zip projectX.ipa
#-2 zip tests
zip --symlinks -r projectXUITests-Runner.zip projectXUITests-Runner.app
#-3 upload app
upload_app=$(curl -u "$BROWSERSTACK_USER:$BROWSERSTACK_USER_TOKEN" -X POST "https://api-cloud.browserstack.com/app-automate/upload" -F "file=@projectX.ipa")
app_url=$(echo $upload_app | jq -r .app_url)
envman add --key BROWSERSTACK_APP_URL --value $app_url
echo -e "\napp_url: $app_url\n"
#-4 upload test
upload_test=$(curl -u "$BROWSERSTACK_USER:$BROWSERSTACK_USER_TOKEN" -X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/test-suite" -F "file=@projectXUITests-Runner.zip")
test_url=$(echo $upload_test | jq -r .test_url)
envman add --key BROWSERSTACK_TEST_URL --value $test_url
echo -e "\ntest_url: $test_url\n"
#-5 upload test
# we can filter the test for different purposes
# test_name="\"ProductCampaignScreenTests\", \"LoginScreenTests\"" ==> \"only-testing\": [$test_name]
test_name=""
trigger_tests=$(curl -u "$BROWSERSTACK_USER:$BROWSERSTACK_USER_TOKEN" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/build" \
-d "{\"devices\": [\"iPhone 11 Pro-13\"], \"app\": \"$app_url\", \"deviceLogs\" : \"true\", \"testSuite\": \"$test_url\", \"only-testing\": [$test_name]}" \
-H "Content-Type: application/json")
build_id=$(echo $trigger_tests | jq -r .build_id)
envman add --key BROWSERSTACK_TEST_BUILD_ID --value $build_id
echo -e "\ntrigger_tests: $trigger_tests\n"
echo -e "\nbuild_id: $build_id\n"
#-6 wait tests until 30mins
end=$((SECONDS+1800))
exit_code=1
status="not run"
while true
do
if [ $SECONDS -gt $end ]; then
echo " - Timeout for Test RUN!"
break
fi
status=$( curl -u "$BROWSERSTACK_USER:$BROWSERSTACK_USER_TOKEN" -X GET "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/builds/$build_id" | jq -r .status )
if [ "$status" == "running" ]; then
echo -e " - Still running, waiting . . ."
sleep 5;
elif [ "$status" == "passed" ]; then
exit_code=0
break
else
break
fi
done;
test_result_url="https://app-automate.browserstack.com/dashboard/v2/builds/$build_id"
envman add --key BROWSERSTACK_TEST_RESULT_URL --value $test_result_url
echo "status: $status"
echo -e "\nCheck the test result from Browserstack: \n - $test_result_url"
exit $exit_code
view raw xcuitest-run-on-browserstack.sh hosted with ❤ by GitHub

Labels

Labels:Software testing

Popular posts for software testing and automation

Selenium Error "Element is not currently interactable and may not be manipulated"

By
Selenium webdriver can drive different browsers like as Firefox, Chrome or Internet Explorer. These browsers actually cover the majority of internet users, so testing these browsers possibly covers the 90% of the internet users. However, there is no guaranty that the same automation scripts can work without a failure on these three browsers. For this reason, automation code should be error-prone for the browsers you want to cover. The following error is caught when the test script run for Chrome and Internet Explorer, but surprisingly there is no error for the Firefox. Selenium gives an error like below: Traceback (most recent call last):   File "D:\workspace\sample_project\sample_run.py", line 10, in <module>     m.login()   File "D:\workspace\ sample_project \test_case_imps.py", line 335, in login     driver.find_element_by_id("id_username").clear()   File "C:\Python27\lib\site-packages\selenium-2.35.0-py2.7.egg\seleni...
Read more

Change Default Timeout and Wait Time of Capybara

By
One of the biggest challenge for automation is handling timeout problem. Most of the time, timeout is 60 seconds but it may sometimes not enough if you have badly designed asynchronous calls or the third party ajax calls. This makes handling timeout more complex. set large enough to tolerate network related problems. For Selenium based automation frameworks, like Capybara, default Webdriver timeout is set to Net::ReadTimeout (Net::ReadTimeout) Changing ReadTimeout If you have timeout problem for Capybara, it gives an error like above. This means that the page is not fully loaded in given timeout period. Even you can see that page is loaded correctly but webdriver wait until the Ajax calls finish. class BufferedIO #:nodoc: internal use only def initialize (io) @io = io @read_timeout = 60 @continue_timeout = nil @debug_output = nil @rbuf = '' end . . . . . def rbuf_fill beg...
Read more

Create an Alias for Interactive Console Work: Selenium and Capybara

By
If you are working on shell most of the time Aliases are very helpfull and time saving. For testing purposes you can use Alias for getting ready your test suites. In this post, I want to explain both running Selenium and Capybara on console and creating aliases for each.  This post is for Windows machines, if you are using Unix-like see   this post . Creating Scripts for Selenium and Capybara First of all, it is assumed that you have installed Selenium and Capybara correctly and they work on your machines. If you haven't installed, you can see my previous posts. I am using the Selenium with Python and the Capybara with Ruby. You can use several different language for Selenium but Capybara works only with Ruby.  Create scripts in a directory called scripts (in your home folder, like as  ~/scripts ) for your automation tool as following, save them as capybara.rb, sel.py :  Creating Aliases Depends on your favourite shell, you need to add the al...
Read more

Page-Object Pattern for Selenium Test Automation with Python

By
Page-object model is a pattern that you can apply it to develop efficient automation framework. With the page-model, it is possible to minimize maintenance cost. Basically page-object means that your every page is inherited from a base class which includes basic functionalities for every page. If you have some new functionalities that every page should have, you can simple add it to the base class. Base class is like the following: In this part we are creating pages which are inherited from base page. Every page has its own functionalities written as python functions. Some functions return to a new page, it means that these functions leave the current page and produce a new page. You should write as much as functions you need in the assertion part because this is the only part you can use the webdriver functions to interact with web pages . This part can be evaluate as providing data to assertion part.   The last part is related to...
Read more

Performance Testing on CI: Locust is running on Jenkins

By
For a successful Continuous Integration pipeline, there should be jobs for testing the performance of the application. It is necessary if the application is still performing well. Generally performance testing is thought as kinds of activities performed one step before going to live. In general approach it is true but don't forget to test your application's performance as soon as there is an testable software, such as an api end point, functions, and etc. For CI it is a good approach to testing performance after functional testing and just before the deployment of next stage. In this post, I want to share some info about Jenkins and Locust. In my previous post you can find some information about Locust and Jenkins. Jenkins operates the CI environment and Locust is a tool for performance testing. To run the Locust on Jenkins you need command line arguments which control the number of clients ,   hatch rate,  running locust without web interface and there s...
Read more