Cloud Audit Log Catalog

README.md

@@ -37,7 +37,23 @@ This repository contains definitions for the following CloudEvents:
 |Firebase Remote Config|[Proto](proto/google/events/firebase/remoteconfig/v1/data.proto) / [JSON](https://googleapis.github.io/google-cloudevents/jsonschema/google/events/firebase/remoteconfig/v1/RemoteConfigEventData.json)|<br>Data Type:<br>`google.events.firebase.remoteconfig.v1.RemoteConfigEventData`<br>CloudEvent Type(s):<br>`google.firebase.remoteconfig.remoteConfig.v1.updated`|
 <!-- GENERATED END -->
 
-A [registry of the JSON schema catalog](https://googleapis.github.io/google-cloudevents/jsonschema/catalog.json) is also available.
+## Google CloudEvent Catalogs
+
+This repository contains catalogs for Google CloudEvent event discovery:
+
+### Google CloudEvent JSON Schema catalog
+
+Link: [`catalog.json`](./jsonschema/catalog.json)
+
+A machine-readable list of Google CloudEvent JSON schemas. In the format of a [JSON Schema catalog](https://json.schemastore.org/schema-catalog).
+
+### Cloud Audit Log catalog
+
+Link: [`AUDIT_CATALOG.md`](./AUDIT_CATALOG.md)
+
+A human-readable list of Audit Log `methodName` and `serviceName` event filters.
+
+Used for filtering events of type `google.cloud.audit.log.v1.written`.
 
 ## Google CloudEvent Type Libraries
 

tools/readme-catalog/README.md

@@ -1,6 +1,11 @@
 # readme-catalog
 
-Edits the top-level [`README.md`](../../README.md) event catalog.
+Edits README catalog markdown files using a generator.
+
+The following files are generated:
+
+- The top-level [`README.md`](../../README.md) – CloudEvent catalog
+- The [`AUDIT_CATALOG.md`](../../AUDIT_CATALOG.md) – Cloud Audit Log catalog
 
 ## Requirements
 

tools/readme-catalog/common.js

@@ -0,0 +1,17 @@
+/**
+ * Replaces the contents of a string's GENERATED comments with a replacement.
+ * @param {string} s The string to replace.
+ * @param {string} replacement The replacement string.
+ */
+export const getGeneratedStringWithReplacement = (s, replacement) => {
+  const README_GEN_START = '<!-- GENERATED START -->';
+  const README_GEN_END = '<!-- GENERATED END -->';
+
+  const README_BEFORE_TABLE = s.substring(0, s.indexOf(README_GEN_START) + README_GEN_START.length);
+  const README_AFTER_TABLE = s.substring(s.indexOf(README_GEN_END));
+
+  // Return result (with newlines)
+  return `${README_BEFORE_TABLE}
+${replacement}
+${README_AFTER_TABLE}`;
+};

tools/readme-catalog/gen-audit-catalog.js

@@ -0,0 +1,64 @@
+import * as fs from 'fs';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { getGeneratedStringWithReplacement } from './common.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+/**
+ * The const `CATALOG` contains an object with a Cloud Audit Log catalog.
+ * This data is used for generating the audit log catalog.
+ * @example
+ * [{
+ *   "serviceName": "workflows.googleapis.com",
+ *   "displayName": "Workflows",
+ *   "methods": [
+ *     {
+ *       "methodName": "google.cloud.workflows.v1.Workflows.CreateWorkflow",
+ *       "lastAdded": "1607367890"
+ *     },
+ *   ]
+ * },
+ *   ...
+ * ]
+ * {@link ../../json/audit/service_catalog.json}
+ */
+const CATALOG = JSON.parse(fs.readFileSync(`${__dirname}/../../json/audit/service_catalog.json`));
+
+/**
+ * Generates markdown containing a Cloud Audit Log catalog
+ * and saves the markdown in the file called `AUDIT_CATALOG.md`.
+ */
+export const genAuditCatalog = () => {
+  // Update README
+  const AUDIT_CATALOG_PATH = `${__dirname}/../../AUDIT_CATALOG.md`;
+  const auditCatalogContents = fs.readFileSync(AUDIT_CATALOG_PATH).toString();
+  const replacementString = CATALOG.services.map(getServiceCatalogEntryMarkdown).join('');
+  const updatedReadmeContents = getGeneratedStringWithReplacement(auditCatalogContents, replacementString);
+
+  console.log(updatedReadmeContents);
+
+  // Save updated README
+  fs.writeFileSync(AUDIT_CATALOG_PATH, updatedReadmeContents);
+  console.log('- Updated README.');
+};
+
+/**
+ * Gets markdown for a CAL service catalog entry.
+ * @param {object} calEntry A single Cloud Audit Log entry.
+ * @returns {string} Markdown with info about this CAL entry.
+ */
+const getServiceCatalogEntryMarkdown = (calEntry) => {
+  return `### ${calEntry.displayName}
+
+#### \`serviceName\`
+
+- \`${calEntry.serviceName}\`
+
+#### \`methodName\`
+
+${calEntry.methods.map((method => {
+  return `- \`${method.methodName}\``;
+})).join('\n')}
+
+`;
+};

tools/readme-catalog/gen-cloudevent-catalog.js

@@ -0,0 +1,66 @@
+import * as fs from 'fs';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { getGeneratedStringWithReplacement } from './common.js';
+
+/**
+ * Generates a CloudEvent catalog for the README.
+ */
+
+/**
+ * Gets markdown for the proto / JSON schema table cell.
+ * @param {object} schemaEntry The JSON schema catalog entry.
+ * @returns {string} Markdown for the schema entry.
+ */
+const getSchemaLinkMarkdown = (schemaEntry) => {
+  // Get the path the to the data from the datatype.
+  // in: "google.events.cloud.audit.v1.LogEntryData"
+  // out: "cloud/audit/v1"
+  const prefix = 'google.';
+  const schemaPath = schemaEntry.datatype.substring(
+    schemaEntry.datatype.indexOf(prefix) + prefix.length,
+    schemaEntry.datatype.indexOf(`.${schemaEntry.name}`),
+  ).replace(/\./g, '/');
+
+  // Proto link is the path + data.proto
+  const protoLink = `proto/google/${schemaPath}/data.proto`;
+
+  // JSON schema path is the URL + jsonschema path + {name}.json
+  const jsonschemaPath = `${schemaPath}/${schemaEntry.name}`;
+  const jsonLink = `https://googleapis.github.io/google-cloudevents/jsonschema/google/${jsonschemaPath}.json`;
+  return `[Proto](${protoLink}) / [JSON](${jsonLink})`;
+};
+
+/**
+ * Updates the main README with a CloudEvent catalog.
+ */
+export const genCloudEventCatalog = () => {
+  console.log('- Updating README...');
+
+  // Generate table
+  const replacementTableRow = (schemaEntry) => {
+    // Add escaped ticks (\`) to code.
+    const PRODUCT = schemaEntry.product;
+    const SCHEMAS = getSchemaLinkMarkdown(schemaEntry);
+    const DATA_TYPE = `\`${schemaEntry.datatype}\``;
+    const CLOUDEVENT_TYPE = schemaEntry.cloudeventTypes.map(t => `\`${t}\``).join('<br/>');
+    return `|${PRODUCT}|${SCHEMAS}|<br>Data Type:<br>${DATA_TYPE}<br>CloudEvent Type(s):<br>${CLOUDEVENT_TYPE}|`;
+  };
+
+  // Get the catalog file, and replace the table.
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+  const CATALOG = JSON.parse(fs.readFileSync(`${__dirname}/../../jsonschema/catalog.json`));
+  const replacementTable =
+    `|Product|Schemas|Types|
+|-|-|-|
+${CATALOG.schemas.map(replacementTableRow).join('\n')}`;
+
+  // Update README
+  const README_PATH = `${__dirname}/../../README.md`;
+  const readmeContents = fs.readFileSync(README_PATH).toString();
+  const updatedReadmeContents = getGeneratedStringWithReplacement(readmeContents, replacementTable);
+
+  // Save updated README
+  fs.writeFileSync(README_PATH, updatedReadmeContents);
+  console.log('- Updated README.');
+};

tools/readme-catalog/index.js

@@ -13,79 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-const fs = require('fs');
-
-/**
- * Generates a catalog for the README.
- */
-const CATALOG = JSON.parse(fs.readFileSync(`${__dirname}/../../jsonschema/catalog.json`));
+import {genAuditCatalog} from './gen-audit-catalog.js';
+import {genCloudEventCatalog} from './gen-cloudevent-catalog.js';
 
 /**
- * Replaces the contents of a string's GENERATED comments with a replacement.
- * @param {string} s The string to replace.
- * @param {string} replacement The replacement string.
+ * Generate and update the READMEs.
  */
-const getGeneratedStringWithReplacement = (s, replacement) => {
-  const README_GEN_START = '<!-- GENERATED START -->';
-  const README_GEN_END = '<!-- GENERATED END -->';
-
-  const README_BEFORE_TABLE = s.substring(0, s.indexOf(README_GEN_START) + README_GEN_START.length);
-  const README_AFTER_TABLE = s.substring(s.indexOf(README_GEN_END));
-
-  // Return result (with newlines)
-  return `${README_BEFORE_TABLE}
-${replacement}
-${README_AFTER_TABLE}`;
-};
-
-/**
- * Gets markdown for the proto / JSON schema table cell.
- * @param {object} schemaEntry The JSON schema catalog entry.
- * @returns {string} Markdown for the schema entry.
- */
-const getSchemaLinkMarkdown = (schemaEntry) => {
-  // Get the path the to the data from the datatype.
-  // in: "google.events.cloud.audit.v1.LogEntryData"
-  // out: "cloud/audit/v1"
-  const prefix = 'google.';
-  const schemaPath = schemaEntry.datatype.substring(
-    schemaEntry.datatype.indexOf(prefix) + prefix.length,
-    schemaEntry.datatype.indexOf(`.${schemaEntry.name}`),
-  ).replace(/\./g, '/');
-
-  // Proto link is the path + data.proto
-  const protoLink = `proto/google/${schemaPath}/data.proto`;
-
-  // JSON schema path is the URL + jsonschema path + {name}.json
-  const jsonschemaPath = `${schemaPath}/${schemaEntry.name}`;
-  const jsonLink = `https://googleapis.github.io/google-cloudevents/jsonschema/google/${jsonschemaPath}.json`;
-  return `[Proto](${protoLink}) / [JSON](${jsonLink})`;
-}
-
-(async () => {
-  console.log('- Updating README...');
-
-  // Generate table
-  const replacementTableRow = (schemaEntry) => {
-    // Add escaped ticks (\`) to code.
-    const PRODUCT = schemaEntry.product;
-    const SCHEMAS = getSchemaLinkMarkdown(schemaEntry);
-    const DATA_TYPE = `\`${schemaEntry.datatype}\``;
-    const CLOUDEVENT_TYPE = schemaEntry.cloudeventTypes.map(t => `\`${t}\``).join('<br/>');
-    return `|${PRODUCT}|${SCHEMAS}|<br>Data Type:<br>${DATA_TYPE}<br>CloudEvent Type(s):<br>${CLOUDEVENT_TYPE}|`;
-  };
-  const replacementTable =
-    `|Product|Schemas|Types|
-|-|-|-|
-${CATALOG.schemas.map(replacementTableRow).join('\n')}`;
-
-  // Update README
-  const README_PATH = `${__dirname}/../../README.md`;
-  const readmeContents = fs.readFileSync(README_PATH).toString();
-  const updatedReadmeContents = getGeneratedStringWithReplacement(readmeContents, replacementTable);
-
-  // Save updated README
-  fs.writeFileSync(README_PATH, updatedReadmeContents);
-  console.log('- Updated README.');
-})();
+genAuditCatalog();
+genCloudEventCatalog();

tools/readme-catalog/package.json

@@ -3,6 +3,7 @@
   "scripts": {
     "start": "node ."
   },
+  "type": "module",
   "dependencies": {
   }
 }