ExcelBDD PHP Guideline

在PHP里面支持利用Excel的BDD,也支持利用Excel进行参数化测试

ExcelBDD

Use Excel file as BDD feature file, get example data from Excel files, support automation tests.

Features

The main features provided by this library are:

  • Read test data according to BDD from excel files.
  • Read test data according to Table from excel files.

Install

Install the library using composer Opens in new window or tab:

复制代码
composer require excelbdd/excelbdd

or

php composer.phar require excelbdd/excelbdd

Excel BDD Tool Specification By ExcelBDD Method

This tool is to get BDD test data from an excel file, its requirement specification is below

Examples

Read Simple BDD data

The above is the simple BDD format for most usage.

php 复制代码
<?php
use PHPUnit\Framework\TestCase;
use ExcelBDD\Behavior;

final class BehaviorTest extends TestCase
{
    public static function BehaviorgetExampleListProvider(): array
    {
        $excelFile = "./BDDExcel/ExcelBDD.xlsx";
        $sheetName = "Sheet1";
        return Behavior::getExampleList($excelFile, $sheetName, "", "wrong");
    }

    /** @dataProvider BehaviorgetExampleListProvider */
    public function testBehaviorgetExampleList($ParamName1, $ParamName2, $ParamName3, $ParamName4)
    {
        echo $ParamName1, $ParamName2, $ParamName3, $ParamName4, "\n";
        $this->assertSame(strpos($ParamName1, "V1"), 0);
        $this->assertSame(strpos($ParamName2, "V2"), 0);
    }
}

Input vs Expect + Test Result Format - SBT - Specification By Testcase

testcase example is below, which uses headerMatcher to filter the data

php 复制代码
    public static function BDDSBTDataProvider(): array
    {
        $excelFile = "../Java/src/test/resources/excelbdd/ExcelBDD.xlsx";
        $sheetName = "SBTSheet1";
        return Behavior::getExampleList($excelFile, $sheetName, "Scenario");
    }


    #[DataProvider('BDDSBTDataProvider')]
    public function testBDDSBTExampleList($ParamName1, $ParamName1Expected, $ParamName1TestResult, $ParamName2, $ParamName2Expected, $ParamName2TestResult, $ParamName3, $ParamName3Expected, $ParamName3TestResult, $ParamName4, $ParamName4Expected, $ParamName4TestResult)
    {
        echo "===testBDDSBTExampleList===", "\n";
        echo $ParamName1, $ParamName1Expected, $ParamName1TestResult, $ParamName2, $ParamName2Expected, $ParamName2TestResult, $ParamName3, $ParamName3Expected, $ParamName3TestResult, $ParamName4, $ParamName4Expected, $ParamName4TestResult, "\n";
        $this->assertSame(strpos($ParamName1, "V1"), 0);
        $this->assertSame(strpos($ParamName2, "V2"), 0);
        $this->assertSame($ParamName1TestResult,"pass");
    }

Input vs Expected

ExcelBDD can detect 3 parameter-header patterns automatically, the last one is below.

php 复制代码
    public static function BDDExpectedDataProvider(): array
    {
        $excelFile = "../Java/src/test/resources/excelbdd/ExcelBDD.xlsx";
        $sheetName = "Expected1";
        return Behavior::getExampleList($excelFile, $sheetName);
    }


    #[DataProvider('BDDExpectedDataProvider')]
    public function testBDDExpectedExampleList($ParamName1, $ParamName1Expected, $ParamName2, $ParamName2Expected, $ParamName3, $ParamName3Expected, $ParamName4, $ParamName4Expected)
    {
        echo "===testBDDSBTExampleList===", "\n";
        echo $ParamName1, $ParamName1Expected, $ParamName2, $ParamName2Expected, $ParamName3, $ParamName3Expected, $ParamName4, $ParamName4Expected, "\n";
        $this->assertSame(strpos($ParamName1, "V1"), 0);
        $this->assertSame(strpos($ParamName2, "V2"), 0);
    }

Read table data

php 复制代码
<?php
use PHPUnit\Framework\TestCase;
use ExcelBDD\Behavior;
use PHPUnit\Framework\Attributes\DataProvider;

final class BDDTest extends TestCase
{
    public static function TableDataProvider(): array
    {
        $excelFile = "../Java/src/test/resources/excelbdd/DataTable.xlsx";
        $sheetName = "DataTable2";
        return Behavior::getExampleTable($excelFile, $sheetName);
    }

    #[DataProvider('TableDataProvider')]
    public function testTableData($Header01, $Header02, $Header03, $Header04, $Header05, $Header06, $Header07, $Header08)
    {
        echo $Header01, $Header02, $Header03, $Header04, $Header05, $Header06, $Header07, $Header08, "\n";
        $this->assertStringContainsString("Value1", $Header01);
    }
}

API

Behavior::getExampleList

public static function getExampleList(string excelFile, string sheetName = null, string headerMatcher = null, string headerUnmatcher = null): array

  1. $excelFile: excel file path and name, relative or absolute
  2. $sheetName: sheet name, optional, default is the first sheet in excel file
  3. $HeaderMatcher: filter the header row by this matcher, if matched, this set will be collected in. optional, default is to select all.
  4. $HeaderUnmatcher: filter the header row by this matcher, if matched, this set will be excluded. optional, default is to exclude none.

Behavior::getExampleTable

public static function getExampleTable(excelFile, sheetName = null, headerRow = 1, startColumn = '`'): array

  1. $excelFile: excel file path and name, relative or absolute
  2. $sheetName: sheet name, optional, default is the first sheet in excel file
  3. $headerRow: the number of header row, optional, default is 1
  4. $startColumn: the char of first data area, optional, default is auto detect

ExcelBDD PHP Guideline 线上版维护在 ExcelBDD PHP Guideline on Azure

ExcelBDD开源项目位于 ExcelBDD Homepagehttps://dev.azure.com/simplopen/ExcelBDD

相关推荐
我爱Jack10 分钟前
时间与空间复杂度详解:算法效率的度量衡
java·开发语言·算法
米饭「」11 分钟前
C++AVL树
java·开发语言·c++
心愿许得无限大44 分钟前
Qt 常用界面组件
开发语言·c++·qt
2401_858286111 小时前
OS15.【Linux】gdb调试器的简单使用
linux·运维·服务器·开发语言·gdb
牛马baby1 小时前
MATLAB下载安装教程(附安装包)2025最新版(MATLAB R2024b)
开发语言·matlab
shenyan~1 小时前
关于 c、c#、c++ 三者区别
开发语言·c++
Ashlee_code1 小时前
什么是Web3?金融解决方案
开发语言·金融·架构·eclipse·web3·区块链·php
Evand J1 小时前
【MATLAB例程】AOA与TDOA混合定位例程,适用于三维环境、4个锚点的情况,附下载链接
开发语言·matlab
机器视觉知识推荐、就业指导1 小时前
Qt 与Halcon联合开发八: 结合Qt与Halcon实现海康相机采图显示(附源码)
开发语言·数码相机·qt
Heartoxx2 小时前
c语言-指针与一维数组
c语言·开发语言·算法