feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate) #13081
Conversation
…GetEff, ListEff, ListDesc, Validate)
|
Here is the summary of changes. You are about to add 4 region tags.
This comment is generated by snippet-bot.
|
product-auto-label
bot
added
api: securitycenter
![code-review-assist[bot]](https://avatars.githubusercontent.com/in/1008254?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, I'm providing this summary to help everyone quickly understand the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center's Organization Management API's Event Threat Detection (ETD). Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New Python file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pywas added, containing functions for:- Retrieving an effective ETD custom module (
get_effective_event_threat_detection_custom_module) - Listing effective ETD custom modules (
list_effective_event_threat_detection_custom_module) - Listing descendant ETD custom modules (
list_descendant_event_threat_detection_custom_module) - Validating an ETD custom module (
validate_event_threat_detection_custom_module)
- Retrieving an effective ETD custom module (
- New Test file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pywas added to test the new functions. - Updated requirements files:
securitycenter/snippets_management_api/requirements.txtandsecuritycenter/snippets_management_api/requirements-test.txtwere updated to include necessary libraries. - New
noxfile_config.py: Anoxfile_config.pyfile was added to configure testing environments. This file includes environment variables for testing purposes.
The code additions are substantial, introducing new functionality for interacting with the Security Command Center's ETD custom modules. The test suite appears comprehensive, covering each of the new functions. I will be verifying the functionality and testing thoroughly.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, joy remains.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will have a full review ready in a few minutes. In the meantime, I wanted to provide a quick summary of the changes for you and other reviewers to get up to speed.
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Health Analytics (SHA) Org Management API's Event Threat Detection feature. The changes address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New Python file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for the new custom modules, including functions for:- Getting effective event threat detection custom modules (
get_effective_event_threat_detection_custom_module) - Listing effective event threat detection custom modules (
list_effective_event_threat_detection_custom_module) - Listing descendant event threat detection custom modules (
list_descendant_event_threat_detection_custom_module) - Validating event threat detection custom modules (
validate_event_threat_detection_custom_module)
- Getting effective event threat detection custom modules (
- New Test file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file contains comprehensive unit tests for the functions in the new Python file. The tests usepytestandbackofflibraries for robust testing and retry mechanisms. - Updated requirements files:
securitycenter/snippets_management_api/requirements.txtandsecuritycenter/snippets_management_api/requirements-test.txthave been updated to include necessary dependencies. - New noxfile configuration:
securitycenter/snippets_management_api/noxfile_config.pyThis file configures the testing environment, specifying the organization ID and other environment variables.
The PR description indicates that new APIs may need to be enabled and environment variables set in testing projects for the tests to pass. The CODEOWNERS and blunderbuss.yml files have also been updated to reflect the addition of these new samples.
I'll be looking closely at the code for correctness, readability, and test coverage in my full review.
And now, a little haiku to brighten your day:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will have a full review in a few minutes. In the meantime, here's a quick summary for you and other reviewers to get up to speed:
This pull request, authored by vijaykanthm, aims to add new sample modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) Custom Modules. Specifically, it adds samples for the following functionalities:
- Get Effective ETD Custom Module: Retrieves an ETD custom module.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including inherited ones.
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates an ETD custom module configuration.
The changes involve adding a new Python file (securitycenter/snippets_management_api/event_threat_detection_custom_modules.py) containing the sample code for these four functions. A corresponding test file (securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py) has also been added to ensure the functionality works as expected. Additionally, noxfile_config.py, requirements.txt, and requirements-test.txt have been updated to reflect the added dependencies.
The pull request addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) and includes a checklist to ensure all necessary steps have been followed, including testing and linting.
Here's a little something to brighten your day:
Code flows like a stream,
A gentle cascade of thought,
Solutions take form.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection feature. Specifically, it adds samples for the following functionalities:
get_effective_event_threat_detection_custom_module: Retrieves a specific Event Threat Detection custom module.list_effective_event_threat_detection_custom_module: Lists all effective Event Threat Detection custom modules (both resident and inherited).list_descendant_event_threat_detection_custom_module: Lists all resident and descendant Event Threat Detection custom modules.validate_event_threat_detection_custom_module: Validates a custom module configuration.
The changes involve creating a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure functionality. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies, and a new noxfile_config.py file has been added. The PR also addresses four internal Google bug issues (b/347347769, b/347347958, b/347348171, b/347348172).
The author has indicated that the samples require new API enablements and environment variables to pass tests. These specifics are noted in the PR description.
I'll provide a more detailed review shortly.
Here's a little haiku to brighten your day:
Code flows like a stream,
Testing's waves crash on the shore,
Bugs vanish in sun.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functionalities:
- Get Effective ETD Custom Module: Retrieves an ETD custom module given a parent and module ID.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including resident and inherited ones.
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates an ETD custom module configuration.
The changes involve the creation of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. The noxfile_config.py file was updated to include the necessary environment variables for testing, and requirements.txt and requirements-test.txt were updated to include the necessary dependencies. The original PR description mentions that this addresses four internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172).
Files Changed:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py(Added)securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py(Added)securitycenter/snippets_management_api/noxfile_config.py(Modified)securitycenter/snippets_management_api/requirements-test.txt(Modified)securitycenter/snippets_management_api/requirements.txt(Modified)
I'll be checking the code for correctness, style, and test coverage shortly.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests ensure the path is clear,
Bugs flee in the night.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, I'm providing this summary of the pull request's content for you and other reviewers to quickly get up to speed on the changes and intent.
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functionalities:
- Get Effective ETD Custom Module: Retrieves an ETD custom module given a parent and module ID. This is implemented in
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pylines 22-48. - List Effective ETD Custom Modules: Lists all ETD custom modules, including inherited ones, for a given parent. Implemented in
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pylines 52-89. - List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules for a given parent. Implemented in
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pylines 94-129. - Validate ETD Custom Module: Validates a custom module configuration for ETD. Implemented in
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pylines 134-188.
The pull request also includes comprehensive unit tests in securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py to verify the functionality of these new samples. The noxfile_config.py file was updated to include testing configuration, and the requirements.txt and requirements-test.txt files were updated to include necessary dependencies.
The changes address issues b/347347769, b/347347958, b/347348171, and b/347348172.
I'll have a more detailed review shortly. Thanks!
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. The intent is to address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Specifically, the following changes have been made:
- New Python file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyhas been added. This file contains four new functions:get_effective_event_threat_detection_custom_module: Retrieves a single ETD custom module.list_effective_event_threat_detection_custom_module: Lists all effective ETD custom modules (resident and inherited).list_descendant_event_threat_detection_custom_module: Lists all resident and descendant ETD custom modules.validate_event_threat_detection_custom_module: Validates an ETD custom module configuration.
- New Test file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyhas been added. This file contains unit tests for the functions in the new Python file. - Updated requirements files:
securitycenter/snippets_management_api/requirements.txtandsecuritycenter/snippets_management_api/requirements-test.txthave been updated to include necessary dependencies. - New noxfile config:
securitycenter/snippets_management_api/noxfile_config.pyhas been added to configure the testing environment.
The changes appear to be well-structured and documented. The author has also included a checklist to ensure all necessary steps have been followed.
I'll be looking at the code in more detail shortly, but this summary should give you a good overview of the PR's content and intent.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, peace of mind.
Thanks,
Gemini/code-review-assist
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Health Analytics (SHA) Event Threat Detection API. Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core Python code for the new custom modules. The functions added include:get_effective_event_threat_detection_custom_module: Retrieves a specific Event Threat Detection custom module.list_effective_event_threat_detection_custom_module: Lists all effective Event Threat Detection custom modules.list_descendant_event_threat_detection_custom_module: Lists all resident and descendant Event Threat Detection custom modules.validate_event_threat_detection_custom_module: Validates a custom module configuration.
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py: This file includes comprehensive unit tests for the new custom modules, ensuring functionality and robustness. The tests cover theget,list(effective and descendant), andvalidatefunctions. - Updated Files:
securitycenter/snippets_management_api/noxfile_config.py,securitycenter/snippets_management_api/requirements-test.txt,securitycenter/snippets_management_api/requirements.txtThese files contain configuration and dependency updates necessary for the new code. Therequirements.txtandrequirements-test.txtfiles have been updated to include the necessary libraries for the Security Health Analytics API and testing.
The PR also includes a checklist to ensure all necessary steps are completed before merging.
I'll be looking at the code in more detail shortly, but this should give everyone a good overview.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run green, a joyful sight,
Bugs flee in the night.
Best,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. Specifically, it adds samples for:
GetEffectiveEventThreatDetectionCustomModule: Retrieves an ETD custom module.ListEffectiveEventThreatDetectionCustomModules: Lists ETD custom modules, including inherited ones.ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant ETD custom modules.ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes involve the creation of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, was also added to ensure functionality. Additionally, the requirements.txt and requirements-test.txt files were updated to include necessary dependencies. The noxfile_config.py file was also updated.
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) and includes a checklist to ensure all necessary steps have been followed.
I'll provide a more detailed review shortly.
Here's a little haiku to brighten your day:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, joy is found.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functions:
- Get Effective ETD Custom Module: Retrieves a specific ETD custom module.
- List Effective ETD Custom Modules: Lists all effective ETD custom modules (resident and inherited).
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates a custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated.
The PR addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a table summarizing the file changes:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the implementation of the four new ETD custom module functions. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the new functions. |
securitycenter/snippets_management_api/requirements.txt |
Updated to include google-cloud-securitycentermanagement, google-cloud-bigquery, and google-cloud-pubsub dependencies. |
securitycenter/snippets_management_api/requirements-test.txt |
Updated to include backoff and pytest testing dependencies, as well as google-cloud-bigquery and google-cloud-securitycentermanagement. |
securitycenter/snippets_management_api/noxfile_config.py |
Updated configuration for testing. |
I'll be back with a more detailed review soon!
Meanwhile, a little verse to brighten your day:
Code flows like a river,
Tests ensure it's clear and pure,
A well-reviewed stream.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) samples for the Organization Management API's Event Threat Detection (ETD) custom modules. Specifically, it adds samples for the following four functions:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific ETD custom module.
- ListEffectiveEventThreatDetectionCustomModule: Lists all effective ETD custom modules (resident and inherited).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident ETD custom modules and their descendants.
- ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. The noxfile_config.py file was updated, and the requirements.txt and requirements-test.txt files were updated to include the necessary dependencies.
The PR addresses issues b/347347769, b/347347958, b/347348171, and b/347348172. The author has indicated that the samples require new API enablements and environment variables in testing projects. The CODEOWNERS file and Blunderbuss issue/PR auto-assigner have been updated accordingly.
I'll be checking the code for correctness, readability, and test coverage. I'll also verify that the added samples follow the guidelines outlined in the AUTHORING_GUIDE.MD.
A little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code shines so bright.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) samples for the Organization Management API's Event Threat Detection (ETD) custom modules. Specifically, it adds samples for the following four functions:
- Get Effective ETD Custom Module: Retrieves a specific ETD custom module.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including inherited ones.
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates a custom module's configuration.
The changes involve creating a new Python file (securitycenter/snippets_management_api/event_threat_detection_custom_modules.py) containing the code for these four functions. A corresponding test file (securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py) is also added for comprehensive testing. Additionally, the requirements.txt and requirements-test.txt files are updated to include necessary dependencies. The noxfile_config.py file is also modified, likely to configure the testing environment.
The PR addresses four internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172). The author has indicated that the samples require new API enablements and environment variables in testing projects, which will need to be addressed during review.
Files Changed:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py(Added)securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py(Added)securitycenter/snippets_management_api/noxfile_config.py(Modified)securitycenter/snippets_management_api/requirements.txt(Modified)securitycenter/snippets_management_api/requirements-test.txt(Modified)
I'll be looking at the code in more detail shortly. In the meantime, please review the summary and let me know if you have any questions.
And now, a little haiku to brighten your day:
Code flows like a stream,
Testing's a gentle waterfall,
Bugs vanish in mist.
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm currently reviewing this pull request and will provide feedback in a few minutes. In the meantime, I'm providing this summary of the pull request's content to help you and other reviewers quickly understand the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center's Organization Management API's Event Threat Detection (ETD) functionality. The changes address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New Python file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for the new custom modules. It includes functions for:- Getting an effective ETD custom module (
get_effective_event_threat_detection_custom_module) - Listing effective ETD custom modules (
list_effective_event_threat_detection_custom_module) - Listing descendant ETD custom modules (
list_descendant_event_threat_detection_custom_module) - Validating an ETD custom module (
validate_event_threat_detection_custom_module)
- Getting an effective ETD custom module (
- New Test file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file contains unit tests for the new functions added in the above file. It uses thepytestframework and includes tests for each of the functions in the main file. - Updated requirements files:
securitycenter/snippets_management_api/requirements.txtandsecuritycenter/snippets_management_api/requirements-test.txtwere updated to include the necessary dependencies for the new modules and tests. - New noxfile config:
securitycenter/snippets_management_api/noxfile_config.pywas added to configure the testing environment.
The code additions are substantial, adding approximately 188 lines to event_threat_detection_custom_modules.py and 258 lines to event_threat_detection_custom_modules_test.py, along with several lines added to the requirements files and a new noxfile config file. The code appears well-structured and well-documented.
I'll be checking for proper error handling, test coverage, and adherence to Google's coding style guidelines during my full review.
Here's a little haiku to brighten your day:
Code flows like a stream,
Tests ensure the waters run,
Clean and pure, it gleams.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. Specifically, it adds samples for the following four functionalities:
- GetEffective: Retrieves an ETD custom module.
- ListEffective: Lists all effective ETD custom modules (resident and inherited).
- ListDescendant: Lists all resident and descendant ETD custom modules.
- Validate: Validates an ETD custom module configuration.
The changes involve creating a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file has also been updated to include some configuration details.
The pull request addresses four internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172).
Here's a quick overview of the file changes:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the core functionality for the four new custom modules. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the new custom modules. |
securitycenter/snippets_management_api/requirements.txt |
Updated dependencies for the project. |
securitycenter/snippets_management_api/requirements-test.txt |
Updated testing dependencies for the project. |
securitycenter/snippets_management_api/noxfile_config.py |
Updated configuration for testing. |
I'll be looking at the code in more detail shortly. In the meantime, please review the summary above and let me know if you have any questions.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm Gemini, and I'm currently reviewing this pull request. In the meantime, I'm providing a summary of its content to help you and other reviewers quickly get up to speed on the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center's Organization Management API's Event Threat Detection (ETD) functionality. Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for the new custom modules. It includes functions for:- Getting effective ETD custom modules (
get_effective_event_threat_detection_custom_module) Lines 22-48 - Listing effective ETD custom modules (
list_effective_event_threat_detection_custom_module) Lines 52-90 - Listing descendant ETD custom modules (
list_descendant_event_threat_detection_custom_module) Lines 94-130 - Validating ETD custom modules (
validate_event_threat_detection_custom_module) Lines 134-188
- Getting effective ETD custom modules (
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file contains unit tests for the new functions. Lines 1-258 - Updated Files:
securitycenter/snippets_management_api/noxfile_config.py,securitycenter/snippets_management_api/requirements-test.txt,securitycenter/snippets_management_api/requirements.txtThese files were updated to reflect the addition of the new modules and their dependencies.
The pull request also includes updates to the README and CODEOWNERS files (as indicated in the checklist). The author has indicated that new API's and environment variables are needed to pass tests.
I'll provide a more detailed review shortly.
Meanwhile, here's a little something to brighten your day:
Code flows like a stream,
Tests cascade, a waterfall,
Bugs, they swim downstream.
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm currently reviewing this pull request and will provide my feedback in a few minutes. In the meantime, I'm providing this summary of the pull request's content to help you and other reviewers quickly understand the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New Python file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyhas been added. This file contains four new functions:get_effective_event_threat_detection_custom_module: Retrieves a specific ETD custom module.list_effective_event_threat_detection_custom_module: Lists all effective ETD custom modules (resident and inherited).list_descendant_event_threat_detection_custom_module: Lists all resident and descendant ETD custom modules.validate_event_threat_detection_custom_module: Validates an ETD custom module configuration.
- New Test file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyhas been added to test the new functions. This includes helper functions to setup and cleanup test resources. - Updated requirements files:
securitycenter/snippets_management_api/requirements.txtandsecuritycenter/snippets_management_api/requirements-test.txthave been updated to include necessary dependencies. - New noxfile config:
securitycenter/snippets_management_api/noxfile_config.pyhas been added to provide configuration for testing.
The changes involve adding approximately 188 lines of code to event_threat_detection_custom_modules.py and 258 lines to event_threat_detection_custom_modules_test.py. The requirements files have also been updated to include the necessary libraries for the new functionality. The noxfile_config.py file adds configuration for testing.
I'll be looking at the code closely to ensure correctness, readability, and adherence to best practices. I'll also verify that the tests are comprehensive and effective.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests ensure the path is clear,
Bugs flee in the night.
Looking forward to your feedback!
Best,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add several new custom modules for the Security Health Analytics (SHA) Org Management API's Event Threat Detection feature. The changes address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for the new custom modules. It includes functions for:- Getting an effective Event Threat Detection custom module (
get_effective_event_threat_detection_custom_module) - Listing effective Event Threat Detection custom modules (
list_effective_event_threat_detection_custom_module) - Listing descendant Event Threat Detection custom modules (
list_descendant_event_threat_detection_custom_module) - Validating an Event Threat Detection custom module (
validate_event_threat_detection_custom_module)
- Getting an effective Event Threat Detection custom module (
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file includes comprehensive unit tests for the functions in the above file. The tests cover various scenarios, including error handling and module retrieval. - Updated Files:
securitycenter/snippets_management_api/noxfile_config.py,securitycenter/snippets_management_api/requirements-test.txt,securitycenter/snippets_management_api/requirements.txtThese files were updated to reflect the addition of the new modules and their dependencies.
The author has indicated that new API's may need to be enabled and new environment variables set in testing projects. Please check the PR description for details.
I'll provide a more detailed review shortly. Thanks!
And now, a little haiku to brighten your day:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code shines so bright.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback in a few minutes. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) samples for the Event Threat Detection (ETD) custom modules. Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- Added
event_threat_detection_custom_modules.py: This file contains four new functions:get_effective_event_threat_detection_custom_module: Retrieves a single ETD custom module.list_effective_event_threat_detection_custom_module: Lists all effective ETD custom modules (resident and inherited).list_descendant_event_threat_detection_custom_module: Lists all resident and descendant ETD custom modules.validate_event_threat_detection_custom_module: Validates an ETD custom module configuration.
- Added
event_threat_detection_custom_modules_test.py: This file includes comprehensive unit tests for the functions inevent_threat_detection_custom_modules.py. - Updated
noxfile_config.py: This file was updated to include configuration for testing the new samples. - Updated
requirements.txtandrequirements-test.txt: These files were updated to include necessary dependencies for the new samples and tests.
The changes involve adding approximately 188 lines of code to event_threat_detection_custom_modules.py, 258 lines to event_threat_detection_custom_modules_test.py, and 41 lines to noxfile_config.py. The requirements.txt and requirements-test.txt files also received updates to reflect the new dependencies.
The PR description mentions the need for new API enablement and environment variables in testing projects. This will need to be addressed before the PR can be fully tested.
I'll be checking the code style, test coverage, and functionality in my full review.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, pure delight.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add several new custom modules for the Security Health Analytics (SHA) Event Threat Detection API. Specifically, it adds samples for:
- Get Effective Event Threat Detection Custom Module: Retrieves a specific custom module.
- List Effective Event Threat Detection Custom Modules: Lists all effective custom modules (resident and inherited).
- List Descendant Event Threat Detection Custom Modules: Lists all resident and descendant custom modules.
- Validate Event Threat Detection Custom Module: Validates a custom module configuration.
The changes primarily involve adding a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure functionality. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated to include environment variables for testing.
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) and includes a checklist to ensure all necessary steps have been completed before merging.
I'll be looking at the code in more detail shortly to ensure correctness, completeness, and adherence to style guidelines.
Here's a little haiku to brighten your day:
Code flows like a stream,
Testing's the river's strong bank,
Bugs swim to the sea.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four operations:
- Get Effective ETD Custom Module: Retrieves an ETD custom module.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including inherited ones.
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates an ETD custom module configuration.
The changes involve creating a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the sample code for these four operations. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality of the samples. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file has also been updated. The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172).
Here's a quick breakdown of the file changes:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the core sample code for the four ETD custom module operations. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the sample code. |
securitycenter/snippets_management_api/requirements.txt |
Lists the project dependencies. |
securitycenter/snippets_management_api/requirements-test.txt |
Lists the testing dependencies. |
securitycenter/snippets_management_api/noxfile_config.py |
Configuration file for nox testing. |
I'll be looking at the code closely to ensure correctness, style, and test coverage. I'll also verify that the README is updated appropriately.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. Specifically, it adds samples for:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific ETD custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists all effective ETD custom modules (including inherited ones).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant ETD custom modules.
- ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes involve creating a new Python file (securitycenter/snippets_management_api/event_threat_detection_custom_modules.py) containing the code for these functions, and a corresponding test file (securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py). Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated. The changes are quite extensive, adding approximately 188 lines to event_threat_detection_custom_modules.py and 258 lines to event_threat_detection_custom_modules_test.py.
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) and includes a checklist to ensure all necessary steps have been taken before merging.
Here's a little poem to lighten the mood:
Code flows like a river,
Tests ensure the waters clear,
Bugs swim away fast.
Looking forward to a thorough review!
Best,
Gemini/code-review-assist
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, submitted by vijaykanthm, aims to add new sample modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) Custom Modules. Specifically, it adds samples for the following functionalities:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific ETD custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists all effective ETD custom modules (resident and inherited).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant ETD custom modules.
- ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes involve adding a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added for comprehensive testing. Additionally, the noxfile_config.py file has been updated, and requirements.txt and requirements-test.txt have been updated to include necessary dependencies.
The PR addresses issues b/347347769, b/347347958, b/347348171, and b/347348172. The author has also indicated that the necessary updates to the README, CODEOWNERS, and Blunderbuss files have been made.
Here's a quick overview of the file changes:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the core functionality for the four new ETD custom module management functions. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the functions in event_threat_detection_custom_modules.py. |
securitycenter/snippets_management_api/noxfile_config.py |
Configuration file for Nox, used for testing. Updated to reflect the new samples. |
securitycenter/snippets_management_api/requirements.txt |
Lists the project dependencies. |
securitycenter/snippets_management_api/requirements-test.txt |
Lists the project test dependencies. |
I'll provide a more detailed review shortly.
And now, a little haiku to brighten your day:
Code flows like a stream,
Tests run, bugs swiftly are caught,
Clean code, joy is found.
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm currently reviewing this pull request and will provide my feedback in a few minutes. In the meantime, I'm providing this summary of the pull request's content to help you and other reviewers quickly understand the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. The changes address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for the new custom modules. It includes functions for:- Getting effective ETD custom modules (
get_effective_event_threat_detection_custom_module) lines 22-48 - Listing effective ETD custom modules (
list_effective_event_threat_detection_custom_module) lines 52-90 - Listing descendant ETD custom modules (
list_descendant_event_threat_detection_custom_module) lines 94-130 - Validating ETD custom modules (
validate_event_threat_detection_custom_module) lines 134-188
- Getting effective ETD custom modules (
- New file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file contains comprehensive unit tests for the new functions, ensuring correctness and robustness. lines 1-258 - Updated files:
securitycenter/snippets_management_api/noxfile_config.py,securitycenter/snippets_management_api/requirements-test.txt,securitycenter/snippets_management_api/requirements.txtThese files were updated to reflect the addition of new dependencies and test configurations.
The pull request also includes updates to the README and CODEOWNERS files, as well as addressing the requirements outlined in the checklist.
I hope this summary is helpful! Let me know if you have any questions.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, pure delight.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, submitted by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection feature. Specifically, it adds samples for:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists all effective custom modules (resident and inherited).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant custom modules.
- ValidateEventThreatDetectionCustomModule: Validates a custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure functionality. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file has also been updated.
The pull request addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172). The author has indicated that the samples require new API enablements and environment variables in testing projects; this information should be clarified during review.
I'll be looking at the code for correctness, style, and test coverage in my full review.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests catch bugs, a gentle hand,
Clean code, joy is found.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback in a few minutes. In the meantime, I'm providing this summary of the pull request's content for you and other reviewers to quickly get up to speed on the changes and intent.
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection feature. Specifically, it adds samples for:
- GetEffective: Retrieving an Event Threat Detection custom module.
- ListEffective: Listing Event Threat Detection custom modules (including inherited ones).
- ListDescendant: Listing all resident and descendant Event Threat Detection custom modules.
- Validate: Validating a custom module configuration.
The changes involve the creation of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Finally, updates were made to noxfile_config.py, requirements.txt, and requirements-test.txt to support the new code. The requirements.txt file now includes google-cloud-securitycentermanagement==0.1.17, google-cloud-bigquery==3.11.4, and google-cloud-pubsub==2.21.5. The requirements-test.txt file includes backoff==2.2.1, pytest==8.2.0, google-cloud-bigquery==3.11.4, and google-cloud-securitycentermanagement==0.1.17.
The pull request addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) and includes a comprehensive checklist to ensure all necessary steps have been taken.
Here's a little poem to brighten your day:
Code flows like a river,
Tests ensure the path is clear,
Bugs flee in the night.
Thanks,
Gemini/code-review-assist
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) Org Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functions:
- GetEffective: Retrieves an ETD custom module.
- ListEffective: Lists all ETD custom modules (resident and inherited).
- ListDescendant: Lists all resident ETD custom modules and their descendants.
- Validate: Validates an ETD custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure functionality. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated to include some environment variables.
The pull request addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172).
I'll be checking the following:
- Code style and readability.
- Thoroughness of test coverage.
- Correctness of the implemented functions.
- Proper error handling and documentation.
Stay tuned for my complete review!
Here's a little haiku to brighten your day:
Code flows like a stream,
Testing's the dam to hold it,
Quality then flows free.
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm Gemini, and I'm currently reviewing this pull request. In the meantime, I'm providing a summary of its content to help everyone quickly get up to speed on the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center's Organization Management API's Event Threat Detection (ETD) functionality. Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for:- Retrieving an effective ETD custom module (
get_effective_event_threat_detection_custom_module) lines 22-48 - Listing effective ETD custom modules (
list_effective_event_threat_detection_custom_module) lines 52-90 - Listing descendant ETD custom modules (
list_descendant_event_threat_detection_custom_module) lines 94-130 - Validating an ETD custom module (
validate_event_threat_detection_custom_module) lines 134-188
- Retrieving an effective ETD custom module (
- New file:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file adds comprehensive unit tests for the new functions, ensuring proper functionality and error handling. The tests cover all four functions added in the previous file. Lines 1-258 - Updated files:
securitycenter/snippets_management_api/noxfile_config.py,securitycenter/snippets_management_api/requirements-test.txt,securitycenter/snippets_management_api/requirements.txtThese files were updated to reflect the addition of new dependencies and test configurations.
The checklist in the PR description indicates that the author has followed the sample guidelines, updated the README, and the tests and lint checks have passed. However, it also notes that new APIs and environment variables might be required for the tests to pass successfully. This will need to be addressed during review.
I'll provide a more detailed review shortly.
Meanwhile, here's a little something to lighten the mood:
Code flows like a river,
Tests are the sturdy bridges,
Crossing to the end.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Org Management API's Event Threat Detection (ETD) feature. Specifically, it adds samples for:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves an ETD custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists ETD custom modules (including inherited ones).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant ETD custom modules.
- ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes involve creating a new Python file (securitycenter/snippets_management_api/event_threat_detection_custom_modules.py) containing the code for these functions, and a corresponding test file (securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py). Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated to include environment variables for testing.
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172). The author has indicated that the samples require new API enablements and environment variables in testing projects to pass. The CODEOWNERS file and the Blunderbuss issue/PR auto-assigner have also been updated.
I'll be checking the code for correctness, style, and test coverage shortly.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Testing's waves crash on the shore,
Clarity emerges.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functionalities:
GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific ETD custom module.ListEffectiveEventThreatDetectionCustomModules: Lists all effective ETD custom modules (including inherited ones).ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant ETD custom modules.ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the implementations of these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. Finally, noxfile_config.py has been updated to include configuration overrides for testing.
The PR addresses four internal Google bugs: b/347347769, b/347347958, b/347348171, and b/347348172.
I'll be checking the code for style, functionality, and test coverage in my full review.
A little haiku to brighten your day:
Code flows like a stream,
Tests run, bugs swim far away,
Clean code, joy is found.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functionalities:
- Get Effective ETD Custom Module: Retrieves an ETD custom module using its parent and ID.
- List Effective ETD Custom Modules: Retrieves a list of ETD custom modules, including both resident and inherited modules.
- List Descendant ETD Custom Modules: Retrieves a list of all resident ETD custom modules and their descendants.
- Validate ETD Custom Module: Validates a custom module's configuration.
The changes involve creating a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, was also added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files were updated to include necessary dependencies. The noxfile_config.py file was also updated to include the necessary environment variables for testing.
The pull request addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a quick overview of the file changes:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the core functionality for the four ETD custom module operations. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the functions in event_threat_detection_custom_modules.py. |
securitycenter/snippets_management_api/requirements.txt |
Lists the project dependencies. |
securitycenter/snippets_management_api/requirements-test.txt |
Lists the project test dependencies. |
securitycenter/snippets_management_api/noxfile_config.py |
Contains configuration for the nox testing environment. |
I'll be back with a more detailed review shortly.
Meanwhile, enjoy this little poem:
Code flows like a river,
Tests ensure the path is clear,
Bugs are swept away.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. Specifically, it adds samples for:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves an ETD custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists all ETD custom modules (including inherited ones).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant ETD custom modules.
- ValidateEventThreatDetectionCustomModule: Validates an ETD custom module configuration.
The changes involve creating a new Python file (securitycenter/snippets_management_api/event_threat_detection_custom_modules.py) containing the code for these functions, and a corresponding test file (securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py). Additionally, the requirements.txt and requirements-test.txt files were updated to include necessary dependencies. The noxfile_config.py file was also modified, likely to configure the testing environment for these new samples.
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172). The author has indicated that the samples require new API enablements and environment variables in testing projects to pass. The CODEOWNERS file and Blunderbuss configuration have also been updated.
I'll be looking at the code for correctness, efficiency, and adherence to style guidelines. I'll also check the test coverage and ensure the new samples are well-documented.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
Thanks,
Gemini/code-review-assist
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback in a few minutes. In the meantime, I'm providing this summary of the pull request's content for you and other reviewers to quickly get up to speed on the changes and intent.
This pull request, authored by vijaykanthm, aims to add Security Command Center (SCC) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functions:
get_effective_event_threat_detection_custom_module: Retrieves an ETD custom module.list_effective_event_threat_detection_custom_module: Lists ETD custom modules (including inherited ones).list_descendant_event_threat_detection_custom_module: Lists all resident and descendant ETD custom modules.validate_event_threat_detection_custom_module: Validates an ETD custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the implementation of these functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works correctly. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies, and noxfile_config.py has been modified (lines 1-41).
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172). The author has indicated that the samples require new API enablements and environment variables in testing projects to pass. The CODEOWNERS file and the Blunderbuss issue/PR auto-assigner have been updated.
Here's a little poem to lighten the mood:
Code flows like a river,
Tests ensure the path is clear,
Bugs flee in the night.
Thanks,
Gemini/code-review-assist
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection feature. Specifically, it adds samples for the following functionalities:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific Event Threat Detection custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists all effective (resident and inherited) Event Threat Detection custom modules.
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant Event Threat Detection custom modules.
- ValidateEventThreatDetectionCustomModule: Validates a custom module configuration.
The changes involve adding a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. Finally, a new noxfile_config.py file was added.
The pull request addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172). The author has indicated that the samples require new API enablements and environment variables to pass tests, details of which should be clarified.
I'll be checking the code for correctness, style, and test coverage in my full review.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests catch the bugs, clear the way,
Clean code shines so bright.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection feature. Specifically, it addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a breakdown of the changes:
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.pyThis file contains the core functionality for the new custom modules. It includes functions for:- Getting effective event threat detection custom modules (
get_effective_event_threat_detection_custom_module) - Listing effective event threat detection custom modules (
list_effective_event_threat_detection_custom_module) - Listing descendant event threat detection custom modules (
list_descendant_event_threat_detection_custom_module) - Validating event threat detection custom modules (
validate_event_threat_detection_custom_module)
- Getting effective event threat detection custom modules (
- New File:
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.pyThis file provides comprehensive unit tests for the functions in the above file. It includes tests for each of the four functions mentioned above, using a setup and teardown to create and delete test custom modules. - Updated Files:
securitycenter/snippets_management_api/noxfile_config.py,securitycenter/snippets_management_api/requirements-test.txt, andsecuritycenter/snippets_management_api/requirements.txtThese files were updated to include necessary dependencies and configurations for testing the new modules. Thenoxfile_config.pyfile was updated to include environment variables for testing, such asGCLOUD_ORGANIZATIONandGCLOUD_PROJECT.
The changes add approximately 188 lines of code to event_threat_detection_custom_modules.py and 258 lines to event_threat_detection_custom_modules_test.py, along with smaller updates to the other files mentioned above.
I'll be looking closely at the code quality, test coverage, and overall functionality of these new modules. I'll also verify that the updated dependencies and configurations are correct.
A little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, pure delight.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Health Analytics (SHA) Org Management API's Event Threat Detection feature. Specifically, it adds samples for:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves a specific custom module.
- ListEffectiveEventThreatDetectionCustomModules: Lists all effective custom modules (resident and inherited).
- ListDescendantEventThreatDetectionCustomModules: Lists all resident and descendant custom modules.
- ValidateEventThreatDetectionCustomModule: Validates a custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies.
The PR also addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) related to these features. The author has indicated that new APIs may need to be enabled and environment variables set in testing projects for successful execution.
I'll be checking the code for correctness, style, and test coverage shortly. I'll also verify that the README is updated appropriately.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, peace is found.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly understand the changes:
This pull request, submitted by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection (ETD) feature. These modules address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Specifically, the following changes were made:
- Added
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py: This file contains four new functions:get_effective_event_threat_detection_custom_module: Retrieves a specific ETD custom module.list_effective_event_threat_detection_custom_module: Lists all effective ETD custom modules for a given parent resource.list_descendant_event_threat_detection_custom_module: Lists all resident and descendant ETD custom modules.validate_event_threat_detection_custom_module: Validates an ETD custom module configuration.
- Added
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py: This file contains unit tests for the functions inevent_threat_detection_custom_modules.py. - Updated
securitycenter/snippets_management_api/noxfile_config.py: This file was updated to include environment variables for testing purposes. TheGCLOUD_ORGANIZATIONvariable is set to1081635000895and other variables are also set. - Updated
securitycenter/snippets_management_api/requirements-test.txtandsecuritycenter/snippets_management_api/requirements.txt: These files were updated to include necessary dependencies for testing and running the code.
The author has indicated that new APIs may need to be enabled and environment variables set in testing projects to ensure successful execution of the samples. The CODEOWNERS and blunderbuss.yml files have also been updated.
I'll be checking the code for correctness, style, and test coverage in my full review.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, green lights fill the screen,
A bug's silent scream.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add several new custom modules for the Security Command Center (SCC) Organization Management API's Event Threat Detection feature. Specifically, it adds samples for:
- GetEffectiveEventThreatDetectionCustomModule: Retrieves an effective Event Threat Detection custom module.
- ListEffectiveEventThreatDetectionCustomModules: Retrieves a list of effective Event Threat Detection custom modules.
- ListDescendantEventThreatDetectionCustomModules: Retrieves a list of all resident and descendant Event Threat Detection custom modules.
- ValidateEventThreatDetectionCustomModule: Validates a custom module configuration.
The changes involve the creation of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, was also added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files were updated to include necessary dependencies. Finally, noxfile_config.py was updated to include environment variables for testing.
The pull request addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
I'll provide a more detailed review shortly.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code, peace is found.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide my feedback shortly. In the meantime, here's a summary of the changes for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add Security Health Analytics (SHA) samples for the Organization Management API's Event Threat Detection (ETD) custom modules. Specifically, it introduces samples for the following four functions:
- Get Effective ETD Custom Module: Retrieves a specific ETD custom module.
- List Effective ETD Custom Modules: Lists all effective ETD custom modules (resident and inherited).
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates the configuration of an ETD custom module.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, was also added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files were updated to include necessary dependencies. The noxfile_config.py file was also updated to include configuration overrides for testing.
The PR addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
I'll be checking the code style, testing, and overall functionality in my full review.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code shines so bright.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functions:
- Get Effective ETD Custom Module: Retrieves a specific ETD custom module.
- List Effective ETD Custom Modules: Lists all effective ETD custom modules (resident and inherited).
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates an ETD custom module configuration.
The changes involve adding a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated to include relevant environment variables for testing.
The PR addresses issues b/347347769, b/347347958, b/347348171, and b/347348172. The author has indicated that the samples require new API enablements and environment variables in testing projects to pass. The CODEOWNERS file and Blunderbuss issue/PR auto-assigner have been updated.
I'll be checking the code for correctness, style, and test coverage in my full review.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add several new custom modules for the Security Health Analytics (SHA) API's Event Threat Detection feature. Specifically, it adds samples for:
- Get Effective Event Threat Detection Custom Module: Retrieves a specific custom module.
- List Effective Event Threat Detection Custom Modules: Lists all effective custom modules (resident and inherited).
- List Descendant Event Threat Detection Custom Modules: Lists all resident and descendant custom modules.
- Validate Event Threat Detection Custom Module: Validates a custom module configuration.
The changes primarily involve adding a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure functionality. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated to include the necessary environment variables for testing.
The PR addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172) and includes a checklist to ensure all necessary steps have been completed before merging.
Here's a quick overview of the file changes:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the core functionality for the four new custom module functions. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the new functions. |
securitycenter/snippets_management_api/requirements.txt |
Updated to include google-cloud-securitycentermanagement, google-cloud-bigquery, and google-cloud-pubsub dependencies. |
securitycenter/snippets_management_api/requirements-test.txt |
Updated to include backoff and pytest testing dependencies, along with google-cloud-bigquery and google-cloud-securitycentermanagement. |
securitycenter/snippets_management_api/noxfile_config.py |
Updated to include environment variables for testing. |
I'll be back with a more detailed review shortly.
Meanwhile, enjoy this little poem:
Code flows like a river,
Tests ensure the waters run clear,
A bug-free delight.
There was a problem hiding this comment.
Hi @vijaykanthm and reviewers,
I'm currently reviewing this pull request and will provide a full review in a few minutes. In the meantime, I'm providing this summary to help you and other reviewers quickly understand the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Org Mgt API ETD Custom Modules (GetEff, ListEff, ListDesc, Validate)", aims to add several new custom modules for the Security Command Center's Organization Management API's Event Threat Detection (ETD). The changes address issues b/347347769, b/347347958, b/347348171, and b/347348172.
Here's a summary of the changes:
- Added
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py: This file contains the core Python code for the new custom modules. It includes functions for:- Getting an effective ETD custom module (
get_effective_event_threat_detection_custom_module) - Listing effective ETD custom modules (
list_effective_event_threat_detection_custom_module) - Listing descendant ETD custom modules (
list_descendant_event_threat_detection_custom_module) - Validating an ETD custom module (
validate_event_threat_detection_custom_module)
- Getting an effective ETD custom module (
- Added
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py: This file contains comprehensive unit tests for the functions inevent_threat_detection_custom_modules.py. - Updated
securitycenter/snippets_management_api/noxfile_config.py: This file was updated to include configuration for the new tests. - Updated
securitycenter/snippets_management_api/requirements-test.txtandsecuritycenter/snippets_management_api/requirements.txt: These files were updated to include necessary dependencies for the new code and tests.
The code adds functionality to retrieve, list, and validate Security Health Analytics custom modules. The tests ensure that these functions work correctly.
A little poem to brighten your day:
Code flows like a river,
Tests like dams, strong and steady,
Bugs flee in the night.
Looking forward to your feedback!
Best,
Gemini/code-review-assist
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) samples for the Organization Management API's Event Threat Detection (ETD) custom modules. Specifically, it adds samples for the following functionalities:
- Get Effective ETD Custom Module: Retrieves an ETD custom module using parent and module ID.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including resident and inherited ones.
- List Descendant ETD Custom Modules: Lists all resident ETD custom modules and their descendants.
- Validate ETD Custom Module: Validates a custom module's configuration.
The changes involve the creation of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files have been updated to include necessary dependencies. The noxfile_config.py file was also updated to include some environment variables.
The PR also addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172).
I'll be checking the following during my review:
- Code style and readability
- Error handling and exception management
- Test coverage and effectiveness
- Documentation clarity
I'll post my detailed review soon.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Tests run, a green light appears,
Bugs flee in the night.
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add new sample modules for the Security Health Analytics (SHA) API's Event Threat Detection (ETD) custom modules. Specifically, it adds samples for the following functionalities:
- Get Effective ETD Custom Module: Retrieves a single ETD custom module.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including inherited ones.
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates the configuration of an ETD custom module.
The changes involve adding a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, has also been added to ensure the functionality works as expected. Additionally, the noxfile_config.py file has been updated, and dependency files (requirements.txt and requirements-test.txt) have been modified to include necessary libraries.
The PR addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
The author has indicated that the samples require new API enablements and environment variables to pass tests. This information will need to be verified during review.
Here's a quick haiku to lighten the mood:
Code flows like a stream,
Testing's a calming waterfall,
Bugs vanish in mist.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, submitted by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functions:
- Get Effective ETD Custom Module: Retrieves an ETD custom module.
- List Effective ETD Custom Modules: Lists all ETD custom modules, including inherited ones.
- List Descendant ETD Custom Modules: Lists all resident and descendant ETD custom modules.
- Validate ETD Custom Module: Validates an ETD custom module configuration.
The changes include the addition of a new Python file, securitycenter/snippets_management_api/event_threat_detection_custom_modules.py, containing the code for these four functions. A corresponding test file, securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py, was also added to ensure the functionality works as expected. Additionally, the requirements.txt and requirements-test.txt files were updated to include necessary dependencies. The noxfile_config.py file was also updated to include the correct organization ID for testing purposes.
The pull request addresses several internal Google bugs (b/347347769, b/347347958, b/347348171, b/347348172).
Here's a quick overview of the files changed:
| File | Description |
|---|---|
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py |
Contains the core functionality for the four ETD custom module functions. |
securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py |
Contains unit tests for the functions in event_threat_detection_custom_modules.py. |
securitycenter/snippets_management_api/requirements.txt |
Lists the project dependencies. |
securitycenter/snippets_management_api/requirements-test.txt |
Lists the project test dependencies. |
securitycenter/snippets_management_api/noxfile_config.py |
Contains configuration for the testing environment. |
I'll be sure to check the README updates and CODEOWNERS file as part of my review.
And now, a little haiku to lighten the mood:
Code flows like a stream,
Tests run, bugs swim to the shore,
Clean code shines anew.
Thanks,
Gemini
There was a problem hiding this comment.
Hi team,
I'm currently reviewing this pull request and will provide feedback shortly. In the meantime, here's a summary for you and other reviewers to quickly get up to speed:
This pull request, authored by vijaykanthm, aims to add Security Health Analytics (SHA) Organization Management API Event Threat Detection (ETD) custom module samples. Specifically, it adds samples for the following four functionalities:
- Get Effective ETD Custom Module: Retrieves an ETD custom module using its parent and ID. Handles
NotFoundexceptions. - List Effective ETD Custom Modules: Lists all ETD custom modules, including resident and inherited ones.
- List Descendant ETD Custom Modules: Lists all resident ETD custom modules and their descendants.
- Validate ETD Custom Module: Validates a custom module's configuration, printing any errors encountered.
The following files were modified:
securitycenter/snippets_management_api/event_threat_detection_custom_modules.py: This file contains the core implementation of the four functions described above. The changes introduce approximately 188 lines of new code implementing these functions, handling exceptions, and providing clear output to the console.securitycenter/snippets_management_api/event_threat_detection_custom_modules_test.py: This file contains unit tests for the functions. The changes introduce approximately 258 lines of new code to test the four functions, including setup and cleanup functions to manage test resources, and using backoff strategies to handle transient errors.securitycenter/snippets_management_api/noxfile_config.py: This file was updated to include configuration overrides for testing, adding environment variables for organization ID, project ID, and other relevant settings. The changes are relatively small, adding configuration for testing purposes.securitycenter/snippets_management_api/requirements-test.txtandsecuritycenter/snippets_management_api/requirements.txt: These files were updated to include necessary dependencies for testing and running the samples.
The pull request also addresses issues b/347347769, b/347347958, b/347348171, and b/347348172.
I'll provide a more detailed review shortly.
A little haiku to brighten your day:
Code flows like a stream,
Tests run, bugs swim downstream,
Clean code shines so bright.
There was a problem hiding this comment.
The code samples themselves look good, however I think the tests could be simplified. Is there a reason that tests get a random module? This seems like it could cause flaky non-deterministic tests
From what I see, it seems like multiple modules are created, then tests run, and then there's a cleanup step that deletes them. This could be done with "yield" fixtures to allow for cleanup. https://docs.pytest.org/en/6.2.x/fixture.html#yield-fixtures-recommended
Instead of getting a random module, I would create a fixture around a module, and pass that into each test. If the tests mutate the modules or there's any risk of race conditions, I would create a separate module fixture for each test that needs its own.
If you do end up needing multiple modules, there can be a helper function to create and destroy them. And then each fixture can just do "create, yield, destroy".
Hi David, thank you for the feedback and the helpful suggestion regarding fixtures. I initially tried creating a separate module for each test method, but that approach caused race conditions and ran into limitations with multiple write/update operations on an organization. To address this, I opted to create a small number of modules (2-3) at the start of the tests, collect them into a list, and reuse them by assigning a random module to each test. This approach helps avoid race conditions while staying within the constraints. For cleanup, I’m currently using the |
|
With #13004 merged this PR will need to be rebased from main, and edited to only include the new files and any adjustments to dependencies |
Description
Fixes b/347347769, b/347347958, b/347348171, b/347348172
This PR adds SCC Org Managament API ETD Custom Module Samples to GetEff, ListEff, ListDesc & Validate.
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
nox -s py-3.9(see Test Environment Setup)nox -s lint(see Test Environment Setup)