PHPUnit

BrowserStack supports Selenium automated tests using PHPUnit, and running your tests on our cloud setup is simple and straightforward. Get started with a sample test, which opens Google's homepage, searches for ‘BrowserStack’, and asserts for the title of the search results page. For the code to run successfully on your machine, please ensure that the following libraries have been installed:

# Install using composer
php composer.phar install phpunit/phpunit-selenium

Here is a sample test case written for running with PHPUnit.

class SingleTest extends BrowserStackTest {

    public function testGoogle() {
        self::$driver->get("https://www.google.com/ncr");
        $element = self::$driver->findElement(WebDriverBy::name("q"));
        $element->sendKeys("BrowserStack");
        $element->submit();
        $this->assertEquals('BrowserStack - Google Search', self::$driver->getTitle());
    }

}

To actually run the test case, we need to integrate with BrowserStack as follows.

To obtain your username and access keys, sign up for a Free Trial or purchase a plan.

Integration of PHPUnit with BrowserStack is made possible by use of following module:

$config_file = getenv('CONFIG_FILE');
if(!$config_file) $config_file = 'config/single.conf.json';
$GLOBALS['CONFIG'] = json_decode(file_get_contents($config_file), true);

$GLOBALS['BROWSERSTACK_USERNAME'] = getenv('BROWSERSTACK_USERNAME');
if(!$GLOBALS['BROWSERSTACK_USERNAME']) $GLOBALS['BROWSERSTACK_USERNAME'] = $CONFIG['user'];

$GLOBALS['BROWSERSTACK_ACCESS_KEY'] = getenv('BROWSERSTACK_ACCESS_KEY');
if(!$GLOBALS['BROWSERSTACK_ACCESS_KEY']) $GLOBALS['BROWSERSTACK_ACCESS_KEY'] = $CONFIG['key'];

class BrowserStackTest extends PHPUnit_Framework_TestCase
{
    protected static $driver;
    protected static $bs_local;

    public static function setUpBeforeClass()
    {
        $CONFIG = $GLOBALS['CONFIG'];
        $task_id = getenv('TASK_ID') ? getenv('TASK_ID') : 0;

        $url = "https://" . $GLOBALS['BROWSERSTACK_USERNAME'] . ":" . $GLOBALS['BROWSERSTACK_ACCESS_KEY'] . "@" . $CONFIG['server'] ."/wd/hub";
        $caps = $CONFIG['environments'][$task_id];

        foreach ($CONFIG["capabilities"] as $key => $value) {
            if(!array_key_exists($key, $caps))
                $caps[$key] = $value;
        }

        if(array_key_exists("browserstack.local", $caps) && $caps["browserstack.local"])
        {
            $bs_local_args = array("key" => $GLOBALS['BROWSERSTACK_ACCESS_KEY']);
            self::$bs_local = new BrowserStack\Local();
            self::$bs_local->start($bs_local_args);
        }

        self::$driver = RemoteWebDriver::create($url, $caps);
    }

    public static function tearDownAfterClass()
    {
        self::$driver->quit();
        if(self::$bs_local) self::$bs_local->stop();
    }
}

The module reads from config file where you need to put the BrowserStack Hub URL and credentials.

{
  "server": "hub-cloud.browserstack.com",
  "user": "USERNAME",
  "key": "ACCESS_KEY",

  "capabilities": {
    "browserstack.debug": true,
    "name": "Bstack-[PhpUnit] Sample Test"
  },

  "environments": [{
    "browser": "chrome"
  }]
}

Run your test on BrowserStack using following command:

# Run using composer
composer single

To test a private server with PHPUnit on BrowserStack, install local bindings.

# Install using composer
php composer.phar install browserstack/browserstack-local

Then update config file and set the browserstack.local capability to true.

{
  "server": "hub-cloud.browserstack.com",
  "user": "USERNAME",
  "key": "ACCESS_KEY",

  "capabilities": {
    "browserstack.local": true,
    "name": "Bstack-[PhpUnit] Local Test"
  },

  "environments": [{
    "browser": "chrome"
  }]
}

Here is a sample test case written for running local with PHPUnit.

class LocalTest extends BrowserStackTest {

    public function testLocal() {
      self::$driver->get("http://bs-local.com:45691/check");
      $this->assertContains('Up and running', self::$driver->getPageSource(), '', true);
    }

}

Run your local test on BrowserStack using following command:

# Run using composer
composer local

To run tests on multiple browsers in parallel with JBehave on BrowserStack, modify the config file as below:

{
  "server": "hub-cloud.browserstack.com",
  "user": "USERNAME",
  "key": "ACCESS_KEY",

  "capabilities": {
    "browserstack.debug": true,
    "name": "Bstack-[PhpUnit] Parallel Test"
  },

  "environments": [{
    "browser": "chrome"
  },{
    "browser": "firefox"
  },{
    "browser": "safari"
  },{
    "browser": "internet explorer"
  }]
}

Capabilities for each environment can be customised as explained earlier.

You need the following custom script to launch the tests in parallel.

$config_file = getenv('CONFIG_FILE');
if(!$config_file) $config_file = 'config/single.conf.json';
$GLOBALS['CONFIG'] = json_decode(file_get_contents($config_file), true);

$GLOBALS['BROWSERSTACK_USERNAME'] = getenv('BROWSERSTACK_USERNAME');
if(!$GLOBALS['BROWSERSTACK_USERNAME']) $GLOBALS['BROWSERSTACK_USERNAME'] = $CONFIG['user'];

$GLOBALS['BROWSERSTACK_ACCESS_KEY'] = getenv('BROWSERSTACK_ACCESS_KEY');
if(!$GLOBALS['BROWSERSTACK_ACCESS_KEY']) $GLOBALS['BROWSERSTACK_ACCESS_KEY'] = $CONFIG['key'];

$CONFIG = $GLOBALS['CONFIG'];
$procs = array();

foreach ($CONFIG['environments'] as $key => $value) {
    $cmd = "TASK_ID=$key vendor/bin/phpunit tests/single_test.php 2>&1\n";
    print_r($cmd);

    $procs[$key] = popen($cmd, "r");
}

foreach ($procs as $key => $value) {
    while (!feof($value)) { 
        print fgets($value, 4096);
    }
    pclose($value);
}

Run your tests in parallel on BrowserStack using following command:

# Run using composer
composer parallel

To run your tests on BrowserStack Automate, the tests have to be run on remote machines. Therefore, the capabilities of the WebDriver have to be changed accordingly.

"environments": [{
  "os": "Windows",
  "os_version": "7",
  "browser": "IE",
  "browser_version": "8.0",
  "resolution": "1024x768"
}]

"capabilities": {
  "build": "version1",
  "project": "newintropage"
}

"capabilities": {
  "acceptSslCerts": true
}

"capabilities": {
  "browserstack.ie.enablePopups": true
}

"capabilities": {
  "browserstack.safari.enablePopups": true
}

"capabilities": {
  "browserstack.debug": true
}

"capabilities": {
  "browserstack.video": false
}