GitLab – automatyzacja sprawdzania kodu za pomocą GenAI

1. Przegląd

W tym module skonfigurujesz potok GitLab CICD i zintegrujesz go z Gemini, aby zautomatyzować kroki inspekcji kodu.

Czego się nauczysz

W tym laboratorium dowiesz się, jak wykonać następujące czynności:

• dodać w GitLabie kroki automatyzacji inspekcji kodu z użyciem generatywnej AI,
• uruchamiać lokalnie interfejs wiersza poleceń devai, aby zautomatyzować inspekcje kodu.

Wymagania wstępne

• W tym module zakładamy, że znasz środowiska konsoli Cloud i Cloud Shell.

2. Konfiguracja i wymagania

Konfiguracja projektu Cloud

1. Zaloguj się w konsoli Google Cloud i utwórz nowy projekt lub użyj istniejącego. Jeśli nie masz jeszcze konta Gmail ani Google Workspace, musisz je utworzyć.

• Nazwa projektu to wyświetlana nazwa dla uczestników tego projektu. Jest to ciąg znaków, który nie jest używany przez interfejsy API Google. Możesz go w każdej chwili zaktualizować.
• Identyfikator projektu jest unikalny we wszystkich projektach Google Cloud i niezmienny (nie można go zmienić po ustawieniu). Konsola Cloud automatycznie generuje unikalny ciąg znaków. Zwykle nie musisz się nim przejmować. W większości ćwiczeń będziesz musiał(-a) odwołać się do identyfikatora projektu (zwykle oznaczanego jako PROJECT_ID). Jeśli wygenerowany identyfikator Ci się nie podoba, możesz wygenerować inny losowy identyfikator. Możesz też spróbować użyć własnego identyfikatora i sprawdzić, czy jest dostępny. Po tym kroku nie można go zmienić i pozostaje on taki przez cały czas trwania projektu.
• Dla Twojej informacji istnieje też trzecia wartość – numer projektu, której używają niektóre interfejsy API. Więcej informacji o tych 3 wartościach znajdziesz w dokumentacji.

Uwaga: identyfikator projektu jest unikalny na całym świecie i po jego wybraniu nie może być używany przez nikogo innego. Jesteś jedynym użytkownikiem tego identyfikatora. Nawet jeśli projekt zostanie usunięty, identyfikatora nie można użyć ponownie.

Uwaga: jeśli używasz konta Gmail, możesz pozostawić domyślną lokalizację ustawioną na Brak organizacji. Jeśli używasz konta Google Workspace, wybierz lokalizację, która ma sens dla Twojej organizacji.

2. Następnie musisz włączyć płatności w konsoli Cloud, aby korzystać z zasobów i interfejsów API Cloud. Wykonanie tego ćwiczenia nie będzie Cię kosztować lub będzie kosztować bardzo mało. Aby wyłączyć zasoby i uniknąć naliczania opłat po zakończeniu tego samouczka, możesz usunąć utworzone zasoby lub projekt. Nowi użytkownicy Google Cloud mogą skorzystać z programu bezpłatnego okresu próbnego o wartości 300 USD.

Konfiguracja środowiska

Otwórz rozmowę z Gemini.

Możesz też wpisać „Zapytaj Gemini” w pasku wyszukiwania.

Włącz Gemini for Google Cloud API:

Kliknij "Start chatting" i odpowiedz na jedno z przykładowych pytań lub wpisz własny prompt, aby wypróbować tę funkcję.

Prompty do wypróbowania:

• Wyjaśnij, czym jest Cloud Run, w 5 najważniejszych punktach.
• Jesteś menedżerem produktu Google Cloud Run. Wyjaśnij studentowi, czym jest Cloud Run, w 5 krótkich punktach.
• Jesteś menedżerem produktu Google Cloud Run. Wyjaśnij certyfikowanemu programiście Kubernetes, czym jest Cloud Run, w 5 krótkich punktach.
• Jesteś menedżerem produktu Google Cloud Run. Wyjaśnij starszemu programiście, kiedy używać Cloud Run, a kiedy GKE, w 5 krótkich punktach.

Więcej informacji o pisaniu lepszych promptów znajdziesz w przewodniku po tworzeniu promptów.

Jak Gemini w Google Cloud korzysta z danych użytkowników

Zobowiązanie Google do ochrony prywatności

Google jako jedna z pierwszych firm w branży opublikowała zobowiązanie do ochrony prywatności w zakresie AI/ML, w którym podkreślamy, że klienci powinni mieć najwyższy poziom bezpieczeństwa i kontroli nad swoimi danymi przechowywanymi w chmurze.

Dane przesyłane i odbierane

Pytania, które zadajesz Gemini, w tym wszelkie dane wejściowe lub kod, które przesyłasz do Gemini w celu analizy lub uzupełnienia, nazywamy promptami. Odpowiedzi lub uzupełnienia kodu, które otrzymujesz od Gemini, nazywamy odpowiedziami. Gemini nie używa Twoich promptów ani swoich odpowiedzi jako danych do trenowania swoich modeli.

Szyfrowanie promptów

Gdy przesyłasz prompty do Gemini, Twoje dane są szyfrowane podczas przesyłania jako dane wejściowe do modelu bazowego w Gemini.

Dane programu wygenerowane przez Gemini

Gemini jest trenowany na podstawie kodu Google Cloud oraz wybranego kodu innych firm. Odpowiadasz za bezpieczeństwo, testowanie i skuteczność swojego kodu, w tym za wszelkie uzupełnienia, generowanie lub analizę kodu, które oferuje Ci Gemini.

Dowiedz się więcej o tym, jak Google przetwarza Twoje prompty.

3. Opcje testowania promptów

Jeśli chcesz zmienić lub rozszerzyć istniejące prompty interfejsu wiersza poleceń devai, masz kilka opcji.

• Vertex AI Studio

Vertex AI Studio jest częścią platformy Vertex AI w Google Cloud, która została zaprojektowana specjalnie w celu uproszczenia i przyspieszenia tworzenia i używania modeli generatywnej AI.

• Google AI Studio

Google AI Studio to internetowe narzędzie do tworzenia prototypów i eksperymentowania z inżynierią promptów oraz interfejsem Gemini API.

• Aplikacja internetowa Gemini (gemini.google.com)

Aplikacja internetowa Gemini od Google (gemini.google.com) to narzędzie internetowe, które pomaga odkrywać i wykorzystywać możliwości modeli AI Gemini od Google.

• Aplikacja mobilna Gemini na Android i aplikacja Google na iOS

4. Utwórz konto usługi

Aktywuj Cloud Shell, klikając ikonę po prawej stronie paska wyszukiwania.

W otwartym terminalu włącz wymagane usługi, aby korzystać z interfejsów Vertex AI API i rozmowy z Gemini.

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

Jeśli pojawi się prośba o autoryzację, kliknij „Autoryzuj”, aby kontynuować.

Uruchom te polecenia, aby utworzyć nowe konto usługi i klucze.

Będziesz używać tego konta usługi do wywoływania interfejsu Vertex AI Gemini API z potoków 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"

Przyznaj role.

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. Importowanie repozytorium GitHub do repozytorium GitLab

Otwórz https://gitlab.com/projects/new i wybierz opcję „Import project” / „Repository by URL”:

Adres URL repozytorium Git:

https://github.com/GoogleCloudPlatform/genai-for-developers.git

W sekcji Project URL (Adres URL projektu) wybierz swój identyfikator użytkownika GitLab.

Ustaw opcję Visibility (Widoczność) na Public (Publiczny).

Aby rozpocząć proces importowania, kliknij „Create Project” (Utwórz projekt).

Jeśli zobaczysz błąd dotyczący nieprawidłowego adresu URL repozytorium GitHub, utwórz nowy token GitHub(szczegółowy) z dostępem tylko do odczytu do repozytoriów publicznych i spróbuj ponownie zaimportować, podając swój identyfikator użytkownika GitHub i token.

6. Dodawanie zmiennych potoku GitLab CICD

Następnie włączysz potok GitLab CICD, aby przeprowadzać inspekcję kodu, gdy zmiany są przesyłane do repozytorium.

Otwórz repozytorium GitLab w przeglądarce i przejdź do sekcji "Settings / CICD".

Rozwiń sekcję Variables (Zmienne) i kliknij „Add variable” (Dodaj zmienną).

Gdy dodajesz nowe zmienne, odznacz wszystkie pola wyboru.

Przykład:

Dodaj 3 zmienne:

• PROJECT_ID – identyfikator projektu Qwiklabs
• LOCATION – us-central1
• GOOGLE_CLOUD_CREDENTIALS

Jako wartość zmiennej GOOGLE_CLOUD_CREDENTIALS użyj klucza konta usługi utworzonego w sekcji powyżej. Uruchom to polecenie w Google Cloud Shell i skopiuj/wklej wartość.

cat ~/vertex-client-key.json

Widok zmiennych CI/CD:

7. Uruchamianie potoku GitLab CICD

W interfejsie GitLab otwórz „Build / Pipelines” (Kompilacja / Potoki) i kliknij „Run Pipeline” (Uruchom potok).

8. Sprawdzanie danych wyjściowych potoku GitLab

W interfejsie GitLab otwórz „Build / Jobs” (Kompilacja / Zadania) i sprawdź dane wyjściowe potoku.

Omówienie poleceń potoku

Konfiguracja potoku GitLab: .gitlab-ci.yml

Polecenie test coverage (Pokrycie testami):

devai review testcoverage -c ./sample-app/src

To polecenie devai review testcoverage analizuje kod i powiązany z nim zestaw testów (jeśli jest dostępny) za pomocą modelu generatywnej AI, Gemini. Ocenia pokrycie testami podanego kodu, identyfikując pliki i metody z testami jednostkowymi i bez nich. Następnie polecenie wykorzystuje model do podsumowania pokrycia, w tym danych takich jak pokryte wiersze i gałęzie/warunki. Na podstawie analizy przedstawia rekomendacje dotyczące poprawy pokrycia testami, sugerując dodanie konkretnych testów i oferując ogólne porady dotyczące sprawdzonych metod testowania. Na koniec wyświetla odpowiedź modelu Gemini, która zawiera szczegóły takie jak pliki bez pokrycia i sugestie dotyczące ulepszenia istniejących testów, przekazując je użytkownikowi za pośrednictwem wiersza poleceń.

Polecenie code review (Inspekcja kodu):

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

Polecenie devai review code przeprowadza kompleksową inspekcję kodu podanego fragmentu kodu za pomocą modelu generatywnej AI. Jako dane wejściowe (kontekst) przyjmuje kod do sprawdzenia oraz preferowany format wyjściowy (output). Wykorzystuje duży model językowy do analizy kodu pod kątem poprawności, wydajności, łatwości utrzymania, bezpieczeństwa i zgodności ze sprawdzonymi metodami. Polecenie tworzy szczegółowy prompt, który instruuje Gemini, jak przeprowadzić inspekcję, a następnie wysyła go do modelu w celu oceny podanego kodu. Na koniec przetwarza odpowiedź Gemini, formatując ją w formacie Markdown, JSON lub tabeli zgodnie z preferencjami użytkownika, i wyświetla wyniki inspekcji.

Polecenie compliance review (Sprawdzanie zgodności):

devai review compliance --context ./sample-app/k8s --config ./devai-cli/gemini/styleguide.md

Polecenie devai review compliance analizuje kod pod kątem zestawu sprawdzonych metod, zwykle w przypadku konfiguracji Kubernetes. Wykorzystuje model Gemini do sprawdzenia podanego kodu (context) i porównania go z określonymi standardami zdefiniowanymi w osobnym pliku konfiguracyjnym (config). Polecenie używa prompta, aby poinstruować model Gemini, aby działał jako ekspert w dziedzinie Kubernetes i dostarczył raport zgodności. Następnie formatuje wyniki jako krótkie wyjaśnienie, skupiając się na przykładach kodu, które pokazują, jak rozwiązać zidentyfikowane problemy. Na koniec polecenie wyświetla w konsoli dane wyjściowe sprawdzania zgodności Gemini. Umożliwia to użytkownikowi łatwe sprawdzenie zgodności kodu.

9. Kopiowanie repozytorium GitLab

Wróć do terminala Google Cloud Shell i skopiuj repozytorium.

cd ~
mkdir gitlab
cd gitlab

Zastąp tekst swoim identyfikatorem użytkownika GitLab i adresem URL repozytorium, które zostało właśnie utworzone.

git clone https://gitlab.com:YOUR_GITLAB_USERID/genai-for-developers.git

Zmień katalog i otwórz plik .gitlab-ci.yml. Jeśli podczas importowania zmienisz nazwę repozytorium, przed uruchomieniem tych poleceń zaktualizuj nazwę folderu.

cd genai-for-developers

cloudshell edit .gitlab-ci.yml

10. Wyjaśnianie kodu za pomocą Gemini Code Assist

Kliknij prawym przyciskiem myszy dowolne miejsce w pliku .gitlab-ci.yml i wybierz Gemini Code Assist > Explain (Wyjaśnij).

Sprawdź wyjaśnienie:

11. Tworzenie interfejsu wiersza poleceń DevAI

W tej sekcji wprowadzisz zmiany w devai cli.

Na początek skonfiguruj wirtualne środowisko Pythona, zainstaluj wymagania i uruchom przykładowe polecenie.

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

Ustaw wymagane zmienne środowiskowe.

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

Uruchom polecenie inspekcji kodu, aby sprawdzić, czy wszystko działa prawidłowo:

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

cloudshell edit code-review.md

Sprawdź wyniki za pomocą podglądu Markdown w edytorze Cloud Shell.

Użyj palety poleceń i wybierz „Markdown: Open Preview” (Markdown: otwórz podgląd).

12. Przeglądanie poleceń interfejsu wiersza poleceń devai

Polecenie sprawdzania pokrycia testami

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

cloudshell edit testcoverage.md

Polecenie sprawdzania zgodności

devai review compliance --context ~/genai-for-developers/sample-app/k8s --config ~/genai-for-developers/devai-cli/.gemini/styleguide.md > k8s-review.md

cloudshell edit k8s-review.md

Polecenie sprawdzania wydajności

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

cloudshell edit performance-review.md

Polecenie sprawdzania bezpieczeństwa

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

cloudshell edit security-review.md

Polecenia sprawdzania blokad

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

Sprawdzanie i podsumowywanie obrazów/schematów

Schemat wejściowy [~/genai-for-developers/images/extension-diagram.png]:

Polecenie sprawdzania:

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

cloudshell edit image-review.md

Dane wyjściowe:

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.

Analiza różnic między obrazami:

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

 cloudshell edit image-diff-review.md

Dane wyjściowe:

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.

Analiza pliku wideo:

devai review video \
  -f "/tmp/video.mp4" \
  -p "Review user journey video and create unit tests using jest framework"

Polecenie generowania dokumentacji

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

Dane wyjściowe:

# 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

- Securely retrieves account balances using JWT authentication.
- Leverages a local cache for fast balance retrieval.
- Asynchronously processes transactions from a central ledger.
- Provides health check endpoints for Kubernetes liveness and readiness probes.
...

Sprawdź dostępne polecenia interfejsu wiersza poleceń devai w edytorze Cloud Shell:

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

Możesz też sprawdzić plik README.md w repozytorium GitHub.

13. Gratulacje!

Gratulacje! Ćwiczenie zostało ukończone.

Omówione zagadnienia:

• Dodawanie w GitLabie kroków automatyzacji inspekcji kodu z użyciem generatywnej AI
• Uruchamianie lokalnie interfejsu wiersza poleceń devai

Co dalej?

• Wkrótce pojawi się więcej sesji praktycznych.

Zwalnianie miejsca

Aby uniknąć obciążenia konta Google Cloud opłatami za zasoby zużyte w tym samouczku, możesz usunąć projekt zawierający te zasoby lub zachować projekt i usunąć poszczególne zasoby.

Usuwanie projektu

Najprostszym sposobem na uniknięcie płatności jest usunięcie projektu utworzonego w tym samouczku.

©2024 Google LLC. Wszelkie prawa zastrzeżone. Google i logo Google są znakami towarowymi Google LLC. Wszelkie inne nazwy firm i produktów mogą być znakami towarowymi odpowiednich podmiotów, z którymi są powiązane.