Skip to main content

Behat With Appium

Tutorial To Run Your First Test On LambdaTest​

In this topic, you will learn how to configure and run your PHP Behat automation testing scripts with Appium on LambdaTest Real Device Cloud platform.

Objective​

By the end of this topic, you will be able to:

  1. Run a sample automation script of PHP Behat for application testing with Appium on LambdaTest.
  2. Learn more about Desired Capabilities for Appium testing.
  3. Explore advanced features of LambdaTest.
Sample repo

All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. Image View on GitHub

Pre-requisites​

Before you begin automation testing with Appium, you would need to follow these steps:

Install PHP (latest)

Download and install the latest version of PHP in your system.

Previous versions of MacOS have PHP installed by default. But for the latest MacOS versions starting with Monterey, PHP has to be downloaded and installed manually by using below commands:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install php
Download Composer in the project directory
  1. Download composer in the project directory from here (Linux/MacOS, Windows).
note

To use the composer command directly, it should have been downloaded in the project directory. In windows the composer gets installed in different directory. So, copy the 'composer.phar' to the project directory using copy command:

copy C:\ProgramData\ComposerSetup\bin\composer.phar
  1. Install the composer dependencies in the current project directory using the command below:
composer update
php composer.phar require phpwhois/phpwhois
php composer.phar install
php composer.phar require php-webdriver/webdriver
php composer.phar require behat/behat

In case of any error, please try restarting.

Run Your First Test​

1. Upload your application​

Upload your iOS application (.ipa file) or android application (.apk file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey in the cURL command for authentication. Make sure to add the path of the appFile in the cURL request. Here is an example cURL request to upload your app using our REST API:

Using App File from System:

curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app""

Using App URL:

curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=:https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk" -F "name=Proverbial_App"
tip

  • If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample 🔗 Android app or sample 🔗 iOS app.

  • Response of above cURL will be a JSON object containing the APP_URL of the format - lt://APP123456789123456789 and will be used in the next step.

2. Clone The Sample Project​

Clone the LambdaTest’s 🔗 LT-appium-php repository and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/LT-appium-php-behat
cd LT-appium-php-behat

3. Set Up Your Authentication​

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest. To obtain your access credentials, purchase a plan or access the Automation Dashboard. Set LambdaTest Username and Access Key in environment variables.

export LT_USERNAME=undefined \
export LT_ACCESS_KEY=undefined

4. Write your automation script​

An automation script for the sample application available above has been provided here.

FeatureContext.php
<?php

require "vendor/autoload.php";

class FeatureContext extends LambdaContext {
    /**
     * @Given I am on the proverbial home page
     */
    public function iAmOnTheProverbialHomePage()
    {
      echo "I am on the proverbial home page";

    }

    /**
     * @When I click on color
     */
    public function iClickOnColor()
    {
      $element = self::$driver->findElement(WebDriverBy::id("color"));
      $element->click();
    }

    /**
     * @When I click on text element
     */
    public function iClickOnTextElement()
    {
      $element = self::$driver->findElement(WebDriverBy::id("Text"));
      $element->click();
    }

    /**
     * @When I click on notification element
     */
    public function iClickOnNotificationElement()
    {
      $element = self::$driver->findElement(WebDriverBy::id("notification"));
      $element->click();
    }

    /**
     * @Then I click on toast element
     */
    public function iClickOnToastElement()
    {
      $element = self::$driver->findElement(WebDriverBy::id("toast"));
      $element->click();
    }
}

Configure the test capabilities​

You can update your custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object. Ensure to update the APP_URL, username and accessKey in the code scripts before running the tests. The capabilities object in the sample code are defined as:

iossingle.conf.yml
user: "YOUR USERNAME HERE"       #Add LambdaTest username here 
key: "YOUR ACCESS KEY HERE"      #Add LambdaTest accessKey here
    capabilities:
        build: "behat-appium-ios"
        name: "single-behat-test"
        isRealMobile: true
        app: "lt://proverbial-ios"    #Add app url here
    environments:
        -
        deviceName: iPhone 11
        platform: ios
        platformVersion: 14
Note

Executing your test​

Execute the following command to run your test on LambdaTest platform:

composer iossingle   #for single tests
composer iosparallel  #for parallel tests
info

Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on the 🔗 LambdaTest App Automation Dashboard.

Last updated on