Cloud Audit Log Catalog #158
Merged
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
Signed-off-by: Grant Timmerman <[email protected]>
Signed-off-by: Grant Timmerman <[email protected]>
Signed-off-by: Grant Timmerman <[email protected]>
google-cla
bot
added
the
cla: yes
product-auto-label
bot
added
the
api: eventarc
jskeet
approved these changes
Feb 16, 2021
Signed-off-by: Grant Timmerman <[email protected]>
grant
added
the
automerge
|
Merge-on-green is not authorized to push to this branch. Visit https://help.github.com/en/github/administering-a-repository/enabling-branch-restrictions to give gcf-merge-on-green permission to push to this branch. |
grant
removed
the
automerge
|
Blocked by broken build. Fixed with: #162 |
grayside
requested changes
Mar 6, 2021
There was a problem hiding this comment.
I left a couple nits and a couple action items.
Overall this makes sense.
Future Consideration: It seems like it's starting to push the limits of easily maintained "string hacking", keeping all these pieces in mind as an intermittent maintainer starts to get more challenging.
We should consider at what point using another approach such as a templating engine might be more maintainable.
Comment on lines
7
to
23
| * Generates a Cloud Audit Log catalog markdown for the README. | ||
| * @example Example input: | ||
| * [{ | ||
| * "serviceName": "workflows.googleapis.com", | ||
| * "displayName": "Workflows", | ||
| * "methods": [ | ||
| * { | ||
| * "methodName": "google.cloud.workflows.v1.Workflows.CreateWorkflow", | ||
| * "lastAdded": "1607367890" | ||
| * }, | ||
| * ] | ||
| * }, | ||
| * ... | ||
| * ] | ||
| * {@link ../../json/audit/service_catalog.json} |
There was a problem hiding this comment.
Discussion: This is fantastically clear and detailed commenting. Is this complying with any particular commenting standard? I've been meaning to look up best practice around node.js.
There was a problem hiding this comment.
Thank you.
I am generally using the JSDoc standard, which has support with editors like VS Code:
https://jsdoc.app/
https://code.visualstudio.com/docs/languages/javascript#_jsdoc-support
There's lots of rich IDE support for these tags. Unfortunately the @link tag like here at line 21 is still in the works for VS Code:
Signed-off-by: Grant Timmerman <[email protected]>
grayside
approved these changes
Mar 10, 2021
jay-shi
added a commit
that referenced
this pull request
Mar 23, 2021
* chore: run the generator, feb 26, 2021 (#173) Runs the generator manually. The latest change has improvements to metadata about base64 type strings. Fixes: #174 * chore(deps): bump urijs from 1.19.5 to 1.19.6 in /tools/quicktype-wrapper (#175) Bumps [urijs](https://github.com/medialize/URI.js) from 1.19.5 to 1.19.6. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/medialize/URI.js/releases">urijs's releases</a>.</em></p> <blockquote> <h2>1.19.6 (February 13th 2021)</h2> <ul> <li><strong>SECURITY</strong> fixing <a href="http://medialize.github.io/URI.js/docs.html#static-parse"><code>URI.parse()</code></a> to rewrite <code>\</code> in scheme delimiter to <code>/</code> as Node and Browsers do - disclosed privately by <a href="https://twitter.com/ynizry">Yaniv Nizry</a> from the CxSCA AppSec team at Checkmarx</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/medialize/URI.js/blob/gh-pages/CHANGELOG.md">urijs's changelog</a>.</em></p> <blockquote> <h3>1.19.6 (February 13th 2021)</h3> <ul> <li><strong>SECURITY</strong> fixing <a href="http://medialize.github.io/URI.js/docs.html#static-parse"><code>URI.parse()</code></a> to rewrite <code>\</code> in scheme delimiter to <code>/</code> as Node and Browsers do - disclosed privately by <a href="https://twitter.com/ynizry">Yaniv Nizry</a> from the CxSCA AppSec team at Checkmarx</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/medialize/URI.js/commit/46c8ac0c7e6997daad8ff6859784b39f8892fa97"><code>46c8ac0</code></a> chore(build): bumping to version 1.19.6</li> <li><a href="https://github.com/medialize/URI.js/commit/a1ad8bcbc39a4d136d7e252e76e957f3ece70839"><code>a1ad8bc</code></a> fix(parse): treat backslash as forwardslash in scheme delimiter</li> <li>See full diff in <a href="https://github.com/medialize/URI.js/compare/v1.19.5...v1.19.6">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/googleapis/google-cloudevents/network/alerts). </details> * JSON Schema postgen native json fieldnames (#178) * fix: uses protoc plugin field for json schema field capitalization Signed-off-by: Grant Timmerman <[email protected]> * fix: fix replacement string Signed-off-by: Grant Timmerman <[email protected]> * fix: use full id name in jsonschema definitions Signed-off-by: Grant Timmerman <[email protected]> * Add action script to handle copybara flow (#181) * Add a action script that auto-generates a pull request when there is a push to branch "copybara". The branch "copybara" only receives push from Copybara flow. * Cloud Audit Log Catalog (#158) * docs: add CAL catalog Signed-off-by: Grant Timmerman <[email protected]> * docs: updates docs with cal catalog Signed-off-by: Grant Timmerman <[email protected]> * docs: detailed test for CAL trigger docs Signed-off-by: Grant Timmerman <[email protected]> * fix: cal catalog script use json quotes not js quotes Signed-off-by: Grant Timmerman <[email protected]> * refactor: improve readability of audit log gen script Signed-off-by: Grant Timmerman <[email protected]> * chore: add licenses to files (#183) Signed-off-by: Grant Timmerman <[email protected]> * fix: Fix generation on Windows Fixes #154 * ci: jsonschema validation (#186) Validates that the JSON schemas are valid schemas according to the JSON schema schema. I've ran a few CI runs to ensure that this check is correct. We already have CI that checks for a 0 diff between proto and jsonschema, so naturally that check also breaks when if modifying the json schema manually. ## Example CI runs Purposeful invalid JSON schema break:  Purposeful valid JSON schema fix:  ## Notes Local testing is pretty easy, just install Node and copy the npx script. ### Example CI output ```md Run JSON_SCHEMAS=$(find ./jsonschema/google/events -name "*.json") npx: installed 41 in 4.585s ./jsonschema/google/events/cloud/firestore/v1/DocumentEventData.json valid npx: installed 41 in 2.189s ./jsonschema/google/events/cloud/storage/v1/StorageObjectData.json valid npx: installed 41 in 2.085s ./jsonschema/google/events/cloud/cloudbuild/v1/BuildEventData.json valid npx: installed 41 in 2.149s ./jsonschema/google/events/cloud/audit/v1/LogEntryData.json valid npx: installed 41 in 2.085s ./jsonschema/google/events/cloud/scheduler/v1/SchedulerJobData.json valid npx: installed 41 in 2.181s ./jsonschema/google/events/cloud/pubsub/v1/MessagePublishedData.json valid npx: installed 41 in 2.166s ./jsonschema/google/events/firebase/database/v1/ReferenceEventData.json valid npx: installed 41 in 2.094s ./jsonschema/google/events/firebase/analytics/v1/AnalyticsLogData.json valid npx: installed 41 in 2.091s ./jsonschema/google/events/firebase/remoteconfig/v1/RemoteConfigEventData.json valid npx: installed 41 in 2.161s ./jsonschema/google/events/firebase/auth/v1/AuthEventData.json valid ``` Co-authored-by: Grant Timmerman <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jon Skeet <[email protected]>
grant
added a commit
that referenced
this pull request
Mar 24, 2021
* chore: run the generator, feb 26, 2021 (#173) Runs the generator manually. The latest change has improvements to metadata about base64 type strings. Fixes: #174 * chore(deps): bump urijs from 1.19.5 to 1.19.6 in /tools/quicktype-wrapper (#175) Bumps [urijs](https://github.com/medialize/URI.js) from 1.19.5 to 1.19.6. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/medialize/URI.js/releases">urijs's releases</a>.</em></p> <blockquote> <h2>1.19.6 (February 13th 2021)</h2> <ul> <li><strong>SECURITY</strong> fixing <a href="http://medialize.github.io/URI.js/docs.html#static-parse"><code>URI.parse()</code></a> to rewrite <code>\</code> in scheme delimiter to <code>/</code> as Node and Browsers do - disclosed privately by <a href="https://twitter.com/ynizry">Yaniv Nizry</a> from the CxSCA AppSec team at Checkmarx</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/medialize/URI.js/blob/gh-pages/CHANGELOG.md">urijs's changelog</a>.</em></p> <blockquote> <h3>1.19.6 (February 13th 2021)</h3> <ul> <li><strong>SECURITY</strong> fixing <a href="http://medialize.github.io/URI.js/docs.html#static-parse"><code>URI.parse()</code></a> to rewrite <code>\</code> in scheme delimiter to <code>/</code> as Node and Browsers do - disclosed privately by <a href="https://twitter.com/ynizry">Yaniv Nizry</a> from the CxSCA AppSec team at Checkmarx</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/medialize/URI.js/commit/46c8ac0c7e6997daad8ff6859784b39f8892fa97"><code>46c8ac0</code></a> chore(build): bumping to version 1.19.6</li> <li><a href="https://github.com/medialize/URI.js/commit/a1ad8bcbc39a4d136d7e252e76e957f3ece70839"><code>a1ad8bc</code></a> fix(parse): treat backslash as forwardslash in scheme delimiter</li> <li>See full diff in <a href="https://github.com/medialize/URI.js/compare/v1.19.5...v1.19.6">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/googleapis/google-cloudevents/network/alerts). </details> * JSON Schema postgen native json fieldnames (#178) * fix: uses protoc plugin field for json schema field capitalization Signed-off-by: Grant Timmerman <[email protected]> * fix: fix replacement string Signed-off-by: Grant Timmerman <[email protected]> * fix: use full id name in jsonschema definitions Signed-off-by: Grant Timmerman <[email protected]> * Add action script to handle copybara flow (#181) * Add a action script that auto-generates a pull request when there is a push to branch "copybara". The branch "copybara" only receives push from Copybara flow. * Cloud Audit Log Catalog (#158) * docs: add CAL catalog Signed-off-by: Grant Timmerman <[email protected]> * docs: updates docs with cal catalog Signed-off-by: Grant Timmerman <[email protected]> * docs: detailed test for CAL trigger docs Signed-off-by: Grant Timmerman <[email protected]> * fix: cal catalog script use json quotes not js quotes Signed-off-by: Grant Timmerman <[email protected]> * refactor: improve readability of audit log gen script Signed-off-by: Grant Timmerman <[email protected]> * chore: add licenses to files (#183) Signed-off-by: Grant Timmerman <[email protected]> * fix: Fix generation on Windows Fixes #154 * ci: jsonschema validation (#186) Validates that the JSON schemas are valid schemas according to the JSON schema schema. I've ran a few CI runs to ensure that this check is correct. We already have CI that checks for a 0 diff between proto and jsonschema, so naturally that check also breaks when if modifying the json schema manually. ## Example CI runs Purposeful invalid JSON schema break:  Purposeful valid JSON schema fix:  ## Notes Local testing is pretty easy, just install Node and copy the npx script. ### Example CI output ```md Run JSON_SCHEMAS=$(find ./jsonschema/google/events -name "*.json") npx: installed 41 in 4.585s ./jsonschema/google/events/cloud/firestore/v1/DocumentEventData.json valid npx: installed 41 in 2.189s ./jsonschema/google/events/cloud/storage/v1/StorageObjectData.json valid npx: installed 41 in 2.085s ./jsonschema/google/events/cloud/cloudbuild/v1/BuildEventData.json valid npx: installed 41 in 2.149s ./jsonschema/google/events/cloud/audit/v1/LogEntryData.json valid npx: installed 41 in 2.085s ./jsonschema/google/events/cloud/scheduler/v1/SchedulerJobData.json valid npx: installed 41 in 2.181s ./jsonschema/google/events/cloud/pubsub/v1/MessagePublishedData.json valid npx: installed 41 in 2.166s ./jsonschema/google/events/firebase/database/v1/ReferenceEventData.json valid npx: installed 41 in 2.094s ./jsonschema/google/events/firebase/analytics/v1/AnalyticsLogData.json valid npx: installed 41 in 2.091s ./jsonschema/google/events/firebase/remoteconfig/v1/RemoteConfigEventData.json valid npx: installed 41 in 2.161s ./jsonschema/google/events/firebase/auth/v1/AuthEventData.json valid ``` Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jay Shi <[email protected]> Co-authored-by: Jon Skeet <[email protected]>
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.
Cloud Audit Log Catalog
Creates a catalog of Cloud Audit Log
serviceNameandmethodNamecombinations using the audit catalog.Required for
google.cloud.audit.log.v1.writtentype.Preview
PR Changes
AUDIT_CATALOG.md.json/audit/service_catalog.json. Note: that file is sync'd from g3 via copybara.README.mdto link to 2 event catalogs.tools/readme-catalogtoolcommonutil file for catalog generators.