Add path constants on alerting plugin side, use them in tests

elastic · Apr 24, 2023 · fdd93c8 · fdd93c8
1 parent 32089fe
commit fdd93c8
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 20 deletions.
diff --git a/x-pack/plugins/alerting/common/index.ts b/x-pack/plugins/alerting/common/index.ts
@@ -58,8 +58,12 @@ export const LEGACY_BASE_ALERT_API_PATH = '/api/alerts';
 export const BASE_ALERTING_API_PATH = '/api/alerting';
 export const INTERNAL_BASE_ALERTING_API_PATH = '/internal/alerting';
 export const INTERNAL_ALERTING_API_FIND_RULES_PATH = `${INTERNAL_BASE_ALERTING_API_PATH}/rules/_find`;
+
+export const INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH =
+  `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window` as const;
 export const INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH =
-  `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/_active` as const;
+  `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/_active` as const;
+
 export const ALERTS_FEATURE_ID = 'alerts';
 export const MONITORING_HISTORY_LIMIT = 200;
 export const ENABLE_MAINTENANCE_WINDOWS = false;
diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/active_maintenance_windows.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/active_maintenance_windows.ts
@@ -8,7 +8,10 @@
 import { IRouter } from '@kbn/core/server';
 import { ILicenseState } from '../../lib';
 import { verifyAccessAndContext, rewriteMaintenanceWindowRes } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH,
+} from '../../types';
 import { MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 export const activeMaintenanceWindowsRoute = (
@@ -17,7 +20,7 @@ export const activeMaintenanceWindowsRoute = (
 ) => {
   router.get(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/_active`,
+      path: INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH,
       validate: {},
       options: {
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW}`],

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/archive_maintenance_window.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/archive_maintenance_window.ts
@@ -9,7 +9,10 @@ import { IRouter } from '@kbn/core/server';
 import { schema } from '@kbn/config-schema';
 import { ILicenseState } from '../../lib';
 import { verifyAccessAndContext, rewritePartialMaintenanceBodyRes } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 const paramSchema = schema.object({
@@ -26,7 +29,7 @@ export const archiveMaintenanceWindowRoute = (
 ) => {
   router.post(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/{id}/_archive`,
+      path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/{id}/_archive`,
       validate: {
         params: paramSchema,
         body: bodySchema,

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/create_maintenance_window.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/create_maintenance_window.ts
@@ -14,7 +14,10 @@ import {
   RewriteRequestCase,
   rewriteMaintenanceWindowRes,
 } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MaintenanceWindowCreateBody, MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 const bodySchema = schema.object({
@@ -37,7 +40,7 @@ export const createMaintenanceWindowRoute = (
 ) => {
   router.post(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window`,
+      path: INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
       validate: {
         body: bodySchema,
       },

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/delete_maintenance_window.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/delete_maintenance_window.ts
@@ -9,7 +9,10 @@ import { IRouter } from '@kbn/core/server';
 import { schema } from '@kbn/config-schema';
 import { ILicenseState } from '../../lib';
 import { verifyAccessAndContext } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 const paramSchema = schema.object({
@@ -22,7 +25,7 @@ export const deleteMaintenanceWindowRoute = (
 ) => {
   router.delete(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/{id}`,
+      path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/{id}`,
       validate: {
         params: paramSchema,
       },

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/find_maintenance_windows.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/find_maintenance_windows.ts
@@ -8,7 +8,10 @@
 import { IRouter } from '@kbn/core/server';
 import { ILicenseState } from '../../lib';
 import { verifyAccessAndContext, rewriteMaintenanceWindowRes } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 export const findMaintenanceWindowsRoute = (
@@ -17,7 +20,7 @@ export const findMaintenanceWindowsRoute = (
 ) => {
   router.get(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/_find`,
+      path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/_find`,
       validate: {},
       options: {
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW}`],

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/finish_maintenance_window.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/finish_maintenance_window.ts
@@ -9,7 +9,10 @@ import { IRouter } from '@kbn/core/server';
 import { schema } from '@kbn/config-schema';
 import { ILicenseState } from '../../lib';
 import { verifyAccessAndContext, rewritePartialMaintenanceBodyRes } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 const paramSchema = schema.object({
@@ -22,7 +25,7 @@ export const finishMaintenanceWindowRoute = (
 ) => {
   router.post(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/{id}/_finish`,
+      path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/{id}/_finish`,
       validate: {
         params: paramSchema,
       },

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/get_maintenance_window.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/get_maintenance_window.ts
@@ -9,7 +9,10 @@ import { IRouter } from '@kbn/core/server';
 import { schema } from '@kbn/config-schema';
 import { ILicenseState } from '../../lib';
 import { verifyAccessAndContext, rewriteMaintenanceWindowRes } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 const paramSchema = schema.object({
@@ -22,7 +25,7 @@ export const getMaintenanceWindowRoute = (
 ) => {
   router.get(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/{id}`,
+      path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/{id}`,
       validate: {
         params: paramSchema,
       },

diff --git a/x-pack/plugins/alerting/server/routes/maintenance_window/update_maintenance_window.ts b/x-pack/plugins/alerting/server/routes/maintenance_window/update_maintenance_window.ts
@@ -14,7 +14,10 @@ import {
   RewriteRequestCase,
   rewritePartialMaintenanceBodyRes,
 } from '../lib';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../../types';
+import {
+  AlertingRequestHandlerContext,
+  INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
+} from '../../types';
 import { MaintenanceWindowSOProperties, MAINTENANCE_WINDOW_API_PRIVILEGES } from '../../../common';
 
 const paramSchema = schema.object({
@@ -49,7 +52,7 @@ export const updateMaintenanceWindowRoute = (
 ) => {
   router.post(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/{id}`,
+      path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/{id}`,
       validate: {
         body: bodySchema,
         params: paramSchema,

diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { INTERNAL_BASE_ALERTING_API_PATH } from '@kbn/alerting-plugin/common';
+import { INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH } from '@kbn/alerting-plugin/common';
 import type { MaintenanceWindowCreateBody } from '@kbn/alerting-plugin/common';
 import type { AsApiContract } from '@kbn/alerting-plugin/server/routes/lib';
 import { cleanKibana } from '../../tasks/common';
@@ -33,7 +33,7 @@ describe('Maintenance window callout on Rule Management page', () => {
     // Create a test maintenance window
     cy.request({
       method: 'POST',
-      url: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window`,
+      url: INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH,
       headers: { 'kbn-xsrf': 'cypress-creds' },
       body,
     }).then((response) => {
@@ -45,7 +45,7 @@ describe('Maintenance window callout on Rule Management page', () => {
     // Delete a test maintenance window
     cy.request({
       method: 'DELETE',
-      url: `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window/${maintenanceWindowId}`,
+      url: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/${maintenanceWindowId}`,
       headers: { 'kbn-xsrf': 'cypress-creds' },
     });
   });