PHPUnit Automated App Testing

Lets start with making sure PHP is available on your system


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

For Mac

PHP should already be present on Mac OS X 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

Please see the example below. We're going to run a test on our sample app (calculator) where we'll add values to two input fields.


<?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 8',
        '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");
    }
}

Upload Your App

Upload your Android (.apk) or iOS app (simulator build in a .zip file) via our REST API:

curl -u "key:secret" \
-X POST "https://api.testingbot.com/v1/storage/" \
-F "file=@/path/to/app/file/Application-debug.apk"

You will get back a response from the API, similar to:

{"app_url":"tb://..."}


Upload app from a Public URL

If you want to use an app available on a public URL, please use this command:

curl -u "key:secret" \
-X POST "https://api.testingbot.com/v1/storage/" \
-d url="https://testingbot.com/appium/sample.zip"

You can now use the uploaded app in your tests by passing the tb://... URI you got from the API:

desiredCaps = {
  'name': 'My First App Test',
  'deviceName' : 'iPhone 8',
  'platformName': 'iOS',
  'version': '12.1',
  'app' : 'tb://...'
};

TestingBot will automatically download the app from TestingBot Storage and open the app for testing.

Configuring capabilities

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');

Specifying the operating system, browser and version

To let TestingBot know on which browser/platform you want to run your test on, you need to specify the browsername, version, OS 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 browser version and platform in the drop-down menus below


1. Select a Platform
2. Select a Browser


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 file.
    Important: the .apk file needs to be a x86 build (x86 ABI).

For iOS:
  • 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/emulator (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

Testing Internal/Staged 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 PHPUnit 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");
    }
}

Other Options

We offer many other test options, for example: disable video recording, specifying a custom Firefox Profile, loading Chrome/Firefox/Safari extensions, running an executable before your test starts, uploading files, ...
See our list of test options for a full list of options to customize your tests.

Parallel Testing

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.


Queueing

Every plan we provide comes with a limit of concurrent VMs (how many tests you can run in parallel).
For example: if you have a plan with 5 concurrent VMs, it is possible to start more tests. TestingBot will queue the additional tests and run the tests as soon as slots become available.


To run tests in parallel, we recommend using Paratest, which makes it very easy to run multiple PHP 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).