Groovy中如何将Jenkins代理节点工作区路径传入XmlTestRunListener.setReportDir

项目目标 #

尝试在Jenkins节点上使用XmlTestRunListener和InstrumentationResultParser解析adb am instrument -r日志，生成XML测试报告文件。

问题描述 #

XmlTestRunListener的setReportDir方法要求传入File类型参数，但当前代码中硬编码的路径指向Jenkins控制器的文件系统，而非执行任务的代理节点，导致无法在代理节点工作区创建有效文件指针，强制将字符串路径转为File类型也无法解决该问题。

原示例代码 #

def outputXmlDir = new File("/opt/myworkspace") 
def listener = new XmlTestRunListener()
listener.setReportDir(outputXmlDir)
def parser = new InstrumentationResultParser("", listener)
parser.processNewLines("instrument.log")
parser.done() 

解决方案 #

要让File对象指向Jenkins代理节点的工作区，核心是确保代码在代理节点的执行上下文内运行，并使用Jenkins提供的代理节点工作区路径：

1. 将代码包裹在node块中：指定代理节点标签，确保所有文件操作在目标代理节点上执行，而非Jenkins控制器。
2. 使用pwd()获取代理节点工作区路径：该方法返回代理节点当前工作区的绝对路径，基于此创建的File对象会指向代理节点的文件系统。
3. 按需指定子目录：如果需要将报告放在工作区的子目录下，可通过File的构造函数拼接路径。

修改后的代码示例 #

node('your-agent-label') { // 替换为你的代理节点标签
    // 获取代理节点的工作区绝对路径
    def workspacePath = pwd()
    // 创建指向工作区下test-reports目录的File对象
    def outputXmlDir = new File(workspacePath, "test-reports")
    // 确保目录存在（可选，若XmlTestRunListener未自动创建）
    outputXmlDir.mkdirs()

    def listener = new XmlTestRunListener()
    listener.setReportDir(outputXmlDir)
    def parser = new InstrumentationResultParser("", listener)
    // 确保instrument.log存在于代理节点的工作区内
    parser.processNewLines("instrument.log")
    parser.done()
}

关键说明 #

• node块是上下文切换的核心，只有在该块内执行的代码才会在指定的代理节点上运行，文件操作才会映射到代理节点的文件系统。
• pwd()方法返回的路径是代理节点本地的工作区路径，而非Jenkins控制器的路径，以此创建的File对象能被setReportDir正确识别。
• 若需要自定义路径，可基于pwd()返回的路径拼接，避免使用硬编码的绝对路径，保证代码在不同代理节点上的通用性。

内容的提问来源于stack exchange，提问作者S. Kartik