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

问题描述 投票:1回答:2

Why again this type of question?

这个问题似乎已被多次询问,但所有答案都与Jenkins Pipeline工作相关(插件:workflow-job)。

Situation

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

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

但是我偶尔(ad-hoc)需要删除此类作业的工作空间。我不希望这样做:

而且我没有r / w访问该从属节点上的FS(这是最简单的事情)。

Googling

在互联网上快速搜索,我从几个结果[1234,...]崩溃了如何从Jenkins脚本控制台运行的Groovy脚本中清理WS()。

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

My Groovy attempt to cleanWS

根据从互联网上收集的答案,我开始了我的Groovy清理脚本,可以从Jenkins script console <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 Item\nand 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("==========================================================")
  }
}

Results (kinda expected, but disaponting)

正如你所看到的,我的脚本会在以下调用时爆炸:

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

问题:如何删除Pipeline作业的工作区?

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

这是一个增强Jenkins Pipeline作业插件的错误/请求吗?或者有没有其他方法如何将项目转换为我可以访问所需功能的东西?

groovy jenkins-pipeline jenkins-plugins jenkins-job-dsl jenkins-groovy
2个回答
2
投票

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

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

cmd.execute()

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

"rm -rf $workspace".execute()

1
投票

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

Independently to CLEAN-UP Pipeline Job's WORKSPACE via Jenkins script console

(仅使用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

任务完成:)

References

主要是Jenkins javadoc

© www.soinside.com 2019 - 2024. All rights reserved.