feat(securityCenter): Adding SCC's BigQueryExport resource #3847

vijaykanthm · 2024-09-11T22:52:38Z

Description

Fixes #349577531
Reference to https://b.corp.google.com/issues/349577531
This PR adds v2 API Big Query Node js client samples to Create, List, Get, Delete & Update.

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

Checklist

snippet-bot · 2024-09-11T22:52:42Z

Here is the summary of changes.

You are about to add 5 region tags.

security-center/snippets/v2/createBigQueryExport.js:22, tag securitycenter_create_bigquery_export_v2
security-center/snippets/v2/deleteBigQueryExport.js:22, tag securitycenter_delete_bigquery_export_v2
security-center/snippets/v2/getBigQueryExport.js:22, tag securitycenter_get_bigquery_export_v2
security-center/snippets/v2/listAllBigQueryExports.js:22, tag securitycenter_list_bigquery_export_v2
security-center/snippets/v2/updateBigQueryExport.js:22, tag securitycenter_update_bigquery_export_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

grayside

This PR has combined changes for samples across products. Please clean up or delete and send a new PR. The title specifies bigquery, the referenced bug specifies security center, the code includes changes for both.

Once this is done, we can proceed with a code review.

vijaykanthm · 2024-09-20T17:42:25Z

This PR has combined changes for samples across products. Please clean up or delete and send a new PR. The title specifies bigquery, the referenced bug specifies security center, the code includes changes for both.

Once this is done, we can proceed with a code review.

I didn't understand what you meant, can you please elaborate on the comment. The bug doesn't have all the details but the requirement is to create samples for different components which are raised in separate PR's. This one has changes only related to the Big query.

grayside · 2024-09-20T21:08:03Z

I didn't understand what you meant, can you please elaborate on the comment. The bug doesn't have all the details but the requirement is to create samples for different components which are raised in separate PR's. This one has changes only related to the Big query.

The changes in this PR have accidentally picked up changes for BigQuery and Security Center. If this PR is meant to make changes for BigQuery samples, please remove accidentally included Security Center code.

vijaykanthm · 2024-09-20T22:38:05Z

I didn't understand what you meant, can you please elaborate on the comment. The bug doesn't have all the details but the requirement is to create samples for different components which are raised in separate PR's. This one has changes only related to the Big query.

The changes in this PR have accidentally picked up changes for BigQuery and Security Center. If this PR is meant to make changes for BigQuery samples, please remove accidentally included Security Center code.

Thank you for the clarification. I realize the title of the PR might have been misleading.
To clarify, the changes in this PR are specifically for Security Center's integration with BigQuery via the BigQueryExport resource.

The changes are scoped to Security Center snippets, and the BigQueryExport is a resource type under the Security Center that integrates with BigQuery. I will update the PR title to reflect this and avoid further confusion.

grayside · 2024-09-27T17:22:45Z

.github/workflows/security-center-snippets.yaml

@@ -81,7 +81,7 @@ jobs:
    - run: npm test
      env:
        GCLOUD_ORGANIZATION: 1081635000895
-        GOOGLE_SAMPLES_PROJECT: "long-door-651"
+        GOOGLE_SAMPLES_PROJECT: "project-a-id"


issue: Use of this project is under discussion in #3830. It is probably not usable.

grayside · 2024-09-27T17:23:58Z

.github/workflows/utils/workflows.json

@@ -94,5 +94,6 @@
  "video-intelligence",
  "vision/productSearch",
  "workflows",
-  "workflows/invoke-private-endpoint"
+  "workflows/invoke-private-endpoint",
+  "security-center/snippets/v2"


issue: #3883 means we shouldn't separately add v2.

grayside · 2024-09-27T17:24:57Z

security-center/snippets/package.json

@@ -9,7 +9,7 @@
    "node": ">=16.0.0"
  },
  "scripts": {
-    "test": "c8 mocha -p -j 2 --recursive --timeout 6000000 system-test/v2/findings.test.js"
+    "test": "c8 mocha -p -j 2 --recursive --timeout 6000000 system-test/v2/"


issue: The test command for security center snippets overall should run all snippet tests, not just v2.

grayside · 2024-09-27T17:27:16Z

security-center/snippets/system-test/v2/bigQueryExport.test.js

+const organizationId = '1081635000895';
+const projectId = 'project-a-id';


question: Shouldn't these be populated from environment variables configured on the workflow?

grayside · 2024-09-27T17:27:40Z

security-center/snippets/system-test/v2/notifications.test.js

@@ -27,7 +27,7 @@ const exec = cmd => execSync(cmd, {encoding: 'utf8'});

 // TODO(developers): update for your own environment
 const organizationId = '1081635000895';
-const projectId = 'long-door-651';
+const projectId = 'project-a-id';


question: Shouldn't these be populated from environment variables configured on the workflow?

grayside · 2024-09-27T17:37:10Z

security-center/snippets/v2/createBigQueryExport.js

+   *  characters or less.
+   */
+  const bigQueryExportId =
+    'bigqueryexportid-' + uuidv1().replace(/-/g, '').substring(0, 20);


issue: Please remove the unneeded dependency on uuid, apply the Math.random approach from #3830

grayside · 2024-09-27T17:38:29Z

security-center/snippets/v2/listAllBigQueryExports.js

+   *  "folders/[folder_id]/locations/[location_id]", or
+   *  "projects/[project_id]/locations/[location_id]".
+   */
+  const parent = client.organizationLocationPath(organizationId, location);


issue: Referencing organizationId and location from outside the region tag scope is a violation of the copy-paste-runnable goal for samples.

suggestion: Minimally, any referenced variable should have a commented out variable declaration with an instruction for use on each variable.

For example,

/** * TODO(developer): Uncomment the following line before running the sample. */ // const projectId = 'YOUR_PROJECT_ID';

In https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/security-center/snippets/v2/createFinding.js it appears the decision was made to hard-code location to global. If that's how we're testing, hardcoding the global value without comment and adding an inline comment explaining would be better than a commented out instantiation.

See #3830 for previously discussed instances

grayside · 2024-09-27T17:38:43Z

security-center/snippets/v2/updateBigQueryExport.js

+   *  + `folders/{folder}/locations/{location}/bigQueryExports/{export_id}`
+   *  + `projects/{project}locations/{location}/bigQueryExports/{export_id}`
+   */
+  const name = `organizations/${organizationId}/locations/${location}/bigQueryExports/${exportId}`;


issue: Referencing organizationId and location from outside the region tag scope is a violation of the copy-paste-runnable goal for samples.

suggestion: Minimally, any referenced variable should have a commented out variable declaration with an instruction for use on each variable.

For example,

/** * TODO(developer): Uncomment the following line before running the sample. */ // const projectId = 'YOUR_PROJECT_ID';

In https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/security-center/snippets/v2/createFinding.js it appears the decision was made to hard-code location to global. If that's how we're testing, hardcoding the global value without comment and adding an inline comment explaining would be better than a commented out instantiation.

grayside · 2024-09-27T17:42:07Z

security-center/snippets/v2/listAllBigQueryExports.js

+   *  When paginating, all other parameters provided to `ListBigQueryExports`
+   *  must match the call that provided the page token.
+   */
+  // const pageToken = 'abc123'


issue: I don't see how the commented out variables are used in the snippet below. How is this guidance meant to be used?

grayside · 2024-09-27T17:46:12Z

security-center/snippets/v2/updateBigQueryExport.js

+      updateBigQueryExportRequest,
+      fieldMask
+    );
+    console.log('BigQueryExport updated successfully!: %j', response);


issue: The guideline to process the result calls for outputting specific attributes in the response.
https://googlecloudplatform.github.io/samples-style-guide/#result

feat(bigquery): Add Resource v2 API Big Query Samples

1365f7b

vijaykanthm requested review from a team as code owners September 11, 2024 22:52

Fix lint

c54bfe6

product-auto-label bot added api: bigquery Issues related to the BigQuery API. samples Issues that are directly related to samples. api: securitycenter Issues related to the Security Command Center API. api: workflows Issues related to the Workflows API. labels Sep 11, 2024

blunderbuss-gcf bot assigned iennae Sep 11, 2024

iennae assigned subfuzion and unassigned iennae Sep 12, 2024

product-auto-label bot removed api: securitycenter Issues related to the Security Command Center API. api: workflows Issues related to the Workflows API. labels Sep 12, 2024

grayside assigned grayside and unassigned subfuzion Sep 20, 2024

grayside requested changes Sep 20, 2024

View reviewed changes

vijaykanthm closed this Sep 20, 2024

vijaykanthm reopened this Sep 20, 2024

vijaykanthm requested a review from a team as a code owner September 20, 2024 17:39

grayside requested review from a team September 20, 2024 21:09

vijaykanthm changed the title ~~feat(bigquery): Add Resource v2 API Big Query Samples~~ feat(securityCenter): Adding SCC's BigQueryExport resource Sep 20, 2024

vijaykanthm added 2 commits September 23, 2024 11:03

Merge branch 'main' into bigquery-samples-v2

58e8a25

fix the failing test check by replacing the project

59818c9

vijaykanthm requested a review from grayside September 24, 2024 21:32

Merge branch 'main' into bigquery-samples-v2

7e698b3

grayside requested changes Sep 27, 2024

View reviewed changes

vijaykanthm added 6 commits September 27, 2024 16:18

Merge branch 'main' into bigquery-samples-v2

011cb9f

Address Suggestions

badce75

fix the test error

eff59dc

fix the lint error

1af5bcb

Add dataset creation logic

0c61757

fix lint error

350aed2

vijaykanthm requested a review from grayside October 1, 2024 21:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(securityCenter): Adding SCC's BigQueryExport resource #3847

feat(securityCenter): Adding SCC's BigQueryExport resource #3847

vijaykanthm commented Sep 11, 2024

snippet-bot bot commented Sep 11, 2024 •

edited

Loading

grayside left a comment •

edited

Loading

vijaykanthm commented Sep 20, 2024

grayside commented Sep 20, 2024

vijaykanthm commented Sep 20, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

grayside Sep 27, 2024

vijaykanthm Sep 30, 2024

		const organizationId = '1081635000895';
		const projectId = 'project-a-id';

feat(securityCenter): Adding SCC's BigQueryExport resource #3847

Are you sure you want to change the base?

feat(securityCenter): Adding SCC's BigQueryExport resource #3847

Conversation

vijaykanthm commented Sep 11, 2024

Description

Checklist

snippet-bot bot commented Sep 11, 2024 • edited Loading

grayside left a comment • edited Loading

Choose a reason for hiding this comment

vijaykanthm commented Sep 20, 2024

grayside commented Sep 20, 2024

vijaykanthm commented Sep 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snippet-bot bot commented Sep 11, 2024 •

edited

Loading

grayside left a comment •

edited

Loading