接口测试之——Karate框架搭建

vlambda
2020-09-04

接口测试之——Karate框架搭建

相信做过接口测试的童鞋都习惯用Jmeter，Rest-Assured，Postman来编写，可能对Karate还比较陌生。KarateDSL是一种新的API测试工具，它帮助以一种简单的方式为基于API的BDD测试创建场景，而无需编写步骤定义。

之前项目用Karate做API测试，跟着开发写了一段时间API测试代码，我发现只需一点编程基础就能轻松上手，现在Karate已经成为Top10的API工具了，于是呼我决定普及一下，说一说Karate的框架搭建。

搭建Karate框架

1.创建一个gradle/maven工程，以下以gradle为例

接口测试之——Karate框架搭建

2.然后在build.gradle文件里添加所需要得jar包

testCompile 'com.intuit.karate:karate-junit4:0.9.2'
testCompile 'com.intuit.karate:karate-apache:0.9.2'

3.再在build.gradle里添加以下配置

为什么要添加这个配置呢，因为Karate测试有文件扩展名.feature，一般gradle是将非java源文件存放在src/test/resources结构中，配置这个得目的是将非java源文件与.java文件可以放在并排的位置，让程序知道src/test/java下.java以外的文件都是资源文件。

sourceSets { test { resources { srcDir file('src/test/java') exclude '*/.java' } }

接口测试之——Karate框架搭建

4.添加日志配置文件

<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%npattern> encoder> appender> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>target/karate.logfile> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%npattern> encoder> appender> <logger name="com.intuit.karate" level="DEBUG"/> <root level="info"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /> root> configuration>

接口测试之——Karate框架搭建

5.添加karate配置文件 karate-config.js

这里面的配置都是全局配置，在执行每个Scenario前都会先获取karate-config里的配置，当然不存在这个文件也可以正常工作，具体根据你的工程来决定。

karate.configure可以设置很多参数的值，具体可以参见git hub上Managing Headers, SSL, Timeouts and HTTP Proxy，这里有一个例子：

接口测试之——Karate框架搭建

我们项目的配置：

function config() { karate.configure('connectTimeout', 10000);//设置连接超时时间10s karate.configure('readTimeout', 10000);//设置读取超时时间10s karate.configure('logPrettyRequest', true);//使用缩进打印请求 karate.configure('logPrettyResponse', true);//使用缩进打印响应 karate.configure('retry', {count: 3, interval: 2000});//设置重试机制为3次，间隔时间为2s

var env = karate.env;//获取java系统属性“kara .env”，跑流水线时传入env参数值，可以在不同的环境运行api测试

if (!env) { env = 'sit'; } var config = read('classpath:karate-env.json')[env];

//这里是读取env配置文件，相当于我们是把上面例子的config文件写在了一个karate-env.json文件中，由于我们有多个环境，每个环境以对象的形式存储，当想获取某个环境的数据时，直接把对象名传过去就能获取到该环境的所有全局变量了

var customerInfo = karate.callSingle( 'classpath:apiTests/toC/common/customer/customer.feature', config);

//这里使用 karate.callSingle方法将配置传入customer.feature文件下面，也可以使用call方法，callSingle与call方法的区别是执行Scenario时call每执行一次调一次，而callSingle只会在第一次执行时调用，后面取之前执行的缓存。customer.feature是用来获取用户token的

config.customerToken = customerInfo.customerToken; config.customerId = customerInfo.customerId; return config; }

接口测试之——Karate框架搭建

6.添加运行案例的类

由于我们希望用例并行运行，这里面我们使用Runner.parallel方法，可以参考官方文档

接口测试之——Karate框架搭建

下的DemoTestParallel类，如果是想串行运行，直接用@RunWith(Karate.class)即可。

@Test public void testParallel() { Results results = Runner.parallel(getClass(), 5);//设置5个线程，并行运行

generateReport(results.getReportDir());//输出报告，在执行每个特性之后，HTML报告将输出到target/surefire-reports文件夹，你也可以自己定义报告输出路径

Assert.assertTrue(results.getErrorMessages(), results.getFailCount() == 0); } public static void generateReport(String karateOutputPath) {

Collection 
     
       jsonFiles = FileUtils.listFiles( 
      new File(karateOutputPath), 
      new 
      String[] { 
      "json"}, 
      true);

List<String> jsonPaths = new ArrayList(jsonFiles.size()); jsonFiles.forEach(file -> jsonPaths.add(file.getAbsolutePath()));

Configuration config = new Configuration(new File("target"), "demo");//这里的target填写报告文件根目录，demo是填写你的工程名称

ReportBuilder reportBuilder = new ReportBuilder(jsonPaths, config); reportBuilder.generateReports(); }

这里由于有些包没有引入导致部分类找不到，需要在gradle下引入这些包：

testCompile 'commons-io:commons-io:2.5'
testCompile 'net.masterthought:cucumber-reporting:3.8.0'

接口测试之——Karate框架搭建

在这里，如果我们不想要全部案例都运行，我们可以使用@KarateOptions注解，可以选择想要运行的案例，例子：

//运行1个feature @KarateOptions(features = "classpath:animals/cats/cats-post.feature") //运行多个feature @KarateOptions(features = { "classpath:animals/cats/cats-post.feature", "classpath:animals/cats/cats-get.feature"}) //运行features 在classpath:animals/cats路径下的，且tag非@ignore的 @KarateOptions(features = "classpath:animals/cats", tags = "~@ignore") //运行tags为非@ignore，且含@customer、@bargain的 @KarateOptions(tags = {"~@ignore", "@customer", "@bargain"})

7、下面可以开始写feature了，feature格式如下：

Feature \描述该特性的测试内容
Background\这里是场景执行的前置条件，一般在这里定义该特性的全局变量，在每个Scenario执行前都会执行
Scenario\这里是执行步骤，如我要测试创建拼团活动的api，对拼团活动进行创建，判断是否创建成功

Feature: brief description of what is being tested more lines of description if needed. Background: -this section is optional ! -steps here are executed before each Scenario in this file -variables defined here will be 'global' to all scenarios -and will be re-initialized before every scenario Scenario: brief description of this scenario -steps for this scenario Scenario: a different scenario -steps for this other scenario

如下，是一个创建商品的feature，在接口测试中，有几个最重要的项：
1、url
2、header
3、请求参数

首先，我们要保证我们拿到的接口能正常调通，可以在postman试验：

接口测试之——Karate框架搭建

可以看到，我们在background里配了url及headers，background里的配置运用于所有的scenario，然后定义参数，这里我们使用read()方法读取variables.json文件获取入参，然后使用post方式发送请求，获取response，比较response和期望的结果是否一致，如果一致就pass，不一致就抛出错误。

接口测试之——Karate框架搭建