🥇Създаване на динамични параметри в Jenkins job, или как да направите задачата си user-friendly

Добър ден, Хабр!

Днес бих искал да споделя един от начините, по които можем да използваме Active Choices Plugin за да направим задачата в Jenkins най-унитарен и разбираем за потребителя.

Въведение

Съкращението DevOps отдавна не е нещо ново за IT общността. За много хора фразата "да направим DevOps" асоциира с някакъв вълшебен бутон, при натискането на който кодът на приложението автоматично се превръща в разгърнато и тествано приложение (всъщност всичко е много по-сложно, но ще се абстрахираме от всички процеси).

И така, получихме поръчка да направим такъв вълшебен бутон, за да могат администраторите да разгръщат приложението с едно щракване. Има различни видове реализации на тази задача: от написване на бот за някой от месинджърите до разработване на отделно приложение. Въпреки това целта е една – да направим стартирането на изграждането и разгръщането на приложението максимално прозрачно и удобно.

В нашия случай ще използваме Jenkins.

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

Задача

Създайте удобна Jenkins работа, която ще стартира изграждане и (или) разгръщане на избрания микросервиз с определена версия.

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

Входни данни

Имаме няколко репозитория, в които се съхранява изходният код на различни микросервизи.

Определение на параметрите

На входа на нашата работа трябва да постъпват следните параметри:

URL на репозитория с кода на микросервиза, който искаме да изградим и разгръщаме при стартиране на работата.
ID на комита, от който ще се извършва изграждането.

AS IS

Най-простият начин за изпълнение на зададената задача е да създадем два параметъра от тип String.

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

В този случай потребителят ще трябва ръчно да въведе пътя до репозитория и ID на комита, което, да призная, не е особено удобно.

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

AS TO BE

А сега да опитаме друг тип параметри, за да разгледаме всичките му предимства.
Ще създадем първия параметър от тип Choice Parameter, втория — Active Choices Reactive Reference Parameter. В параметъра с тип Choice ще добавим ръчно в полето Choices имената на репозиториите, където се съхранява кодът на нашите микросервизи.

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

Ако статията е интересна за аудиторията, в следващата статия ще опиша процеса по конфигуриране на задачи в Jenkins, използвайки описание чрез код (Configuration as code), т.е. няма да е нужно ръчно да въвеждаме имената на репозиториите и да създаваме параметри, всичко ще се случи автоматично (нашият код ще получи списък с репозитории от SCM и ще създаде параметър с този списък).

Стойностите на втория параметър ще се запълват динамично, в зависимост от това какво значение ще приеме първият параметър (test1 или test2), тъй като всеки репозиторий има свой списък с комити.

Active Choices Reactive Reference Parameter има следните полета за попълване:

Name – име на параметъра.
Скрипт – код, който ще се изпълнява всеки път, когато стойността на параметъра в полето Referenced parameter бъде променена (в нашия случай, когато избираме между test1 и test2).
Описание – кратко описание на параметъра.
Тип избор – тип на обекта, който скриптът ще върне (в нашия случай ще върнем html код).
Referenced parameter – име на параметъра, при промяна на стойността на който ще се изпълнява кодът от секцията Скрипт.

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

Преминаваме директно към попълване на най-важното поле в този параметър. За избор ни предлагат два варианта на реализация: използване на Groovy Script или Scriptler Script.
Избираме първото, тъй като Scriptler е само плъгин, който запазва вече написаните от вас скриптове и позволява да ги използвате в други задачи без повторно копиране и поставяне.

Groovy код за получаване на всички комити от избрания репозиторий:

AUTH = "логин и парола в Base64"                           
GIT_URL = "url до вашето SCM (https://bitbucket.org/)"                       
PROJECT_NAME = "име на проектната област, където се намират репозиториите"

def htmlBuild() {
    html = """
            <html>
            <head>
            <meta charset="windows-1251">
            <style type="text/css">
            div.grayTable {
            text-align: left;
            border-collapse: collapse;
            }
            .divTable.grayTable .divTableCell, .divTable.grayTable .divTableHead {
            padding: 0px 3px;
            }
            .divTable.grayTable .divTableBody .divTableCell {
            font-size: 13px;
            }
            </style>
            </head>
            <body>
        """

    def commitOptions = ""
    getCommitsForMicroservice(MICROSERVICE_NAME).each {
        commitOptions += "<option style='font-style: italic' value='COMMIT=${it.getKey()}'>${it}</option>"
    }
    html += """<p style="display: inline-block;">
        <select id="commit_id" size="1" name="value">
            ${commitOptions}
        </select></p></div>"""

    html += """
            </div>
            </div>
            </div>
            </body>
            </html>
         """
    return html
}

def getCommitsForMicroservice(microserviceRepo) {
    def commits = [:]
    def endpoint = GIT_URL + "\/rest\/api\/1.0\/projects\/${PROJECT_NAME}\/repos\/${microserviceRepo}\/commits"
    def conn = new URL(endpoint).openConnection()
    conn.setRequestProperty("Authorization", "Basic ${AUTH}")
    def response = new groovy.json.JsonSlurper().parseText(conn.content.text)
    response.values.each {
        commits.put(it.displayId, it.message)
    }
    return commits
}

return htmlBuild()

Ако не се задълбочаваме в детайлите, този код получава името на микросервиса (MICROSERVICE_NAME), изпраща заявка в Bitbucket (метод getCommitsForMicroservice), използвайки неговото API, и получава id и commit message на всички комити за този микросервис.
Както вече споменахме, този код трябва да върне html, който ще се покаже на страницата Build with Parameters в Jenkins, затова всички получени стойности от Bitbucket обвиваме в списък и добавяме в select.

След изпълнението на всички действия трябва да получим такава красива страница. Build with Parameters.

Ако сме избрали микросервис test1:

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

Ако сме избрали микросервис test2:

Създаване на динамични параметри в Jenkins job, или как да направите задачата си удобна за потребителя

Съгласете се, че на потребителя ще му е много по-удобно да взаимодейства с вашата задача по този начин, вместо всеки път да копира url и да търси нужния commit id.

P.S. В тази статия е представен много опростен пример, който, вероятно, няма практическо приложение в този вид, тъй като сборките имат много повече различни параметри, но целта на тази статия беше да покаже работата на инструмента, а не да предостави работно решение.

P.S.S. Както вече писах по-рано, ако тази статия е полезна, следващата ще бъде за динамично конфигуриране на задачи Jenkins чрез код.

Източник: habr.com