Move Kea & logic mocks/helpers into kea_logic subfolder

- for organization NOTE: It can't be a plain kea/ folder because then Jest automatically mocks the `kea` module itself kea 🤦
elastic · Jun 1, 2021 · df7177b · df7177b
1 parent ce903b8
commit df7177b
Show file tree

Hide file tree

Showing 252 changed files with 418 additions and 336 deletions.
diff --git a/...ns/__mocks__/flash_messages_logic.mock.ts → ...__/kea_logic/flash_messages_logic.mock.ts b/...ns/__mocks__/flash_messages_logic.mock.ts → ...__/kea_logic/flash_messages_logic.mock.ts
@@ -28,8 +28,8 @@ export const mockFlashMessageHelpers = {
   flashErrorToast: jest.fn(),
 };
 
-jest.mock('../shared/flash_messages', () => ({
-  ...(jest.requireActual('../shared/flash_messages') as object),
+jest.mock('../../shared/flash_messages', () => ({
+  ...(jest.requireActual('../../shared/flash_messages') as object),
   ...mockFlashMessageHelpers,
   FlashMessagesLogic: {
     values: mockFlashMessagesValues,

diff --git a/x-pack/plugins/enterprise_search/public/applications/__mocks__/kea_logic/hooks.mock.ts b/x-pack/plugins/enterprise_search/public/applications/__mocks__/kea_logic/hooks.mock.ts
@@ -0,0 +1,65 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+/**
+ * Combine all shared mock values/actions into a single obj
+ *
+ * NOTE: These variable names MUST start with 'mock*' in order for
+ * Jest to accept its use within a jest.mock()
+ */
+import { mockFlashMessagesValues, mockFlashMessagesActions } from './flash_messages_logic.mock';
+import { mockHttpValues } from './http_logic.mock';
+import { mockKibanaValues } from './kibana_logic.mock';
+import { mockLicensingValues } from './licensing_logic.mock';
+import { mockTelemetryActions } from './telemetry_logic.mock';
+
+export const mockAllValues = {
+  ...mockKibanaValues,
+  ...mockLicensingValues,
+  ...mockHttpValues,
+  ...mockFlashMessagesValues,
+};
+export const mockAllActions = {
+  ...mockTelemetryActions,
+  ...mockFlashMessagesActions,
+};
+
+/**
+ * Import this file directly to mock useValues with a set of default values for all shared logic files.
+ * Example usage:
+ *
+ * import '../../../__mocks__/kea_logic'; // Must come before kea's import, adjust relative path as needed
+ */
+jest.mock('kea', () => ({
+  ...(jest.requireActual('kea') as object),
+  useValues: jest.fn(() => ({ ...mockAllValues })),
+  useActions: jest.fn(() => ({ ...mockAllActions })),
+}));
+
+/**
+ * React component helpers
+ *
+ * Call this function to override a specific set of Kea values while retaining all other defaults
+ *
+ * Example usage:
+ *
+ * import { setMockValues } from '../../../__mocks__/kea_logic';
+ * import { SomeComponent } from './';
+ *
+ * it('some test', () => {
+ *   setMockValues({ someValue: 'hello' });
+ *   shallow(<SomeComponent />);
+ * });
+ */
+import { useValues, useActions } from 'kea';
+
+export const setMockValues = (values: object) => {
+  (useValues as jest.Mock).mockImplementation(() => ({ ...mockAllValues, ...values }));
+};
+export const setMockActions = (actions: object) => {
+  (useActions as jest.Mock).mockImplementation(() => ({ ...mockAllActions, ...actions }));
+};
diff --git a/...applications/__mocks__/http_logic.mock.ts → ...ns/__mocks__/kea_logic/http_logic.mock.ts b/...applications/__mocks__/http_logic.mock.ts → ...ns/__mocks__/kea_logic/http_logic.mock.ts
@@ -13,6 +13,6 @@ export const mockHttpValues = {
   readOnlyMode: false,
 };
 
-jest.mock('../shared/http', () => ({
+jest.mock('../../shared/http', () => ({
   HttpLogic: { values: mockHttpValues },
 }));
diff --git a/...ch/public/applications/__mocks__/index.ts → ...applications/__mocks__/kea_logic/index.ts b/...ch/public/applications/__mocks__/index.ts → ...applications/__mocks__/kea_logic/index.ts
@@ -14,12 +14,6 @@ export {
   mockFlashMessagesActions,
   mockFlashMessageHelpers,
 } from './flash_messages_logic.mock';
-export {
-  mockAllValues,
-  mockAllActions,
-  setMockValues,
-  setMockActions,
-  LogicMounter,
-} from './kea.mock';
+export { mockAllValues, mockAllActions, setMockValues, setMockActions } from './hooks.mock';
 
-// Note: shallow_useeffect must be imported directly as a file
+export { LogicMounter } from './logic_mounter';
diff --git a/...plications/__mocks__/kibana_logic.mock.ts → .../__mocks__/kea_logic/kibana_logic.mock.ts b/...plications/__mocks__/kibana_logic.mock.ts → .../__mocks__/kea_logic/kibana_logic.mock.ts
@@ -5,9 +5,9 @@
  * 2.0.
  */
 
-import { chartPluginMock } from '../../../../../../src/plugins/charts/public/mocks';
+import { chartPluginMock } from '../../../../../../../src/plugins/charts/public/mocks';
 
-import { mockHistory } from './react_router/state.mock';
+import { mockHistory } from '../react_router/state.mock';
 
 export const mockKibanaValues = {
   config: { host: 'http://localhost:3002' },
@@ -24,6 +24,6 @@ export const mockKibanaValues = {
   renderHeaderActions: jest.fn(),
 };
 
-jest.mock('../shared/kibana', () => ({
+jest.mock('../../shared/kibana', () => ({
   KibanaLogic: { values: mockKibanaValues },
 }));
diff --git a/...cations/__mocks__/licensing_logic.mock.ts → ...mocks__/kea_logic/licensing_logic.mock.ts b/...cations/__mocks__/licensing_logic.mock.ts → ...mocks__/kea_logic/licensing_logic.mock.ts
@@ -5,14 +5,14 @@
  * 2.0.
  */
 
-import { licensingMock } from '../../../../licensing/public/mocks';
+import { licensingMock } from '../../../../../licensing/public/mocks';
 
 export const mockLicensingValues = {
   license: licensingMock.createLicense(),
   hasPlatinumLicense: false,
   hasGoldLicense: false,
 };
 
-jest.mock('../shared/licensing', () => ({
+jest.mock('../../shared/licensing', () => ({
   LicensingLogic: { values: mockLicensingValues },
 }));
diff --git a/...public/applications/__mocks__/kea.mock.ts → ...ions/__mocks__/kea_logic/logic_mounter.ts b/...public/applications/__mocks__/kea.mock.ts → ...ions/__mocks__/kea_logic/logic_mounter.ts
@@ -6,75 +6,14 @@
  */
 
 /**
- * Combine all shared mock values/actions into a single obj
- *
- * NOTE: These variable names MUST start with 'mock*' in order for
- * Jest to accept its use within a jest.mock()
- */
-import { mockFlashMessagesValues, mockFlashMessagesActions } from './flash_messages_logic.mock';
-import { mockHttpValues } from './http_logic.mock';
-import { mockKibanaValues } from './kibana_logic.mock';
-import { mockLicensingValues } from './licensing_logic.mock';
-import { mockTelemetryActions } from './telemetry_logic.mock';
-
-export const mockAllValues = {
-  ...mockKibanaValues,
-  ...mockLicensingValues,
-  ...mockHttpValues,
-  ...mockFlashMessagesValues,
-};
-export const mockAllActions = {
-  ...mockTelemetryActions,
-  ...mockFlashMessagesActions,
-};
-
-/**
- * Import this file directly to mock useValues with a set of default values for all shared logic files.
- * Example usage:
- *
- * import '../../../__mocks__/kea'; // Must come before kea's import, adjust relative path as needed
- */
-jest.mock('kea', () => ({
-  ...(jest.requireActual('kea') as object),
-  useValues: jest.fn(() => ({ ...mockAllValues })),
-  useActions: jest.fn(() => ({ ...mockAllActions })),
-}));
-
-/**
- * React component helpers
- *
- * Call this function to override a specific set of Kea values while retaining all other defaults
- *
- * Example usage:
- *
- * import { setMockValues } from '../../../__mocks__/kea.mock';
- * import { SomeComponent } from './';
- *
- * it('some test', () => {
- *   setMockValues({ someValue: 'hello' });
- *   shallow(<SomeComponent />);
- * });
- */
-import { useValues, useActions } from 'kea';
-
-export const setMockValues = (values: object) => {
-  (useValues as jest.Mock).mockImplementation(() => ({ ...mockAllValues, ...values }));
-};
-export const setMockActions = (actions: object) => {
-  (useActions as jest.Mock).mockImplementation(() => ({ ...mockAllActions, ...actions }));
-};
-
-/**
- * Kea logic helpers
- *
  * Call this function to mount a logic file and optionally override default values.
  * Automatically DRYs out a lot of cruft for us, such as resetting context, creating the
  * nested defaults path obj (see https://kea.js.org/docs/api/context#resetcontext), and
  * returning an unmount function
  *
  * Example usage:
  *
- * import { LogicMounter } from '../../../__mocks__/kea.mock';
+ * import { LogicMounter } from '../../../__mocks__/kea_logic';
  * import { SomeLogic } from './';
  *
  * const { mount, unmount } = new LogicMounter(SomeLogic);
@@ -86,7 +25,7 @@ export const setMockActions = (actions: object) => {
  */
 import { resetContext, LogicWrapper } from 'kea';
 
-type LogicFile = LogicWrapper<any>;
+type LogicFile = LogicWrapper<unknown>;
 
 export class LogicMounter {
   private logicFile: LogicFile;

diff --git a/...cations/__mocks__/telemetry_logic.mock.ts → ...mocks__/kea_logic/telemetry_logic.mock.ts b/...cations/__mocks__/telemetry_logic.mock.ts → ...mocks__/kea_logic/telemetry_logic.mock.ts
@@ -12,7 +12,7 @@ export const mockTelemetryActions = {
   sendWorkplaceSearchTelemetry: jest.fn(),
 };
 
-jest.mock('../shared/telemetry', () => ({
-  ...(jest.requireActual('../shared/telemetry') as object),
+jest.mock('../../shared/telemetry', () => ({
+  ...(jest.requireActual('../../shared/telemetry') as object),
   TelemetryLogic: { actions: mockTelemetryActions },
 }));
diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/app_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/app_logic.test.ts
@@ -6,7 +6,7 @@
  */
 
 import { DEFAULT_INITIAL_APP_DATA } from '../../../common/__mocks__';
-import { LogicMounter } from '../__mocks__';
+import { LogicMounter } from '../__mocks__/kea_logic';
 
 import { AppLogic } from './app_logic';
 

diff --git a/...rise_search/public/applications/app_search/components/analytics/analytics_layout.test.tsx b/...rise_search/public/applications/app_search/components/analytics/analytics_layout.test.tsx
@@ -6,7 +6,7 @@
  */
 
 import '../../../__mocks__/shallow_useeffect.mock';
-import { mockKibanaValues, setMockValues, setMockActions } from '../../../__mocks__';
+import { mockKibanaValues, setMockValues, setMockActions } from '../../../__mocks__/kea_logic';
 import { mockUseParams } from '../../../__mocks__/react_router';
 
 import React from 'react';

diff --git a/...rprise_search/public/applications/app_search/components/analytics/analytics_logic.test.ts b/...rprise_search/public/applications/app_search/components/analytics/analytics_logic.test.ts
@@ -10,7 +10,7 @@ import {
   mockKibanaValues,
   mockHttpValues,
   mockFlashMessageHelpers,
-} from '../../../__mocks__';
+} from '../../../__mocks__/kea_logic';
 
 jest.mock('../engine', () => ({
   EngineLogic: { values: { engineName: 'test-engine' } },

diff --git a/...h/public/applications/app_search/components/analytics/components/analytics_chart.test.tsx b/...h/public/applications/app_search/components/analytics/components/analytics_chart.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { mockKibanaValues } from '../../../../__mocks__';
+import { mockKibanaValues } from '../../../../__mocks__/kea_logic';
 
 import React from 'react';
 

diff --git a/.../public/applications/app_search/components/analytics/components/analytics_header.test.tsx b/.../public/applications/app_search/components/analytics/components/analytics_header.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues, mockKibanaValues } from '../../../../__mocks__';
+import { setMockValues, mockKibanaValues } from '../../../../__mocks__/kea_logic';
 
 import React, { ReactElement } from 'react';
 

diff --git a/.../public/applications/app_search/components/analytics/components/analytics_search.test.tsx b/.../public/applications/app_search/components/analytics/components/analytics_search.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { mockKibanaValues } from '../../../../__mocks__';
+import { mockKibanaValues } from '../../../../__mocks__/kea_logic';
 import '../../../../__mocks__/react_router';
 import '../../../__mocks__/engine_logic.mock';
 

diff --git a/...ions/app_search/components/analytics/components/analytics_tables/analytics_table.test.tsx b/...ions/app_search/components/analytics/components/analytics_tables/analytics_table.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import '../../../../../__mocks__/kea.mock';
+import '../../../../../__mocks__/kea_logic';
 import '../../../../../__mocks__/react_router';
 import '../../../../__mocks__/engine_logic.mock';
 

diff --git a/...s/app_search/components/analytics/components/analytics_tables/query_clicks_table.test.tsx b/...s/app_search/components/analytics/components/analytics_tables/query_clicks_table.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import '../../../../../__mocks__/kea.mock';
+import '../../../../../__mocks__/kea_logic';
 import '../../../../../__mocks__/react_router';
 import '../../../../__mocks__/engine_logic.mock';
 

diff --git a/...app_search/components/analytics/components/analytics_tables/recent_queries_table.test.tsx b/...app_search/components/analytics/components/analytics_tables/recent_queries_table.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import '../../../../../__mocks__/kea.mock';
+import '../../../../../__mocks__/kea_logic';
 import '../../../../../__mocks__/react_router';
 import '../../../../__mocks__/engine_logic.mock';
 

diff --git a/...ch/components/analytics/components/analytics_tables/test_helpers/shared_columns_tests.tsx b/...ch/components/analytics/components/analytics_tables/test_helpers/shared_columns_tests.tsx
@@ -9,7 +9,7 @@ import {
   mockHttpValues,
   mockKibanaValues,
   mockFlashMessageHelpers,
-} from '../../../../../../__mocks__';
+} from '../../../../../../__mocks__/kea_logic';
 import '../../../../../__mocks__/engine_logic.mock';
 
 import { ReactWrapper } from 'enzyme';

diff --git a/...prise_search/public/applications/app_search/components/analytics/views/analytics.test.tsx b/...prise_search/public/applications/app_search/components/analytics/views/analytics.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 import '../../../__mocks__/engine_logic.mock';
 
 import React from 'react';

diff --git a/...se_search/public/applications/app_search/components/analytics/views/query_detail.test.tsx b/...se_search/public/applications/app_search/components/analytics/views/query_detail.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 import { mockUseParams } from '../../../../__mocks__/react_router';
 
 import React from 'react';

diff --git a/..._search/public/applications/app_search/components/analytics/views/recent_queries.test.tsx b/..._search/public/applications/app_search/components/analytics/views/recent_queries.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 
 import React from 'react';
 

diff --git a/...ise_search/public/applications/app_search/components/analytics/views/top_queries.test.tsx b/...ise_search/public/applications/app_search/components/analytics/views/top_queries.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 
 import React from 'react';
 

diff --git a/.../public/applications/app_search/components/analytics/views/top_queries_no_clicks.test.tsx b/.../public/applications/app_search/components/analytics/views/top_queries_no_clicks.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 
 import React from 'react';
 

diff --git a/...public/applications/app_search/components/analytics/views/top_queries_no_results.test.tsx b/...public/applications/app_search/components/analytics/views/top_queries_no_results.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 
 import React from 'react';
 

diff --git a/...ublic/applications/app_search/components/analytics/views/top_queries_with_clicks.test.tsx b/...ublic/applications/app_search/components/analytics/views/top_queries_with_clicks.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues } from '../../../../__mocks__';
+import { setMockValues } from '../../../../__mocks__/kea_logic';
 
 import React from 'react';
 

diff --git a/...search/public/applications/app_search/components/api_logs/api_log/api_log_flyout.test.tsx b/...search/public/applications/app_search/components/api_logs/api_log/api_log_flyout.test.tsx
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { setMockValues, setMockActions } from '../../../../__mocks__';
+import { setMockValues, setMockActions } from '../../../../__mocks__/kea_logic';
 import { mockApiLog } from '../__mocks__/api_log.mock';
 
 import React from 'react';
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ @@
      * 2.0.
      */
-    import { mockKibanaValues } from '../../../../__mocks__';
+    import { mockKibanaValues } from '../../../../__mocks__/kea_logic';
     import React from 'react';
@@ Expand Down @@