check suffix only in tests

elastic · Nov 27, 2024 · 2ea6b1c · 2ea6b1c
1 parent 1a44804
commit 2ea6b1c
Show file tree

Hide file tree

Showing 16 changed files with 128 additions and 48 deletions.
diff --git a/x-pack/plugins/alerting/server/routes/legacy/create.test.ts b/x-pack/plugins/alerting/server/routes/legacy/create.test.ts
@@ -597,16 +597,21 @@ describe('createAlertRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{id?}",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/delete.test.ts b/x-pack/plugins/alerting/server/routes/legacy/delete.test.ts
@@ -152,16 +152,21 @@ describe('deleteAlertRoute', () => {
 
     const [config] = router.delete.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "DELETE",
           "newApiPath": "/api/alerting/rule/{id}",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/disable.test.ts b/x-pack/plugins/alerting/server/routes/legacy/disable.test.ts
@@ -123,16 +123,21 @@ describe('disableAlertRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{id}/_disable",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/enable.test.ts b/x-pack/plugins/alerting/server/routes/legacy/enable.test.ts
@@ -123,16 +123,21 @@ describe('enableAlertRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{id}/_enable",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/find.test.ts b/x-pack/plugins/alerting/server/routes/legacy/find.test.ts
@@ -419,16 +419,21 @@ describe('findAlertRoute', () => {
 
     const [config] = router.get.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "GET",
           "newApiPath": "/api/alerting/rules/_find",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/get.test.ts b/x-pack/plugins/alerting/server/routes/legacy/get.test.ts
@@ -223,16 +223,21 @@ describe('getAlertRoute', () => {
     getAlertRoute(router, licenseState, docLinks);
     const [config] = router.get.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "GET",
           "newApiPath": "/api/alerting/rule/{id}",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/get_alert_instance_summary.test.ts b/x-pack/plugins/alerting/server/routes/legacy/get_alert_instance_summary.test.ts
@@ -159,14 +159,19 @@ describe('getAlertInstanceSummaryRoute', () => {
 
     const [config] = router.get.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "type": "remove",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/get_alert_state.test.ts b/x-pack/plugins/alerting/server/routes/legacy/get_alert_state.test.ts
@@ -194,14 +194,19 @@ describe('getAlertStateRoute', () => {
 
     const [config] = router.get.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "type": "remove",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/health.test.ts b/x-pack/plugins/alerting/server/routes/legacy/health.test.ts
@@ -453,16 +453,21 @@ describe('healthRoute', () => {
 
     const [config] = router.get.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "GET",
           "newApiPath": "/api/alerting/rule/_health",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/list_alert_types.test.ts b/x-pack/plugins/alerting/server/routes/legacy/list_alert_types.test.ts
@@ -266,16 +266,21 @@ describe('listAlertTypesRoute', () => {
 
     const [config] = router.get.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "GET",
           "newApiPath": "/api/alerting/rule_types",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/mute_all.test.ts b/x-pack/plugins/alerting/server/routes/legacy/mute_all.test.ts
@@ -123,16 +123,21 @@ describe('muteAllAlertRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{id}/_mute_all",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/mute_instance.test.ts b/x-pack/plugins/alerting/server/routes/legacy/mute_instance.test.ts
@@ -131,16 +131,21 @@ describe('muteAlertInstanceRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/unmute_all.test.ts b/x-pack/plugins/alerting/server/routes/legacy/unmute_all.test.ts
@@ -123,16 +123,21 @@ describe('unmuteAllAlertRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{id}/_unmute_all",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/unmute_instance.test.ts b/x-pack/plugins/alerting/server/routes/legacy/unmute_instance.test.ts
@@ -131,16 +131,21 @@ describe('unmuteAlertInstanceRoute', () => {
 
     const [config] = router.post.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/update.test.ts b/x-pack/plugins/alerting/server/routes/legacy/update.test.ts
@@ -370,16 +370,21 @@ describe('updateAlertRoute', () => {
 
     const [config] = router.put.mock.calls[0];
 
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "PUT",
           "newApiPath": "/api/alerting/rule/rule/{id}",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });
diff --git a/x-pack/plugins/alerting/server/routes/legacy/update_api_key.test.ts b/x-pack/plugins/alerting/server/routes/legacy/update_api_key.test.ts
@@ -124,16 +124,21 @@ describe('updateApiKeyRoute', () => {
     updateApiKeyRoute(router, licenseState, docLinks);
 
     const [config] = router.post.mock.calls[0];
-    expect(config.options?.deprecated).toMatchInlineSnapshot(`
+    expect(config.options?.deprecated).toMatchInlineSnapshot(
+      {
+        documentationUrl: expect.stringMatching(/#breaking-201550$/),
+      },
+      `
       Object {
-        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201550",
+        "documentationUrl": StringMatching /#breaking-201550\\$/,
         "reason": Object {
           "newApiMethod": "POST",
           "newApiPath": "/api/alerting/rule/{id}/_update_api_key",
           "type": "migrate",
         },
         "severity": "warning",
       }
-    `);
+    `
+    );
   });
 });