warnings ng plugin devenv

Lingkungan Pengembangan untuk Plugin Jenkins

Lingkungan pengembangan berbasis Docker ini adalah untuk kontributor baru dari Jenkins Warnings dan Cakupan plugin untuk mengurangi waktu peningkatan awal. Ini terdiri dari bagian -bagian berikut:

• Script untuk memeriksa semua modul plugin Jenkins ini dari GitHub. Bergantung pada bagian di mana Anda ingin berkontribusi, Anda biasanya bekerja hanya dengan salah satu modul ini. Namun, ini menyederhanakan pengembangan jika semua modul sudah menjadi bagian dari ruang kerja. Kemudian Anda dapat beralih kapan saja ke salah satu modul lainnya.
• Pengontrol Jenkins berbasis Docker yang memiliki semua plugin yang diperlukan diinstal untuk melihat plugin ini beraksi. Pengontrol Jenkins ini sudah dikonfigurasi dengan benar menggunakan JCASC untuk membangun modul Java pada agen berbasis Linux (juga disediakan sebagai Docker Container). Ini sudah berisi beberapa pekerjaan yang menggunakan semua plugin ini (tes, cakupan, analisis statis).
• Proyek IntelliJ yang mengkonfigurasi plugin ini sebagai modul Maven. Proyek ini berisi preset gaya pengkodean saya dan beberapa konfigurasi bermanfaat lainnya. Terutama, ia memiliki pelari yang dikonfigurasi untuk men -debug plugin Jenkins baik pada pengontrol atau agen.

Saya mempresentasikan lingkungan pengembangan ini dalam pertemuan online Jenkins yang tercatat pada Januari 2022.

Sistem Operasi yang Didukung

Lingkungan pengembangan telah diuji pada macOS, Ubuntu Linux (dalam mesin virtual yang berjalan pada macOS), dan Windows. Permintaan tarik selalu diterima.

Tldr

Persyaratan instalasi

Pengembangan Utama

Versi terbaru dari alat berikut:

• Docker (untuk Windows dan MacOS: Instal Docker Desktop)
• Intellij Ultimate (atau komunitas)
• Maven
• JDK 21
• Git

Pengujian UI

Selain itu, versi terbaru dari alat berikut diperlukan:

• Firefox dan Gecko-Driver
• Chrome dan Chrome-driver

Langkah Instalasi

Jika terjadi kesalahan, perhatikan petunjuk pemecahan masalah di bawah ini. Untuk pengguna Windows: Gunakan Git Bash untuk menjalankan skrip shell.

1. Klon dan bangun modul plugin menggunakan skrip ./bin/clone-repos-https.sh (atau ./bin/clone-repos.sh jika Anda sudah mengatur tombol SSH di github). Anda harus menunggu sampai bangunan berhasil sebelum membuka IntelliJ, jika tidak Intellij tidak akan menemukan semua kelas yang dihasilkan. Pertama kali pengguna Maven perlu menunggu beberapa menit sampai semua dependensi diunduh dari Maven Central.
2. Impor proyek ke IntelliJ:
   1. Mulai IntelliJ
   2. Pilih Buka ...
   3. Pilih folder warnings-ng-plugin-devenv
   4. Opsional (hanya ketika IntelliJ bertanya): Proyek Maven perlu diimpor Select Enable Auto-Impor .
   5. Opsional (hanya ketika IntelliJ bertanya): Proyek Kepercayaan dan Proyek Maven Terbuka Select Trust Project (lihat Intellij Online Help)
3. Jalankan peluncur uji di IntelliJ untuk proyek model analisis dan model cakupan.
4. Untuk pengguna Windows: Mulai Docker Desktop jika belum selesai
5. Mulailah Jenkins dengan ./bin/jenkins.sh . Perintah ini membangun gambar Jenkins Docker, mengunduh semua plugin terdaftar dan menginisialisasi ruang kerja Jenkins dengan beberapa pekerjaan. Ini membutuhkan beberapa menit juga (lihat langkah 9).
6. Masuk ke Jenkins di: http: // localhost: 8080/
7. Gunakan kredensial berikut:
   • Pengguna: Admin
   • Kata sandi: Admin
8. Mulai pekerjaan Jenkins yang disediakan yang menunjukkan plugin beraksi:
   • Freestyle-Analysis-Model : Jenkins Freestyle Job yang membangun perpustakaan model analisis. Kerja kerja ini semua peringatan dalam satu laporan Jenkins dan juga menunjukkan hasil pertanggungan kode Jacoco.
   • Pipeline-CodingStyle : Pipa Jenkins yang dituliskan yang membangun perpustakaan CodingStyle. Pekerjaan ini menunjukkan hasil individu untuk parsers peringatan yang berbeda. Selain itu, pekerjaan ini menunjukkan rincian cakupan kode Jacoco dan cakupan mutasi pit.
   • Sejarah-Coverage-Model : Pipa Jenkins Scripted yang membangun semua rilis yang ada dari proyek model cakupan. Bangunan akan memakan waktu beberapa saat tetapi menunjukkan bagaimana grafik tren bekerja dan bagaimana perhitungan delta dilakukan. Pekerjaan menghasilkan hasil untuk semua alat analisis statis, cakupan kode Jacoco, dan cakupan mutasi pit.
9. Menyebarkan kepala plugin saat ini ke instance Jenkins menggunakan peluncur di IntelliJ.

Instalasi - Pemecahan Masalah

Langkah 1 - Instalasi Gagal

Jika semua unduhan telah berhasil, tetapi instalasi gagal karena kesalahan, perbaiki dan jalankan mvn -V -U -e install –DskipTests untuk mencoba lagi instalasi.

Langkah 3 - "Baris perintah terlalu panjang."

Jika kesalahan "baris perintah terlalu panjang." terjadi, jalankan langkah -langkah berikut:

1. Klik Edit Konfigurasi dan pilih Konfigurasi Jalankan Gagal (atau klik pada nama peluncur tes dalam pesan kesalahan)
2. Klik Bangun dan Jalankan > Modifikasi Opsi > Baris Perintah Shorten
3. Di dalam baris perintah Shorten Field yang muncul, pilih @argfile (Java9+)
4. Klik Terapkan dan OK dan jalankan peluncur uji lagi
5. (Mungkin, IntelliJ harus dimulai ulang jika tidak ada tes yang ditemukan)

Langkah 3 - Jenkins Test Timeout

Jika tes gagal karena batas waktu tes Jenkins, jalankan langkah -langkah berikut:

1. Klik Edit Konfigurasi dan pilih Konfigurasi Jalankan Gagal
2. Tambahkan ke opsi VM : -Djenkins.test.timeout=1000 . Ini meningkatkan batas batas waktu hingga 1000 detik.

Mengkloning modul

Anda dapat menggunakan skrip shell sederhana ( ./bin/clone-repos.sh ) untuk mengkloning dan membangun modul dalam satu langkah. Skrip memeriksa modul berikut menggunakan protokol Git SSH. Ini mengharuskan Anda telah mendaftarkan kunci publik Anda di GitHub. Jika Anda tidak memiliki kunci di github, Anda dapat menggunakan skrip ./bin/clone-repos-https.sh yang menggunakan protokol https.

• CodingStyle: My CodingStyle dengan aturan yang telah dikonfigurasi sebelumnya untuk CheckStyle, PMD, dan SpotBugs. Konfigurasi ini dapat ditautkan di IntelliJ untuk memastikan bahwa kode sesuai dengan aturan.
• Analisis-Model: Perpustakaan untuk membaca laporan analisis statis ke dalam model objek Java. Modul ini tidak tergantung pada Jenkins.
• Analisis-Model-API-PLUGIN: Pembungkus sederhana untuk pustaka model analisis. Ini menyediakan kelas model analisis sebagai plugin Jenkins. Overhead ini diperlukan untuk menyederhanakan peningkatan modul model-model di Jenkins.
• PERINGATAN-NG-PLUGIN: Plugin untuk membaca laporan analisis statis dan menunjukkan hasil yang sesuai di Jenkins.
• Model cakupan: Perpustakaan untuk membaca laporan cakupan ke dalam model objek Java. Modul ini tidak tergantung pada Jenkins.
• Cakupan-Plugin: Plugin untuk membaca laporan cakupan dan menunjukkan hasil yang sesuai di Jenkins.

Forking beberapa modul

Ketika Anda berencana untuk memberikan permintaan tarik untuk salah satu plugin yang Anda butuhkan untuk membuat garpu repositori dan membuat semua perubahan di garpu ini. Saya membuat dokumentasi kolaborasi GitHub dalam proyek gaya pengkodean saya.

Memodifikasi dan men -debugging kode dengan IntelliJ

IntelliJ (Ultimate) adalah lingkungan pengembangan utama yang didukung untuk plugin peringatan. Proyek yang telah ditentukan disimpan di folder .idea yang merujuk semua modul plugin peringatan. Proyek ini berisi preset gaya pengkodean saya dan beberapa konfigurasi bermanfaat lainnya.

Harus dimungkinkan untuk menggunakan IDE lain (Eclipse, NetBeans, Visual Studio Code) juga.

Menjalankan unit dan tes integrasi

Gunakan Konfigurasi Jalankan IntelliJ yang disediakan All in [module-name] untuk menjalankan unit dan uji integrasi dari modul yang sesuai. Konfigurasi ini sudah dikonfigurasi untuk merekam cakupan cabang dari paket modul yang sesuai (gunakan aksi Run with Coverage ).

Debugging

Sebelum Anda dapat men -debug perubahan, terlebih dahulu Anda harus mencari tahu di mana kode Anda berjalan: pada pengontrol atau pada agen? Jika Anda tidak yakin, maka jalankan kedua debugger jarak jauh, atur beberapa breakpoint dan tunggu debugger yang sesuai berhenti.

Debugging The Jenkins Controller

Konfigurasi Docker Compose memulai pengontrol Jenkins secara otomatis dalam mode 'Debug', yaitu, itu mendengarkan permintaan debug jarak jauh. Jika kode Anda berjalan di controller, maka Anda perlu memasang debugger jarak jauh di localhost:8000 (dipetakan ke port yang sama di wadah Docker). Gunakan konfigurasi debug Jenkins Controller (Remote Debugger) yang disediakan untuk menghubungkan debugger di IntelliJ.

Men -debug agen Jenkins

Konfigurasi Docker Compose juga memulai agen Jenkins secara otomatis dalam mode 'Debug', yaitu, itu mendengarkan permintaan debug jarak jauh. Lampirkan debugger jarak jauh di localhost:8001 (dipetakan ke port yang sama di wadah Docker) untuk men -debug kode yang berjalan pada agen. Gunakan konfigurasi debug Jenkins Agent (Remote Debugger) yang disediakan untuk menghubungkan debugger di IntelliJ.

Menjalankan tes UI

Tes UI dapat dimulai menggunakan UI Tests [module] (Firefox) atau UI Tests [module] (Chrome) . Perhatikan bahwa kedua peluncur memerlukan pemasangan driver selenium yang sesuai. Jika driver ini tidak diinstal di /opt/bin pada mesin lokal Anda maka Anda perlu menyesuaikan konfigurasi peluncur agar sesuai dengan pengaturan Anda.

Semua tes UI memerlukan berjalan dalam subjek tertentu yang diuji (yaitu, Jenkins Under Test, Jut), lihat Proyek Harness Tes Penerimaan untuk lebih jelasnya.

Memulai Jenkins

Lingkungan pengembangan ini berisi instalasi Jenkins yang disesuaikan di mana Anda dapat menggunakan plugin yang dimodifikasi, sehingga Anda dapat melihat perubahan Anda secara langsung di beberapa pekerjaan yang telah dikonfigurasi sebelumnya yang menggunakan plugin ini.

Mulai pengontrol Jenkins yang disediakan dalam proyek ini (Anda perlu menginstal Docker dan Docker-Compose). Buka terminal dan jalankan ./jenkins.sh di folder level atas. Perintah ini adalah pembungkus untuk docker-compose up : menggunakan pengaturan pengguna dan grup yang tepat sehingga izin volume Docker untuk folder rumah Jenkins diatur dengan benar. Perintah ini membuat wadah Docker untuk pengontrol Jenkins dan satu untuk agen Java. Ini akan membutuhkan waktu ketika disebut pertama kali karena gambar Docker akan disusun. Setelah gambar dibuat, dua wadah berikut akan dimulai:

• Jenkins-Controller: Resmi Jenkins LTS Docker Image (Alpine Linux). Pengontrol sebelumnya dikonfigurasikan menggunakan JCASC untuk membangun aplikasi Java pada agen. Pengontrol tidak diperbolehkan menjalankan pekerjaan.
• Java-Agent: Agen Java minimal berdasarkan gambar Docker OpenJDK8 resmi (Alpine Linux). Pengontrol dan agen terhubung menggunakan SSH.

Anda kemudian dapat membuka Jenkins di url http: // localhost: 8080/. Gunakan kredensial berikut untuk masuk sebagai administrator:

• Pengguna: Admin
• Kata sandi: Admin

Volume untuk Jenkins_Home

Direktori Home dari Jenkins Controller (Jenkins_Home) dipasang sebagai volume Docker. Yaitu, itu terlihat pada tuan rumah sebagai direktori normal di ./docker/volumes/jenkins-controller . Ini akan selamat dari sesi dan dapat diubah langsung pada host, lihat dokumentasi resmi untuk detailnya. Ini membantu untuk memeriksa file yang telah dibuat oleh pengontrol Jenkins.

Karena masalah kinerja di plugin DSL pekerjaan Jenkins, menyiapkan instance Jenkins yang baru sangat lambat. Oleh karena itu, masuk akal untuk menghapus bagian konfigurasi pekerjaan dari file jenkins.yaml Anda setelah pekerjaan telah dibuat. Anda dapat menimpa konten file ./docker/volumes/jenkins-home/jenkins.yaml dalam instance Jenkins Anda yang baru dibuat dengan konten di jenkins-no-jobs.yaml .

Volume di bawah macOS cukup lambat. Pada MacBook saya menjalankan pekerjaan Jenkins yang disediakan dari analysis-model dalam wadah Docker lebih lambat daripada menjalankan pekerjaan Jenkins yang sama dalam wadah Docker yang berjalan di mesin virtual Linux pada MacBook yang sama (terdengar agak absurd?).

Menyebarkan plugin yang diubah ke Jenkins

Setelah Anda menyelesaikan perubahan pengembangan lokal Anda (yaitu, tes unit semuanya hijau), Anda harus menguji perubahan Anda di Jenkins. Ini juga membantu menyiapkan tes integrasi atau tes UI untuk perubahan Anda.

Mengubah model analisis tanpa menambahkan metode API baru

Jika Anda hanya memiliki perubahan dalam modul analysis-model (dan Anda tidak menambahkan metode API baru) maka Anda perlu membangun kembali dan menginstal analysis-model.jar dan setelah itu membangun kembali plugin analysis-model-api-plugin . Plugin ini kemudian perlu digunakan ke Jenkins.

Proses ini disederhanakan dengan menjalankan skrip ./bin/go.sh dalam Modul analysis-model , ia akan menginstal Modul analysis-model.jar di repositori Maven lokal Anda. Maka skrip ini akan membangun plugin yang sebenarnya dan menggunakannya ke Jenkins.

Mengubah Plugin Peringatan

Jika Anda hanya memiliki perubahan dalam plugin peringatan-NG maka Anda perlu membangun kembali Plugin Jenkins warnings-ng.jpi dan menggunakannya ke Jenkins. Anda dapat menggunakan salah satu skrip shell berikut untuk tugas ini:

• ./bin/clean.sh : Membangun plugin menggunakan mvn clean install dan menggunakannya pada kesuksesan ke instance Jenkins.
• ./bin/go.sh : Membangun plugin menggunakan mvn clean install -DskipITs (lewati uji integrasi) dan menyebarkannya pada keberhasilan ke dalam Jenkins Instace.
• ./bin/skip.sh : Membangun plugin menggunakan mvn clean install -DskipTests (melompati semua tes dan analisis statis) dan menggunakannya pada keberhasilan ke instance Jenkins.

Mengubah model analisis dengan menambahkan metode API baru

Todo

Mengubah forensik-api-plugin dan git-forensik-plugin

Jika Anda memiliki perubahan di salah satu plugin Foresics (implementasi API atau GIT) maka Anda perlu membangun kembali plugin Jenkins ini dan menyebarkannya ke instance Jenkins.

Untuk menyederhanakan proses ini, jalankan skrip ./go.sh di folder plugin yang sesuai, itu akan membangun plugin dan menggunakannya pada kesuksesan ke Jenkins.

Mengubah modul dengan perubahan API yang melanggar

Sebelum membuat perubahan besar, silakan menghubungi saya. Biasanya, dimungkinkan untuk membuat perubahan kompatibel ke belakang.

Peluncur Intellij untuk menggunakan plugin

Skrip build dari bagian terakhir juga dapat dimulai menggunakan salah satu peluncur IntelliJ Build and Deploy [module-name] . Peluncur ini membangun plugin yang sesuai dan menggunakannya ke Jenkins.

Harness Tes Penerimaan

Tes UI dapat dimulai menggunakan konfigurasi peluncur IntelliJ atau menggunakan skrip baris perintah. Seperti yang telah disebutkan, semua tes UI perlu dijalankan dalam subjek tertentu yang diuji. Dalam kasus kami, kami menggunakan versi Jenkins LTS terbaru yang tersedia dan set plugin yang telah ditentukan dari gambar Docker kami.

Menjalankan tes UI di IntelliJ

Tes UI dapat dimulai menggunakan UI Tests Warnings (Firefox) atau UI Warnings Tests (Chrome) . Perhatikan bahwa kedua peluncur memerlukan pemasangan driver selenium yang sesuai. Jika driver ini tidak diinstal di /opt/bin pada mesin lokal Anda maka Anda perlu menyesuaikan konfigurasi peluncur agar sesuai dengan pengaturan Anda.

Menjalankan tes UI dari konsol

Anda juga dapat memulai tes UI menggunakan scrips scrips yang disediakan testFirefox.sh atau testChrome.sh . Perhatikan bahwa Anda mungkin perlu mengadaptasi skrip ini juga (lihat bagian sebelumnya).