Gauge中文文档(9)—配置

gauge.properties

~/.gauge/config

%APPDATA%\GAUGE\config

GAUGE_ROOT

全局配置

# set to a url, which acts as plugin repository for Gauge.
# gauge插件库下载地址
gauge_repository_url = https://downloads.getgauge.io/plugin 
# set to a url, which holds version information of Gauge.
# This is used to determine if an update is available.
# gauge插件库升级地址
gauge_update_url = https://downloads.getgauge.io/gauge 
# set to an url, which acts as template repository for Gauge.
# gauge模版库下载地址
gauge_templates_url = https://downloads.getgauge.io/templates 
# sets the timeout in milliseconds for making a
# connection to the language runner.
# 连接到language runner的超时时间，时间单位：毫秒
runner_connection_timeout = 30000

# sets the timeout in milliseconds for making a connection
# to plugins (except language runner plugins).
# 连接到除了language runner之外的插件的超时时间，时间单位：毫秒
plugin_connection_timeout = 10000

# sets the timeout in milliseconds for a plugin to stop
# after a kill message has been sent.
# 设置在发送kill消息后插件停止的超时时间，时间单位：毫秒
plugin_kill_timeout = 10000

# sets the timeout in milliseconds for requests from the
# language runner.
# If the size of the project is too big, Gauge may timeout before the
# runner returns the response message. This value can be configured
# accordingly.
# 设置从language runner请求超时，单位毫秒
# 如果项目太大，gauge可能会在runner返回响应消息之前超时。这个值应当设置合理。
runner_request_timeout = 10000

# sets the excluded dirs for gauge.
# Gauge always looks for concepts in the whole project, folders starting
# with dot(.) are excluded and a user can add folders to the excluded
# folders list by passing a comma separeted paths of folder.Paths can be
# relative to the path of directory or absolute.
# 设置gauge排除目录
# gauge通常在整个项目中查找concepts，排除以点(.)开头的文件夹
# 用户可以通过传递逗号分割的文件夹路径来将其添加到排除文件夹列表中
# 文件夹的路径可以相对于目录路径或者绝对路径。
gauge_exclude_dirs = "src/test,bin"

本地配置（项目层级）

env/default/default.properties

# The path to the gauge reports directory. Should be either relative to
# the project directory or an absolute path
# gauge报告目录路径，可以是对于项目的相对路径或者绝对路径
gauge_reports_dir = reports

# Set as false if gauge reports should not be overwritten
# on each execution.
# If set to true, a new time-stamped directory will be
# created on each execution.
# 设置为false则报告在每次执行后不会被覆盖
# 设置为true则每次执行会生成一个新的带时间戳的目录
overwrite_reports = true

# Set to false to disable screenshots on failure in reports.
# 设置为flase则报告中的失败不会截屏
screenshot_on_failure = false

# The path to the gauge logs directory. Should be either relative to the
# project directory or an absolute path
# gauge日志目录路径，可以是对于项目的相对路径或者绝对路径
logs_directory = GaugeLogs

# Specify the level at which cached objects should get removed while
# execution.
# 指定执行时被移除缓存对象的层级
# Possible values for this property are 'suite', 'spec' or 'scenario'.
# default: 'scenario'.
# 可用的属性值：'suite', 'spec' or 'scenario'。
# 默认值：'scenario'.
gauge_clear_state_level = spec
# The above clears the objects after the execution of each specification, so
# that new objects are created for next execution.
# 上述内容在执行每个spec后清除对象，以便创建新对象已供下次执行。

# Set to false to disable screenshots on failure in reports.
# 设置为flase则报告中的失败不会截屏
# （译者注：上面的配置中已经有一个false，只需要配置一个true或者false）
screenshot_on_failure = true

# Path to generate custom report theme.
# Should be either relative to the project directory or an absolute path.
# Default theme is used if not set
# 生成自定义报告主题的路径
# 可以是对于项目的相对路径或者绝对路径
# 如果不设置则使用默认
GAUGE_HTML_REPORT_THEME_PATH = custom_theme_path

环境变量

default

Java

├── env
└── default
├── default.properties
└── java.properties

创建新环境变量

ci

env

ci

user.properties

├── env
├── ci
|── user.properties
|── default
├── default.properties
└── java.properties

通过环境变量执行

env

ci

环境优先级

--env

env/default

--env

default

default

--env

default

default

--env

示例

gauge run specs

<project_root>/env/default

<project_root>/env/default

default

gauge run --env==java_ci specs

<project_root>/env/java_ci

<project_root>/env/java_ci

java_ci

default

gauge_reports_dir=newReportsDir gauge run specs

gauge_reports_dir=newReportsDir

gauge run specs

gauge_reports_dir

env/default

newReportsDir

gauge_reports_dir=newReportsDir gauge run --env=java_ci specs

gauge_reports_dir=newReportsDir

gauge run --env=java_ci specs

java_ci

default

gauge_reports_dir

newReportsDir

语言插件

一般情况

Java

env/default/java.properties

# Specify an alternate Java home if you want to use a custom version.
# 如果你想使用自定义版本，指定备用的java home路径
gauge_java_home = PATH_TO_JAVA_HOME

# Use this property if you need to override the build path for the
# project.
# Note: IntelliJ out directory will be usually auto-detected.
# 使用此属性如果你想为此项目覆盖构建路径
# 备注：Intellij输出路径通常会自动检测
gauge_custom_build_path = PATH_TO_CUSTOM_BUILDPATH

# Specify the directory where additional libraries are kept.
#   You can specify multiple directory names separated with a comma `,`
#   `libs` directory in the gauge project is added by default.
# 指定额外库保存目录，您可以指定多个目录名字以逗号`,`隔开
# `libs`目录在gauge项目中默认被添加
gauge_additional_libs = libs/*, PATH_TO_NEW_LIBRARY

# Specify the JVM arguments passed to java while launching.
# 在执行时传递给java的指定JVM参数
gauge_jvm_args = <JVM_ARGS>

HTTP代理

无认证

HTTP_PROXY

有认证

HTTP_PROXY

构建工具

Maven

从archetype创建新项目

在IDE创建gauge maven项目

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion>

<groupId>com.foo</groupId>
<artifactId>my-gauge-tests</artifactId>
<version>1.0-SNAPSHOT</version>

<dependencies>
<dependency>
<groupId>com.thoughtworks.gauge</groupId>
<artifactId>gauge-java</artifactId>
<version>0.2.2</version>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<testSourceDirectory>${project.basedir}/src/test/java</testSourceDirectory>
<plugins>
<plugin>
<groupId>com.thoughtworks.gauge.maven</groupId>
<artifactId>gauge-maven-plugin</artifactId>
<version>1.0.3</version>
<executions>
<execution>
<phase>test</phase>
<configuration>
<specsDir>specs</specsDir>
</configuration>
<goals>
<goal>execute</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

使用maven执行specs

仅仅执行gauge specs

运行对应pom.xml中特定测试配置文件的gauge specs

并行执行specs

通过tags执行specs

指定执行环境

所有其他属性

parallel

Gradle

项目中使用插件

apply plugin: 'java'
apply plugin: 'gauge'
apply plugin: 'application'

group = "my-gauge-tests"
version = "1.0.0"

description = "My Gauge Tests"

buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.thoughtworks.gauge.gradle:gauge-gradle-plugin:+'
}
}

repositories {
mavenCentral()
}

dependencies {
}

// configure gauge task here (optional)
gauge {
specsDir = 'specs'
inParallel = true
nodes = 2
env = 'dev'
tags = 'tag1'
additionalFlags = '--verbose'
}

执行specs

并行执行specs

通过tags执行specs

指定执行环境

所有其他属性

parallel

添加/配置自定义gauge任务

GaugePlugin

task gaugeDev(type: GaugeTask) {
doFirst {
gauge {
specsDir = 'specs'
inParallel = true
nodes = 2
env = 'dev'
additionalFlags = '--verbose'
}
}
}

task gaugeTest(type: GaugeTask) {
doFirst {
gauge {
specsDir = 'specs'
inParallel = true
nodes = 4
env = 'test'
additionalFlags = '--verbose'
}
}
}

Ant Task

build.xml

<target name="specs">
<exec executable="gauge">
<arg value="specs"/>
</exec>
</target>