id

title

sidebar_label

description

keywords

image

url

site_name

slug

appium-php

PHP With Appium

PHP

Now you can run your automation scripts using Appium with PHP on LambdaTest online grid of 3000+ real desktop browsers and real operating systems.

appium

java

lambdatest java

framework on lambdatest

testng

app testing

real devices

/assets/images/og-images/appium-testing-og-image.jpg

https://www.lambdatest.com/support/docs/appium-php/

LambdaTest

appium-php/

import CodeBlock from '@theme/CodeBlock'; import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Tutorial To Run Your First Test On LambdaTest

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

Objective

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

Run a sample automation script of PHP for application testing with Appium on LambdaTest.
Learn more about Desired Capabilities for Appium testing.
Explore advanced features of LambdaTest.

:::tip 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. <img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> 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

sudo apt-get install curl libcurl3 libcurl3-dev php

For Windows, you can download PHP from here. Also, refer to this documentation for ensuring the accessibility of PHP through Command Prompt(cmd).

Please add PHP to Windows System Variables Path.

Download Composer in the project directory

Download composer in the project directory from here (Linux/MacOS, Windows).

:::tip 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

:::

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

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 "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -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 "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -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
cd LT-appium-php

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=${ YOUR_LAMBDATEST_USERNAME()} \\ export LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}

{`set LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \` set LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}

4. Write your automation script

An automation script for the sample application available above has been provided here. Ensure to update the APP_URL, username and accesKey in the code scripts before running the tests.

<?php
 require __dir__.'/vendor/autoload.php';
 use Facebook\WebDriver\Remote\DesiredCapabilities;
 use Facebook\WebDriver\WebDriverBy;
 use Facebook\WebDriver\WebDriverWait;
 use Facebook\WebDriver\WebDriverExpectedCondition;
 use Facebook\WebDriver\Chrome\ChromeOptions;
 use Facebook\WebDriver\Remote\RemoteWebDriver;

 $caps = array(
    //highlight-next-line
   "app"=> "APP_URL", //Enter app_url here
   "deviceName" => "iPhone 11",
   "platformName" => "ios",
   "platformVersion" => "14",
   "isRealMobile" => TRUE,
   "visual" => TRUE,
   "video" => TRUE,
   "name" => "Php - iOS test",
   "build" => "Php Vanilla - iOS"
);

    //highlight-next-line
    $username = getenv("LT_USERNAME") ? getenv("LT_USERNAME") : "USERNAME"; //Enter username here
    //highlight-next-line
    $accesskey = getenv("LT_ACCESS_KEY") ? getenv("LT_ACCESS_KEY") : "ACCESS_KEY"; //Enter accesskey here
 $driver = RemoteWebDriver::create("http://$username:$accesskey@mobile-hub.lambdatest.com/wd/hub",$caps);
try{
    $wait = new WebDriverWait($driver, 30);
    $wait->until(WebDriverExpectedCondition::visibilityOfElementLocated(WebDriverBy::id('color')));
    $color_element = $driver->findElement(WebDriverBy::id('color'));
    $color_element->click();
    $text_element = $driver->findElement(WebDriverBy::id('Text'));
    $text_element->click();
    $toast_element = $driver->findElement(WebDriverBy::id('toast'));
    $toast_element->click();
    $notification_element = $driver->findElement(WebDriverBy::id('notification'));
    $notification_element->click();
    sleep(2);
    $wait->until(WebDriverExpectedCondition::visibilityOfElementLocated(WebDriverBy::id('geoLocation')));
    $geolocation_element = $driver->findElement(WebDriverBy::id('geoLocation'));
    $geolocation_element->click();
    sleep(5);
    $home_element = $driver->findElement(WebDriverBy::id('Back'));
    $home_element->click();
    $speedtest_element = $driver->findElement(WebDriverBy::id('speedTest'));
    $speedtest_element->click();
    sleep(5);
    $home_element = $driver->findElement(WebDriverBy::id('Back'));
    $home_element->click();
    $browser_element = $driver->findElement(WebDriverBy::id('Browser'));
    $browser_element->click();
    $url_element = $driver->findElement(WebDriverBy::id('url'));
    $url_element->sendKeys("https://www.lambdatest.com");
    $find_element = $driver->findElement(WebDriverBy::id('find'));
    $find_element->click();
    sleep(2);
    $driver->quit();
 }  finally {
     $driver->quit();
 }
?>

<?php
    require 'vendor/autoload.php';
    use Facebook\WebDriver\Remote\DesiredCapabilities;
    use Facebook\WebDriver\WebDriverBy;
    use Facebook\WebDriver\Remote;
    use Facebook\WebDriver\Chrome\ChromeOptions;
    use Facebook\WebDriver\WebDriverExpectedCondition;
    use Facebook\WebDriver\Remote\RemoteWebDriver;

    $caps = array(
        "app"=> "APP_URL", //Enter app_url here
        "deviceName" => "Galaxy S20",
        "platformName" => "Android",
        "platformVersion" => "10",
        "isRealMobile" => TRUE,
        "visual" => TRUE,
        "video" => TRUE,
        "name" => "Php - Android test",
        "build" => "Php Vanilla - Android"
    );

    //highlight-next-line
    $username = getenv("LT_USERNAME") ? getenv("LT_USERNAME") : "USERNAME"; //Enter username here
    //highlight-next-line
    $accesskey = getenv("LT_ACCESS_KEY") ? getenv("LT_ACCESS_KEY") : "ACCESS_KEY"; //Enter accesskey here

    $driver = RemoteWebDriver::create("http://$username:$accesskey@mobile-hub.lambdatest.com/wd/hub",$caps);

 try{
    $color_element = $driver->findElement(WebDriverBy::id('color'));
    $color_element->click();

    $text_element = $driver->findElement(WebDriverBy::id('Text'));
    $text_element->click();

    $toast_element = $driver->findElement(WebDriverBy::id('toast'));
    $toast_element->click();

    $notification_element = $driver->findElement(WebDriverBy::id('notification'));
    $notification_element->click();

    $geoLocation_element = $driver->findElement(WebDriverBy::id('geoLocation'));
    $geoLocation_element->click();
    sleep(5);
    
    $url_element = $driver->findElement(WebDriverBy::id('url'));
    $url_element->sendkeys("https://www.lambdatest.com");

    $find_element = $driver->findElement(WebDriverBy::id('find'));
    $find_element->click();
    sleep(2);

    $driver->quit();
 } finally {
    $driver->quit();
 }

?>

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. The capabilities object in the sample code are defined as:

  $caps = array(
    //highlight-next-line
    "app"=> "APP_URL", //Enter app_url here
   "deviceName" => "iPhone 11",
   "platformName" => "ios",
   "platformVersion" => "14",
   "isRealMobile" => TRUE,
   "visual" => TRUE,
   "video" => TRUE,
   "name" => "Php - iOS test",
   "build" => "Php Vanilla - iOS"
 );

  $caps = array(
        //highlight-next-line
        "app"=> "APP_URL", //Enter app_url here
        "deviceName" => "Galaxy S20",
        "platformName" => "Android",
        "platformVersion" => "10",
        "isRealMobile" => TRUE,
        "visual" => TRUE,
        "video" => TRUE,
        "name" => "Php - Android test",
        "build" => "Php Vanilla - Android"
    );

:::info Note

You must add the generated APP_URL to the "app" capability in the config file.
You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool. For more details, please refer to our guide on Desired Capabilities in Appium.

:::

5. Executing your test

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

php IOSApp.php

php AndroidApp.php

:::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. :::

Additional Links

Advanced Configuration for Capabilities
How to test locally hosted apps
How to integrate LambdaTest with CI/CD

Home
Support
PHP With Appium

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

appium-php.md

appium-php.md

Tutorial To Run Your First Test On LambdaTest

Objective

Pre-requisites

Run Your First Test

1. Upload your application

2. Clone The Sample Project

3. Set Up Your Authentication

4. Write your automation script

Configure the test capabilities

5. Executing your test

Additional Links

Files

appium-php.md

Latest commit

History

appium-php.md

File metadata and controls

Tutorial To Run Your First Test On LambdaTest

Objective

Pre-requisites

Run Your First Test

1. Upload your application

2. Clone The Sample Project

3. Set Up Your Authentication

4. Write your automation script

Configure the test capabilities

5. Executing your test

Additional Links