GitHub – אוטומציה של בדיקת קוד באמצעות GenAI

1. סקירה כללית

בשיעור ה-Lab הזה תלמדו להגדיר את תהליך העבודה של GitHub Actions ולשלב אותו עם Gemini כדי לבצע אוטומציה של שלבי בדיקת הקוד.

מה תלמדו

בשיעור Lab זה תלמדו איך:

• איך מוסיפים שלבים לאוטומציה של בדיקת הקוד ב-GenAI ב-GitHub
• איך מריצים את ה-CLI של devai באופן מקומי כדי להפוך את בדיקות הקוד לאוטומטיות

דרישות מוקדמות

• ההנחה בשיעור ה-Lab הזה היא שיש לכם היכרות עם סביבות Cloud Console ו-Cloud Shell.

2. הגדרה ודרישות

הגדרת פרויקט ב-Cloud

1. נכנסים למסוף Google Cloud ויוצרים פרויקט חדש או משתמשים מחדש בפרויקט קיים. אם עדיין אין לכם חשבון Gmail או חשבון Google Workspace, עליכם ליצור חשבון.

• שם הפרויקט הוא השם המוצג של המשתתפים בפרויקט. זוהי מחרוזת תווים שלא משמשת את Google APIs. תמיד אפשר לעדכן אותו.
• מזהה הפרויקט הוא ייחודי לכל הפרויקטים ב-Google Cloud ואי אפשר לשנות אותו אחרי שמגדירים אותו. מסוף Cloud יוצר מחרוזת ייחודית באופן אוטומטי. בדרך כלל לא משנה מה המחרוזת הזו. ברוב ה-codelabs תצטרכו להפנות למזהה הפרויקט (בדרך כלל מזהים אותו בתור PROJECT_ID). אם המזהה שנוצר לא מוצא חן בעיניכם, תוכלו ליצור מזהה אקראי אחר. לחלופין, אפשר לנסות כתובת משלכם ולבדוק אם היא זמינה. לא ניתן לשנות את השם אחרי השלב הזה, והוא יישאר למשך כל תקופת הפרויקט.
• לידיעתך, יש ערך שלישי, מספר פרויקט, שמשתמשים בו בחלק מממשקי ה-API. מידע נוסף על כל שלושת הערכים האלה זמין במסמכי העזרה.

שימו לב: מזהה הפרויקט הוא ייחודי גלובלי, ואף אחד אחר לא יוכל להשתמש בו אחרי שתבחרו בו. אתם היחידים שמשתמשים במזהה הזה. גם אם מוחקים פרויקט, אי אפשר להשתמש שוב במזהה שלו

הערה: אם אתם משתמשים בחשבון Gmail, אתם יכולים להשאיר את מיקום ברירת המחדל כפי שהוא – ללא ארגון. אם אתם משתמשים בחשבון Google Workspace, בחרו מיקום שמתאים לארגון שלכם.

2. בשלב הבא, כדי להשתמש במשאבים או ב-API של Cloud, תצטרכו להפעיל את החיוב במסוף Cloud. השלמת הקודלאב הזה לא תעלה הרבה, אם בכלל. כדי להשבית את המשאבים ולמנוע חיובים אחרי סיום המדריך, אפשר למחוק את המשאבים שיצרתם או למחוק את הפרויקט. משתמשים חדשים ב-Google Cloud זכאים להשתתף בתוכנית תקופת ניסיון בחינם בסך 300$.

הגדרת הסביבה

פותחים את Gemini Chat.

אפשר גם להקליד 'שאל Gemini' בסרגל החיפוש.

מפעילים את Cloud AI Companion API:

לוחצים על 'Start chatting' ופועלים לפי אחת מהשאלות לדוגמה או מקלידים הנחיה משלכם כדי לנסות את התכונה.

הנחיות שאפשר לנסות:

• הסבר על Cloud Run ב-5 נקודות עיקריות.
• אתם מנהלי מוצרים ב-Google Cloud Run, ואתם צריכים להסביר לתלמיד/ה על Cloud Run ב-5 נקודות עיקריות קצרות.
• אתם מנהלי מוצרים ב-Google Cloud Run, ואתם צריכים להסביר את Cloud Run למפתח Kubernetes מוסמך ב-5 נקודות עיקריות קצרות.
• אתם מנהלי מוצר של Google Cloud Run, ואתם צריכים להסביר למפתח בכיר מתי כדאי להשתמש ב-Cloud Run לעומת GKE, ב-5 נקודות מפתח קצרות.

במדריך להנחיות מוסבר איך לכתוב הנחיות טובות יותר.

איך Gemini for Google Cloud משתמש בנתונים שלכם

המחויבות של Google לפרטיות

Google הייתה אחת מהחברות הראשונות בתחום לפרסם מחויבות לפרטיות ב-AI/ML, שבה אנו מבטאים את האמונה שלנו שללקוחות צריכה להיות רמה הגבוהה ביותר של אבטחה ושליטה על הנתונים שלהם שנשמרים בענן.

נתונים שאתם שולחים ומקבלים

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

הצפנה של הנחיות

כששולחים הנחיות ל-Gemini, הנתונים מוצפנים במעבר כקלט למודל הבסיסי ב-Gemini.

נתוני תוכנית שנוצרו מ-Gemini

‫Gemini מאומן על קוד מ-Google Cloud (מצד ראשון) ועל קוד נבחר של צד שלישי. אתם אחראים על האבטחה, הבדיקה והיעילות של הקוד שלכם, כולל כל השלמה, יצירה או ניתוח של קוד ש-Gemini מציעה לכם.

מידע נוסף על האופן שבו Google מטפלת בהנחיות

3. אפשרויות לבדיקה של הנחיות

אם אתם רוצים לשנות או להרחיב הנחיות קיימות של CLI של devai, יש כמה אפשרויות לעשות זאת.

• Vertex AI Studio

Vertex AI Studio הוא חלק מפלטפורמת Vertex AI של Google Cloud, שמיועדת במיוחד לפשט ולהאיץ את הפיתוח והשימוש במודלים של AI גנרטיבי.

• Google AI Studio

Google AI Studio הוא כלי מבוסס-אינטרנט ליצירת אב טיפוס ולניסויים בתכנון הנחיות וב-Gemini API.

• אפליקציית Gemini בדפדפן (gemini.google.com)

אפליקציית האינטרנט של Google Gemini‏ (gemini.google.com) היא כלי מבוסס-אינטרנט שמיועד לעזור לכם לגלות את מלוא הפוטנציאל של מודלי ה-AI של Gemini מבית Google ולהשתמש בו.

• אפליקציית Google Gemini לנייד ל-Android ו-אפליקציית Google ל-iOS

4. יצירת חשבון שירות

לוחצים על הסמל שמשמאל לסרגל החיפוש כדי להפעיל את Cloud Shell.

במסוף שנפתח, מפעילים את השירותים הנדרשים לשימוש בממשקי ה-API של Vertex AI וב-Gemini Chat.

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

אם מתבקשים לאשר, לוחצים על 'אישור' כדי להמשיך.

מריצים את הפקודות הבאות כדי ליצור חשבון שירות ומפתחות חדשים.

תשתמשו בחשבון השירות הזה כדי לבצע קריאות API ל-Vertex AI Gemini API מצינורות עיבוד נתונים של 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. איך יוצרים פורק ממאגר GitHub למאגר GitHub אישי

עוברים אל https://github.com/GoogleCloudPlatform/genai-for-developers/fork ובוחרים את מזהה המשתמש ב-GitHub בתור הבעלים.

מבטלים את הסימון של האפשרות להעתקת ההסתעפות 'main' בלבד.

לוחצים על 'Create fork'.

6. הפעלת תהליך העבודה של GitHub Actions

פותחים את המאגר המחובר ב-GitHub בדפדפן ומעברים לכרטיסייה Actions כדי להפעיל את תהליכי העבודה.

7. הוספת סודות למאגר

יוצרים סוד במאגר בקטע 'Settings / Secrets and variables / Actions' במאגר המחובר ב-GitHub.

מוסיפים סוד למאגר בשם GOOGLE_API_CREDENTIALS.

עוברים לחלון או לכרטיסייה של Google Cloud Shell ומריצים את הפקודה הבאה בטרמינל של Cloud Shell.

cat ~/vertex-client-key.json

מעתיקים את תוכן הקובץ ומדביקים אותו כערך של הסוד.

מוסיפים את הסוד PROJECT_ID עם מזהה הפרויקט ב-Qwiklabs בתור ערך:

8. הפעלת תהליך עבודה של GitHub Actions

עוברים למאגר ב-GitHub בדפדפן ומפעילים את תהליך העבודה.

תהליך העבודה מוגדר לפעול בהעברת קוד או בהפעלה ידנית.

בדיקת התוצאות:

תוצאות הפקודה של בדיקת הכיסוי:

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

התוצאות של פקודת בדיקת הקוד:

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

התוצאות של הפקודה לבדיקת הביצועים:

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

התוצאות של הפקודה לבדיקה האבטחה:

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

הגורמים החוסמים בודקים את תוצאות הפקודה:

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

9. שכפול המאגר

חוזרים לטרמינל של Cloud Shell ומשכפלים את המאגר.

לפני שמריצים את הפקודות, צריך לשנות את YOUR-GITHUB-USERID למזהה המשתמש ב-GitHub.

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

שינוי התיקייה ופתיחת קובץ תהליך העבודה ב-Cloud Shell Editor.

cd genai-for-developers

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

ממתינים עד שקובץ התצורה יוצג בסביבת הפיתוח המשולבת.

10. הפעלת Gemini Code Assist

לוחצים על הסמל Gemini בפינה השמאלית התחתונה ,

לוחצים על 'Login to Google Cloud' ו'Select a Google Cloud Project'.

בחלון הקופץ, בוחרים את הפרויקט ב-Qwiklabs.

11. הסבר על קוד באמצעות Gemini Code Assist

לוחצים לחיצה ימנית במקום כלשהו בקובץ devai-review.yml ובוחרים באפשרות Gemini Code Assist > Explain.

הסבר על הבדיקה:

12. הפעלת DEVAI CLI באופן מקומי

חוזרים לטרמינל של Cloud Shell ומריצים את הפקודות הבאות כדי להתקין את devai באופן מקומי.

pip3 install devai-cli

ה-CLI הותקן אבל הוא לא נמצא ב-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.

מריצים את הפקודה הבאה כדי לעדכן את משתנה הסביבה PATH. מחליפים את השם בשם של תיקיית הבית של המשתמש. לדוגמה: student_00_478dfeb8df15

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

מריצים את הפקודה devai cli כדי לבצע בדיקת קוד באופן מקומי. בודקים את הפלט של 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

פותחים את סקריפט הבדיקה על ידי הפעלת הפקודה הבאה:

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

לוחצים לחיצה ימנית במקום כלשהו בקובץ review.py ובוחרים באפשרות Gemini Code Assist > Explain.

קוראים את ההסבר.

13. פיתוח CLI של DevAI

בקטע הזה תבצעו שינויים ב-devai cli.

כדי להתחיל, מגדירים את python virtualenv, מתקינים את הדרישות ומריצים את הפקודה לדוגמה.

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

מריצים מחדש את הפקודה לבדיקת הקוד כדי לוודא שהכול פועל כמו שצריך:

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

בודקים את התוצאות באמצעות תצוגה מקדימה של Markdown ב-Cloud Shell Editor.

יוצרים קובץ חדש ומדביקים את התשובה של Gemini.

לאחר מכן משתמשים בלוח הפקודות ובוחרים באפשרות Markdown: Open Preview.

14. פקודות CLI של devai

הפקודה לבדיקת קוד

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

פקודה לבדיקת הביצועים

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

פקודת בדיקת האבטחה

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

הפקודה לבדיקה של כיסוי הבדיקה

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

פקודות לבדיקה של גורמים שחוסמים את הגישה

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

בדיקה וסיכום של תמונות/תרשימים:

תרשים קלט[~/genai-for-developers/images/extension-diagram.png]:

בודקים את הפקודה:

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

פלט:

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.

ניתוח ההבדלים בין תמונות:

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

פלט:

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.

הפקודה ליצירת מסמכי תיעוד:

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

פלט:

# 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
...

אפשר לעיין בפקודות הזמינות של devai cli ב-Cloud Shell Editor:

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

לחלופין, אפשר לעיין בקובץ README.md במאגר ב-GitHub.

15. מעולה!

כל הכבוד, סיימת את הקודלאב!

הנושאים שעסקנו בהם:

• הוספת שלבים לאוטומציה של בדיקת הקוד של GenAI ב-GitHub
• הרצת CLI של devai באופן מקומי

השלב הבא:

• בקרוב נוסיף עוד סשנים מעשיים.

הסרת המשאבים

כדי להימנע מחיובים בחשבון Google Cloud בגלל השימוש במשאבים שנעשה במסגרת המדריך הזה, אפשר למחוק את הפרויקט שמכיל את המשאבים, או להשאיר את הפרויקט ולמחוק את המשאבים הנפרדים.

מחיקת הפרויקט

הדרך הקלה ביותר לבטל את החיוב היא למחוק את הפרויקט שיצרתם בשביל המדריך.

©2024 Google LLC כל הזכויות שמורות. Google והלוגו של Google הם סימנים מסחריים רשומים של Google LLC. שמות של חברות ומוצרים אחרים עשויים להיות סימנים מסחריים של החברות, בהתאמה, שאליהן הם משויכים.