feat(securitycenter): Add Resource SCC Management API Org security ce… #3960
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nter service custom module samples
|
Here is the summary of changes. You are about to add 3 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 @lovenishs04 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 understand the changes and intent.
This pull request, titled "feat(securitycenter): Add Resource SCC Management API Org security ce…", aims to add Security Command Center (SCC) Management API samples for managing Security Center services. Specifically, it includes samples for Get, List, and Update operations. The description mentions that it addresses issues b/347347700, b/347347712, and b/347347246.
Here's a summary of the changes:
- New files added:
security-center/snippets/management_api/getSecurityCenterService.js: Implements theGetoperation for SCC services.security-center/snippets/management_api/listSecurityCenterServices.js: Implements theListoperation for SCC services.security-center/snippets/management_api/updateSecurityCenterService.js: Implements theUpdateoperation for SCC services.security-center/snippets/system-test/management_api/securityCenterService.test.js: Adds system tests for the new samples.
security-center/snippets/package.jsonupdated: Adds a dependency on@google-cloud/securitycentermanagement.
The changes primarily involve adding new JavaScript files containing the sample code, along with corresponding tests. The code uses the @google-cloud/securitycentermanagement client library to interact with the SCC Management API.
I'll have a more detailed review shortly. In the meantime, please let me know if you have any questions.
A little poem for your coding pleasure:
Code flows like a river,
Tests ensure it's clear and pure,
Bugs flee in the night.
There was a problem hiding this comment.
This pull request adds samples for the Security Health Analytics API. The code generally looks good, but there are some minor improvements that can be made. The Google JavaScript Style Guide was used as a reference for this review: https://google.github.io/styleguide/jsguide.html
Here is a summary of the style guide elements that were referenced in the review comments below:
- Function Declarations: Function expressions should be used instead of function declarations. Function declarations are hoisted, which can lead to unexpected behavior. Function expressions are not hoisted, so they are easier to reason about.
- Arrow Functions: Arrow functions provide a more concise syntax for function expressions. They are especially useful for short, simple functions.
- Constants: Constants should be declared using
constwhenever possible. This helps to prevent accidental modification of values that should not be changed. - Template Literals: Template literals provide a more readable way to create strings that contain expressions. They are especially useful for strings that contain multiple lines or complex formatting.
- Promises: Promises should be used for asynchronous operations. They provide a more structured and easier-to-use way to handle asynchronous code than callbacks.
- Async/Await: Async/await makes asynchronous code look and behave a bit more like synchronous code. This can make asynchronous code easier to read and reason about.
- Comments: Comments should be used to explain the purpose of code and to document any non-obvious behavior. Comments should be clear, concise, and up-to-date.
- Linting: Use a linter, such as ESLint, to enforce coding style and to catch potential errors.
Comment on lines
19
to
59
| function main(organizationId, service, location = 'global') { | ||
| // [START securitycenter_get_security_center_service] | ||
| // Imports the Google Cloud client library. | ||
| const {SecurityCenterManagementClient} = | ||
| require('@google-cloud/securitycentermanagement').v1; | ||
|
|
||
| // Create a Security Center Management client | ||
| const client = new SecurityCenterManagementClient(); | ||
|
|
||
| /* | ||
| * Required. Resource name of security center service | ||
| * Its format is | ||
| * `organizations/[organizationId]/locations/[location]/securityCenterServices/[service]` | ||
| * `folders/[folderId]/locations/[location]/securityCenterServices/[service]` | ||
| * `projects/[projectId]/locations/[location]/securityCenterServices/[service]` | ||
| */ | ||
| // TODO(developer): Update the following references for your own environment before running the sample. | ||
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | ||
| // const location = 'LOCATION_ID'; | ||
| // const service = 'SERVICE'; | ||
| // Replace SERVICE with one of the valid values: | ||
| // container-threat-detection, event-threat-detection, security-health-analytics, | ||
| // vm-threat-detection, web-security-scanner | ||
| const name = `organizations/${organizationId}/locations/${location}/securityCenterServices/${service}`; | ||
|
|
||
| // Build the request. | ||
| const getSecurityCenterServiceRequest = { | ||
| name: name, | ||
| }; | ||
|
|
||
| async function getSecurityCenterService() { | ||
| // Call the API. | ||
| const [response] = await client.getSecurityCenterService( | ||
| getSecurityCenterServiceRequest | ||
| ); | ||
| console.log('Retrieved SecurityCenterService:', response.name); | ||
| } | ||
|
|
||
| getSecurityCenterService(); | ||
| // [END securitycenter_get_security_center_service] | ||
| } |
There was a problem hiding this comment.
Per the Google JavaScript Style Guide, prefer using a function expression or an arrow function over a function declaration. This makes it easier to reason about the code, as function expressions are not hoisted. Also, consider using template literals for string concatenation, as it makes the code more readable.
const main = (organizationId, service, location = 'global') => {
// [START securitycenter_get_security_center_service]
// Imports the Google Cloud client library.
const {SecurityCenterManagementClient} =
require('@google-cloud/securitycentermanagement').v1;
// Create a Security Center Management client
const client = new SecurityCenterManagementClient();
/*
* Required. Resource name of security center service
* Its format is
* `organizations/[organizationId]/locations/[location]/securityCenterServices/[service]`
* `folders/[folderId]/locations/[location]/securityCenterServices/[service]`
* `projects/[projectId]/locations/[location]/securityCenterServices/[service]`
*/
// TODO(developer): Update the following references for your own environment before running the sample.
// const organizationId = 'YOUR_ORGANIZATION_ID';
// const location = 'LOCATION_ID';
// const service = 'SERVICE';
// Replace SERVICE with one of the valid values:
// container-threat-detection, event-threat-detection, security-health-analytics,
// vm-threat-detection, web-security-scanner
const name = `organizations/${organizationId}/locations/${location}/securityCenterServices/${service}`;
// Build the request.
const getSecurityCenterServiceRequest = {
name,
};
const getSecurityCenterService = async () => {
// Call the API.
const [response] = await client.getSecurityCenterService(
getSecurityCenterServiceRequest
);
console.log(`Retrieved SecurityCenterService: ${response.name}`);
};
getSecurityCenterService();
// [END securitycenter_get_security_center_service]
};
Comment on lines
35
to
41
| // TODO(developer): Update the following references for your own environment before running the sample. | ||
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | ||
| // const location = 'LOCATION_ID'; | ||
| // const service = 'SERVICE'; | ||
| // Replace SERVICE with one of the valid values: | ||
| // container-threat-detection, event-threat-detection, security-health-analytics, | ||
| // vm-threat-detection, web-security-scanner |
There was a problem hiding this comment.
The TODO comment should be more specific. Instead of just saying "Update the following references", it should specify what the references are and how they should be updated. For example, it could say "Update the organization ID, location, and service name to match your environment."
Suggested change
| // TODO(developer): Update the following references for your own environment before running the sample. | |
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | |
| // const location = 'LOCATION_ID'; | |
| // const service = 'SERVICE'; | |
| // Replace SERVICE with one of the valid values: | |
| // container-threat-detection, event-threat-detection, security-health-analytics, | |
| // vm-threat-detection, web-security-scanner | |
| // TODO(developer): Update the organization ID, location, and service name to match your environment. | |
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | |
| // const location = 'LOCATION_ID'; | |
| // const service = 'SERVICE'; | |
| // Replace SERVICE with one of the valid values: | |
| // container-threat-detection, event-threat-detection, security-health-analytics, | |
| // vm-threat-detection, web-security-scanner |
Comment on lines
19
to
58
| function main(organizationId, location = 'global') { | ||
| // [START securitycenter_list_security_center_service] | ||
| // Imports the Google Cloud client library. | ||
| const {SecurityCenterManagementClient} = | ||
| require('@google-cloud/securitycentermanagement').v1; | ||
|
|
||
| // Create a Security Center Management client | ||
| const client = new SecurityCenterManagementClient(); | ||
|
|
||
| /** | ||
| * Required. The name of the parent resource. Its | ||
| * format is "organizations/[organizationId]/locations/[location]", | ||
| * "folders/[folderId]/locations/[location]", or | ||
| * "projects/[projectId]/locations/[location]". | ||
| */ | ||
| //TODO(developer): Update the following references for your own environment before running the sample. | ||
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | ||
| // const location = 'LOCATION_ID'; | ||
| const parent = `organizations/${organizationId}/locations/${location}`; | ||
|
|
||
| // Build the request. | ||
| const listSecurityCenterServicesRequest = { | ||
| parent: parent, | ||
| }; | ||
|
|
||
| async function listSecurityCenterServices() { | ||
| // Call the API. | ||
| const [services] = await client.listSecurityCenterServices( | ||
| listSecurityCenterServicesRequest | ||
| ); | ||
| for (const service of services) { | ||
| console.log('Security Center Service Name:', service.name); | ||
| } | ||
| } | ||
|
|
||
| listSecurityCenterServices(); | ||
| // [END securitycenter_list_security_center_service] | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |
There was a problem hiding this comment.
Per the Google JavaScript Style Guide, prefer using a function expression or an arrow function over a function declaration. This makes it easier to reason about the code, as function expressions are not hoisted. Also, consider using template literals for string concatenation, as it makes the code more readable.
const main = (organizationId, location = 'global') => {
// [START securitycenter_list_security_center_service]
// Imports the Google Cloud client library.
const {SecurityCenterManagementClient} =
require('@google-cloud/securitycentermanagement').v1;
// Create a Security Center Management client
const client = new SecurityCenterManagementClient();
/**
* Required. The name of the parent resource. Its
* format is "organizations/[organizationId]/locations/[location]",
* "folders/[folderId]/locations/[location]", or
* "projects/[projectId]/locations/[location]".
*/
//TODO(developer): Update the following references for your own environment before running the sample.
// const organizationId = 'YOUR_ORGANIZATION_ID';
// const location = 'LOCATION_ID';
const parent = `organizations/${organizationId}/locations/${location}`;
// Build the request.
const listSecurityCenterServicesRequest = {
parent,
};
const listSecurityCenterServices = async () => {
// Call the API.
const [services] = await client.listSecurityCenterServices(
listSecurityCenterServicesRequest
);
for (const service of services) {
console.log(`Security Center Service Name: ${service.name}`);
}
};
listSecurityCenterServices();
// [END securitycenter_list_security_center_service]
};
Comment on lines
34
to
36
| //TODO(developer): Update the following references for your own environment before running the sample. | ||
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | ||
| // const location = 'LOCATION_ID'; |
There was a problem hiding this comment.
The TODO comment should be more specific. Instead of just saying "Update the following references", it should specify what the references are and how they should be updated. For example, it could say "Update the organization ID and location to match your environment."
Suggested change
| //TODO(developer): Update the following references for your own environment before running the sample. | |
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | |
| // const location = 'LOCATION_ID'; | |
| //TODO(developer): Update the organization ID and location to match your environment. | |
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | |
| // const location = 'LOCATION_ID'; |
Comment on lines
19
to
76
| function main(organizationId, service, location = 'global') { | ||
| // [START securitycenter_update_security_center_service] | ||
| // Imports the Google Cloud client library. | ||
| const {SecurityCenterManagementClient} = | ||
| require('@google-cloud/securitycentermanagement').v1; | ||
|
|
||
| // Create a Security Center Management client | ||
| const client = new SecurityCenterManagementClient(); | ||
|
|
||
| /* | ||
| * Required. Resource name of security center service | ||
| * Its format is | ||
| * `organizations/[organizationId]/locations/[location]/securityCenterServices/[service]` | ||
| * `folders/[folderId]/locations/[location]/securityCenterServices/[service]` | ||
| * `projects/[projectId]/locations/[location]/securityCenterServices/[service]` | ||
| */ | ||
| // TODO(developer): Update the following references for your own environment before running the sample. | ||
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | ||
| // const location = 'LOCATION_ID'; | ||
| // const service = 'SERVICE'; | ||
| // Replace SERVICE with one of the valid values: | ||
| // container-threat-detection, event-threat-detection, security-health-analytics, | ||
| // vm-threat-detection, web-security-scanner | ||
| const name = `organizations/${organizationId}/locations/${location}/securityCenterServices/${service}`; | ||
|
|
||
| // Define the security center service configuration, update the | ||
| // IntendedEnablementState accordingly. | ||
| const securityCenterService = { | ||
| name: name, | ||
| intendedEnablementState: 'ENABLED', | ||
| }; | ||
|
|
||
| // Set the field mask to specify which properties should be updated. | ||
| const fieldMask = { | ||
| paths: ['intended_enablement_state'], | ||
| }; | ||
|
|
||
| // Build the request. | ||
| const updateSecurityCenterServiceRequest = { | ||
| securityCenterService: securityCenterService, | ||
| updateMask: fieldMask, | ||
| }; | ||
|
|
||
| async function updateSecurityCenterService() { | ||
| // Call the API. | ||
| const [response] = await client.updateSecurityCenterService( | ||
| updateSecurityCenterServiceRequest | ||
| ); | ||
| console.log( | ||
| `Updated SecurityCenterService: ${response.name} with new enablement state: ${response.intendedEnablementState}` | ||
| ); | ||
| } | ||
|
|
||
| updateSecurityCenterService(); | ||
| // [END securitycenter_update_security_center_service] | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |
There was a problem hiding this comment.
Per the Google JavaScript Style Guide, prefer using a function expression or an arrow function over a function declaration. This makes it easier to reason about the code, as function expressions are not hoisted. Also, consider using template literals for string concatenation, as it makes the code more readable.
const main = (organizationId, service, location = 'global') => {
// [START securitycenter_update_security_center_service]
// Imports the Google Cloud client library.
const {SecurityCenterManagementClient} =
require('@google-cloud/securitycentermanagement').v1;
// Create a Security Center Management client
const client = new SecurityCenterManagementClient();
/*
* Required. Resource name of security center service
* Its format is
* `organizations/[organizationId]/locations/[location]/securityCenterServices/[service]`
* `folders/[folderId]/locations/[location]/securityCenterServices/[service]`
* `projects/[projectId]/locations/[location]/securityCenterServices/[service]`
*/
// TODO(developer): Update the following references for your own environment before running the sample.
// const organizationId = 'YOUR_ORGANIZATION_ID';
// const location = 'LOCATION_ID';
// const service = 'SERVICE';
// Replace SERVICE with one of the valid values:
// container-threat-detection, event-threat-detection, security-health-analytics,
// vm-threat-detection, web-security-scanner
const name = `organizations/${organizationId}/locations/${location}/securityCenterServices/${service}`;
// Define the security center service configuration, update the
// IntendedEnablementState accordingly.
const securityCenterService = {
name,
intendedEnablementState: 'ENABLED',
};
// Set the field mask to specify which properties should be updated.
const fieldMask = {
paths: ['intended_enablement_state'],
};
// Build the request.
const updateSecurityCenterServiceRequest = {
securityCenterService,
updateMask,
};
const updateSecurityCenterService = async () => {
// Call the API.
const [response] = await client.updateSecurityCenterService(
updateSecurityCenterServiceRequest
);
console.log(
`Updated SecurityCenterService: ${response.name} with new enablement state: ${response.intendedEnablementState}`
);
};
updateSecurityCenterService();
// [END securitycenter_update_security_center_service]
};
Comment on lines
35
to
41
| // TODO(developer): Update the following references for your own environment before running the sample. | ||
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | ||
| // const location = 'LOCATION_ID'; | ||
| // const service = 'SERVICE'; | ||
| // Replace SERVICE with one of the valid values: | ||
| // container-threat-detection, event-threat-detection, security-health-analytics, | ||
| // vm-threat-detection, web-security-scanner |
There was a problem hiding this comment.
The TODO comment should be more specific. Instead of just saying "Update the following references", it should specify what the references are and how they should be updated. For example, it could say "Update the organization ID, location, and service name to match your environment."
Suggested change
| // TODO(developer): Update the following references for your own environment before running the sample. | |
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | |
| // const location = 'LOCATION_ID'; | |
| // const service = 'SERVICE'; | |
| // Replace SERVICE with one of the valid values: | |
| // container-threat-detection, event-threat-detection, security-health-analytics, | |
| // vm-threat-detection, web-security-scanner | |
| // TODO(developer): Update the organization ID, location, and service name to match your environment. | |
| // const organizationId = 'YOUR_ORGANIZATION_ID'; | |
| // const location = 'LOCATION_ID'; | |
| // const service = 'SERVICE'; | |
| // Replace SERVICE with one of the valid values: | |
| // container-threat-detection, event-threat-detection, security-health-analytics, | |
| // vm-threat-detection, web-security-scanner |
| const exec = cmd => execSync(cmd, {encoding: 'utf8'}); | ||
| const {describe, it} = require('mocha'); | ||
|
|
||
| // TODO(developer): update for your own environment |
There was a problem hiding this comment.
The TODO comment should be more specific. Instead of just saying "update for your own environment", it should specify what needs to be updated and how. For example, it could say "Update the organization ID, location, and service name to match your testing environment."
Suggested change
| // TODO(developer): update for your own environment | |
| // TODO(developer): Update the organization ID, location, and service name to match your testing environment |
anissa-abu
approved these changes
Jan 28, 2025
iennae
reviewed
Jan 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…nter service custom module samples
Description
Fixes #b/347347700, b/347347712, b/347347246
This PR adds SCC Managament API Org Security Center Service Custom Module Samples for Get, List and Update.
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.