feat(modelarmor): modelarmor update template with labels #5278
Conversation
…eleting model armor templates
…eleting modelarmor templates
product-auto-label
bot
added
the
samples
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @tirthrajsinh-zala-crest, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces code snippets for creating, getting, and updating Model Armor templates with labels in the golang-samples repository. It adds new files for these operations under the modelarmor directory and includes necessary modifications to the go.mod and go.work files to incorporate the new module. The changes also include a test case to verify the functionality of updating template labels.
Highlights
- New Module: A new
modelarmormodule is added to the golang-samples repository, containing code for interacting with Model Armor templates. - Create Template: The
create_template.gofile provides a function to create a new Model Armor template with specified filters. - Get Template: The
get_template.gofile implements a function to retrieve an existing Model Armor template. - Update Template Labels: The
update_template_labels.gofile contains a function to update the labels of a Model Armor template. - Test Case: A test case
TestUpdateTemplateLabelsis added inmodelarmor_test.goto verify the functionality of updating template labels.
Changelog
Click here to see the changelog
- go.work
- Added the
./modelarmordirectory to thego.workfile to include it in the workspace.
- Added the
- modelarmor/create_template.go
- Created a new file
create_template.gowith a functioncreateModelArmorTemplateto create a Model Armor template. - The function takes projectID, location, and templateID as input.
- It sets up default filters for PiAndJailbreakFilterSettings and MaliciousUriFilterSettings.
- It prints the created template name to the provided io.Writer.
- Created a new file
- modelarmor/get_template.go
- Created a new file
get_template.gowith a functiongetModelArmorTemplateto retrieve a Model Armor template. - The function takes projectID, location, and templateID as input.
- It prints the retrieved template name to the provided io.Writer.
- Created a new file
- modelarmor/go.mod
- Created a new file
go.modto define the module's dependencies. - It includes dependencies such as
cloud.google.com/go/modelarmor,google.golang.org/api, andgoogle.golang.org/grpc.
- Created a new file
- modelarmor/go.sum
- Created a new file
go.sumto track the dependencies' checksums.
- Created a new file
- modelarmor/modelarmor_test.go
- Created a new file
modelarmor_test.gowith a test caseTestUpdateTemplateLabels. - The test case creates a template, updates its labels, and verifies the updated labels.
- Helper functions
testLocation,testClient, andtestCleanupTemplateare defined for testing purposes.
- Created a new file
- modelarmor/testdata/env/test.env
- Created a new file
test.envto store the environment variables for testing. - It includes
GOLANG_SAMPLES_ORGANIZATION_IDandGOLANG_SAMPLES_FOLDER_ID.
- Created a new file
- modelarmor/update_template_labels.go
- Created a new file
update_template_labels.gowith a functionupdateModelArmorTemplateLabelsto update the labels of a Model Armor template. - The function takes projectID, locationID, templateID, and labels as input.
- It uses a FieldMask to update only the labels field.
- It prints the updated template name to the provided io.Writer.
- Created a new file
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
In realms of code, where templates reside,
Model Armor's strength, our digital guide.
With labels aligned, and filters in place,
Security's embrace, a fortified space.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request introduces new functionalities for creating, getting, and updating Model Armor templates with labels. The code is well-structured and includes necessary error handling. However, there are a few areas that could be improved for clarity and efficiency.
Summary of Findings
- Error message consistency: The error messages in
create_template.goandget_template.gouse slightly different formats. Maintaining consistency in error message formatting improves readability and maintainability. - Redundant filter documentation: The filter documentation link is repeated in both
create_template.goandupdate_template_labels.go. Consider centralizing this documentation or using a constant for the URL to avoid duplication. - Missing tests for edge cases: The test case in
modelarmor_test.goonly covers the successful update of labels. Adding tests for edge cases, such as updating with an empty label map or invalid template IDs, would improve the robustness of the code.
Merge Readiness
The pull request is almost ready for merging. Addressing the error message consistency and redundant documentation would improve the code quality. Additionally, adding more test cases would increase confidence in the code's reliability. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
modelarmor/create_template.go
Outdated
| option.WithEndpoint(fmt.Sprintf("modelarmor.%s.rep.googleapis.com:443", location)), | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create client for project %s, location %s: %v", projectID, location, err) |
There was a problem hiding this comment.
Consider using a consistent error message format across all functions. For example, you could use fmt.Errorf("CreateTemplate: failed to create client: %w", err) to provide more context and enable easier error tracking.
| return nil, fmt.Errorf("failed to create client for project %s, location %s: %v", projectID, location, err) | |
| return nil, fmt.Errorf("CreateTemplate: failed to create client for project %s, location %s: %w", projectID, location, err) |
modelarmor/get_template.go
Outdated
| option.WithEndpoint(fmt.Sprintf("modelarmor.%s.rep.googleapis.com:443", location)), | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create client for project %s, location %s: %v", projectID, location, err) |
There was a problem hiding this comment.
For consistency, use the same error message format as in create_template.go. This helps in debugging and maintaining the codebase.
| return nil, fmt.Errorf("failed to create client for project %s, location %s: %v", projectID, location, err) | |
| return nil, fmt.Errorf("GetTemplate: failed to create client for project %s, location %s: %w", projectID, location, err) |
modelarmor/modelarmor_test.go
Outdated
| if _, err := updateModelArmorTemplateLabels(&b, tc.ProjectID, "us-central1", templateID, map[string]string{"testkey": "testvalue"}); err != nil { | ||
| t.Fatal(err) | ||
| } |
There was a problem hiding this comment.
Consider adding test cases for edge cases, such as updating with an empty label map or using an invalid template ID. This would ensure the function handles unexpected inputs gracefully.
|
Here is the summary of changes. You are about to add 1 region tag.
This comment is generated by snippet-bot.
|
Description
Added code snippet for update modelarmor template with labels
Checklist
go test -v ./..(see Testing)gofmt(see Formatting)go vet(see Formatting)