Simple collection of Groovy scripts to help me maintain some Jenkins systems.
See also https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+Script+Console
Please comment & let me know if you have a fork / fixes you'd like to include.
-
-
Save krish143434/dfc18ffb37577886e3254706264b52ae to your computer and use it in GitHub Desktop.
jenkins groovy scripts collection.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // for all builds from build-flow-plugin whose parameters include a GIT_BRANCH paramater, | |
| // change the displayName to include branch and build number | |
| import com.cloudbees.plugins.flow.*; | |
| jobs = Jenkins.instance.getAllItems(BuildFlow); | |
| jobs.each { it -> | |
| it.builds.each { b -> | |
| GIT_BRANCH = b.envVars['GIT_BRANCH'] | |
| ( GIT_BRANCH =~ /(?:refs\/remotes\/)?(.+)/ ).each { full,branch -> | |
| b.displayName = branch + ' (#' + b.number + ')' | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // --------------------------------------------------------- | |
| // This script goes through all the jobs and checks the disk usage. | |
| // prints some disk usage stats as well as the retention policy. | |
| // --------------------------------------------------------- | |
| // e.g.: | |
| // | |
| // JOB: playground/test-python | |
| // -> lastbuild: #1 = FAILURE, time: 2015-02-12T20:56:16Z | |
| // -> builds=12, average=8 KB, max=9 KB, total=97 KB, worstCase=113 KB | |
| // | |
| // | |
| def printDiscarder(job) { | |
| d = job.buildDiscarder | |
| if (d) { | |
| println(" -> keep: builds=(${d.daysToKeep} days, ${d.numToKeep} total); artifacts=(${d.artifactDaysToKeep} days, ${d.artifactNumToKeep} total)") | |
| } else { | |
| println(" -> no retention policy.") | |
| } | |
| } | |
| import hudson.plugins.disk_usage.BuildDiskUsageAction | |
| import hudson.plugins.disk_usage.DiskUsageUtil | |
| def getDiskUsage(build) { | |
| usage = null | |
| build.getTransientActions().each { | |
| action -> | |
| if (action instanceof BuildDiskUsageAction) { | |
| // println action.buildUsageString | |
| // println action.allDiskUsage | |
| usage = action | |
| } | |
| } | |
| return usage | |
| } | |
| def printDiskUsage(job) { | |
| maxUsage = 0 | |
| totalUsage = 0 | |
| numBuilds = 0 | |
| job.builds.each() { | |
| build -> | |
| usage = getDiskUsage(build) | |
| if (usage.allDiskUsage > maxUsage) { maxUsage = usage.allDiskUsage } | |
| totalUsage += usage.allDiskUsage | |
| numBuilds += 1 | |
| // println(" * build ${build.number} - ${usage.buildUsageString}") | |
| } | |
| averageUsage = 0 | |
| if (numBuilds) { averageUsage = (totalUsage / numBuilds).longValue() } | |
| worstCase = numBuilds * maxUsage | |
| println(" -> builds=${numBuilds}, average=${DiskUsageUtil.getSizeString(averageUsage)}, max=${DiskUsageUtil.getSizeString(maxUsage)}, total=${DiskUsageUtil.getSizeString(totalUsage)}, worstCase=${DiskUsageUtil.getSizeString(worstCase)}") | |
| } | |
| jobs = Jenkins.instance.getAllItems() | |
| jobs.each { j -> | |
| if (j instanceof com.cloudbees.hudson.plugins.folder.Folder) { return } | |
| numbuilds = j.builds.size() | |
| println 'JOB: ' + j.fullName | |
| if (numbuilds == 0) { | |
| println ' -> no build' | |
| } else { | |
| lastbuild = j.builds[numbuilds - 1] | |
| println ' -> lastbuild: ' + lastbuild.displayName + ' = ' + lastbuild.result + ', time: ' + lastbuild.timestampString2 | |
| } | |
| printDiscarder(j) | |
| printDiskUsage(j) | |
| println '' | |
| } | |
| '' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // adapted from https://github.com/tkrzeminski/jenkins-groovy-scripts/blob/master/show-all-credentials.groovy | |
| // --------------------------------------------------------- | |
| // This script goes through all the credentials and tries to find a matching item. | |
| // Useful to find the secret that needs to be updated (e.g. it was leaked in log or similar). | |
| // --------------------------------------------------------- | |
| // find needle in credentials | |
| needle = 'xxxxxxx' | |
| import jenkins.model.* | |
| import com.cloudbees.plugins.credentials.* | |
| import com.cloudbees.plugins.credentials.impl.* | |
| import com.cloudbees.plugins.credentials.domains.* | |
| import com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey | |
| import com.cloudbees.jenkins.plugins.awscredentials.AWSCredentialsImpl | |
| import org.jenkinsci.plugins.plaincredentials.StringCredentials | |
| import org.jenkinsci.plugins.plaincredentials.impl.FileCredentialsImpl | |
| def showRow = { credentialType, secretId, content = null, username = null, password = null, description = null -> | |
| println("━" * 80) | |
| println("type".padLeft(20) + "┃ ${credentialType}") | |
| println("description".padLeft(20) + "┃ ${description}") | |
| println("secret id".padLeft(20) + "┃ ${secretId}") | |
| println("username".padLeft(20) + "┃ ${username}") | |
| println("password".padLeft(20) + "┃ ${password}") | |
| println("content:") | |
| println("┅" * 80) | |
| println(content) | |
| println("━" * 80) | |
| } | |
| // set Credentials domain name (null means is it global) | |
| domainName = null | |
| credentialsStore = Jenkins.instance.getExtensionList('com.cloudbees.plugins.credentials.SystemCredentialsProvider')[0]?.getStore() | |
| domain = new Domain(domainName, null, Collections.<DomainSpecification>emptyList()) | |
| credentialsStore?.getCredentials(domain).each{ | |
| if(it instanceof UsernamePasswordCredentialsImpl && (it.username == needle || it.password?.getPlainText() == needle)) | |
| showRow("user/password", it.id, null, it.username, it.password?.getPlainText(), it.description) | |
| if(it instanceof BasicSSHUserPrivateKey && (it.passphrase?.getPlainText() == needle)) | |
| showRow("ssh priv key", it.id, null, it.passphrase?.getPlainText(), it.privateKeySource?.getPrivateKey(), it.description) | |
| if(it instanceof AWSCredentialsImpl && (it.accessKey == needle || it.secretKey?.getPlainText() == needle)) | |
| showRow("aws", it.id, null, it.accessKey, it.secretKey?.getPlainText(), it.description) | |
| if(it instanceof StringCredentials && (it.secret?.getPlainText()?.contains(needle))) | |
| showRow("secret text", it.id, it.secret?.getPlainText(), null, null, it.description) | |
| if(it instanceof FileCredentialsImpl && (it.content?.text?.contains(needle))) | |
| showRow("secret file", it.id, it.content?.text, null, null, it.description) | |
| } | |
| return |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // scan all jobs and check if the last build was aborted (e.g. maintenance) | |
| // and output user / timestamp | |
| jobs = Jenkins.instance.getAllItems() | |
| jobs.each { j -> | |
| if (j instanceof com.cloudbees.hudson.plugins.folder.Folder) { return } | |
| numbuilds = j.builds.size() | |
| if (numbuilds == 0) { return } | |
| lastbuild = j.builds[numbuilds - 1] | |
| if (lastbuild.result == Result.ABORTED) { | |
| println 'JOB: ' + j.fullName | |
| abortCause = lastbuild.getAction(InterruptedBuildAction).getCauses()[0] | |
| println ' -> lastbuild: ' + lastbuild.displayName + ' = ' + lastbuild.result + ', cause: ' + abortCause.shortDescription + ', time: ' + lastbuild.timestampString2 | |
| } | |
| } | |
| '' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // list jobs and their last build. | |
| jobs = Jenkins.instance.getAllItems() | |
| jobs.each { j -> | |
| if (j instanceof com.cloudbees.hudson.plugins.folder.Folder) { return } | |
| println 'JOB: ' + j.fullName | |
| numbuilds = j.builds.size() | |
| if (numbuilds == 0) { | |
| println ' -> no build' | |
| return | |
| } | |
| lastbuild = j.builds[numbuilds - 1] | |
| println ' -> lastbuild: ' + lastbuild.displayName + ' = ' + lastbuild.result + ', time: ' + lastbuild.timestampString2 | |
| } | |
| // returns blank | |
| '' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // list jobs not run in the last N days / last N months | |
| import groovy.time.TimeCategory | |
| use ( TimeCategory ) { | |
| // e.g. find jobs not run in last 3 months | |
| sometimeago = (new Date() - 3.months) | |
| } | |
| jobs = Jenkins.instance.getAllItems() | |
| lastabort = null | |
| jobs.each { j -> | |
| if (j instanceof com.cloudbees.hudson.plugins.folder.Folder) { return } | |
| numbuilds = j.builds.size() | |
| if (numbuilds == 0) { | |
| println 'JOB: ' + j.fullName | |
| println ' -> no build' | |
| return | |
| } | |
| lastbuild = j.builds[numbuilds - 1] | |
| if (lastbuild.timestamp.getTime() < sometimeago) { | |
| println 'JOB: ' + j.fullName | |
| println ' -> lastbuild: ' + lastbuild.displayName + ' = ' + lastbuild.result + ', time: ' + lastbuild.timestampString2 | |
| } | |
| } | |
| '' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // --------------------------------------------------------- | |
| // This script cleans a subdir in all existing workspaces for a selected job. | |
| // node -> check workspace (concurrent too) -> check subdir -> delete | |
| // --------------------------------------------------------- | |
| job = Jenkins.instance.getItemByFullName('SomeJobFolder/myJob') | |
| subdir = 'dist' | |
| println "Looking for job: " + job.fullName | |
| import hudson.slaves.WorkspaceList | |
| combinator = System.getProperty(WorkspaceList.class.getName(),"@"); | |
| for (node in Jenkins.instance.getNodes()) { | |
| println "Node: '" + node.getSelfLabel().toString() + "' (" + node.getAssignedLabels().join(",") + ")" | |
| workspacePathBase = node.getWorkspaceFor(job) | |
| // handle concurrent workspaces | |
| for (int i=1; ; i++) { | |
| // they are suffixed... | |
| workspacePath = i==1 ? workspacePathBase : workspacePathBase.withSuffix(combinator+i); | |
| // stop checking (unlikely to have higher suffix) | |
| if (!workspacePath.exists()) { | |
| break; | |
| } else { | |
| println " * found workspace: " + workspacePath.getRemote() | |
| targetDir = workspacePath.child(subdir) | |
| if (targetDir.exists()) { | |
| println " * found target directory" | |
| if (!job.isBuilding()) { | |
| println " * removing directory (job is not building)" | |
| targetDir.deleteRecursive() | |
| } else { | |
| println " * not removing directory (job is building)" | |
| } | |
| } | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // --------------------------------------------------------- | |
| // Retroactively add badges to promoted builds. | |
| // --------------------------------------------------------- | |
| import hudson.plugins.promoted_builds.*; | |
| import org.jvnet.hudson.plugins.groovypostbuild.*; | |
| // customize these | |
| project_name = "project/full/name" | |
| promotion_name = "promotion_process_name" | |
| // look up promoted builds for project + promotion process. | |
| project = Jenkins.instance.getItemByFullName(project_name) | |
| action = project.getAction(PromotedProjectAction.class) | |
| promotion = action.getProcess(promotion_name) | |
| promoted_builds = action.getPromotions(promotion) | |
| // check this other gist: | |
| // https://gist.github.com/dnozay/fc528b43cf27755017cc | |
| def add_release_version(promo_build) { | |
| target = promo_build.target; | |
| // access the promotion build environment and the RELEASE_VERSION parameter. | |
| release_version = promo_build.environment.get('RELEASE_VERSION'); | |
| // create the summary with the gold star icon and attach to target. | |
| GroovyPostbuildSummaryAction action = new GroovyPostbuildSummaryAction("star-gold.png"); | |
| target.getActions().add(action); | |
| // customize text for the summary. | |
| action.appendText("RELEASE VERSION = " + release_version, false); | |
| // also add a short text that will appear in the build history | |
| target.getActions().add(GroovyPostbuildAction.createShortText(release_version)); | |
| // save build | |
| target.save(); | |
| } | |
| // do stuff; e.g. add release version in the description. | |
| for (Promotion promo: promoted_builds) { | |
| add_release_version(promo) | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Licensed under MIT | |
| // author : Damien Nozay | |
| // --------------------------------------------------------- | |
| // This script goes through all the jobs and checks if they are using the Groovy Postbuild | |
| // if they are, then it computes the hash value, and checks against the ones that are approved. | |
| // --------------------------------------------------------- | |
| import org.jenkinsci.plugins.scriptsecurity.scripts.*; | |
| import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.*; | |
| import hudson.model.RootAction; | |
| import org.jvnet.hudson.plugins.groovypostbuild.*; | |
| // instance containing the approvals | |
| // list of approved hashes: println instance.approvedScriptHashes | |
| ScriptApproval instance = Jenkins.getInstance().getExtensionList(RootAction.class).get(ScriptApproval.class); | |
| approvedScriptHashes = instance.approvedScriptHashes | |
| import java.util.* | |
| import java.security.MessageDigest; | |
| def hash(String script, String language) { | |
| MessageDigest digest = MessageDigest.getInstance("SHA-1"); | |
| digest.update(language.getBytes("UTF-8")); | |
| digest.update((byte) ':'); | |
| digest.update(script.getBytes("UTF-8")); | |
| return Util.toHexString(digest.digest()); | |
| } | |
| jobs = hudson.model.Hudson.instance.getAllItems(FreeStyleProject) | |
| for (job in jobs) { | |
| for (publisher in job.publishersList) { | |
| if (publisher instanceof GroovyPostbuildRecorder) { | |
| hashval = hash(publisher.script.script, "groovy") | |
| println "#" * 80 | |
| println "job: " + job.getFullName() | |
| println "script hash: " + hashval | |
| println "approved: " + (hashval in approvedScriptHashes) | |
| println "script: " | |
| println "-" * 80 | |
| println publisher.script.script | |
| println "#" * 80 | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Wipe workspaces for a set of jobs on all nodes | |
| //The script wipes workspaces of certain jobs on all nodes. | |
| //Execute it from <Jenkins host>/computer/(master)/script Change the TODO part to specify which jobs to affect | |
| ------------------------------------------------------------------------------------------------------------------ | |
| import hudson.model.* | |
| // For each job | |
| for (item in Hudson.instance.items) | |
| { | |
| jobName = item.getFullDisplayName() | |
| // check that job is not building | |
| if (!item.isBuilding()) | |
| { | |
| // TODO: Modify the following condition to select which jobs to affect | |
| if (jobName == "MyJob") | |
| { | |
| println("Wiping out workspaces of job " + jobName) | |
| customWorkspace = item.getCustomWorkspace() | |
| println("Custom workspace = " + customWorkspace) | |
| for (node in Hudson.getInstance().getNodes()) | |
| { | |
| println(" Node: " + node.getDisplayName()) | |
| workspacePath = node.getWorkspaceFor(item) | |
| if (workspacePath == null) | |
| { | |
| println(" Could not get workspace path") | |
| } | |
| else | |
| { | |
| if (customWorkspace != null) | |
| { | |
| workspacePath = node.getRootPath().child(customWorkspace) | |
| } | |
| pathAsString = workspacePath.getRemote() | |
| if (workspacePath.exists()) | |
| { | |
| workspacePath.deleteRecursive() | |
| println(" Deleted from location " + pathAsString) | |
| } | |
| else | |
| { | |
| println(" Nothing to delete at " + pathAsString) | |
| } | |
| } | |
| } | |
| } | |
| } | |
| else | |
| { | |
| println("Skipping job " + jobName + ", currently building") | |
| } | |
| } | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment