DEV Community: Alexei Moussatov

Howto: Drop-down list with Gitlab projects in Jenkins if you have more them 99 projects in namespace

Alexei Moussatov — Tue, 17 Sep 2019 06:57:07 +0000

In the previous receipt about Drop-down list for values we learned how-to choice any component from Jira. But in Jira ofteт isn't need in real life for development process.
At this receipt I've tell about how to create drop-down list for choosing projects's names by regex from Gitlab via API.

Prerequisites:

Active Choices plugin
Gitlab token for API

Step 1: In job configuration add parameter Active Choice Reactive Parameter

Step 2: Set name for your parameter (for example COMPONENT)

Step 3: Select Groovy script and add next groovy-code

import groovy.json.JsonSlurperClassic
import java.util.regex.*

def projectNamespace = JIRA_PROJECT.toLowerCase()
def regexLine = "^((${projectNamespace}-(int|sys|service|bpl|pl|stp|tst)-([a-z,0-9,-]*)))"

def gitlabUrl = "https://gitlab.domain.org"
def gitlabApiToken = "secretToken"

def page = 1
def perPage = 64

def data = []
def list = []

while (true) {  
  paging = "&per_page=${perPage}&page=${page}"
  url = "curl -k -H PRIVATE-TOKEN:${gitlabApiToken} ${gitlabUrl}/api/v4/projects?search=${projectNamespace}-${paging}"
  json = url.execute().text.replaceAll("\r\n", "")
  data = new JsonSlurperClassic().parseText(json)
  if( data == [] ) { break }  
  data.each { project ->
    def projectMatcher = (project.name =~ regexLine)    
    if(projectMatcher.count && project.namespace.path == projectNamespace) {
      list += project.name
    }
  }
  page++
}


return list.sort()

Howto: Drop-down list with branches from Gitlab project

Alexei Moussatov — Tue, 09 Jul 2019 07:59:18 +0000

In the previous receipt about Drop-down list for values we learned how-to choice any component from Jira or project name from Gitlab.
On the next step we need in branch selector for choosen project.

Prerequisites:

Active Choices plugin
Gitlab token for API

Step 1: In job configuration add parameter Active Choice Reactive Parameter

Step 2: Set name for your parameter (for example GIT_BRANCH)

Step 3: Set value for Referenced parameters as COMPONENT

Step 4: Select Groovy script and add next groovy-code

import groovy.json.JsonSlurperClassic

def projectName = COMPONENT
def gitlabUrl = "https://gitlab.domain.org"
def gitlabApiToken = "SecretToken"
def per_page = 128

def url = "curl -k -H PRIVATE-TOKEN:${gitlabApiToken} ${gitlabUrl}/api/v4/projects?search=$projectName"
def json = url.execute().text.replaceAll("\r\n", "")
def data = new JsonSlurperClassic().parseText(json)
def project = data.find { it.name == projectName }
def projectId = project.id

url = "curl -k -H PRIVATE-TOKEN:${gitlabApiToken} ${gitlabUrl}/api/v4/projects/${projectId}/repository/branches?per_page=${per_page}"
json = url.execute().text.replaceAll("\r\n", "")
data = new JsonSlurperClassic().parseText(json)
def list = []
data.each { branch ->
    list += branch.name
}
return list

Howto: Drop-down list with Gitlab projects in Jenkins

Alexei Moussatov — Mon, 08 Jul 2019 07:54:40 +0000

Prerequisites:

Active Choices plugin
Gitlab token for API

Step 1: In job configuration add parameter Active Choice Reactive Parameter

Step 2: Set name for your parameter (for example COMPONENT)

Step 3: Select Groovy script and add next groovy-code

import groovy.json.JsonSlurperClassic
import java.util.regex.*

def projectNamespace = JIRA_PROJECT.toLowerCase()
def regexLine = "^((${projectNamespace}-(int|sys|service|bpl|pl|stp|tst)-([a-z,0-9,-]*)))"
def gitlabUrl = "https://gitlab.domain.org"
def gitlabApiToken = "secretToken"
def per_page = 128

def data = []
def url = "curl -k -H PRIVATE-TOKEN:${gitlabApiToken} ${gitlabUrl}/api/v4/projects?per_page=${per_page}"
def json = url.execute().text.replaceAll("\r\n", "")
data += new JsonSlurperClassic().parseText(json)

def list = []
data.each { project ->
    Matcher projectMatcher = Pattern.compile(regexLine).matcher(project.path)
    if(projectMatcher && project.namespace.path == projectNamespace) {
        list += project.path
    }
}
return list.sort()

Howto: Drop-down list Jira's components in Jenkins

Alexei Moussatov — Fri, 07 Jun 2019 12:21:02 +0000

In the previous receipt about Drop-down list for values we learned how-to choice any predefined project.
At this receipt I've tell about how to create drop-down list for choosing component's names by regex from Jira via API.

Prerequisites:

Active Choices plugin
Jira credentials

Step 1: In job configuration add parameter Active Choice Reactive Parameter

Step 2: Set name for your parameter (for example COMPONENT)

Step 3: Select Groovy script and add next groovy-code

import groovy.json.JsonSlurperClassic
import java.util.regex.*

def regexLine = "(((my|other)-(int|sys|bpl|pl|stp|tst)-([a-z,0-9,-]*)))"
def jiraUrl = "http://jira.domain.org"
def jiraProjectKey = JIRA_PROJECT

def juser = "JenkinsJiraUser"
def jpass = "PasswordOfJenkinsJiraUser"
def url = "curl -u ${juser}:${jpass} ${jiraUrl}/rest/api/2/project/${jiraProjectKey}/components"
def json = url.execute().text.replaceAll("\r\n", "")
def data = new JsonSlurperClassic().parseText(json)
def names = []
data.each{ component->
    if (component) {
        Matcher componentsMatcher = Pattern.compile(regexLine).matcher(component.name)
        if( componentsMatcher ) {
            names += component.name
        }
    }
}
return names

Step 4: Set to "Referenced parameters" JIRA_PROJECT

Step 5: Enjoy!

Howto: Drop-down list for values in Jenkins

Alexei Moussatov — Fri, 07 Jun 2019 11:30:18 +0000

How to create drop-down list in Jenkins with predefined items.

Prerequisites:

Extended choice parameter plugin

Step 1: create in Global properties at http://jenkins.domain.org/configure property with name PROJECTS and comma-separated list of your projects

Step 2: In job configuration add parameter Extended choice parameter
Set name for your parameter (for example JIRA_PROJECT)
Select Groovy script and add next groovy-code

    import jenkins.model.*
    nodes = Jenkins.instance.globalNodeProperties
    nodes.getAll(hudson.slaves.EnvironmentVariablesNodeProperty.class)
    envVars = nodes[0].envVars
    return "${envVars['PROJECTS']}".split(',')

Step 3: Enjoy!