diff --git a/docs/pages/reference/audit-events.mdx b/docs/pages/reference/audit-events.mdx index e1c97b4b6fe..d5a5fd572f9 100644 --- a/docs/pages/reference/audit-events.mdx +++ b/docs/pages/reference/audit-events.mdx @@ -3,7 +3,7 @@ title: "Audit Event Reference" description: "Provides a comprehensive list of Teleport audit events and their fields." --- {/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} +{/* To regenerate, run `make audit-event-reference` */} {/*cSpell:disable*/} @@ -7452,7 +7452,7 @@ Example: "code": "T1014W", "cluster_name": "root.cluster", "event": "user.login", - "method": "headdless", + "method": "headless", "ei": 0, "success": false, "time": "2019-04-22T00:49:03Z", diff --git a/web/packages/teleport/src/Audit/fixtures/index.ts b/web/packages/teleport/src/Audit/fixtures/index.ts index 18fc6aecbc7..0b97bfb5932 100644 --- a/web/packages/teleport/src/Audit/fixtures/index.ts +++ b/web/packages/teleport/src/Audit/fixtures/index.ts @@ -2800,7 +2800,7 @@ export const events = [ code: 'T1014W', cluster_name: 'root.cluster', event: 'user.login', - method: 'headdless', + method: 'headless', ei: 0, success: false, time: '2019-04-22T00:49:03Z', diff --git a/web/packages/teleport/src/services/audit/gen-event-reference/__snapshots__/gen-event-reference.test.ts.snap b/web/packages/teleport/src/services/audit/gen-event-reference/__snapshots__/gen-event-reference.test.ts.snap new file mode 100644 index 00000000000..673eac94296 --- /dev/null +++ b/web/packages/teleport/src/services/audit/gen-event-reference/__snapshots__/gen-event-reference.test.ts.snap @@ -0,0 +1,251 @@ +// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing + +exports[`createReferencePage deduplicates event codes 1`] = ` +"--- +title: \\"Audit Event Reference\\" +description: \\"Provides a comprehensive list of Teleport audit events and their fields.\\" +--- +{/* Generated file. Do not edit. */} +{/* To regenerate, run \`make audit-event-reference\` */} + +This is an intro paragraph. + +## event.a + +Event A + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.a\\", + \\"code\\": \\"ABC123\\" +} +\`\`\` +" +`; + +exports[`createReferencePage displays multiple events with only one raw field 1`] = ` +"--- +title: \\"Audit Event Reference\\" +description: \\"Provides a comprehensive list of Teleport audit events and their fields.\\" +--- +{/* Generated file. Do not edit. */} +{/* To regenerate, run \`make audit-event-reference\` */} + +This is an intro paragraph. + +## access_request.review + +Access Request Reviewed + +Code: \`T5002I\` + +Event: \`access_request.review\` + +## stable_unix_user.create + +Stable UNIX user created + +Code: \`TSUU001I\` + +Event: \`stable_unix_user.create\` +" +`; + +exports[`createReferencePage formats a list of events as expected 1`] = ` +"--- +title: \\"Audit Event Reference\\" +description: \\"Provides a comprehensive list of Teleport audit events and their fields.\\" +--- +{/* Generated file. Do not edit. */} +{/* To regenerate, run \`make audit-event-reference\` */} + +This is an intro paragraph. + +## kube.create + +Kubernetes Created + +Example: + +\`\`\`json +{ + \\"cluster_name\\": \\"root\\", + \\"code\\": \\"T3010I\\", + \\"kube_labels\\": [ + null + ], + \\"ei\\": 0, + \\"event\\": \\"kube.create\\", + \\"expires\\": \\"0001-01-01T00:00:00Z\\", + \\"name\\": \\"kube-local\\", + \\"time\\": \\"2022-09-08T15:42:36.005Z\\", + \\"uid\\": \\"9d37514f-aef5-426f-9fda-31fd35d070f5\\", + \\"user\\": \\"05ff66c9-a948-42f4-af0e-a1b6ba62561e.root\\" +} +\`\`\` + +## kube.update + +Kubernetes Updated + +Example: + +\`\`\`json +{ + \\"cluster_name\\": \\"root\\", + \\"code\\": \\"T3011I\\", + \\"kube_labels\\": [ + null + ], + \\"ei\\": 0, + \\"event\\": \\"kube.update\\", + \\"expires\\": \\"0001-01-01T00:00:00Z\\", + \\"name\\": \\"kube-local\\", + \\"time\\": \\"2022-09-08T15:42:36.005Z\\", + \\"uid\\": \\"fe631a5a-6418-49d6-99e7-5280654663ec\\", + \\"user\\": \\"05ff66c9-a948-42f4-af0e-a1b6ba62561e.root\\" +} +\`\`\` +" +`; + +exports[`createReferencePage includes H3 sections for event codes if there are duplicate types 1`] = ` +"--- +title: \\"Audit Event Reference\\" +description: \\"Provides a comprehensive list of Teleport audit events and their fields.\\" +--- +{/* Generated file. Do not edit. */} +{/* To regenerate, run \`make audit-event-reference\` */} + +This is an intro paragraph. + +## event.a + +There are multiple events with the \`event.a\` type. + +### ABC123 + +Event A + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.a\\", + \\"code\\": \\"ABC123\\" +} +\`\`\` + +### ABC456 + +Event A failed + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.a\\", + \\"code\\": \\"ABC456\\" +} +\`\`\` +" +`; + +exports[`createReferencePage includes H3 sections for event codes with duplicate types and partial fields 1`] = ` +"--- +title: \\"Audit Event Reference\\" +description: \\"Provides a comprehensive list of Teleport audit events and their fields.\\" +--- +{/* Generated file. Do not edit. */} +{/* To regenerate, run \`make audit-event-reference\` */} + +This is an intro paragraph. + +## event.a + +There are multiple events with the \`event.a\` type. + +### ABC123 + +Event A + +Code: \`ABC123\` + +Event: \`event.a\` + +### ABC456 + +Event A failed + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.a\\", + \\"code\\": \\"ABC456\\", + \\"user\\": \\"myuser\\" +} +\`\`\` + +### ABC789 + +Event A starting + +Code: \`ABC789\` + +Event: \`event.a\` +" +`; + +exports[`createReferencePage orders event sections by H2 1`] = ` +"--- +title: \\"Audit Event Reference\\" +description: \\"Provides a comprehensive list of Teleport audit events and their fields.\\" +--- +{/* Generated file. Do not edit. */} +{/* To regenerate, run \`make audit-event-reference\` */} + +This is an intro paragraph. + +## event.a + +Event A + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.a\\", + \\"code\\": \\"ABC123\\" +} +\`\`\` + +## event.b + +Event B + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.b\\", + \\"code\\": \\"DEF123\\" +} +\`\`\` + +## event.c + +Event C + +Example: + +\`\`\`json +{ + \\"event\\": \\"event.c\\", + \\"code\\": \\"GHI123\\" +} +\`\`\` +" +`; diff --git a/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.test.ts b/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.test.ts index b9b394bdb5b..8e5142e2aa4 100644 --- a/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.test.ts +++ b/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.test.ts @@ -251,63 +251,7 @@ describe('createReferencePage', () => { }, ]; - const expected = `--- -title: "Audit Event Reference" -description: "Provides a comprehensive list of Teleport audit events and their fields." ---- -{/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} - -This is an intro paragraph. - -## kube.create - -Kubernetes Created - -Example: - -\`\`\`json -{ - "cluster_name": "root", - "code": "T3010I", - "kube_labels": [ - null - ], - "ei": 0, - "event": "kube.create", - "expires": "0001-01-01T00:00:00Z", - "name": "kube-local", - "time": "2022-09-08T15:42:36.005Z", - "uid": "9d37514f-aef5-426f-9fda-31fd35d070f5", - "user": "05ff66c9-a948-42f4-af0e-a1b6ba62561e.root" -} -\`\`\` - -## kube.update - -Kubernetes Updated - -Example: - -\`\`\`json -{ - "cluster_name": "root", - "code": "T3011I", - "kube_labels": [ - null - ], - "ei": 0, - "event": "kube.update", - "expires": "0001-01-01T00:00:00Z", - "name": "kube-local", - "time": "2022-09-08T15:42:36.005Z", - "uid": "fe631a5a-6418-49d6-99e7-5280654663ec", - "user": "05ff66c9-a948-42f4-af0e-a1b6ba62561e.root" -} -\`\`\` -`; - const actual = createReferencePage(events, introParagraph); - expect(actual).toEqual(expected); + expect(createReferencePage(events, introParagraph)).toMatchSnapshot(); }); test('orders event sections by H2', () => { @@ -350,56 +294,7 @@ Example: }, ]; - const expected = `--- -title: "Audit Event Reference" -description: "Provides a comprehensive list of Teleport audit events and their fields." ---- -{/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} - -This is an intro paragraph. - -## event.a - -Event A - -Example: - -\`\`\`json -{ - "event": "event.a", - "code": "ABC123" -} -\`\`\` - -## event.b - -Event B - -Example: - -\`\`\`json -{ - "event": "event.b", - "code": "DEF123" -} -\`\`\` - -## event.c - -Event C - -Example: - -\`\`\`json -{ - "event": "event.c", - "code": "GHI123" -} -\`\`\` -`; - const actual = createReferencePage(events, introParagraph); - expect(actual).toEqual(expected); + expect(createReferencePage(events, introParagraph)).toMatchSnapshot(); }); test('includes H3 sections for event codes if there are duplicate types', () => { @@ -422,47 +317,7 @@ Example: }, ]; - const expected = `--- -title: "Audit Event Reference" -description: "Provides a comprehensive list of Teleport audit events and their fields." ---- -{/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} - -This is an intro paragraph. - -## event.a - -There are multiple events with the \`event.a\` type. - -### ABC123 - -Event A - -Example: - -\`\`\`json -{ - "event": "event.a", - "code": "ABC123" -} -\`\`\` - -### ABC456 - -Event A failed - -Example: - -\`\`\`json -{ - "event": "event.a", - "code": "ABC456" -} -\`\`\` -`; - const actual = createReferencePage(events, introParagraph); - expect(actual).toEqual(expected); + expect(createReferencePage(events, introParagraph)).toMatchSnapshot(); }); test('deduplicates event codes', () => { @@ -485,30 +340,7 @@ Example: }, ]; - const expected = `--- -title: "Audit Event Reference" -description: "Provides a comprehensive list of Teleport audit events and their fields." ---- -{/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} - -This is an intro paragraph. - -## event.a - -Event A - -Example: - -\`\`\`json -{ - "event": "event.a", - "code": "ABC123" -} -\`\`\` -`; - const actual = createReferencePage(events, introParagraph); - expect(actual).toEqual(expected); + expect(createReferencePage(events, introParagraph)).toMatchSnapshot(); }); test('displays multiple events with only one raw field', () => { @@ -533,33 +365,7 @@ Example: }, ]; - const expected = `--- -title: "Audit Event Reference" -description: "Provides a comprehensive list of Teleport audit events and their fields." ---- -{/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} - -This is an intro paragraph. - -## access_request.review - -Access Request Reviewed - -Code: \`T5002I\` - -Event: \`access_request.review\` - -## stable_unix_user.create - -Stable UNIX user created - -Code: \`TSUU001I\` - -Event: \`stable_unix_user.create\` -`; - const actual = createReferencePage(events, introParagraph); - expect(actual).toEqual(expected); + expect(createReferencePage(events, introParagraph)).toMatchSnapshot(); }); test('includes H3 sections for event codes with duplicate types and partial fields', () => { @@ -601,50 +407,6 @@ Event: \`stable_unix_user.create\` }, ]; - const expected = `--- -title: "Audit Event Reference" -description: "Provides a comprehensive list of Teleport audit events and their fields." ---- -{/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} - -This is an intro paragraph. - -## event.a - -There are multiple events with the \`event.a\` type. - -### ABC123 - -Event A - -Code: \`ABC123\` - -Event: \`event.a\` - -### ABC456 - -Event A failed - -Example: - -\`\`\`json -{ - "event": "event.a", - "code": "ABC456", - "user": "myuser" -} -\`\`\` - -### ABC789 - -Event A starting - -Code: \`ABC789\` - -Event: \`event.a\` -`; - const actual = createReferencePage(events, introParagraph); - expect(actual).toEqual(expected); + expect(createReferencePage(events, introParagraph)).toMatchSnapshot(); }); }); diff --git a/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.ts b/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.ts index ab9ce4ffccb..cc6d1eecd18 100644 --- a/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.ts +++ b/web/packages/teleport/src/services/audit/gen-event-reference/gen-event-reference.ts @@ -176,7 +176,7 @@ title: "Audit Event Reference" description: "Provides a comprehensive list of Teleport audit events and their fields." --- {/* Generated file. Do not edit. */} -{/* To regenerate, navigate to docs/gen-event-reference and run pnpm gen-docs */} +{/* To regenerate, run \`make audit-event-reference\` */} ${introParagraph} `