הפעל IntelliJ IDEA Inspections על Jenkins

ל- IntelliJ IDEA כיום יש את מנתח הקוד הסטטי של Java הסטטי המתקדם ביותר, אשר ביכולותיו משאיר הרחק מאחור "ותיקים" כמו צ'קסטייל и ספוט באגים. ה"בדיקות" הרבות שלו בודקות את הקוד בהיבטים שונים, מסגנון קידוד ועד באגים טיפוסיים.

עם זאת, כל עוד תוצאות הניתוח מוצגות רק בממשק המקומי של ה-IDE של המפתח, הן מועילות מעט לתהליך הפיתוח. ניתוח סטטי חייב להתמלא כשלב הראשון של צינור הבנייה, התוצאות שלו צריכות להגדיר שערים איכותיים, והבנייה אמורה להיכשל אם השערים האיכותיים לא יעברו. ידוע כי TeamCity CI משולב עם IDEA. אבל גם אם אינך משתמש ב-TeamCity, אתה יכול בקלות לנסות להריץ בדיקות IDEA בכל שרת CI אחר. אני מציע שתראה כיצד ניתן לעשות זאת באמצעות IDEA Community Edition, Jenkins ו-Warnings NG תוסף.

שלב 1. הפעל את הניתוח בקונטיינר וקבל דוח

בהתחלה, הרעיון של הפעלת IDE (יישום שולחן עבודה!) בתוך מערכת CI שאין לה ממשק גרפי עשוי להיראות מפוקפק ומאוד בעייתי. למרבה המזל, מפתחי IDEA סיפקו את היכולת לרוץ עיצוב קוד и בדיקות משורת הפקודה. יתרה מכך, כדי להפעיל את IDEA במצב זה, לא נדרשת תת-מערכת גרפית וניתן לבצע משימות אלו בשרתים עם מעטפת טקסט.

בדיקות מופעלות באמצעות סקריפט bin/inspect.sh מספריית ההתקנה של IDEA. הפרמטרים הנדרשים הם:

• הנתיב המלא לפרויקט (הקרובים אינם נתמכים),
• נתיב לקובץ .xml עם הגדרות בדיקה (ממוקם בדרך כלל בתוך הפרויקט ב-.idea/inspectionProfiles/Project_Default.xml),
• נתיב מלא לתיקיה שבה יאוחסנו קבצי .xml עם דוחות על תוצאות הניתוח.

בנוסף, צפוי כי

• הנתיב ל- Java SDK יוגדר ב-IDE, אחרת הניתוח לא יעבוד. הגדרות אלו כלולות בקובץ התצורה jdk.table.xml בתיקיית התצורה הגלובלית של IDEA. התצורה הגלובלית של IDEA עצמה ממוקמת בספריית הבית של המשתמש כברירת מחדל, אבל המיקום הזה ניתן לציין במפורש בקובץ idea.properties.
• הפרויקט המנותח חייב להיות פרויקט IDEA חוקי, שעבורו תצטרך לבצע כמה קבצים שמתעלמים מהם בדרך כלל לבקרת גרסאות, כלומר:
  • .idea/inspectionProfiles/Project_Default.xml - הגדרות מנתח, ברור שהן ישמשו בעת הפעלת בדיקות במיכל,
  • .idea/modules.xml - אחרת נקבל את השגיאה 'פרויקט זה אינו מכיל מודולים',
  • .idea/misc.xml - אחרת נקבל את השגיאה 'ה-JDK אינו מוגדר כהלכה עבור הפרויקט הזה',
  • *.iml-файлы - אחרת נקבל שגיאה לגבי JDK לא מוגדר במודול.

למרות שקבצים אלה נכללים בדרך כלל ב .gitignore, הם אינם מכילים מידע ספציפי לסביבה של מפתח מסוים - בניגוד, למשל, לקובץ workspace.xml, כאשר מידע כזה כלול, ולכן אין צורך לבצעו.

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

דוקרפיל

FROM openkbs/ubuntu-bionic-jdk-mvn-py3

ARG INTELLIJ_VERSION="ideaIC-2019.1.1"

ARG INTELLIJ_IDE_TAR=${INTELLIJ_VERSION}.tar.gz

ENV IDEA_PROJECT_DIR="/var/project"

WORKDIR /opt

COPY jdk.table.xml /etc/idea/config/options/

RUN wget https://download-cf.jetbrains.com/idea/${INTELLIJ_IDE_TAR} && 
    tar xzf ${INTELLIJ_IDE_TAR} && 
    tar tzf ${INTELLIJ_IDE_TAR} | head -1 | sed -e 's//.*//' | xargs -I{} ln -s {} idea && 
    rm ${INTELLIJ_IDE_TAR} && 
    echo idea.config.path=/etc/idea/config >> idea/bin/idea.properties && 
    chmod -R 777 /etc/idea

CMD idea/bin/inspect.sh ${IDEA_PROJECT_DIR} ${IDEA_PROJECT_DIR}/.idea/inspectionProfiles/Project_Default.xml ${IDEA_PROJECT_DIR}/target/idea_inspections -v2

שימוש באפשרות idea.config.path אילצנו את IDEA לחפש את התצורה הגלובלית שלה בתיקייה /etc/idea, כי תיקיית הבית של המשתמש בעת עבודה ב-CI היא דבר לא בטוח ולעיתים קרובות נעדר לחלוטין.

כך נראה הקובץ שהועתק למיכל: jdk.table.xml, המכיל את הנתיבים ל-OpenJDK המותקנים בתוך הקונטיינר (ניתן לקחת קובץ דומה מהספרייה שלך עם הגדרות IDEA כבסיס):

jdk.table.xml

<application>
 <component name="ProjectJdkTable">
   <jdk version="2">
     <name value="1.8" />
     <type value="JavaSDK" />
     <version value="1.8" />
     <homePath value="/usr/java" />
     <roots>
       <annotationsPath>
         <root type="composite">
           <root url="jar://$APPLICATION_HOME_DIR$/lib/jdkAnnotations.jar!/" type="simple" />
         </root>
       </annotationsPath>
       <classPath>
         <root type="composite">
           <root url="jar:///usr/java/jre/lib/charsets.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/deploy.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/access-bridge-64.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/cldrdata.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/dnsns.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/jaccess.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/jfxrt.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/localedata.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/nashorn.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunec.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunjce_provider.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunmscapi.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/sunpkcs11.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/ext/zipfs.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/javaws.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jce.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jfr.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jfxswt.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/jsse.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/management-agent.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/plugin.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/resources.jar!/" type="simple" />
           <root url="jar:///usr/java/jre/lib/rt.jar!/" type="simple" />
         </root>
       </classPath>
     </roots>
     <additional />
   </jdk>
 </component>
</application>

התמונה המוגמרת זמין ב- Docker Hub.

לפני שנמשיך, בואו נבדוק שהנתח של IDEA פועל במיכל:

docker run --rm -v <путь/к/вашему/проекту>:/var/project inponomarev/intellij-idea-analyzer

הניתוח אמור לפעול בהצלחה, וקובצי XML רבים עם דוחות מנתח צריכים להופיע בתיקיית המשנה target/idea_inspections.

כעת אין יותר ספק שניתן להפעיל את מנתח ה-IDEA באופן עצמאי בכל סביבת CI, ואנחנו עוברים לשלב השני.

שלב 2. הצג ונתח את הדוח

קבלת הדוח בצורה של קובצי ‎.xml היא חצי העבודה; כעת עליך להפוך אותו לקריאה אנושית. וגם יש להשתמש בתוצאות שלו בשערי איכות - ההיגיון לקביעה האם השינוי המקובל עובר או נכשל לפי קריטריוני איכות.

זה יעזור לנו תוסף Jenkins Warnings NG, אשר שוחרר בינואר 2019. עם הופעתו, תוספים בודדים רבים לעבודה עם תוצאות ניתוח סטטי בג'נקינס (CheckStyle, FindBugs, PMD וכו') מסומנים כעת כמיושנים.

התוסף מורכב משני חלקים:

• מספר רב של אוספי הודעות מנתח (רשימה מלאה כולל את כל הנתחים המוכרים למדע מ- AcuCobol ועד ZPT Lint),
• מציג דוחות יחיד עבור כולם.

רשימת הדברים ש- Warnings NG יכולה לנתח כוללת אזהרות מהמהדר של Java ואזהרות מיומני ביצוע של Maven: למרות שהם גלויים כל הזמן, הם מנותחים רק לעתים רחוקות. דוחות IntelliJ IDEA כלולים גם הם ברשימת הפורמטים המוכרים.

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

stage ('Static analysis'){
    sh 'rm -rf target/idea_inspections'
    docker.image('inponomarev/intellij-idea-analyzer').inside {
       sh '/opt/idea/bin/inspect.sh $WORKSPACE $WORKSPACE/.idea/inspectionProfiles/Project_Default.xml $WORKSPACE/target/idea_inspections -v2'
    }
    recordIssues(
       tools: [ideaInspection(pattern: 'target/idea_inspections/*.xml')]
    )
}

ממשק הדוחות נראה כך:

באופן נוח, ממשק זה הוא אוניברסלי עבור כל הנתחים המוכרים. הוא מכיל תרשים אינטראקטיבי של התפלגות הממצאים לפי קטגוריות וגרף של הדינמיקה של שינויים במספר הממצאים. ניתן לבצע חיפוש מהיר ברשת בתחתית העמוד. הדבר היחיד שלא עבד נכון עבור בדיקות IDEA היה היכולת לגלוש בקוד ישירות בג'נקינס (אם כי עבור דוחות אחרים, למשל Checkstyle, התוסף הזה יכול לעשות זאת בצורה יפה). נראה שזה באג במנתח הדוחות של IDEA שצריך לתקן.

בין המאפיינים של Warnings NG היא היכולת לצבור ממצאים ממקורות שונים בדוח אחד ולתכנת שערי איכות, כולל "מחגר" עבור מכלול העזר. חלק מהתיעוד לתכנות Quality Gates זמין כאן - עם זאת, זה לא שלם, ואתה צריך להסתכל על קוד המקור. מצד שני, לשליטה מלאה על המתרחש, ניתן ליישם את ה"מחגר" באופן עצמאי (ראה שלי פוסט קודם על נושא זה).

מסקנה

לפני תחילת הכנת החומר הזה, החלטתי לחפש: מישהו כבר כתב על הנושא הזה ב-Habré? רק מצאתי ראיון 2017 с לאנישבו הוא אומר:

עד כמה שידוע לי, אין אינטגרציה עם Jenkins או תוסף Maven […] באופן עקרוני, כל חובב יכול להתיידד עם IDEA Community Edition ו-Jenkins, רבים רק ירוויחו מכך.

ובכן, שנתיים לאחר מכן יש לנו תוסף אזהרות NG, וסוף סוף הידידות הזו יצאה לפועל!

מקור: www.habr.com