Keyword Driven Framework in Selenium

  

What is a Keyword Driven Framework?

A Keyword Driven Framework is a type of automation framework where test cases are written in an external file (like Excel) using keywords that represent actions (example: openBrowser, click, enterText, etc.).

Selenium reads the keywords at runtime and executes corresponding actions.


Benefits of Keyword Driven Framework


FeatureBenefit
Non-programmers can writeBusiness/test teams can create tests in Excel
High reusabilityKeywords/actions are reusable across tests
Easy maintenanceNo changes in code if data or sequence changes
Data + Action separationTest steps (keywords) are separated from Selenium logic


Example: Keyword Driven Framework

Project Structure


KeywordDrivenFramework/ ├── pom.xml ├── TestSteps.xlsx └── src/ └── test/ ├── java/ │ ├── keywords/ │ │ └── ActionKeywords.java │ ├── tests/ │ │ └── KeywordEngine.java


Step 1: TestSteps.xlsx

StepNoKeywordLocatorTypeLocatorValueTestData
1openBrowserchrome
2navigatehttps://example.com
3enterTextidusernameuser1
4enterTextidpasswordpass123
5clickidlogin
6closeBrowser


Step 2: Maven Dependencies for pom.xml

<dependencies>
    <dependency>
        <groupId>org.seleniumhq.selenium</groupId>
        <artifactId>selenium-java</artifactId>
        <version>4.18.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.2.3</version>
    </dependency>
</dependencies>


Step 3: ActionKeywords.java - Core actions

package keywords;

import org.openqa.selenium.*;
import org.openqa.selenium.chrome.ChromeDriver;

public class ActionKeywords {
    public static WebDriver driver;

    public static void openBrowser(String browserName) {
        if (browserName.equalsIgnoreCase("chrome")) {
            driver = new ChromeDriver();
        }
    }

    public static void navigate(String url) {
        driver.get(url);
    }

    public static void enterText(String locatorType, String locatorValue, String data) {
        WebElement element = getElement(locatorType, locatorValue);
        element.sendKeys(data);
    }

    public static void click(String locatorType, String locatorValue) {
        WebElement element = getElement(locatorType, locatorValue);
        element.click();
    }

    public static void closeBrowser() {
        driver.quit();
    }

    private static WebElement getElement(String locatorType, String locatorValue) {
        switch (locatorType.toLowerCase()) {
            case "id":
                return driver.findElement(By.id(locatorValue));
            case "name":
                return driver.findElement(By.name(locatorValue));
            case "xpath":
                return driver.findElement(By.xpath(locatorValue));
            case "css":
                return driver.findElement(By.cssSelector(locatorValue));
            default:
                throw new IllegalArgumentException("Invalid locator: " + locatorType);
        }
    }
}


Step 4: KeywordEngine.java – Reads Excel and executes actions

package tests;

import keywords.ActionKeywords;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import java.io.FileInputStream;

public class KeywordEngine {

    public static void main(String[] args) {
        try {
            FileInputStream fis = new FileInputStream("TestSteps.xlsx");
            Workbook workbook = new XSSFWorkbook(fis);
            Sheet sheet = workbook.getSheetAt(0);

            for (int i = 1; i <= sheet.getLastRowNum(); i++) {
                Row row = sheet.getRow(i);

                String keyword = row.getCell(1).getStringCellValue();
                String locatorType = row.getCell(2) != null ? row.getCell(2).getStringCellValue() : "";
                String locatorValue = row.getCell(3) != null ? row.getCell(3).getStringCellValue() : "";
                String testData = row.getCell(4) != null ? row.getCell(4).getStringCellValue() : "";

                switch (keyword.toLowerCase()) {
                    case "openbrowser":
                        ActionKeywords.openBrowser(testData);
                        break;
                    case "navigate":
                        ActionKeywords.navigate(testData);
                        break;
                    case "entertext":
                        ActionKeywords.enterText(locatorType, locatorValue, testData);
                        break;
                    case "click":
                        ActionKeywords.click(locatorType, locatorValue);
                        break;
                    case "closebrowser":
                        ActionKeywords.closeBrowser();
                        break;
                    default:
                        System.out.println("Unknown keyword: " + keyword);
                }
            }

            workbook.close();
            fis.close();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

No comments:

Post a Comment