GitHub - Otomatisasi Peninjauan Kode dengan GenAI

1. Ringkasan

Di lab ini, Anda akan menyiapkan alur kerja GitHub Actions dan mengintegrasikannya dengan Gemini untuk mengotomatiskan langkah-langkah peninjauan kode.

Yang akan Anda pelajari

Di lab ini, Anda akan mempelajari cara melakukan hal-hal berikut:

• Cara menambahkan langkah otomatisasi peninjauan kode GenAI di GitHub
• Cara menjalankan CLI devai secara lokal untuk mengotomatiskan peninjauan kode

Prasyarat

• Di lab ini, Anda dianggap telah memahami Konsol Cloud dan lingkungan Cloud Shell.

2. Penyiapan dan Persyaratan

Penyiapan Project Cloud

1. Login ke Google Cloud Console dan buat project baru atau gunakan kembali project yang sudah ada. Jika belum memiliki akun Gmail atau Google Workspace, Anda harus membuatnya.

• Project name adalah nama tampilan untuk peserta project ini. String ini adalah string karakter yang tidak digunakan oleh Google API. Anda dapat memperbaruinya kapan saja.
• Project ID bersifat unik di semua project Google Cloud dan tidak dapat diubah (tidak dapat diubah setelah ditetapkan). Cloud Console otomatis membuat string unik; biasanya Anda tidak mementingkan kata-katanya. Di sebagian besar codelab, Anda harus merujuk Project ID-nya (umumnya diidentifikasi sebagai PROJECT_ID). Jika tidak suka dengan ID yang dibuat, Anda dapat membuat ID acak lainnya. Atau, Anda dapat mencobanya sendiri, dan lihat apakah ID tersebut tersedia. ID tidak dapat diubah setelah langkah ini dan tersedia selama durasi project.
• Sebagai informasi, ada nilai ketiga, Project Number, yang digunakan oleh beberapa API. Pelajari lebih lanjut ketiga nilai ini di dokumentasi.

Perhatian: Project ID bersifat unik secara global dan tidak dapat digunakan orang lain setelah Anda memilihnya. Anda adalah satu-satunya pengguna ID tersebut. Meskipun project sudah dihapus, ID tersebut tidak dapat digunakan lagi

Catatan: Jika menggunakan akun Gmail, Anda dapat menyetel lokasi default ke No organization. Jika Anda menggunakan akun Google Workspace, pilih lokasi yang sesuai untuk organisasi Anda.

2. Selanjutnya, Anda harus mengaktifkan penagihan di Konsol Cloud untuk menggunakan resource/API Cloud. Menjalankan operasi dalam codelab ini tidak akan memakan banyak biaya, bahkan mungkin tidak sama sekali. Guna mematikan resource agar tidak menimbulkan penagihan di luar tutorial ini, Anda dapat menghapus resource yang dibuat atau menghapus project-nya. Pengguna baru Google Cloud memenuhi syarat untuk mengikuti program Uji Coba Gratis senilai $300 USD.

Penyiapan Lingkungan

Buka chat Gemini.

Atau ketik "Tanya Gemini" di kotak penelusuran.

Aktifkan Cloud AI Companion API:

Klik "Start chatting" dan ikuti salah satu contoh pertanyaan atau ketik perintah Anda sendiri untuk mencobanya.

Perintah yang dapat dicoba:

• Jelaskan Cloud Run dalam 5 poin utama.
• Anda adalah Product Manager Google Cloud Run, jelaskan Cloud Run kepada seorang siswa dalam 5 poin penting singkat.
• Anda adalah Product Manager Google Cloud Run, jelaskan Cloud Run kepada Developer Kubernetes Bersertifikat dalam 5 poin penting singkat.
• Anda adalah Product Manager Google Cloud Run, jelaskan kapan Anda akan menggunakan Cloud Run versus GKE kepada Developer Senior dalam 5 poin penting singkat.

Lihat Panduan Perintah untuk mempelajari lebih lanjut cara menulis perintah yang lebih baik.

Cara Gemini untuk Google Cloud menggunakan data Anda

Komitmen privasi Google

Google adalah salah satu yang pertama di industri yang memublikasikan komitmen privasi AI/ML, yang menguraikan keyakinan kami bahwa pelanggan harus memiliki tingkat keamanan dan kontrol tertinggi atas data mereka yang disimpan di cloud.

Data yang Anda kirimkan dan terima

Pertanyaan yang Anda ajukan kepada Gemini, termasuk informasi input atau kode yang Anda kirimkan ke Gemini untuk dianalisis atau diselesaikan, disebut perintah. Jawaban atau penyelesaian kode yang Anda terima dari Gemini disebut respons. Gemini tidak menggunakan perintah Anda atau responsnya sebagai data untuk melatih modelnya.

Enkripsi perintah

Saat Anda mengirimkan perintah ke Gemini, data Anda dienkripsi selama pengiriman sebagai input ke model pokok di Gemini.

Data program yang dihasilkan dari Gemini

Gemini dilatih dengan kode Google Cloud pihak pertama serta kode pihak ketiga yang dipilih. Anda bertanggung jawab atas keamanan, pengujian, dan efektivitas kode Anda, termasuk penyelesaian, pembuatan, atau analisis kode yang ditawarkan Gemini kepada Anda.

Pelajari lebih lanjut cara Google menangani perintah Anda.

3. Opsi untuk menguji perintah

Jika ingin mengubah/memperluas perintah devai cli yang ada, Anda memiliki beberapa opsi untuk melakukannya.

• Vertex AI Studio

Vertex AI Studio adalah bagian dari platform Vertex AI Google Cloud, yang dirancang khusus untuk menyederhanakan dan mempercepat pengembangan serta penggunaan model AI generatif.

• Google AI Studio

Google AI Studio adalah alat berbasis web untuk membuat prototipe dan bereksperimen dengan rekayasa perintah dan Gemini API.

• Aplikasi Web Gemini (gemini.google.com)

Aplikasi web Google Gemini (gemini.google.com) adalah alat berbasis web yang dirancang untuk membantu Anda menjelajahi dan memanfaatkan kecanggihan model AI Gemini Google.

• Aplikasi seluler Google Gemini untuk Android dan aplikasi Google di iOS

4. Buat Akun Layanan

Aktifkan Cloud Shell dengan mengklik ikon di sebelah kanan kotak penelusuran.

Di terminal yang terbuka, aktifkan layanan yang diperlukan untuk menggunakan Vertex AI API dan chat Gemini.

gcloud services enable \
    aiplatform.googleapis.com \
    cloudaicompanion.googleapis.com \
    cloudresourcemanager.googleapis.com \
    secretmanager.googleapis.com

Jika diminta untuk memberikan otorisasi, klik "Authorize" untuk melanjutkan.

Jalankan perintah berikut untuk membuat akun layanan dan kunci baru.

Anda akan menggunakan akun layanan ini untuk melakukan panggilan API ke Vertex AI Gemini API dari pipeline CICD.

PROJECT_ID=$(gcloud config get-value project)
SERVICE_ACCOUNT_NAME='vertex-client'
DISPLAY_NAME='Vertex Client'
KEY_FILE_NAME='vertex-client-key'

gcloud iam service-accounts create $SERVICE_ACCOUNT_NAME --display-name "$DISPLAY_NAME"

gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com" --role="roles/aiplatform.admin" --condition None

gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com" --role="roles/secretmanager.secretAccessor" --condition None

gcloud iam service-accounts keys create $KEY_FILE_NAME.json --iam-account=$SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com

5. Membuat fork repo GitHub ke repo GitHub pribadi Anda

Buka https://github.com/GoogleCloudPlatform/genai-for-developers/fork dan pilih ID pengguna GitHub Anda sebagai pemilik.

Hapus centang pada opsi untuk hanya menyalin cabang "utama".

Klik "Create fork".

6. Mengaktifkan Alur Kerja GitHub Actions

Buka repo GitHub yang di-fork di browser dan beralih ke tab "Actions" untuk mengaktifkan alur kerja.

7. Menambahkan Secret Repositori

Buat secret repositori di bagian "Settings / Secrets and variables / Actions" di repositori GitHub yang di-fork.

Tambahkan secret Repositori dengan nama "GOOGLE_API_CREDENTIALS".

Beralihlah ke jendela/tab Google Cloud Shell dan jalankan perintah di bawah di terminal Cloud Shell.

cat ~/vertex-client-key.json

Salin konten file dan tempel sebagai nilai untuk secret.

Tambahkan secret PROJECT_ID dengan project ID Qwiklabs Anda sebagai nilai:

8. Menjalankan Alur Kerja GitHub Actions

Buka repositori GitHub Anda di browser dan jalankan alur kerja.

Alur kerja dikonfigurasi untuk berjalan pada push kode atau eksekusi manual.

Meninjau hasil:

Hasil perintah cakupan pengujian:

devai review testcoverage -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Hasil perintah peninjauan kode:

devai review code -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Hasil perintah peninjauan performa:

devai review performance -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Hasil perintah peninjauan keamanan:

devai review security -c ${{ github.workspace }}/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Pemblokir meninjau hasil perintah:

devai review blockers -c ${{ github.workspace }}/sample-app/pom.xml

9. Melakukan cloning repositori

Kembali ke terminal Cloud Shell dan clone repositori.

Ubah YOUR-GITHUB-USERID menjadi userid GitHub Anda sebelum menjalankan perintah.

git clone https://github.com/YOUR-GITHUB-USERID/genai-for-developers.git 

Ubah folder dan buka file alur kerja di Cloud Shell Editor.

cd genai-for-developers

cloudshell edit .github/workflows/devai-review.yml 

Tunggu hingga file konfigurasi ditampilkan di IDE.

10. Mengaktifkan Gemini Code Assist

Klik ikon "Gemini" di pojok kanan bawah ,

klik "Login to Google Cloud" dan "Select a Google Cloud Project".

Dari jendela pop-up, pilih project Qwiklabs Anda.

11. Menjelaskan kode dengan Gemini Code Assist

Klik kanan di mana saja dalam file devai-review.yml dan pilih Gemini Code Assist > Explain ini.

Penjelasan peninjauan:

12. Menjalankan DEVAI CLI secara lokal

Kembali ke terminal Cloud Shell dan jalankan perintah di bawah untuk menginstal devai secara lokal.

pip3 install devai-cli

CLI telah diinstal, tetapi tidak ada di PATH.

WARNING: The script devai is installed in '/home/student_00_478dfeb8df15/.local/bin' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.

Jalankan perintah di bawah untuk memperbarui variabel lingkungan PATH. Ganti dengan nama folder beranda pengguna Anda. Contoh: student_00_478dfeb8df15

export PATH=$PATH:/home/YOUR-USER-HOME-FOLDER/.local/bin

Jalankan perintah devai cli untuk melakukan peninjauan kode secara lokal. Tinjau output CLI.

export PROJECT_ID=$(gcloud config get-value project)
export LOCATION=us-central1

cd ~/genai-for-developers

devai review code -c ./sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Buka skrip peninjauan dengan menjalankan perintah di bawah:

cloudshell edit devai-cli/src/devai/commands/review.py

Klik kanan di mana saja dalam file review.py dan pilih Gemini Code Assist > Explain ini.

Tinjau penjelasan.

13. Pengembangan CLI DevAI

Di bagian ini, Anda akan melakukan perubahan pada devai cli.

Untuk memulai, siapkan virtualenv python, instal persyaratan, dan jalankan perintah contoh.

cd ~/genai-for-developers/devai-cli
python3 -m venv venv
. venv/bin/activate
pip3 install -r src/requirements.txt
pip3 install --editable ./src
devai echo

Jalankan ulang perintah peninjauan kode untuk memeriksa apakah semuanya berfungsi dengan baik:

devai review code -c ~/genai-for-developers/sample-app/src/main/java/anthos/samples/bankofanthos/balancereader

Tinjau hasil menggunakan pratinjau Markdown di Cloud Shell Editor.

Buat file baru dan tempel respons Gemini.

Kemudian, gunakan Palet Perintah dan pilih "Markdown: Open Preview".

14. Menjelajahi perintah devai cli

Perintah peninjauan kode

devai review code -c ~/genai-for-developers/sample-app/src/main/java

Perintah peninjauan performa

devai review performance -c ~/genai-for-developers/sample-app/src/main/java

Perintah peninjauan keamanan

devai review security -c ~/genai-for-developers/sample-app/src/main/java

Perintah peninjauan cakupan pengujian

devai review testcoverage -c ~/genai-for-developers/sample-app/src

Perintah peninjauan pemblokir

devai review blockers -c ~/genai-for-developers/sample-app/pom.xml
devai review blockers -c ~/genai-for-developers/sample-app/setup.md

Peninjauan dan ringkasan Gambar/Diagram:

Diagram input[~/genai-for-developers/images/extension-diagram.png]:

Perintah peninjauan:

devai review image \
  -f ~/genai-for-developers/images/extension-diagram.png \
  -p "Review and summarize this diagram"

Output:

The diagram outlines a process for conducting local code reviews using a VS Code extension or CLI, leveraging Google Cloud's Vertex AI (Gemini Pro) for generating review prompts. 

**Process Flow:**

1. **Code Style Check:** Developers initiate the process by checking their code for adherence to pre-defined style guidelines.
2. **Prompt Generation:** The VS Code extension/CLI sends the code to Vertex AI (Gemini Pro) on Google Cloud. 
3. **Vertex AI Review:**  Vertex AI analyzes the code and generates relevant review prompts.
4. **Local Review:** The prompts are sent back to the developer's IDE for their consideration.
5. **Optional Actions:** Developers can optionally: 
    - Create new JIRA issues directly from the IDE based on the review prompts.
    - Generate new issues in a GitLab repository.

**Key Components:**

* **VS Code Extension/CLI:** Tools facilitating the interaction with Vertex AI and potential integrations with JIRA and GitLab.
* **Vertex AI (Gemini Pro):**  Google Cloud's generative AI service responsible for understanding the code and generating meaningful review prompts.
* **Google Cloud Secret Manager:** Securely stores API keys and access tokens required to authenticate and interact with Google Cloud services.
* **JIRA/GitLab (Optional):** Issue tracking and project management tools that can be integrated for a streamlined workflow.

**Benefits:**

* **Automated Review Assistance:**  Leveraging AI to generate review prompts saves time and improves the consistency and quality of code reviews. 
* **Local Development:** The process empowers developers to conduct reviews locally within their familiar IDE.
* **Integration Options:** The flexibility to integrate with project management tools like JIRA and GitLab streamlines workflow and issue tracking.

Analisis perbedaan gambar:

devai review imgdiff \
  -c ~/genai-for-developers/images/devai-api.png \
  -t ~/genai-for-developers/images/devai-api-slack.png  

Output:

The following UI elements are missing in the "AFTER UPGRADE STATE" image compared to the "BEFORE UPGRADE STATE" image:

1. **Slack:** The entire Slack element, including the icon, "Team channel" label, and the arrow indicating interaction, is absent in the AFTER UPGRADE image. 
2. **Storage Bucket:**  The "Storage Bucket" element with its icon and "PDFs" label is missing in the AFTER UPGRADE image. 
3. **"GenAI Agents" label in Vertex AI block:** The BEFORE UPGRADE image has "Vertex AI Agents" and "GenAI Agent" labels within the Vertex AI block, while the AFTER UPGRADE image only has "Vertex AI."
4. **"Open JIRA Issue" and "Team Project" labels:** In the BEFORE UPGRADE image, these labels are connected to the JIRA block with an arrow. These are missing in the AFTER UPGRADE image.

**Decision Explanation:**

The analysis is based on a direct visual comparison of the two provided images, noting the presence and absence of specific UI elements and their associated labels. The elements listed above are present in the BEFORE UPGRADE image but absent in the AFTER UPGRADE image.

Perintah pembuatan dokumentasi:

devai document readme -c ~/genai-for-developers/sample-app/src/main/

Output:

# Bank of Anthos - Balance Reader Service

## Description

The Balance Reader service is a component of the Bank of Anthos sample application. It provides a REST endpoint for retrieving the current balance of a user account. This service demonstrates key concepts for building microservices with Spring Boot and deploying them to a Kubernetes cluster.

## Features
...

Tinjau perintah devai cli yang tersedia di Cloud Shell Editor:

cloudshell edit ~/genai-for-developers/devai-cli/README.md

Atau tinjau README.md di repositori GitHub.

15. Selamat!

Selamat, Anda telah menyelesaikan codelab!

Yang telah kita bahas:

• Menambahkan langkah otomatisasi peninjauan kode GenAI di GitHub
• Menjalankan cli devai secara lokal

Langkah berikutnya:

• Sesi praktik lainnya akan segera hadir.

Pembersihan

Agar tidak dikenai biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.

Menghapus project

Cara termudah untuk menghilangkan penagihan adalah dengan menghapus project yang Anda buat untuk tutorial.

©2024 Google LLC Semua hak dilindungi undang-undang. Google dan logo Google adalah merek dagang dari Google LLC. Semua nama perusahaan dan produk lain mungkin adalah merek dagang masing-masing perusahaan yang bersangkutan.