SeleniumWebDriverとJavaを使って自動テストを行う際、データ駆動テストを行いたいときがあります。

データ駆動とは

テストの入力値と期待結果を、表やスプレッドシートの形でデータとして保持し、このデータ表に含まれる全てのテストを１つの制御スクリプトで実行できるようにしたスクリプティング技法。（システムテスト自動化標準ガイド　より）

です。

たとえばAmazonで商品を購入する場合、

  • 非会員／通常会員／プライム会員
  • 送料有料／無料
  • 通常配送／お急ぎ便

など、いろいろな選択肢があります。

これらの選択肢の組合せを自動でテストしたい、と思ったとき、それぞれの組合せに対して独立に自動テストスクリプトを書いていては、メンテナンスも大変ですし、新しい組合せを追加するのも手間がかかります。

そこで、これらの組合せをExcelなどの表にもたせておいて、１つの「商品を購入する」という自動テストスクリプトに読ませると、表に従って様々なパターンのテストを行ってくれます。

そうすると、メンテナンスをする自動テストスクリプトは組合せのパターン数によらず一つですし、もし組合せが漏れていたり、新しい組合せを追加したいと思ったら、表を更新するだけで済みます。

といった具合に効果を発揮するのがデータ駆動テストです。

（※テストの自動化を行う場合には必ずデータ駆動にしたほうがいい、という話ではありません。念の為。）

このデータ駆動テストを、JavaでSeleniumWebDriverで使うサンプルを紹介します。

Java+Selenium+ApachePOIでデータ駆動

必要なもの

データ駆動に使う表は、Excelの表を読み込ませて行おうと思います。

JavaでExcelの読み書きをするのにはApache POIというライブラリを使います。

Apache POI – the Java API for Microsoft Documents

mavenを使う場合はpom.xmlに以下を追加。

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.17</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.17</version>
</dependency>

.xlsxを読む処理を作成

まず、そもそものExcelファイルを読み込む処理を書きます。

private static XSSFSheet ExcelWSheet;
private static XSSFWorkbook ExcelWBook;

public static void setExcelFile(String Path, String SheetName) {
    try {
        FileInputStream ExcelFile = new FileInputStream(Path);
        ExcelWBook = new XSSFWorkbook(ExcelFile);
        ExcelWSheet = ExcelWBook.getSheet(SheetName);
    } catch (Exception e) {
        System.out.println(e.getStackTrace());
    }
}

これで、Excelファイルのパスと、シート名を渡すと、内容を取得できるようになります。

あとは、シートのセルを読み込んでいく処理が必要です。

今回はデータ駆動テストのため、指定したシートのA列には必ず「テストケースID」が設定されていて、1行目はラベル行である、とします。

もしラベル行に同じ値のセルが複数あった場合、正常に動作しないのでご注意ください。

public static String getCellValue(String caseID, String colLabel) {
    try {
        Cell = ExcelWSheet.getRow(getRowNumOf(caseID)).getCell(getColNumOf(colLabel));
    } catch (Exception e) {
        e.printStackTrace();
    }
    String CellData = Cell.getStringCellValue();
    return CellData;
}

private static int getRowNumOf(String TestID) {
    try {
        for (int i = 1; i <= ExcelWSheet.getLastRowNum(); i++) {
            Cell = ExcelWSheet.getRow(i).getCell(0);
            if (Cell.getStringCellValue().equals(TestID)) {
                return i;
            }
        }
    } catch (Exception e) {
        return -1;
    }
    return 0;
}

private static int getColNumOf(String colName) {
    try {
        for (int j = 1; getCellData(0, j).length() > 0; j++) {
            Cell = ExcelWSheet.getRow(0).getCell(j);
            if (Cell.getStringCellValue().equals(colName)) {
                return j;
            }
        }
    } catch (Exception e) {
        return -1;
    }
    return 0;
}

便宜上３つのメソッドに分けていますが、使いたいのはgetCellValueです。

これに、ケースIDと列ラベルを渡すと、該当するセルの値を取得します。

先のAmazonでの商品購入の例で言うと、たとえば「ケース2の発送列の値」を取得したいと思ったら、getCellValue("ケース2", "発送")です。

使用例

Excelの表を読み込んで、そこに書かれた値をGoogle検索する、という例を作りました。

private static WebDriver driver;
private String caseID;

// DataTableを読み込む
private static void importDataTable() {
    try {
        // Excelのデータテーブルのパスとシート名を指定
        ExcelUtils.setExcelFile("C:\\DataTable.xlsx", "Sheet1");
    } catch (Exception e) {
        e.printStackTrace();
    }
}

@Parameters(name = "{0}")
public static Collection<Object[]> TestcaseIdList() {
    importDataTable();
    return getTestCases();
}

public SearchOnGoogle(String input) {
    this.caseID = input;
}

@Before
public void before() {
    System.setProperty("webdriver.chrome.driver", "C:\\pleiades\\workspace\\webdriver\\chromedriver.exe");
    driver = new ChromeDriver();
}

@Test
public void Test() {
    // Googleを開く
    driver.get("http://google.com");

    // Excelのシートから読み込んだ文字列を検索欄に入れる
    driver.findElement(By.id("lst-ib")).sendKeys(getCellValue(caseID, "keyword"));
}

ApachePOIで読み込んだExcelのシートの内容を、JUnit4のparametersアノテーションを使って繰り返し実行させることで、データ駆動テストを実現しています。

動くサンプル作って置きました

YoshikiIto/selenium-junit4-datadriven-sample

を見てみてください。

参考