Membuat suite Continuous Integration

Suite Continuous Integration (CI) adalah serangkaian petunjuk validasi yang terkait dengan project LookML Anda. Pengguna Looker dengan izin manage_ci dapat mengonfigurasi hal berikut dalam suite CI:

• Cara pemicuan eksekusi validasi CI (secara manual dari Looker IDE atau secara otomatis saat permintaan pull dikirim ke repositori Anda).
• Validator CI yang akan dijalankan.
• Opsi tambahan untuk setiap pengujian validasi. Lihat halaman dokumentasi untuk setiap validator guna mengetahui detailnya:
  • Validator SQL
  • Validator Pernyataan
  • Validator Konten
  • LookML Validator
  • Validator Gaya

Sebelum memulai

Sebelum dapat membuat suite CI, Anda memerlukan hal berikut:

• Instance Looker yang memenuhi persyaratan untuk CI dan diaktifkan untuk CI.
• Akun pengguna Looker dengan izin manage_ci (izin ini disertakan dalam set izin Admin).
• Project LookML dengan setidaknya satu commit yang telah di-deploy ke produksi. Layanan latar belakang CI dapat mengambil konfigurasi Git project hanya jika project berada dalam Mode Produksi. Jika project hanya ada dalam Mode Pengembangan, CI akan menampilkan error saat mengonfigurasi pemicu webhook.

Membuat suite CI

Anda dapat mengonfigurasi dan menjalankan validator di halaman Suites di Looker IDE:

Untuk membuat suite CI, ikuti langkah-langkah berikut:

1. Dari Looker IDE, klik ikon Continuous Integration dari menu navigasi IDE.
2. Klik tab Suites untuk membuka halaman Suites.
3. Di halaman Suites, Anda dapat membuat suite baru atau mengedit suite yang ada:
   • Untuk membuat suite baru, klik tombol Create suite.
   • Untuk mengedit suite yang ada, klik tombol Edit suite untuk suite tersebut.
4. Masukkan nama untuk Suite name. Jika mengedit suite yang ada, Anda dapat mengklik ikon pensil untuk mengedit nama suite.
5. (Opsional) Aktifkan tombol Trigger on a schedule jika Anda ingin menyiapkan pengujian validasi otomatis pada jadwal berulang. Lihat bagian Memicu sesuai jadwal di halaman ini untuk mengetahui informasi selengkapnya.

6. (Opsional) Aktifkan tombol Trigger on pull requests from Looker jika Anda ingin menyiapkan pengujian validasi otomatis setiap kali developer Looker mengirimkan permintaan pull ke repositori Anda. Lihat bagian Pemicu pada permintaan pull dari Looker di halaman ini untuk mengetahui informasi selengkapnya.

   Jika mengaktifkan pemicuan permintaan pull untuk suite CI, Anda dapat menggunakan kolom Only for target branch untuk menentukan bahwa permintaan pull hanya ke cabang tertentu di repositori yang akan memicu eksekusi suite CI. Lihat bagian Pemicu pada permintaan pull dari Looker di halaman ini untuk mengetahui informasi selengkapnya.

7. (Opsional) Aktifkan tombol Trigger on pull requests from dbt Cloud jika Anda ingin menyiapkan pengujian validasi otomatis setiap kali tugas dbt Cloud CI dijalankan. Lihat bagian Memicu permintaan pull dari dbt Cloud di halaman ini untuk mengetahui informasi selengkapnya.

8. (Opsional) Jika Anda ingin menyiapkan pengujian validasi otomatis setiap kali permintaan pull dikirim ke project upstream (hub) yang diimpor, lakukan langkah-langkah berikut:

   1. Aktifkan tombol Pemicu pada permintaan pull dari project yang diimpor.
   2. Di bagian Select upstream projects to subscribe to, centang kotak untuk setiap project hub yang diimpor yang akan memicu eksekusi suite CI ini. Anda harus memilih minimal satu project upstream.

   Lihat bagian Memicu permintaan pull dari project yang diimpor di halaman ini untuk mengetahui informasi selengkapnya.

9. (Opsional) Aktifkan tombol Enable email alerts jika Anda ingin menerima pemberitahuan email yang didasarkan pada status operasi CI. Lihat bagian Menyiapkan pemberitahuan di halaman ini untuk mengetahui informasi selengkapnya.

10. Secara opsional, aktifkan tombol validator untuk mengaktifkan validator dan mengonfigurasi opsinya. Lihat halaman dokumentasi berikut untuk setiap validator guna mengetahui detailnya:

    • Validator SQL
    • Validator Pernyataan
    • Validator Konten
    • LookML Validator
    • Validator Gaya

11. Simpan perubahan Anda menggunakan salah satu metode berikut:

    • Jika Anda membuat suite baru, klik tombol Create suite.
    • Jika Anda mengedit suite yang ada, klik tombol Update suite.

Pemicu

CI dapat dipicu dengan beberapa cara:

• Secara otomatis, sesuai jadwal berulang.
• Secara otomatis, saat permintaan pull dikirim ke repositori project LookML Anda oleh developer Looker.
• Secara otomatis, saat tugas CI dbt Cloud membuat permintaan pull.
• Secara otomatis, saat permintaan pull dikirim ke project LookML yang diimpor.
• Secara manual, dengan menggunakan tombol Run suite di halaman Suites di Looker IDE.
• Secara manual, dengan menjalankan ulang operasi CI sebelumnya, dari halaman Runs di Looker IDE.

Memicu sesuai jadwal

Anda dapat mengonfigurasi suite CI agar otomatis dipicu sesuai jadwal dengan mengaktifkan tombol Trigger on a schedule.

Jika tombol ini diaktifkan, Anda dapat memilih frekuensi dan detail untuk menjalankan suite CI secara otomatis:

• Bulanan, pada hari dan waktu tertentu
• Mingguan, pada hari dan waktu tertentu
• Harian, pada waktu tertentu
• Per jam atau setiap 2, 3, 4, 6, 8, atau 12 jam, dimulai dan diakhiri pada waktu tertentu dalam sehari
• Menit setiap 5, 10, 15, 20, atau 30 menit, dimulai dan diakhiri pada waktu tertentu dalam sehari
• Bulan tertentu dalam setahun, pada hari dan waktu tertentu
• Hari tertentu dalam seminggu pada waktu tertentu

Pemicu pada permintaan pull dari Looker

Untuk mengonfigurasi suite CI agar dipicu secara otomatis pada permintaan pull, aktifkan tombol Trigger on pull requests from Looker. Untuk menggunakan pemicuan permintaan pull, repositori Git Anda harus dikonfigurasi oleh admin Looker di halaman Admin Continuous Integration di Looker).

Tips: Meskipun Anda mengonfigurasi suite CI untuk berjalan secara otomatis pada permintaan pull, Anda tetap dapat memulai proses manual atau menjalankan ulang proses sebelumnya secara manual dari suite CI dari Looker IDE.

Jika Anda mengaktifkan pemicu permintaan pull untuk suite CI, Anda dapat menentukan bahwa permintaan pull hanya ke cabang tertentu di repositori yang akan memicu eksekusi suite CI. Untuk membatasi pemicu permintaan pull otomatis dari operasi CI ke cabang tertentu di repositori Anda, masukkan daftar cabang yang dipisahkan koma di kolom Only for target branch.

Misalnya, jika repositori memiliki tiga cabang bernama main, release_1, dan dev, Anda dapat memasukkan main, release_1 di kolom Only for target branch. Artinya, CI akan dipicu saat developer Looker mengirimkan permintaan pull ke cabang main atau release_1. Jika developer Looker mengirimkan permintaan pull ke cabang dev, tindakan ini tidak akan memicu eksekusi otomatis suite CI.

Pemicu pada permintaan pull dari dbt Cloud

Jika telah mengonfigurasi integrasi dbt Cloud di instance, Anda dapat mengonfigurasi suite CI agar dipicu secara otomatis saat tugas CI dbt Cloud selesai. Suite CI memverifikasi apakah perubahan pada model dbt Anda akan menyebabkan error SQL di Eksplorasi Looker sebelum perubahan dbt di-deploy.

Catatan: Untuk instance Looker (Google Cloud core) yang menggunakan koneksi pribadi atau koneksi hybrid dengan Private Service Connect, atau untuk instance dalam perimeter Kontrol Layanan VPC, Anda harus memperbarui konfigurasi jaringan untuk mengizinkan traffic masuk dan keluar ke dan dari URL host dbt Cloud Anda. Untuk mengetahui informasi selengkapnya, lihat bagian dbt Cloud Configuration di halaman Admin settings - Continuous Integration.

Untuk mengonfigurasi pemicu ini, aktifkan tombol Trigger on pull requests from dbt Cloud saat membuat atau mengedit suite CI.

Setelah mengaktifkan pemicu ini, konfigurasikan opsi berikut:

• dbt Cloud Job: Pilih tugas CI dbt Cloud dari kolom drop-down yang akan memicu suite ini.

  Catatan: Hanya jenis pekerjaan CI yang didukung dan ditampilkan di drop-down ini. Operasi dbt Cloud manual tidak didukung.

• Schema user attribute: Pilih atribut pengguna Looker yang menyimpan nama skema untuk koneksi database Anda. Hanya atribut pengguna yang telah diaktifkan untuk CI di panel Admin yang akan muncul dalam daftar ini.

Saat Anda menyimpan suite dengan pemicu ini diaktifkan, Looker akan otomatis mendaftarkan webhook di akun dbt Cloud Anda untuk memantau penyelesaian tugas.

Untuk operasi yang dipicu dbt Cloud, Looker secara dinamis mengidentifikasi skema sementara yang dibuat oleh operasi dbt Cloud dan mengganti atribut pengguna yang dipilih dengan nama skema sementara ini selama durasi operasi CI.

Catatan: CI yang dipicu oleh tugas CI dbt Cloud dijalankan terhadap cabang LookML produksi. Oleh karena itu, eksekusi Validator Konten, Validator LookML, dan Validator Gaya yang dipicu oleh tugas CI dbt Cloud tidak akan menguji error pada cabang pengembangan.

Pemicu pada permintaan pull dari project yang diimpor

Jika project Looker Anda menggunakan impor project lokal untuk mengimpor project lain dari instance Looker yang sama, Anda dapat mengonfigurasi suite CI untuk menguji project downstream (dikenal sebagai project spoke) setiap kali permintaan pull dibuka atau diperbarui pada project upstream yang diimpor (dikenal sebagai project hub).

Misalnya, Anda memiliki project hub company_bi yang diimpor ke project spoke marketing dan finance. Anda dapat mengonfigurasi pemicu di project marketing dan finance untuk memvalidasi project spoke tersebut setiap kali permintaan pull dikirim ke repositori company_bi.

Sebelum mengonfigurasi pemicu ini, pertimbangkan prasyarat dan perilaku berikut:

• Hanya impor project lokal: Semua project hub yang di-subscribe harus diimpor secara lokal ke project spoke menggunakan parameter local_dependency di manifest.lkml pada instance Looker yang sama. Project jarak jauh (impor yang menggunakan parameter remote_dependency dalam file manifes project) tidak didukung.
• Git dan Mode Produksi: Project spoke dan project hub yang diimpor harus di-deploy ke Mode Produksi dan memiliki aplikasi GitHub CI yang dikonfigurasi untuk repositori Git-nya.
• Izin: Peran Looker CI Users harus memiliki izin develop untuk model di project spoke dan project hub yang diimpor.
• Perilaku validator: Karena project spoke divalidasi terhadap versi produksinya dan tidak memiliki status Git cabang pengembangan untuk dibandingkan, validasi inkremental akan otomatis dinonaktifkan untuk operasi yang dipicu oleh permintaan pull project yang diimpor, terlepas dari setelan suite. Selain itu, sebaiknya nonaktifkan CI LookML Validator dan CI Style Validator pada suite yang hanya dipicu oleh permintaan pull project yang diimpor, karena validator tersebut hanya memeriksa file project spoke dan tidak terpengaruh oleh perubahan upstream.

Untuk mengonfigurasi project spoke agar menjalankan validasi CI saat permintaan pull dikirim ke satu atau beberapa project hub yang diimpor, ikuti langkah-langkah berikut saat membuat atau mengedit suite CI di project spoke:

1. Aktifkan tombol Pemicu pada permintaan pull dari project yang diimpor.
2. Di bagian Select upstream projects to subscribe to, centang kotak untuk setiap project hub yang diimpor yang akan memicu eksekusi suite CI ini. Anda harus memilih minimal satu project upstream.

Jika Anda ingin perubahan pada project hub memicu operasi validasi di beberapa project spoke, Anda harus mengonfigurasi suite CI di setiap project spoke.

Saat Anda menyimpan suite CI, Looker akan otomatis membuat langganan webhook di setiap repositori project hub yang dipilih untuk peristiwa permintaan pull. Saat permintaan pull dikirim ke repositori project hub yang berlangganan, Looker akan memicu CI yang dijalankan di project spoke. Operasi ini memvalidasi versi produksi project spoke sambil menyematkan sementara project hub yang diimpor ke commit permintaan pull. Looker melaporkan hasil operasi CI project spoke sebagai status commit pada permintaan pull project hub. Anda juga dapat melihat detail operasi di halaman Runs project spoke di Looker IDE, tempat kolom Trigger menampilkan Project Import dan halaman hasil operasi menyertakan bagian Project Imports. Untuk mengetahui informasi selengkapnya tentang cara menjalankan proses ini dan cara memeriksa hasilnya, lihat Menjalankan suite CI dan Melihat hasil proses CI.

Menyiapkan pemberitahuan

Untuk menerima email pemberitahuan berdasarkan status operasi CI, Anda dapat menyiapkan pemberitahuan untuk CI suite. Dengan begitu, Anda dapat memantau operasi Continuous Integration tanpa harus membuka halaman Runs di Looker IDE.

Untuk mengonfigurasi email pemberitahuan untuk CI suite, ikuti langkah-langkah berikut saat membuat atau mengedit CI suite:

1. Aktifkan tombol Aktifkan pemberitahuan email.
2. Di kolom Alamat email, masukkan daftar alamat email yang dipisahkan koma yang akan menerima pemberitahuan.
3. Gunakan kotak centang untuk memilih status tugas yang akan memicu pemberitahuan:
   • Gagal: Memicu email saat eksekusi CI gagal dalam pengujian validasi.
   • Error: Memicu email saat eksekusi CI mengalami error sistem atau konfigurasi.
   • Lulus: Memicu email saat operasi CI berhasil diselesaikan.
   • Cancelled: Memicu email saat operasi CI dibatalkan.

Menghapus suite

Untuk menghapus CI suite, lakukan langkah-langkah berikut:

1. Dari Looker IDE, klik ikon Continuous Integration dari menu navigasi IDE.
2. Klik tab Suites untuk membuka halaman Suites.
3. Di halaman Suites, klik tombol Edit suite untuk suite.
4. Di halaman suite, klik tombol Delete suite.
5. Pada dialog konfirmasi, klik tombol Delete suite.