Karate Mock场景使用bodyPath匹配XML路径时报空指针异常

问题复现 #

使用Karate配置Mock服务时，通过bodyPath()匹配XML请求体节点值编写场景规则，该写法此前运行正常，当前执行抛出空指针异常。
匹配规则代码如下：

Scenario: pathMatches('/some/end/point/v8')
  && methodIs('POST') &&  bodyPath('/xml/path/values/text()') == "4000758341"
  && bodyPath('/xml/path/value/text()') == "2"
  && bodyPath('/xml/request/path/value/text()') == "P"
    * def responseStatus = 200
    * print request
    * def responseHeaders = { 'Content-Type': 'text/xml' }
    * def response  =
"""
"""

运行抛出错误日志：

com.intuit.karate.core.ScriptBridge.xmlPath(ScriptBridge.java:421)
10:06:39.027 [nioEventLoopGroup-3-1] 613209444 WARN com.intuit.karate - scenario match evaluation failed: evaluation (js) failed: pathMatches('/some/end/point/v8')
  && methodIs('POST') &&  bodyPath('/xml/path/values/text()') == "4000758341"
  && bodyPath('/xml/path/value/text()') == "2"
  && bodyPath('/xml/request/path/value/text()') == "P", java.lang.NullPointerException

异常栈定位到com.intuit.karate.core.ScriptBridge.xmlPath(ScriptBridge.java:421)，场景匹配表达式求值失败，抛出java.lang.NullPointerException。

根因分析 #

1. Karate的场景匹配表达式采用从左到右的短路求值逻辑，前序条件返回true才会执行后续条件判断
2. bodyPath()方法执行XML路径取值时没有内置空值校验，当出现以下任意一种情况时，方法返回值为null：
   • 命中路径和方法的请求没有携带请求体
   • 请求体不是合法XML格式
   • 编写的XPath表达式在当前请求XML中不存在匹配节点
   • 请求头Content-Type未声明为XML类型（application/xml/text/xml），Karate未将请求体按XML格式解析
3. 直接将null返回值和字符串做等值比较，就会触发空指针异常。此前写法可正常运行，是因为当时命中该规则的所有请求都满足XML结构、XPath路径、Content-Type的全部要求，没有触发边界场景。

修复方式 #

根据实际场景选择以下任意一种调整方案即可：

• 方案1：在匹配逻辑中增加XML格式校验，提前过滤非XML请求，写法更简洁，适合接口约定请求必须为XML的场景

Scenario: pathMatches('/some/end/point/v8')
  && methodIs('POST') && requestIsXml()
  && bodyPath('/xml/path/values/text()') == "4000758341"
  && bodyPath('/xml/path/value/text()') == "2"
  && bodyPath('/xml/request/path/value/text()') == "P"

• 方案2：对每个bodyPath()的返回值增加非空判断，兼容请求结构不固定的场景

Scenario: pathMatches('/some/end/point/v8')
  && methodIs('POST')
  && bodyPath('/xml/path/values/text()') != null && bodyPath('/xml/path/values/text()') == "4000758341"
  && bodyPath('/xml/path/value/text()') != null && bodyPath('/xml/path/value/text()') == "2"
  && bodyPath('/xml/request/path/value/text()') != null && bodyPath('/xml/request/path/value/text()') == "P"

内容的提问来源于stack exchange，提问作者vidushi sinha