有没有办法通过 Jenkins 脚本控制台使用时髦的脚本清理 Jenkins Worflowjob 工作区?



为什么又是这种类型的问题?

这个问题似乎被问过很多次了,但所有的答案都与 Jenkins Pipeline 作业(插件:workflow-job)相关。

情况

我正在将一堆旧的自由式作业从旧的 Jenkins 独立服务器迁移到分布式 Jenkins env,我决定将它们转换为 Jenkins 管道作业(不能使用 Blue ocean,因为 SCM 是 SVN。

无论如何,对于某些工作,不希望清理其工作区,因为它们是一种理智/验证工作,并且因为SVN结帐和构建内容的大小很大(20K文件中为2GB,只是删除它太慢了)。

但是,我偶尔(临时)需要删除此类作业的工作区。而且我不想通过以下方式做到这一点:

  • 修改 Jenkinsfile 并将其提交到 SVN
  • "重播"管道通过修改运行

而且我无法在该从属节点上访问 FS(这将是最简单的事情)。

谷歌搜索

互联网上的快速搜索使我雪崩了数十个结果[1,2,3,4,...]如何从Jenkins脚本控制台运行的Groovy脚本中清理WS()。

不幸的是,他们都没有尝试删除作业的真正org.jenkinsci.plugins.workflow.job.WorkflowJob项实例的工作区。

我的时髦尝试清理WS

根据从互联网上收集的答案,我启动了我的Groovy清理脚本,该脚本可以从Jenkins脚本控制台执行<Jenkins:port/script>

import hudson.model.*
import com.cloudbees.hudson.*
import com.cloudbees.hudson.plugins.*
import com.cloudbees.hudson.plugins.folder.*
import org.jenkinsci.plugins.workflow.job.*
//jobsToRetrieve = ["aFolder/aJobInFolder","topLevelJob"]
jobsToRetrieve = ["Sandbox/PipelineTests/SamplePipeline"]
enumerateItems(Hudson.instance.items)
def enumerateItems(items) {
items.each { item ->
println("===============::: GENERAL INFO::: =======================")
println(" item: " + item)
println(" item FN:  " + item.fullName)
println(" item.getClass " + item.getClass())
println("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~")
if ( !(item instanceof Folder)) {
jobName = item.getFullDisplayName()
println(" :::jobname::: " + jobName)
if (jobsToRetrieve.contains(item.getFullName())) {
if (item instanceof WorkflowJob) {
println("XXXXXXXXXXXXX--- THIS IS THE JOB --- XXXXXXXXXXXXXXXXXXXXX")
println(" item.workspace: " + item.WORKSPACE)
println("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
println(" following methods ain't implemented for WorkflowJob type of Itemnand it will blow out.")
//see https://javadoc.jenkins.io/hudson/model/FreeStyleProject.html
println(" customWS: " + item.getCustomWorkspace())
println(" WS:" + item.getWorkspace())
item.doDoWipeOutWorkspace()
}
}
} else {
println(" :::foldername::: " + item.displayName)
enumerateItems(((Folder) item).getItems())
}
println("==========================================================")
}
}

结果(有点意料之中,但令人失望)

如您所见,我的脚本将在调用以下内容时爆炸:

item.getCustomWorkspace()
item.getWorkspace()
item.doDoWipeOutWorkspace()

MissingMethodException

groovy.lang.MissingMethodException: No signature of method: org.jenkinsci.plugins.workflow.job.WorkflowJob.doDoWipeOutWorkspace() is applicable for argument types: () values: []
at org.codehaus.groovy.runtime.ScriptBytecodeAdapter.unwrap(ScriptBytecodeAdapter.java:58)
at org.codehaus.groovy.runtime.callsite.PojoMetaClassSite.call(PojoMetaClassSite.java:49)
at org.codehaus.groovy.runtime.callsite.CallSiteArray.defaultCall(CallSiteArray.java:48)
at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:113)
at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:117)
at Script1$_enumerateItems_closure1.doCall(Script1.groovy:33)

仅仅是因为这些方法不适用于此类项目,而仅适用于hudson.model.FreeStyleProject

问:然后如何删除管道作业的工作区?

还有另一个 Jenkins 插件:Workspace Cleanup,它可能通过在stage() {}中调用cleanWs()在 Jenkinsfile 中使用,但我没有弄清楚如何从 Jenkinsfile 外部使用它(就像从我的时髦脚本运行 Jenkins 脚本控制台)。

这是增强 Jenkins 管道作业插件的错误/请求吗?或者有没有其他方法可以将项目投射到我可以访问所需功能的地方?

好吧,更多地调查这个问题,更多地谷歌搜索并倾听你的想法(这个特别启发了我丹尼尔·斯皮尔克)我已经实现了我想要的,那就是:

通过 Jenkins 脚本控制台独立清理管道作业的工作区

(只使用 Jenkins 可用的手段,不搞乱作业配置,也不更新 Jenkinsfile,也不重播)

代码并不奇怪,对于手动演示,它看起来像这样:

Jenkins jenkins = Jenkins.instance
Job item = jenkins.getItemByFullName('Sandbox/PipelineTests/SamplePipeline')
println("RootDir: " + item.getRootDir())
for (Node node in jenkins.nodes) {
// Make sure slave is online
if (!node.toComputer().online) {
println "Node '$node.nodeName' is currently offline - skipping workspace cleanup"
continue
}
println "Node '$node.nodeName' is online - performing cleanup:"
// Do some cleanup
FilePath wrksp = node.getWorkspaceFor(item)
println("WRKSP "  + wrksp)
println("ls " + wrksp.list())
println("Free space " + wrksp.getFreeDiskSpace())
println("===== PERFORMING CLEAN UP!!! =====")
wrksp.deleteContents()
println("ls now " + wrksp.list())
println("Free space now " + wrksp.getFreeDiskSpace())
}

如果找到作业,其输出如下所示:

结果

RootDir: /var/lib/jenkins/jobs/Sandbox/jobs/PipelineTests/jobs/SamplePipeline
....
.... other node's output noise
....
Node 'mcs-ubuntu-chch' is online - performing cleanup:
WRKSP /var/lib/jenkins/workspace/Sandbox/PipelineTests/SamplePipeline
ls [/var/lib/jenkins/workspace/Sandbox/PipelineTests/SamplePipeline/README.md, /var/lib/jenkins/workspace/Sandbox/PipelineTests/SamplePipeline/.git]
Free space 3494574714880
===== PERFORMING CLEAN UP!!! =====
ls now []
Free space now 3494574919680

任务已完成:)

引用

主要是 Jenkins javadoc

  • https://javadoc.jenkins.io/hudson/model/Node.html
  • https://javadoc.jenkins.io/hudson/model/TopLevelItem.html
  • https://javadoc.jenkins.io/hudson/model/Item.html
  • https://javadoc.jenkins.io/hudson/FilePath.html

这不是最漂亮的方式,但您可以执行操作系统命令:

def isWin = Jenkins.instance.windows
def cmd = isWin ? "rmdir /s /q $workspace" : "rm -rf $workspace"
cmd.execute()

如果您只使用一次代码或不处理多个操作系统,则可以将代码缩短为相应的命令:

"rm -rf $workspace".execute()

最新更新