Features

PHPUnit Automated App Testing

See our PHPUnit Mobile example repository for a simple example on how to run PHPUnit tests for Mobile Apps on TestingBot.

Let's start with making sure PHP is available on your system.


For Windows:
For Linux:
sudo apt-get install curl libcurl3 libcurl3-dev php

For macOS:

PHP should already be present on macOS by default.

Install PHPUnit


  • Make sure you have Composer installed.
  • Install PHPUnit by running this command in your terminal:

    php composer.phar require phpunit/phpunit-selenium
  • Install Appium PHP Client by running this command in your terminal:

    php composer.phar require appium/php-client

PHPUnit Example Real Devices

Please see the example below. We're going to test our sample app on a Real Device.
In this test we'll add values to two input fields and see if the calculator works.


<?php

require 'vendor/autoload.php';
require_once('PHPUnit/Extensions/AppiumTestCase.php');
require_once('PHPUnit/Extensions/AppiumTestCase/Element.php');

class TestingBotTest extends \PHPUnit_Extensions_AppiumTestCase
{
    public static $browsers = array(array( 'browserName' => '', 'desiredCapabilities' => array(
        'app' => 'https://testingbot.com/appium/sample.apk',
        'deviceName' => 'Galaxy S8',
        'version' => '9.0',
        'platformName' => 'Android',
    	'realDevice': true
    )));

    public function setupSpecificBrowser($params) {
        $caps = $this->getDesiredCapabilities();
        $this->setHost('api_key:api_secret@hub.testingbot.com');
        $caps = isset($params['desiredCapabilities']) ? $params['desiredCapabilities'] : array();
        $this->setDesiredCapabilities($caps);
        $this->setUpSessionStrategy($params);
        $this->setSeleniumServerRequestsTimeout(180);
    }

    public function testNativeApplication() {
    	$el = $this->byAccessibilityId('inputA');
    	$el->click();
    	$this->keys("10");
    	$el = $this->byAccessibilityId('inputB');
    	$el->click();
    	$this->keys("5");
    }
}
<?php

require 'vendor/autoload.php';
require_once('PHPUnit/Extensions/AppiumTestCase.php');
require_once('PHPUnit/Extensions/AppiumTestCase/Element.php');

class TestingBotTest extends \PHPUnit_Extensions_AppiumTestCase
{
    public static $browsers = array(array( 'browserName' => '', 'desiredCapabilities' => array(
        'app' => 'https://testingbot.com/appium/sample.ipa',
        'deviceName' => 'iPhone XR',
        'version' => '12.1',
        'platformName' => 'iOS',
    	'realDevice': true
    )));

    public function setupSpecificBrowser($params) {
        $caps = $this->getDesiredCapabilities();
        $this->setHost('api_key:api_secret@hub.testingbot.com');
        $caps = isset($params['desiredCapabilities']) ? $params['desiredCapabilities'] : array();
        $this->setDesiredCapabilities($caps);
        $this->setUpSessionStrategy($params);
        $this->setSeleniumServerRequestsTimeout(180);
    }

    public function testNativeApplication() {
    	$el = $this->byAccessibilityId('inputA');
    	$el->click();
    	$this->keys("10");
    	$el = $this->byAccessibilityId('inputB');
    	$el->click();
    	$this->keys("5");
    }
}

PHPUnit Example Simulator/Emulator

Please see the example below. We're going to test our sample app on an iOS Simulator or Android Emulator.
In this test we'll add values to two input fields and see if the calculator works.


<?php

require 'vendor/autoload.php';
require_once('PHPUnit/Extensions/AppiumTestCase.php');
require_once('PHPUnit/Extensions/AppiumTestCase/Element.php');

class TestingBotTest extends \PHPUnit_Extensions_AppiumTestCase
{
    public static $browsers = array(array( 'browserName' => '', 'desiredCapabilities' => array(
        'app' => 'https://testingbot.com/appium/sample.apk',
        'deviceName' => 'Nexus 7',
        'version' => '7.1',
        'platformName' => 'Android'
    )));

    public function setupSpecificBrowser($params) {
        $caps = $this->getDesiredCapabilities();
        $this->setHost('api_key:api_secret@hub.testingbot.com');
        $caps = isset($params['desiredCapabilities']) ? $params['desiredCapabilities'] : array();
        $this->setDesiredCapabilities($caps);
        $this->setUpSessionStrategy($params);
        $this->setSeleniumServerRequestsTimeout(180);
    }

    public function testNativeApplication() {
    	$el = $this->byAccessibilityId('inputA');
    	$el->click();
    	$this->keys("10");
    	$el = $this->byAccessibilityId('inputB');
    	$el->click();
    	$this->keys("5");
    }
}
<?php

require 'vendor/autoload.php';
require_once('PHPUnit/Extensions/AppiumTestCase.php');
require_once('PHPUnit/Extensions/AppiumTestCase/Element.php');

class TestingBotTest extends \PHPUnit_Extensions_AppiumTestCase
{
    public static $browsers = array(array( 'browserName' => '', 'desiredCapabilities' => array(
        'app' => 'https://testingbot.com/appium/sample.zip',
        'deviceName' => 'iPhone XR',
        'version' => '12.1',
        'platformName' => 'iOS'
    )));

    public function setupSpecificBrowser($params) {
        $caps = $this->getDesiredCapabilities();
        $this->setHost('api_key:api_secret@hub.testingbot.com');
        $caps = isset($params['desiredCapabilities']) ? $params['desiredCapabilities'] : array();
        $this->setDesiredCapabilities($caps);
        $this->setUpSessionStrategy($params);
        $this->setSeleniumServerRequestsTimeout(180);
    }

    public function testNativeApplication() {
    	$el = $this->byAccessibilityId('inputA');
    	$el->click();
    	$this->keys("10");
    	$el = $this->byAccessibilityId('inputB');
    	$el->click();
    	$this->keys("5");
    }
}

Uploading Your App

Please see our Upload Mobile App documentation to find out how to upload your app to TestingBot for testing.

Specify Browsers & Devices

To run your existing tests on TestingBot, your tests will need to be configured to use the TestingBot remote machines. If the test was running on your local machine or network, you can simply change your existing test like this:

$this->setHost('api_key:api_secret@hub.testingbot.com');

To let TestingBot know on which device you want to run your test on, you need to specify the deviceName, version, platformName and other optional options in the capabilities field.

public static $browsers = array(array( 'browserName' => '', 'desiredCapabilities' => array(
    'app' => 'tb://...',
    'deviceName' => 'iPhone 8',
    'version' => '12.1',
    'platformName' => 'iOS'
)));

To see how to do this, please select a combination of device type and device name in the drop-down menus below.


1. Select a Device Type
2. Select a Device Name


Testing Internal Websites

We've built TestingBot Tunnel, to provide you with a secure way to run tests against your staged/internal webapps.
Please see our TestingBot Tunnel documentation for more information about this easy to use tunneling solution.


The example below shows how to easily run a PHP WebDriver test with our Tunnel:


1. Download our tunnel and start the tunnel:

java -jar testingbot-tunnel.jar key secret

2. Adjust your test: instead of pointing to 'hub.testingbot.com/wd/hub' like the example above - change it to point to your tunnel's IP address.
Assuming you run the tunnel on the same machine you run your tests, change to 'localhost:4445/wd/hub'. localhost is the machine running the tunnel, 4445 is the default port of the tunnel.


This way your test will go securely through the tunnel to TestingBot and back:


<?php

require 'vendor/autoload.php';
require_once('PHPUnit/Extensions/AppiumTestCase.php');
require_once('PHPUnit/Extensions/AppiumTestCase/Element.php');

class TestingBotTest extends \PHPUnit_Extensions_AppiumTestCase
{
    public static $browsers = array(array( 'browserName' => '', 'desiredCapabilities' => array(
        'app' => 'https://testingbot.com/appium/sample.zip',
        'deviceName' => 'iPhone 8',
        'version' => '12.1',
        'platformName' => 'iOS'
    )));

    public function setupSpecificBrowser($params) {
        $caps = $this->getDesiredCapabilities();
        $this->setHost('api_key:api_secret@localhost');
        $this->setPort(4445);
        $caps = isset($params['desiredCapabilities']) ? $params['desiredCapabilities'] : array();
        $this->setDesiredCapabilities($caps);
        $this->setUpSessionStrategy($params);
        $this->setSeleniumServerRequestsTimeout(180);
    }

    public function testNativeApplication() {
    	$el = $this->byAccessibilityId('inputA');
    	$el->click();
    	$this->keys("10");
    	$el = $this->byAccessibilityId('inputB');
    	$el->click();
    	$this->keys("5");
    }
}

Run tests in Parallel

Parallel Testing means running the same test, or multiple tests, simultaneously. This greatly reduces your total testing time.

You can run the same tests on all different browser configurations or run different tests all on the same browser configuration.
TestingBot has a large grid of machines and browsers, which means you can use our service to do efficient parallel testing. It is one of the key features we provide to greatly cut down on your total testing time.


To run tests in parallel, we recommend using Paratest, which makes it very easy to run multiple PHPUnit tests simultaneously.

vendor/bin/paratest -p 8 -f --phpunit=vendor/bin/phpunit WebdriverTest.php

The command above will run your tests in 8 seperate processes (8 tests at once).


Queuing

Every plan we provide comes with a limit of parallel tests.
If you exceed the number of parallel tests assigned to your account, TestingBot will queue the additional tests (for up to 6 minutes) and run the tests as soon as slots become available.

Mark tests as passed/failed

As TestingBot has no way to dermine whether your test passed or failed (it is determined by your business logic), we offer a way to send the test status back to TestingBot. This is useful if you want to see if a test succeeded or failed from the TestingBot member area.


You can use our PHP API client to report back test results.

$api = new TestingBot\TestingBotAPI($apiKey, $apiSecret);
$api->updateJob($web_driver->getSessionID(), array('name' => 'mytest', 'success' => true));

Preparing your App

You do not need to install any code or plugin to run a test.
Below are some things that are necessary to successfully run a mobile test:


For Android:
  • Please supply the URL to your .apk or .aab file.
    Important: the .apk file needs to be a x86 build (x86 ABI) for Android emulators.

For iOS Real Device:
  • Please supply the URL to an .ipa file.

For iOS Simulator:
  • Please supply the URL to a .zip file that contains your .app
  • The .app needs to be an iOS Simulator build:
    • Create a Simulator build:
      xcodebuild -sdk iphonesimulator -configuration Debug
    • Zip the .app bundle:
      zip -r MyApp.zip MyApp.app

Additional Options

Appium provides a lot of options to configure your test.

Some important options that might help:


For Android:
  • appActivity and appPackage: by default, Appium will try to extract the main Activity from your apk. If this fails, you can supply your own with these options.
  • chromeOptions: additional chromedriver options you can supply.
  • otherApps: a JSON array of other apps that need to be installed, in URL format.

For Android & iOS:
  • locale: the language of the simulator/device (ex: fr_CA)
  • newCommandTimeout: How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session