CukeTest自动化API

CukeTest提供了用于操作和获取自身各种属性的库，库的名称就叫做cuketest。

这个库只用来自动化CukeTest，如果你需要自动化其它应用，请使用以"leanpro."为前缀的是自动化API包，详情可参见附录：CukeTest自动化API。

如何引入

使用下面的代码引入cuketest库。或直接从“工具箱” -> “Cucumber” 中拖拽相关的自动化操作生成。

JavaScript
Python
const {CukeTest} = require("cuketest");
from leanproAuto import CukeTest

cuketest库的介绍

cuketest库的主要对象为CukeTest，该对象的类型定义如下：

JavaScript
Python
export class CukeTest {
    static minimize(): void;
    static maximize(): void;
    static restore(): void;
    static connect(options: ClientConnectOptions, caps?: DesiredCapabilities | ICapabilities): Promise<IAuto>;
    static info(): Promise<RunInfo>;
}
class CukeTest(SyncBase):
	def minimize(self) -> None
	def maximize(self) -> None
	def restore(self) -> None
	def info(self, key: Optional[str]=None) -> TypedDict

例如，下面的代码可以用来在测试运行期间最小化整个CukeTest窗口，然后在测试完成之后恢复CukeTest窗口大小:

JavaScript
Python
const {CukeTest} = require("cuketest");
CukeTest.minimize();

//…执行测试操作…//

CukeTest.restore();
from leanproAuto import CukeTest

CukeTest.minimize()

# 执行测试操作

CukeTest.restore()

自动化API

下面是API的使用说明：

minimize()

最小化CukeTest窗口。

  • 返回值: 不返回任何值。

maximize()

最大化CukeTest窗口。

  • 返回值: 不返回任何值。

restore()

将CukeTest窗口恢复到正常大小。等效于点击右击窗口时会出现的“还原”选项。

  • 返回值: 不返回任何值。

connect(options: ClientConnectOptions, caps?: DesiredCapabilities)

连接到远程自动化的执行端(Worker)。返回远程自动化auto对象。更多信息查看远程自动化

info():Promise<RunInfo>

获取运行时的信息，这些信息将作为一个对象返回。

运行时信息对象RunInfo

JavaScript
interface RunInfo {
    readonly argv: string[];
    readonly profile: Profile;
}

  • argv: string[]字符串数组类型，由传入CukeTest的命令行参数组成的数组，形如["--run", "--format", "html"]。
  • profile: Profile对象，表示当前运行配置的对象。

运行配置对象Profile

用来表示运行配置情况的对象，类型定义如下：

JavaScript
interface Profile {
    name: string,
    format: string[],
    out: string,
    screenId: string,
    screenName: string,
    runItems: string[],
    custom: string
}

  • name: string类型，运行配置的名称。
  • format: string[]类型，报告输出类型，支持选项参考运行配置：报告格式。
  • out: string类型，报告输出目录，不指定则为空，报告会生成于项目的reports文件夹中。
  • screenId: string类型，录制的屏幕编号，用于录制运行视频，为空则不录制。
  • screenName: string类型，录制的屏幕名称，跟screenId一样的作用，用于录制运行视频，为空则不录制。
  • runItems: string[]类型，运行序列。
  • custom: string类型，自定义参数。

比如，在脚本运行中希望获取当前运行配置的名称，则可以写作如下：

JavaScript
const { CukeTest } = require("cuketest");
let info = await CukeTest.info();
console.log(`当前运行配置的名称为: ${info.profile.name}`)

results matching ""

全部 API Walkthrough 其他

    No results matching ""