feat(securitycenter): Add Resource SCC Management API Org Security Center Service Custom Module samples (Get, List, Update) #9913

lovenishs04 · 2024-12-23T08:29:59Z

Description

Fixes # b/347346449, b/347346682, b/347346802
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

snippet-bot · 2024-12-23T08:30:06Z

Here is the summary of changes.

You are about to add 3 region tags.

security-command-center/snippets/src/main/java/management/api/GetSecurityCenterService.java:19, tag securitycenter_get_security_center_service
security-command-center/snippets/src/main/java/management/api/ListSecurityCenterServices.java:19, tag securitycenter_list_security_center_service
security-command-center/snippets/src/main/java/management/api/UpdateSecurityCenterService.java:19, tag securitycenter_update_security_center_service

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

ghost

Hi @lovenishs04 and reviewers,

I'm currently reviewing this pull request and will post my detailed review in a few minutes. In the meantime, here's a quick summary to help everyone get up to speed:

This pull request adds Java samples for the Security Command Center Management API's Organization Security Center Service Custom Module. Specifically, it includes samples for:

Get: Retrieving a Security Center service.
List: Listing all Security Center services.
Update: Updating a Security Center service.

The changes involve creating new Java classes (GetSecurityCenterService.java, ListSecurityCenterServices.java, UpdateSecurityCenterService.java) and corresponding unit tests (SecurityCenterServiceTest.java). These classes use the google-cloud-securitycentermanagement library to interact with the Security Command Center API. The code is well-documented and includes clear instructions and comments.

The intent is to provide developers with clear, concise, and readily usable code examples for common Security Command Center tasks. This will improve the developer experience and make it easier to integrate Security Command Center into their applications.

Here's a little haiku to lighten the mood:

Secure the cloud's keep,
Code samples guide the way clear,
Safety's code unfolds.

Looking forward to the discussion!

Best,
Gemini

ghost

This pull request adds samples for the Security Command Center Management API's Organization Security Center Service Custom Module. The samples cover Get, List, and Update operations. The code generally looks good, but there are a few improvements that can be made regarding clarity, error handling, and documentation.

I've referenced the Sample Format Guide in this review, specifically the sections on TODO comments and placeholder values.

It's important to address the TODOs and ensure the README is updated before merging. The checklist in the PR description mentions several important items that need to be confirmed.

ghost · 2024-12-23T08:31:12Z

security-command-center/snippets/src/main/java/management/api/GetSecurityCenterService.java

+
+  public static void main(String[] args) throws IOException {
+    // https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/get
+    // TODO: Developer should replace project_id with a real project ID before running this code


The TODO comment should be more actionable. Instead of just stating what the developer needs to do, consider providing a more descriptive placeholder or example. Per the Sample Format Guide, placeholder values should be enclosed in angle brackets.

Suggested change

// TODO: Developer should replace project_id with a real project ID before running this code

// TODO: Replace <project-id> with your project ID

String projectId = "<project-id>";

ghost · 2024-12-23T08:31:12Z

security-command-center/snippets/src/main/java/management/api/GetSecurityCenterService.java

+  public static void main(String[] args) throws IOException {
+    // https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/get
+    // TODO: Developer should replace project_id with a real project ID before running this code
+    String projectId = "project_id";


Per the Sample Format Guide, use angle brackets for placeholders. This makes it clear what needs replacing and improves readability.

Suggested change

String projectId = "project_id";

String projectId = "<project-id>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/main/java/management/api/GetSecurityCenterService.java

+    // Replace service with one of the valid values:
+    // container-threat-detection, event-threat-detection, security-health-analytics,
+    // vm-threat-detection, web-security-scanner
+    String service = "service";


Use angle brackets for the placeholder to adhere to the Sample Format Guide.

Suggested change

String service = "service";

String service = "<service>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/main/java/management/api/ListSecurityCenterServices.java

+
+  public static void main(String[] args) throws IOException {
+    // https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/list
+    // TODO: Developer should replace project_id with a real project ID before running this code


Make this TODO comment more actionable and use angle brackets for the placeholder, as per the Sample Format Guide.

Suggested change

// TODO: Developer should replace project_id with a real project ID before running this code

// TODO: Replace <project-id> with your project ID

String projectId = "<project-id>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/main/java/management/api/ListSecurityCenterServices.java

+  public static void main(String[] args) throws IOException {
+    // https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/list
+    // TODO: Developer should replace project_id with a real project ID before running this code
+    String projectId = "project_id";


Use angle brackets for placeholders to follow the Sample Format Guide.

Suggested change

String projectId = "project_id";

String projectId = "<project-id>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/main/java/management/api/UpdateSecurityCenterService.java

+
+  public static void main(String[] args) throws IOException {
+    // https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/patch
+    // TODO: Developer should replace project_id with a real project ID before running this code


Ensure the TODO comment is actionable and uses angle brackets for placeholders, consistent with the Sample Format Guide.

Suggested change

// TODO: Developer should replace project_id with a real project ID before running this code

// TODO: Replace <project-id> with your project ID

String projectId = "<project-id>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/main/java/management/api/UpdateSecurityCenterService.java

+  public static void main(String[] args) throws IOException {
+    // https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/patch
+    // TODO: Developer should replace project_id with a real project ID before running this code
+    String projectId = "project_id";


Use angle brackets for placeholders as per the Sample Format Guide.

Suggested change

String projectId = "project_id";

String projectId = "<project-id>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/main/java/management/api/UpdateSecurityCenterService.java

+    // Replace service with one of the valid values:
+    // container-threat-detection, event-threat-detection, security-health-analytics,
+    // vm-threat-detection, web-security-scanner
+    String service = "service";


Use angle brackets for the placeholder to be consistent with the Sample Format Guide.

Suggested change

String service = "service";

String service = "<service>";

ghost · 2024-12-23T08:31:13Z

security-command-center/snippets/src/test/java/management/api/SecurityCenterServiceTest.java

+
+@RunWith(JUnit4.class)
+public class SecurityCenterServiceTest {
+  // TODO(Developer): Replace the below variable


Instead of a TODO, provide clear instructions on setting the environment variable. This improves the clarity and usability of the test code. For example:

// Set the SCC_PROJECT_ID environment variable. See https://cloud.google.com/docs/authentication/getting-started for more details. private static final String PROJECT_ID = System.getenv("SCC_PROJECT_ID");

Suggested change

// TODO(Developer): Replace the below variable

// Set the SCC_PROJECT_ID environment variable. See https://cloud.google.com/docs/authentication/getting-started for more details.

private static final String PROJECT_ID = System.getenv("SCC_PROJECT_ID");

nit: I think this comment should be removed. There is no point in TODO comment such this in the test code.

minherz

I recommend to delete a confusing comment in the test code and unnecessary new lines.
Please, review the comments regarding security center service name and the "update" test.

minherz · 2025-01-14T00:48:26Z

security-command-center/snippets/src/main/java/management/api/GetSecurityCenterService.java

nit: in this and other files consider to remove unnecessary new lines

nit: security-command-center/snippets/src/main/java/management/api/UpdateSecurityCenterService.java still has empty lines

minherz · 2025-01-14T00:50:45Z

security-command-center/snippets/src/test/java/management/api/SecurityCenterServiceTest.java

+
+@RunWith(JUnit4.class)
+public class SecurityCenterServiceTest {
+  // TODO(Developer): Replace the below variable


nit: I think this comment should be removed. There is no point in TODO comment such this in the test code.

security-command-center/snippets/src/test/java/management/api/SecurityCenterServiceTest.java

minherz · 2025-01-14T00:53:47Z

security-command-center/snippets/src/test/java/management/api/SecurityCenterServiceTest.java

+public class SecurityCenterServiceTest {
+  // TODO(Developer): Replace the below variable
+  private static final String PROJECT_ID = System.getenv("SCC_PROJECT_ID");
+  private static final String SERVICE = "EVENT_THREAT_DETECTION";


what guarantee that this service exists?

Actually there are multiple services mentioned in the documentation. https://cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/organizations.locations.securityCenterServices/get
Out of these services I have picked up one and also ensured that it is available in the security command center console and also tested this in my local machine.

nit: please add a comment explaining this. Also the documentation that I see shows the following list:

container-threat-detection

event-threat-detection

security-health-analytics

vm-threat-detection

web-security-scanner
The service in the test is EVENT_THREAT_DETECTION. The documentation should explain the value.

minherz

lgtm. please consider addressing the couple of remaining comments. they do not ask for code modifications.

minherz · 2025-01-23T15:14:21Z

security-command-center/snippets/src/main/java/management/api/GetSecurityCenterService.java

nit: security-command-center/snippets/src/main/java/management/api/UpdateSecurityCenterService.java still has empty lines

minherz · 2025-01-23T15:17:17Z

security-command-center/snippets/src/test/java/management/api/SecurityCenterServiceTest.java

+public class SecurityCenterServiceTest {
+  // TODO(Developer): Replace the below variable
+  private static final String PROJECT_ID = System.getenv("SCC_PROJECT_ID");
+  private static final String SERVICE = "EVENT_THREAT_DETECTION";


nit: please add a comment explaining this. Also the documentation that I see shows the following list:

container-threat-detection

event-threat-detection

security-health-analytics

vm-threat-detection

web-security-scanner
The service in the test is EVENT_THREAT_DETECTION. The documentation should explain the value.

security-command-center/snippets/src/test/java/management/api/SecurityCenterServiceTest.java

sample codes for security center service

2c060e8

lovenishs04 requested review from yoshi-approver and a team as code owners December 23, 2024 08:30

ghost reviewed Dec 23, 2024

View reviewed changes

product-auto-label bot added api: securitycenter Issues related to the Security Command Center API. samples Issues that are directly related to samples. labels Dec 23, 2024

blunderbuss-gcf bot assigned Mukamik Dec 23, 2024

ghost reviewed Dec 23, 2024

View reviewed changes

fixed lint

d90b092

minherz reviewed Jan 14, 2025

View reviewed changes

lovenishs04 added 2 commits January 14, 2025 05:50

addressed comments

18d539a

header update

42a77ea

lovenishs04 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 14, 2025

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 14, 2025

minherz approved these changes Jan 23, 2025

View reviewed changes

addressed comment

c539b92

lovenishs04 merged commit d7e3ef7 into GoogleCloudPlatform:main Jan 24, 2025
7 checks passed

	// TODO: Developer should replace project_id with a real project ID before running this code
	// TODO: Replace <project-id> with your project ID
	String projectId = "<project-id>";

	String projectId = "project_id";
	String projectId = "<project-id>";

	// TODO(Developer): Replace the below variable
	// Set the SCC_PROJECT_ID environment variable. See https://cloud.google.com/docs/authentication/getting-started for more details.
	private static final String PROJECT_ID = System.getenv("SCC_PROJECT_ID");

feat(securitycenter): Add Resource SCC Management API Org Security Center Service Custom Module samples (Get, List, Update) #9913

feat(securitycenter): Add Resource SCC Management API Org Security Center Service Custom Module samples (Get, List, Update) #9913

Uh oh!

Conversation

lovenishs04 commented Dec 23, 2024

Description

Checklist

Uh oh!

snippet-bot bot commented Dec 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

minherz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

minherz left a comment

Choose a reason for hiding this comment

Uh oh!

snippet-bot bot commented Dec 23, 2024 •

edited

Loading