🥇יצירת פרמטרים דינמיים בעבודת ג'נקינס, או איך להפוך את המשימה שלך לידידותית למשתמש

יום טוב, האבר!

היום אני רוצה לחלוק את אחת הדרכים לשימוש תוסף Active Choices לעשות את המשימה ב ג'נקינס המאוחד והידידותי ביותר למשתמש.

מבוא

קיצור כזה כמו DevOps הוא כבר לא משהו חדש עבור קהילת ה-IT. עבור אנשים רבים, הביטוי "לעשות DevOps" משויך לאיזשהו כפתור קסם, כאשר לוחצים עליו, קוד האפליקציה הופך אוטומטית לאפליקציה פרוסה ובדוקה (הכל למעשה יותר מסובך, אבל אנחנו מופשטים מכל התהליכים).

אז קיבלנו הוראה ליצור כפתור קסם כזה כדי שמנהלי מערכת יוכלו לפרוס את האפליקציה בלחיצה אחת. ישנם סוגים שונים של יישום של משימה זו: מכתיבת בוט עבור כל אחד מהמסרים המיידיים ועד לפיתוח אפליקציה נפרדת. עם זאת, לכל זה יש אותה מטרה - להפוך את התחלת הבנייה והפריסה של האפליקציה לשקופה ונוחה ככל האפשר.

במקרה שלנו נשתמש ג'נקינס.

משימה

צור עבודה נוחה של ג'נקינס שתפעיל את הבנייה ו(או) הפריסה של המיקרו-שירות הנבחר של גרסה מסוימת.

קלט נתונים

יש לנו מספר מאגרים המכילים את קוד המקור של מיקרו-שירותים שונים.

הגדרת פרמטרים

יש לקבל את הפרמטרים הבאים כקלט לתפקידנו:

כתובת האתר של המאגר עם קוד המיקרו-שירות שאנו רוצים לבנות ולפרוס בעת הפעלת העבודה.
מזהה ה-commit שממנו הבנייה תתבצע.

AS IS

הדרך הקלה ביותר לבצע משימה זו היא ליצור שני פרמטרים מסוג String.

במקרה זה, המשתמש יצטרך להזין ידנית את הנתיב למאגר ואת מזהה ה-commit, וזה, אתה מבין, לא לגמרי נוח.

AS TO BE

עכשיו בואו ננסה סוג אחר של פרמטרים כדי לשקול את כל היתרונות שלו.
בוא ניצור את הפרמטר הראשון עם הסוג Choice Parameter, השני - Active Choices Reactive Reference Parameter. בפרמטר עם סוג Choice, נוסיף ידנית בשדה Choices את שמות המאגרים שבהם מאוחסן הקוד של המיקרו-שירותים שלנו.

אם הקהל אוהב את המאמר הזה, אז במאמר הבא אתאר את תהליך הגדרת המשימות בג'נקינס, באמצעות תיאור דרך קוד (Configuration as code), כלומר. לא נצטרך להזין ידנית שמות מאגרים וליצור פרמטרים, הכל יקרה אוטומטית (הקוד שלנו יקבל רשימה של מאגרים מ-SCM ויצור פרמטר עם הרשימה הזו).

הערכים של הפרמטר השני יתמלאו באופן דינמי, בהתאם לערך שהפרמטר הראשון לוקח (test1 או test2), מכיוון שלכל מאגר יש רשימת מחויבות משלו.

Active Choices פרמטר התייחסות תגובתי יש למלא את השדות הבאים:

שם - שם פרמטר.
תסריט – קוד שיבוצע בכל פעם שערך הפרמטר מהשדה Referenced parameter ישתנה (במקרה שלנו, כאשר אנו בוחרים בין test1 ל-test2).
תיאור - תיאור קצר של הפרמטר.
סוג בחירה – סוג האובייקט המוחזר מהסקריפט (במקרה שלנו נחזיר קוד html).
פרמטר מוזכר – שם הפרמטר, כאשר ערכו ישתנה, הקוד מקטע הסקריפט יבוצע.

הבה נמשיך ישירות למילוי השדה החשוב ביותר בפרמטר זה. מוצעים לנו שני סוגי יישום לבחירה: שימוש תסריט גרובי או Scriptler Script.
אנו בוחרים בראשון, שכן Scriptler הוא רק תוסף ששומר סקריפטים שכתבת בעבר ומאפשר לך להשתמש בהם במשימות אחרות מבלי להעתיק שוב.

קוד גרובי כדי לקבל את כל ההתחייבויות מהמאגר הנבחר:

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) כקלט ושולח בקשה אל סיביות (שיטה getCommitsForMicroservice) באמצעות ה-API שלו, ומקבל את הודעת המזהה וההתחייבות של כל ההתחייבויות עבור מיקרו-שירות נתון.
כפי שהוזכר קודם לכן, קוד זה אמור להחזיר html שיוצג בעמוד בנה עם פרמטרים בג'נקינס, אז אנחנו עוטפים את כל הערכים שהתקבלו מ-Bitbucket ברשימה ומוסיפים אותם לבחירה.

לאחר השלמת כל השלבים, אנחנו אמורים לקבל דף כל כך יפה בנה עם פרמטרים.

אם בחרת ב-test1 microservice:

אם בחרת ב-test2 microservice:

מסכים שהרבה יותר נוח למשתמש לקיים אינטראקציה עם המשימה שלך בדרך זו מאשר להעתיק את ה-url בכל פעם ולחפש את מזהה ה-commit הנדרש.

נ.ב. מאמר זה מספק דוגמה מאוד פשוטה, שאולי לא תועיל בצורה מעשית בצורה זו, שכן למכלולים יש עוד הרבה פרמטרים שונים, אבל מטרת המאמר הזה הייתה להראות איך הכלי עובד, לא לספק פתרון עובד.

Pss כפי שכתבתי קודם לכן, אם המאמר הזה שימושי, אז המאמר הבא יעסוק תצורה דינמית של משימות ג'נקינס באמצעות קוד.

מקור: www.habr.com

יצירת פרמטרים דינמיים בעבודת ג'נקינס, או איך להפוך את המשימה שלך לידידותית למשתמש