Jenkinsfile 并允许中止的 `bat()` 命令时间进行清理

Jenkinsfile and allowing an aborted `bat()` command time to clean up

我有一个 Python 脚本,它是在多台 [Windows] 机器上调用许多第三方 tools/processes 的测试系统的一部分,因此旨在清理 comprehensively/carefully 当使用 CTRL-C 中止时;清理可能需要很多秒,具体取决于发生的事情。此清理过程在 [Windows] 命令提示符下运行良好。

我 运行 Python 来自 [脚本化管道] Jenkinsfile 的脚本,使用 return_value = bat("python my_script.py params", returnStatus: true),它也可以正常工作。

但是我需要能够在 Jenkins [v2.263.4] 运行 期间执行 abort/clean-up,即当有人按下红色的小 X 时,我无法理解这一点.我知道 Jenkins 在按下中止按钮时发送 SIGTERM 所以我将其捕获在 my_script.py:

SAVED_SIGTERM_HANDLER = signal(SIGTERM, sigterm_handler)

...和 ​​运行 我通常也会从 sigterm_handler() 中的 KeyboardInterrupt 调用进程,但它们没有被调用。我知道 Jenkins 控制台的 IO 流在按下中止按钮时停止;通过从“另一边”查看我的脚本的行为,我可以看到清理函数没有被调用:看起来 my_script.py 只是停止了,来自它的所有连接按下中止按钮的那一刻,没有清理。

任何人都可以建议一种在 Jenkins 中制作中止按钮的方法,让我的 bat()ed Python 脚本有时间进行清理吗?或者我只是做错了什么?或者在 Jenkins 中是否有我遗漏的其他方法?

您应该能够使用“post”操作来执行任何需要的清理:https://www.jenkins.io/doc/book/pipeline/syntax/#post

我知道这没有考虑您已有的清理逻辑,但这可能是最安全的做法。也许将清理逻辑分离到一个单独的脚本中并使其幂等,然后无论在管道的末尾如何调用它都可以调用它,如果它已经 运行 那么它应该什么都不做,如果 运行再次.

经过大量研究,并感谢我们的工具人员在 Jenkins 中发现了关键的“cookie”实现细节,[在 Windows] 控制中止过程的解决方法如下:

  • 让 Jenkins 调用一个包装器,让我们称之为 (a),然后打开一个套接字或一个命名管道(套接字可以在 Linux 和 Windows 上工作),
  • (a) 然后通过“开始”启动 (b),以便 (b) 运行s 作为一个单独的进程,但至关重要的是,(a) 传递给 (b) 的环境必须具有JENKINS_SERVER_COOKIE="ignore" 添加到它; Jenkins 使用此标志来查找它已启动的进程以杀死它们,因此您必须将此“cookie”设置为“忽略”以阻止 Jenkins 杀死 (b),
  • (b) 通过套接字或管道连接回 (a),
  • 只要 (b) 连接到套接字或管道,
  • (a) 就会保持 运行ning,但也会让自己被 CTRL-C/SIGTERM、
  • 杀死
  • (b) 然后启动您真正想要的东西 运行,
  • 当 (a) 被 Jenkins 中止终止时 (b) 通知(因为套接字或管道将关闭)并在 (b) 之前执行您想要 运行 的受控关闭退出,
  • 单独做一个东西,我们称之为(c),它检查 socket/named-pipe 是否存在:如果存在则 (b) 尚未终止,
  • 在 Jenkinsfile 中,将 (a) 的调用包装在 try()/catch()/finally() 中,并从 finally() 中调用 (c),从而确保Jenkins 管道仅在 (b) 终止时结束(为了安全起见,您可能需要添加一个保护计时器)。

非常重要,但在 Jenkins 中缺少相对简单的 API。