# Migrating Java Selenium Scripts to Avo Assure This section explains how to migrate Selenium automation scripts written in Java into Avo Assure Test cases. ## Prerequisites Before you migrate Selenium scripts to Avo Test cases, make sure the following requirements are fulfilled: * **Selenium Environment**: You must have a configured Selenium development environment (such as Eclipse) to execute the scripts. * **Interceptor Setup**: You must set up the interceptors in your project. * **Script Status**: Your Selenium automation scripts are up to date. * **Error-free Execution**: Ensure the Selenium script runs successfully without any errors before using it in Avo Assure. * **Avo Assure Access**: You must have access to the Avo Assure server. ## Known Limitations * **Maximum Supported ZIP File Size**: The maximum supported size for a ZIP file is 50 MB. * **Duplicate Variables in Excel File**: If the Excel file contains duplicate variables (the same column name defined more than once), the migration process may fail or produce inconsistent parameter mapping results. * **Logical Conditions Support**: Currently, the migration feature supports selenium script or Test case, logical conditions such as IF statements and loops are not supported. ## Best Practices * **Data Parameterization** (**Excel file**): * Make sure each variable name (column name) in the Excel file is unique. * Do not define the same variable name more than once in the data sheet. * Validate the Excel data before executing the Selenium scripts. ## Migrating Selenium Scripts To migrate your Java scripts, you must first set up the interceptor in your project, generate the scenario file, and then import it into Avo Assure. The interceptor allows you to execute code before and after your automation logic without modifying the core functionality of the scripts. {% hint style="info" %} **Note**: * During migration, Avo Assure considers only Selenium actions performed on the browser. * Avo Assure maps Selenium test data automatically. You should review the migrated data to ensure it is correct. * During migration, Avo Assure normalizes all Selenium select actions. The following actions are migrated as selectByValue in Avo Assure: * selectByValue * selectByIndex * selectByVisibleText {% endhint %} ### Downloading and Configuring Interceptor To download and configure the Interceptor for Selenium scripts in Avo Assure, perform the following actions: 1. On the **Home** page, go to **Utilities** and select the **Migrate To Avo** tab.
2. On the **Selenium to Avo** page, select **Java** as the programming language from the **Select Technology** dropdown. 3. Select **Download** to save the interceptor package file (java-intercept.zip) to your local machine.
4. Extract the downloaded **java-intercept.zip** file. 5. Copy the extracted interceptor folder into your Selenium project’s Java source directory (the directory that contains your Selenium framework classes). For Example, \/src/main/java OR \/src/test/java. {% hint style="info" %} **Note**: The interceptor folder must be placed inside a Java source root to ensure it is included during project compilation. {% endhint %}
6. Configure the Interceptor: \ Configuring the Interceptor allows Avo Assure to capture Selenium browser actions and data parameterization during execution, ensuring accurate migration. \ \ To configure the interceptor, perform the following actions: {% hint style="info" %} **Note**: This configuration is a one-time setup. {% endhint %}
Enabling WebDriver Interception In the **BrowserFactory.java** file where the WebDriver is initialized (for example, in a factory class, base class, or any custom setup file), update the driver configuration to use **InterceptWebDriver.** 1\. Add the following import statement to the file: ```java import intercept.InterceptWebDriver; ``` 2. Locate the line where the browser driver is created (for example, new ChromeDriver() or new FirefoxDriver()) and replace it with **InterceptWebDriver**. 1. If your code creates the driver with options: ```java //Before WebDriver driver = new ChromeDriver(options); //After WebDriver driver = new InterceptWebDriver(new ChromeDriver(options)); ``` b. If your code creates the driver without options: ```java //Before WebDriver driver = new ChromeDriver(); //After WebDriver driver = new InterceptWebDriver(new ChromeDriver()); ``` {% hint style="info" %} **Note**: Ensure that every **WebDriver** created in your project uses **InterceptWebDriver**. This applies to all browsers, file names, and initialization methods. {% endhint %} {% hint style="info" %} **How It Works?** **InterceptWebDriver** works along with your existing Selenium driver and captures the actions performed in the browser during execution. It does not change your test scripts. It only records the actions so they can be migrated to Avo Assure. {% endhint %}
Updating testRunner Configuration 1. On the Editor, open **testRunner.java**. 2. Add `"intercept"` to the **glue** parameter. 3. Update the **glue** variable as shown below: ```java glue = { "steps", "intercept" } ``` {% hint style="info" %} **How it works?** * Adding **"intercept"** to the glue parameter in **testRunner.java file** instructs the framework where to look for step definitions related to WebDriver interception. * By updating **glue = { "steps", "intercept" }**, the framework can correctly link your test steps with the interception logic, ensuring smooth execution of tests with the new WebDriver setup. {% endhint %}
Enabling Data Parameterization 1. Add the following code snippet to the **setTestData** function in your common Excel data reader file (such as CommonStepsForTestDataReader.java): ```java import intercept.AvoHooks; AvoHooks.setExcelData(tableValue); ``` {% hint style="info" %} **How it works?** * **tableValue** is the variable that stores the test data from your Excel sheet. It can have multiple rows and columns, depending on your test. * **AvoHooks.setExcelData(tableValue)** lets the automation framework use this data during the test, so your tests can run with different inputs automatically. {% endhint %}
### Generating and Uploading Scenarios To generate and upload Selenium scripts to Avo Assure, perform the following actions: 1. Execute your Selenium automation suite. {% hint style="info" %} **Note**: * The execution generates a **selenium\_testcase\_batch.zip** file at the following location: \ \/target/avo\_intercept\_output. * The ZIP file name must follow the format **selenium\_testcase\_batch.zip**. File names such as selenium\_testcase\_batch1.zip or selenium\_testcase\_batch2.zip are supported. Randomly named ZIP files are not allowed and will fail validation. {% endhint %} 2. Go to **Selenium To Avo** page in Avo Assure. 3. In the **Select Project** dropdown, select the Avo Assure project where you want to import the Selenium test cases.
4. Upload the **selenium\_testcase\_batch.zip** file generated in step 1. {% hint style="info" %} **Note**: The uploaded ZIP file must contain only JSON files. Other file types are not supported. {% endhint %}
5. After uploading the file, select **Start Migration**. The **Migration Status** dialog opens.
6. On the **Migration Status** dialog, the following details are displayed: * **Element Repository Folder** and **Test case Folder** name. * **Test case Name** and migration **Status**. * **Status**: Shows whether a Test case is **SUCCESS**, **FAILED**, or **SKIPPED**. An **Info** (**i**) icon displays the reason for each status. * **Fail**: Migration fails due to an error, such as missing data or missing key in the Test case JSON file. * **Success**: The Test case migrated successfully. * **Skipped**: Migration is skipped because the Test case fails during Selenium execution. * The system provides a downloadable Excel file that contains data parameterization details. Use this Excel file as a reference to review and correct the migrated Test cases in Avo Assure, if required.\ The Excel file includes the following information: * Test case name. * Test Step Group name. * Step details, including whether data parameterization is present. {% hint style="info" %} **Note**: To download the Excel file, the **Download** link is available only when Data Parameterization is configured in your Selenium code. {% endhint %} 7. Select **Ok** to close the **Migration Status** dialog.
{% hint style="info" %} **Note**: After the migration is complete, verify the following: * Review the migrated Test cases for accuracy. * Verify that the test data is mapped correctly. * Manually validate business-critical test scenarios. * Data is parameterized only when you enable Data Parameterization. Otherwise, Avo Assure uses hardcoded values. {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.avoautomation.com/avo-assure/utilities/migration-to-avo/selenium-to-avo/migrating-java-selenium-scripts-to-avo-assure.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.