Generate an Appium script

Generate an Appium script from a manual session, so you can start building your test suite.

Before you start

Export your script

After creating the baseline session, search for your session, open Session Explorer, and select Convert to Test Case.

The Convert to Test Case for the selected session.

Next, select the Export Appium Script icon. If you don’t see an icon, check if your session requires remediation.

Session overview tabs, including Automated Test Case, Jira Integration, Rerun, and the Appium Export icon.

Choose a testing framework, then select Download.

The export Appium script diologue, allowing you to download the Appium script.

While the exact contents of your Appium script may vary depending on your testing framework, your script’s directory structure will resemble the following:

root
├── src
│   └── test
│       ├── <resources>
│       └── <test-suite>
│           ├── <app-config>
│           └── <other-files>
├── README.md
└── <testing-framework-config>

Supported languages and test frameworks

This section lists all programming languages and test frameworks available for generating Appium script:

  • Java - TestNG

  • Java - JUnit

  • NodeJS - Mocha

  • C# - NUnit

Java project requirements

Java projects exported with TestNG or JUnit require JDK 17 or later and Maven. Follow the README.md file in the exported project to build and run the tests.

Exported Java projects use the following stack:

  • Java 17 compile target

  • Appium java-client 10.1.1

  • Selenium 4 (W3C protocol)

  • TestNG or JUnit 4, based on the selected framework

Maven Surefire generates the test reports.

Add an exported Java project as a module in an existing framework that uses current Appium and Selenium versions.