Skip to content

Files

Latest commit

 

History

History
327 lines (257 loc) · 12.8 KB

appium-java-cucumber.md

File metadata and controls

327 lines (257 loc) · 12.8 KB
id title sidebar_label description keywords url site_name slug
appium-java-cucumber
Appium With Cucumber
Cucumber
Test your Appium automation scripts using Java Cucumber on LambdaTest Real Device Cloud Platform of 3000+ real mobile devices.
appium
java
cucumber
lambdatest java
framework on lambdatest
app testing
real devices
LambdaTest
appium-java-cucumber/

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

<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify({ "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "Home", "item": "https://www.lambdatest.com" },{ "@type": "ListItem", "position": 2, "name": "Support", "item": "https://www.lambdatest.com/support/docs/" },{ "@type": "ListItem", "position": 3, "name": "WebDriverIO With Appium", "item": "https://www.lambdatest.com/support/docs/appium-java-cucumber/" }] }) }} ></script>

In this documentation, you will learn how to trigger a automation script of Cucumber for application testing with Appium on LambdaTest, set the desired capabilities for appium testing, and other advanced features of LambdaTest.

Prerequisites

Try our Sample Repository

Step 1: Get a Sample Project

You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

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

Step 2: Setup the Environment Variables

You need to export your environment variables LT_USERNAME and LT_ACCESS_KEY that are available in your LambdaTest Profile page. Run the below mentioned commands in your terminal to setup the 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()}"`}

Step 3: Upload your Application

Upload your iOS application (.ipa file) or android application (.apk or .aab 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. Below is an example cURL request to upload your app using our REST API:

{`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""`}
{`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 apps, 🔗 Android app or 🔗 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

:::

Step 4: Update your Automation Script

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

import java.net.URL;

import io.cucumber.testng.AbstractTestNGCucumberTests;
import io.cucumber.testng.CucumberOptions;
import io.cucumber.testng.TestNGCucumberRunner;
import org.openqa.selenium.remote.CapabilityType;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.AppiumDriver;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Parameters;

import org.openqa.selenium.JavascriptExecutor;
import java.net.MalformedURLException;


@CucumberOptions(
        features = "src/main/java/Features/todo.feature",
        glue = {"stepDefinitions"},
        plugin = "json:target/cucumber-reports/CucumberTestReport.json")

public class TestRunner extends AbstractTestNGCucumberTests {
    
    private TestNGCucumberRunner testNGCucumberRunner;
  
    public static RemoteWebDriver connection;
    
    @BeforeClass(alwaysRun = true)
    public void setUpCucumber() {
         testNGCucumberRunner = new TestNGCucumberRunner(this.getClass());
    }
    
    @BeforeMethod(alwaysRun = true)
    @Parameters({ "deviceName", "platformVersion", "platformName" })
    public void setUpClass(String deviceName, String platformVersion, String platformName) throws Exception {

            String username = System.getenv("LT_USERNAME") == null ? "YOUR_LT_USERNAME" : System.getenv("LT_USERNAME");      //Enter your LambdaTest username at the place of YOUR_LT_USERNAME 
            String accesskey = System.getenv("LT_ACCESS_KEY") == null ? "YOUR_LT_ACCESSKEY" : System.getenv("LT_ACCESS_KEY");     //Enter your LambdaTest accessKey at the place of YOUR_LT_ACCESSKEY

            DesiredCapabilities capability = new DesiredCapabilities();         


            capability.setCapability("platformName", platformName);
            capability.setCapability("deviceName", deviceName);
            capability.setCapability("platformVersion",platformVersion);
                        
            capability.setCapability("build", "Native App automate Demo");
            capability.setCapability("test", "Test Parallel");          
            capability.setCapability("isRealMobile", true);
            // highlight-next-line
            capability.setCapability("app","lt://proverbial-android");     //Enter the app url here
            capability.setCapability("network", false);
            capability.setCapability("video", true);
            capability.setCapability("console", true);
            capability.setCapability("visual", true);

            String gridURL = "https://" + username + ":" + accesskey + "@mobile-hub.lambdatest.com/wd/hub";
            System.out.println(gridURL);
            connection = new RemoteWebDriver(new URL(gridURL), capability);
            System.out.println(capability);
            System.out.println(connection.getSessionId());
}


    @DataProvider
    public Object[][] features() {
        return testNGCucumberRunner.provideScenarios();
    }
 
    @AfterClass(alwaysRun = true)
    public void tearDownClass() {
        testNGCucumberRunner.finish();
    }
}

Step 5: 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:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="BDD Test Suite" verbose="1" parallel="tests"
	thread-count="3" >
    <test name="ANDROIDTEST" annotations="JDK"
		preserve-order="true">
        <parameter name="deviceName" value=".*"/>
        <parameter name="platformVersion" value="12"/>
        <parameter name="platformName" value="Android"/>
        <classes>
            <class name="MyRunner.TestRunner" />
        </classes>
    </test> <!-- Test -->
</suite>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="BDD Test Suite" verbose="1" parallel="tests"
       thread-count="2">
    <test name="Galaxy" annotations="JDK"
          preserve-order="true">
        <parameter name="deviceName" value="Galaxy.*"/>
        <parameter name="platformVersion" value="11"/>
        <parameter name="platformName" value="Android"/>
        <classes>
            <class name="MyRunner.TestRunner"/>
        </classes>
    </test> <!-- Test -->
    <test name="OnePlus" annotations="JDK"
          preserve-order="true">
        <parameter name="deviceName" value="Pixel.*"/>
        <parameter name="platformVersion" value="12"/>
        <parameter name="platformName" value="Android"/>
        <classes>
            <class name="MyRunner.TestRunner"/>
        </classes>
    </test> <!-- Test -->

</suite>

:::info

:::

Step 6: Execute and Monitor your Tests

  • Run the following commands to install the required dependencies:

    mvn clean install

  • The tests can be executed in the terminal using the following command:

    mvn test -D suite=single.xml
    mvn test -D suite=parallel.xml

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

Reference Guides