[Enterprise Search] Refactor MockRouter test helper to not store payl…

…oad (#90206) (#90322) * Update MockRouter to not pass/set a this.payload - but instead intelligently validate payloads based on the request keys * Fix relevance tuning API routes to not need a separate mock router for validating query & body * Update all remaining tests to no longer pass a payload param to MockRouter
elastic · Feb 4, 2021 · da7c3b4 · da7c3b4
1 parent 4e94a58
commit da7c3b4
Show file tree

Hide file tree

Showing 13 changed files with 9 additions and 63 deletions.
diff --git a/x-pack/plugins/enterprise_search/server/__mocks__/router.mock.ts b/x-pack/plugins/enterprise_search/server/__mocks__/router.mock.ts
@@ -23,7 +23,6 @@ type PayloadType = 'params' | 'query' | 'body';
 interface IMockRouter {
   method: MethodType;
   path: string;
-  payload?: PayloadType;
 }
 interface IMockRouterRequest {
   body?: object;
@@ -39,11 +38,10 @@ export class MockRouter {
   public payload?: PayloadType;
   public response = httpServerMock.createResponseFactory();
 
-  constructor({ method, path, payload }: IMockRouter) {
+  constructor({ method, path }: IMockRouter) {
     this.createRouter();
     this.method = method;
     this.path = path;
-    this.payload = payload;
   }
 
   public createRouter = () => {
@@ -62,16 +60,17 @@ export class MockRouter {
    */
 
   public validateRoute = (request: MockRouterRequest) => {
-    if (!this.payload) throw new Error('Cannot validate wihout a payload type specified.');
-
     const route = this.findRouteRegistration();
     const [config] = route;
     const validate = config.validate as RouteValidatorConfig<{}, {}, {}>;
+    const payloads = Object.keys(request) as PayloadType[];
 
-    const payloadValidation = validate[this.payload] as { validate(request: KibanaRequest): void };
-    const payloadRequest = request[this.payload] as KibanaRequest;
+    payloads.forEach((payload: PayloadType) => {
+      const payloadValidation = validate[payload] as { validate(request: KibanaRequest): void };
+      const payloadRequest = request[payload] as KibanaRequest;
 
-    payloadValidation.validate(payloadRequest);
+      payloadValidation.validate(payloadRequest);
+    });
   };
 
   public shouldValidate = (request: MockRouterRequest) => {
@@ -99,7 +98,6 @@ export class MockRouter {
 // const mockRouter = new MockRouter({
 //   method: 'get',
 //   path: '/api/app_search/test',
-//   payload: 'body'
 // });
 //
 // beforeEach(() => {

diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/analytics.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/analytics.test.ts
@@ -18,7 +18,6 @@ describe('analytics routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/app_search/engines/{engineName}/analytics/queries',
-        payload: 'query',
       });
 
       registerAnalyticsRoutes({
@@ -71,7 +70,6 @@ describe('analytics routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/app_search/engines/{engineName}/analytics/queries/{query}',
-        payload: 'query',
       });
 
       registerAnalyticsRoutes({

diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/credentials.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/credentials.test.ts
@@ -18,7 +18,6 @@ describe('credentials routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/app_search/credentials',
-        payload: 'query',
       });
 
       registerCredentialsRoutes({
@@ -54,7 +53,6 @@ describe('credentials routes', () => {
       mockRouter = new MockRouter({
         method: 'post',
         path: '/api/app_search/credentials',
-        payload: 'body',
       });
 
       registerCredentialsRoutes({
@@ -167,7 +165,6 @@ describe('credentials routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/app_search/credentials/details',
-        payload: 'query',
       });
 
       registerCredentialsRoutes({
@@ -191,7 +188,6 @@ describe('credentials routes', () => {
       mockRouter = new MockRouter({
         method: 'put',
         path: '/api/app_search/credentials/{name}',
-        payload: 'body',
       });
 
       registerCredentialsRoutes({

diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/documents.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/documents.test.ts
@@ -18,7 +18,6 @@ describe('documents routes', () => {
       mockRouter = new MockRouter({
         method: 'post',
         path: '/api/app_search/engines/{engineName}/documents',
-        payload: 'body',
       });
 
       registerDocumentsRoutes({

diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/engines.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/engines.test.ts
@@ -29,7 +29,6 @@ describe('engine routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/app_search/engines',
-        payload: 'query',
       });
 
       registerEnginesRoutes({

diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/search_settings.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/search_settings.test.ts
@@ -87,7 +87,6 @@ describe('search settings routes', () => {
     const mockRouter = new MockRouter({
       method: 'put',
       path: '/api/app_search/engines/{engineName}/search_settings',
-      payload: 'body',
     });
 
     beforeEach(() => {
@@ -149,7 +148,6 @@ describe('search settings routes', () => {
     const mockRouter = new MockRouter({
       method: 'post',
       path: '/api/app_search/engines/{engineName}/search_settings_search',
-      payload: 'body',
     });
 
     beforeEach(() => {
@@ -188,29 +186,18 @@ describe('search settings routes', () => {
     });
 
     describe('validates query', () => {
-      const queryRouter = new MockRouter({
-        method: 'post',
-        path: '/api/app_search/engines/{engineName}/search_settings_search',
-        payload: 'query',
-      });
-
       it('correctly', () => {
-        registerSearchSettingsRoutes({
-          ...mockDependencies,
-          router: queryRouter.router,
-        });
-
         const request = {
           query: {
             query: 'foo',
           },
         };
-        queryRouter.shouldValidate(request);
+        mockRouter.shouldValidate(request);
       });
 
       it('missing required fields', () => {
         const request = { query: {} };
-        queryRouter.shouldThrow(request);
+        mockRouter.shouldThrow(request);
       });
     });
   });

diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/settings.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/settings.test.ts
@@ -41,7 +41,6 @@ describe('log settings routes', () => {
       mockRouter = new MockRouter({
         method: 'put',
         path: '/api/app_search/log_settings',
-        payload: 'body',
       });
 
       registerSettingsRoutes({

diff --git a/x-pack/plugins/enterprise_search/server/routes/enterprise_search/telemetry.test.ts b/x-pack/plugins/enterprise_search/server/routes/enterprise_search/telemetry.test.ts
@@ -29,7 +29,6 @@ describe('Enterprise Search Telemetry API', () => {
     mockRouter = new MockRouter({
       method: 'put',
       path: '/api/enterprise_search/stats',
-      payload: 'body',
     });
 
     registerTelemetryRoute({

diff --git a/x-pack/plugins/enterprise_search/server/routes/workplace_search/groups.test.ts b/x-pack/plugins/enterprise_search/server/routes/workplace_search/groups.test.ts
@@ -26,7 +26,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/workplace_search/groups',
-        payload: 'query',
       });
 
       registerGroupsRoute({
@@ -50,7 +49,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'post',
         path: '/api/workplace_search/groups',
-        payload: 'body',
       });
 
       registerGroupsRoute({
@@ -85,7 +83,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'post',
         path: '/api/workplace_search/groups/search',
-        payload: 'body',
       });
 
       registerSearchGroupsRoute({
@@ -163,7 +160,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'put',
         path: '/api/workplace_search/groups/{id}',
-        payload: 'body',
       });
 
       registerGroupRoute({
@@ -246,7 +242,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'post',
         path: '/api/workplace_search/groups/{id}/share',
-        payload: 'body',
       });
 
       registerShareGroupRoute({
@@ -282,7 +277,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'post',
         path: '/api/workplace_search/groups/{id}/assign',
-        payload: 'body',
       });
 
       registerAssignGroupRoute({
@@ -318,7 +312,6 @@ describe('groups routes', () => {
       mockRouter = new MockRouter({
         method: 'put',
         path: '/api/workplace_search/groups/{id}/boosts',
-        payload: 'body',
       });
 
       registerBoostsGroupRoute({

diff --git a/x-pack/plugins/enterprise_search/server/routes/workplace_search/overview.test.ts b/x-pack/plugins/enterprise_search/server/routes/workplace_search/overview.test.ts
@@ -18,7 +18,6 @@ describe('Overview route', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/workplace_search/overview',
-        payload: 'query',
       });
 
       registerOverviewRoute({

diff --git a/x-pack/plugins/enterprise_search/server/routes/workplace_search/security.test.ts b/x-pack/plugins/enterprise_search/server/routes/workplace_search/security.test.ts
@@ -45,7 +45,6 @@ describe('security routes', () => {
       mockRouter = new MockRouter({
         method: 'get',
         path: '/api/workplace_search/org/security/source_restrictions',
-        payload: 'body',
       });
 
       registerSecuritySourceRestrictionsRoute({
@@ -72,7 +71,6 @@ describe('security routes', () => {
       mockRouter = new MockRouter({
         method: 'patch',
         path: '/api/workplace_search/org/security/source_restrictions',
-        payload: 'body',
       });
 
       registerSecuritySourceRestrictionsRoute({

diff --git a/x-pack/plugins/enterprise_search/server/routes/workplace_search/settings.test.ts b/x-pack/plugins/enterprise_search/server/routes/workplace_search/settings.test.ts
@@ -45,7 +45,6 @@ describe('settings routes', () => {
       mockRouter = new MockRouter({
         method: 'put',
         path: '/api/workplace_search/org/settings/customize',
-        payload: 'body',
       });
 
       registerOrgSettingsCustomizeRoute({
@@ -76,7 +75,6 @@ describe('settings routes', () => {
       mockRouter = new MockRouter({
         method: 'put',
         path: '/api/workplace_search/org/settings/oauth_application',
-        payload: 'body',
       });
 
       registerOrgSettingsOauthApplicationRoute({