feat(security-center): Add Resource v2 API Assets Security Marks Samples by vijaykanthm · Pull Request #9680 · GoogleCloudPlatform/java-docs-samples

vijaykanthm · 2024-11-12T20:33:47Z

Description

This PR adds v2 API Assets Security Marks Java client samples to Add Security Marks, Delete Security Marks, Add Delete Security Marks.

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

snippet-bot · 2024-11-12T20:33:55Z

Here is the summary of changes.

You are about to add 3 region tags.

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java:17, tag securitycenter_add_delete_security_marks_assets_v2
security-command-center/snippets/src/main/java/vtwo/assets/AddSecurityMarksToAssets.java:17, tag securitycenter_add_security_marks_assets_v2
security-command-center/snippets/src/main/java/vtwo/assets/DeleteAssetsSecurityMarks.java:17, tag securitycenter_delete_security_marks_assets_v2

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

minherz · 2024-12-12T03:47:00Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+import com.google.protobuf.FieldMask;
+import java.io.IOException;
+
+//[START securitycenter_add_delete_security_marks_assets_v2]


place region tags to enclose necessary imports and the code sample method. no need to leave space lines between the region tags and the code

minherz · 2024-12-12T03:48:16Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+public class AddDeleteSecurityMarks {
+  public static void main(String[] args) throws IOException {
+    // organizationId: Google Cloud Organization id.
+    String organizationId = "{google-cloud-organization-id}";


please align the style of the ID with other code samples. No need for curly brackets. Most of code samples use capitalized expression like PROJECT_ID or ORGANIZATION_ID

minherz · 2024-12-12T03:48:53Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+    String organizationId = "{google-cloud-organization-id}";
+
+    // Specify the finding-id.
+    String assetId = "{asset-id}";


same here. note that "finding-id" is not used anywhere. consider to refactor the comment

minherz · 2024-12-12T03:49:53Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+    // Specify the location.
+    String location = "global";


does your code sample support other locations? if not, please use this literal inside the code sample method instead of using it as parameter. if a user can use different locations, provide a link to documentation that enumerates these locations in the comment for this argument.

minherz · 2024-12-12T03:50:13Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+  // Demonstrates adding/updating at the same time as deleting security
+  // marks from an asset.
+  // To add or change security marks, you must have an IAM role that includes permission:


no need for comments here.

minherz · 2024-12-12T03:57:54Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+    final PrintStream out = System.out;
+    stdOut = new ByteArrayOutputStream();
+    System.setOut(new PrintStream(stdOut));


please use return values instead of capturing and parsing stdout.

minherz · 2024-12-12T03:58:20Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+    stdOut = new ByteArrayOutputStream();
+    System.setOut(new PrintStream(stdOut));
+
+    requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");


nit: you can skip this check

minherz · 2024-12-12T04:00:25Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+    // Fetch a valid asset ID dynamically
+    try (SecurityCenterClient client = SecurityCenterClient.create()) {
+      OrganizationName orgName = OrganizationName.of(ORGANIZATION_ID);
+      ListAssetsRequest request =
+          ListAssetsRequest.newBuilder().setParent(orgName.toString()).setPageSize(1).build();
+
+      Asset asset = client.listAssets(request).iterateAll().iterator().next().getAsset();
+      assetName = asset.getName(); // Get the full resource name for the asset
+      assetId = extractAssetId(assetName);
+    } catch (InvalidArgumentException e) {
+      System.err.println("Error retrieving asset ID: " + e.getMessage());
+      throw e;
+    }


setup method is used to create resources. you cannot assume that a resource exists before the tests are executed. in rare occasions when tests use pre-provisioned resources (e.g. because provisioning a resource takes too long), all required attributes of the resource are hardcoded and expressed via environment variables in the testing environment.

minherz · 2024-12-12T04:00:44Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+
+    stdOut = null;
+    System.setOut(out);
+    TimeUnit.MINUTES.sleep(1);


remove this delay

minherz · 2024-12-12T04:01:01Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+    stdOut = new ByteArrayOutputStream();
+    System.setOut(new PrintStream(stdOut));


do not capture stdout stream

Merge remote into local branch.

security-command-center/snippets/src/main/java/vtwo/assets/AddSecurityMarksToAssets.java

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

security-command-center/snippets/src/main/java/vtwo/assets/DeleteAssetsSecurityMarks.java

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

minherz

Please review and address the comments.
Please provide explanation about differences between AddDeleteSecurityMarks and AddSecurityMarksToAssets code samples.

minherz · 2025-02-24T19:53:30Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+    // organizationId: Google Cloud Organization id.
+    String organizationId = "ORGANIZATION_ID";
+
+    // Specify the asset id.


TODO (actionable comments) are required here to instruct a reader how to create a working example.
See this main() method for an example.

minherz · 2025-02-24T19:54:39Z

security-command-center/snippets/src/main/java/vtwo/assets/AddDeleteSecurityMarks.java

+import com.google.protobuf.FieldMask;
+import java.io.IOException;
+
+public class AddDeleteSecurityMarks {


The example name is confusing. Adding and deleting marks in the same action is contradicting. Consider changing the name to UpdateSecurityMarks. If you want to demonstrate something else, change the name accordingly.

minherz · 2025-02-24T19:57:27Z

security-command-center/snippets/src/main/java/vtwo/assets/AddSecurityMarksToAssets.java

+public class AddSecurityMarksToAssets {
+
+  public static void main(String[] args) throws IOException {
+    // organizationId: Google Cloud Organization id.


TODO (actionable comments) are required here to instruct a reader how to create a working example.

minherz · 2025-02-24T19:58:54Z

security-command-center/snippets/src/main/java/vtwo/assets/AddSecurityMarksToAssets.java

+      String assetName = String.format("organizations/%s/assets/%s", organizationId, assetId);
+
+      // Start setting up a request to add security marks for a finding.
+      ImmutableMap markMap = ImmutableMap.of("key_a", "value_a", "key_b", "value_b");


nit: consider passing the collection of key/value strings as an argument in order to make the example more usable.

minherz · 2025-02-24T20:01:35Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+
+  @Rule
+  public final MultipleAttemptsRule multipleAttemptsRule =
+      new MultipleAttemptsRule(3, 120000); // 2 minutes


2 minutes per test is too long. please consider to reduce the maximal time of execution.

minherz · 2025-02-24T20:03:16Z

security-command-center/snippets/src/test/java/vtwo/AssetSecurityMarksIT.java

+  @Before
+  public void beforeEach() {
+    stdOut = new ByteArrayOutputStream();
+  }
+
+  @After
+  public void afterEach() {
+    stdOut = null;
+    System.setOut(null);
+  }
+
+  @AfterClass
+  public static void cleanUp() {
+    System.setOut(System.out);
+  }


remove this code since code samples do not print to stdout.

minherz · 2025-02-24T20:04:12Z

security-command-center/snippets/src/test/resources/static_asset.json

why to store so much information in order to retrieve a (supposedly) fixed asset ID?

telpirion · 2025-05-15T17:28:33Z

@vijaykanthm -- Hi! It looks like there hasn't been any movement on this PR in a little over three months. Do you intend to return to it?

telpirion · 2025-06-17T18:10:35Z

This PR seems to have been abandoned. @vijaykanthm if you decide to resume work on this PR, please feel free to reopen. Thanks!

Add Resource v2 Assets Security Marks

c64abfb

vijaykanthm requested review from a team and yoshi-approver as code owners November 12, 2024 20:33

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

blunderbuss-gcf bot assigned Sita04 Nov 12, 2024

vijaykanthm added 3 commits November 13, 2024 18:34

lint fixes

8c76982

refactor the imports order in test file:

1d4693b

Lint being petty about variable declarations

406c411

vijaykanthm added kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. and removed kokoro:run Add this label to force Kokoro to re-run the tests. labels Nov 14, 2024

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

owenhuyn added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 26, 2024

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 26, 2024

vijaykanthm added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 3, 2024

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 3, 2024

minherz requested changes Dec 12, 2024

View reviewed changes

vijaykanthm added 4 commits January 31, 2025 23:19

Address comments

38f9e26

Update the copyright year in the headers

99eacfc

Fix Linting

d06981b

Merge remote-tracking branch 'origin/main' into security-marks-assets-v2

e4b8d95

Merge remote into local branch.

vijaykanthm requested review from a team as code owners February 2, 2025 21:27

vijaykanthm force-pushed the security-marks-assets-v2 branch from af64a50 to e4b8d95 Compare February 2, 2025 22:56

fix lint take two

885be93

vijaykanthm removed request for a team February 2, 2025 22:59

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

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

vijaykanthm requested a review from minherz February 3, 2025 18:14

anissa-abu approved these changes Feb 18, 2025

View reviewed changes

telpirion suggested changes Feb 18, 2025

View reviewed changes

telpirion self-assigned this Feb 18, 2025

minherz requested changes Feb 24, 2025

View reviewed changes

telpirion assigned minherz and unassigned telpirion Mar 18, 2025

telpirion closed this Jun 17, 2025

		stdOut = new ByteArrayOutputStream();
		System.setOut(new PrintStream(stdOut));

Conversation

vijaykanthm commented Nov 12, 2024

Description

Checklist

Uh oh!

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

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!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

telpirion commented May 15, 2025

Uh oh!

telpirion commented Jun 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

snippet-bot bot commented Nov 12, 2024 •

edited

Loading