Jenkinsfile 并允许一个中止的 bat() 命令时间来清理

Question

我有一个 Python 脚本，它是测试系统的一部分，它在多个 [Windows] 机器上调用许多第三方工具/进程，因此被设计为在使用 CTRL-C 中止时全面/仔细地清理；清理可能需要几秒钟，具体取决于发生的情况。此清理过程在 [Windows] 命令提示符下运行良好。

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

但是，我需要能够在 Jenkins [v2.263.4] 运行期间执行中止/清理，即当有人按下红色小 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 中是否有其他方法可以解决这个问题？

Answer 1

经过深思熟虑，感谢我们的工具人员在 Jenkins 中发现了关键的“cookie”实现细节，[在 Windows 上] 控制中止过程的解决方法如下：

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

这很重要，而且完全是因为 Jenkins 中缺乏相对简单的 API。

Answer 2

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

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