Appium 1 → Appium 2 Migration
Overview
The Appium 1 → Appium 2 Migration feature allows users to upgrade an existing Appium 1 project by creating a new Appium 2 project based on the selected project’s current structure.
With this feature, users can migrate their existing scenarios, plans, project configuration, repository setup, and device selections through a guided step-by-step upgrade flow.
The original Appium 1 project is not overwritten. Instead, the system creates a new Appium 2 project by cloning the selected project’s related data.
Purpose
Appium 2 introduces a different structure and dependency model compared to Appium 1. Because of this, migrating projects manually may require users to recreate project definitions, scenarios, plans, and device configurations.
This feature reduces that manual effort by providing a controlled migration flow where users can:
- Review the source Appium 1 project
- Define the new Appium 2 project name
- Configure the Git repository
- Review cloned scenarios and plans
- Select devices for the new project
- Confirm the upgrade from a summary screen
How to Access
The migration can be started from the Projects page.
- Go to Projects.
- Find the Appium 1 project that should be upgraded.
- Click the related upgrade action for that project.
- The Appium 1 → Appium 2 Upgrade wizard opens.
Migration Steps
1. Project Information
The first step displays the selected Appium 1 project information.
On this screen, the user can review:
- Source project name
- Project type
- Number of scenarios
- Number of plans
The screen also explains what will be cloned during the migration.
What will be cloned?
The following items are included in the migration:
- All test scenarios and their configurations
- All test plans and their settings
- Git repository with updated Appium 2 code
- Project structure and metadata
This step helps the user confirm that the correct Appium 1 project has been selected before continuing.
2. New Project Name
In this step, the user defines the name of the new Appium 2 project.
The system displays:
- Project Name
- Git Project Folder Name
The new project name will be used when creating the Appium 2 project. The Git project folder name is also shown so the user can verify how the repository folder will be created.
The screen also indicates that the Git repository will be created under the configured repository path.
3. Git Repository Configuration
In this step, the user reviews the repository configuration for the new Appium 2 project.
The system shows the target repository information and explains what will happen during the repository preparation process.
Repository setup includes:
- Git repository will be created
- Appium 2 dependencies will be updated
- Test code will be migrated and modified
- Maven/Gradle access will be given
After repository validation, the system displays a success message indicating that the repository access has been successfully verified and the tool can proceed to the next step.
Manual Appium 2 Code Migration Required
This feature copies your existing test code to the new repository, but it does not convert Appium 1 API usage to Appium 2. You must update the test code manually for Appium 2 compatibility.
Review the Appium 2 migration documentation before running the copied tests.
4. Review Scenarios & Plans
In this step, the user reviews which scenarios and plans will be cloned to the new Appium 2 project.
The screen displays two sections:
- Test Scenarios
- Test Plans
The user can see the existing scenarios and plans from the selected Appium 1 project before proceeding.
This step ensures that the user understands what will be carried over into the new Appium 2 project.
Result
After continuing from this step, the selected scenarios and plans are prepared for cloning into the new Appium 2 project.
5. Device Selection
In this step, the user selects the devices that will be assigned to the new Appium 2 project.
The screen allows filtering devices by platform and other available criteria.
Available filters may include:
- Platform
- Brand
- Model
- Version
The user can then select devices from the available device list.
Important
Shared device configurations are not automatically migrated between Appium 1 and Appium 2. The user must select the devices that should be available for the migrated Appium 2 project.
This ensures that the new project uses compatible and explicitly selected devices.
6. Upgrade Summary
The final step displays the migration summary before the upgrade is completed.
The summary includes the new Appium 2 project information and the items that will be cloned.
The screen shows information such as:
- New project name
- Project type
- Scenario count
- Plan count
- Selected devices
- Repository information
- Migration status/details
The user should review this information before clicking Complete Migration.
Update Your Test Code for Appium 2
To run your tests with Appium 2, you need to add the Appium 2 library to your test code.
For detailed information and sample projects, please check the Appium 2 Documentation.