Improve jest mocking infrastructure

packages/eslint-config-kibana/jest.js

@@ -3,6 +3,7 @@ module.exports = {
     {
       files: [
         '**/*.{test,test.mocks,mock}.{js,ts,tsx}',
+        '**/__mocks__/**/*.{js,ts,tsx}',
       ],
       plugins: [
         'jest',

src/dev/jest/config.js

@@ -65,6 +65,9 @@ export default {
     '<rootDir>/src/dev/jest/setup/polyfills.js',
     '<rootDir>/src/dev/jest/setup/enzyme.js',
   ],
+  setupFilesAfterEnv: [
+    '<rootDir>/src/dev/jest/setup/mocks.js',
+  ],
   coverageDirectory: '<rootDir>/target/jest-coverage',
   coverageReporters: [
     'html',

src/dev/jest/setup/mocks.js

@@ -0,0 +1,48 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/* eslint-env jest */
+
+/**
+ * READ THIS BEFORE ADDING NEW MOCKS TO THIS FILE!
+ *
+ * This file should be loaded via `setupFilesAfterEnv` in all jest configs of the project.
+ * It instantiates some of the very basic mocks that should be available in all jest tests.
+ * Most of the mocks should just be instantiated in the test suites that require them.
+ * We only activate a very rare amount of mocks here, that are used somewhere down the dependency
+ * tree in nearly every test and their implementation is never working without mocking in any tests.
+ * Before adding a mock here it should be considered, whether it's not better to instantiate that mock
+ * in the test suites that needs them individually and if it's really needed to have that mock enabled
+ * for all jest tests by default.
+ *
+ * The mocks that are enabled that way live inside the `__mocks__` folders beside their implementation files.
+ */
+
+jest.mock('ui/metadata');
+jest.mock('ui/chrome');
+
+jest.mock('moment-timezone', () => {
+  // We always want to mock the timezone moment-timezone guesses, since otherwise
+  // test results might be depending on which time zone you are running them.
+  // Using that mock we always make sure moment.tz.guess is always returning the same
+  // timezone in all tests.
+  const moment = jest.requireActual('moment-timezone');
+  moment.tz.guess = () => 'America/New_York';
+  return moment;
+});

src/legacy/core_plugins/data/public/query/query_bar/components/language_switcher.test.tsx

@@ -17,12 +17,6 @@
  * under the License.
  */
 
-jest.mock('ui/metadata', () => ({
-  metadata: {
-    branch: 'foo',
-  },
-}));
-
 import { shallow } from 'enzyme';
 import React from 'react';
 import { QueryLanguageSwitcher } from './language_switcher';

src/legacy/core_plugins/data/public/query/query_bar/components/query_bar_input.test.mocks.ts

@@ -78,11 +78,6 @@ jest.mock('ui/kfetch', () => ({
 jest.mock('ui/persisted_log', () => ({
   PersistedLog: mockPersistedLogFactory,
 }));
-jest.mock('ui/metadata', () => ({
-  metadata: {
-    branch: 'foo',
-  },
-}));
 jest.mock('ui/autocomplete_providers', () => ({
   getAutocompleteProvider: mockGetAutocompleteProvider,
 }));

src/legacy/core_plugins/embeddable_api/public/np_core.test.mocks.ts

@@ -47,13 +47,6 @@ jest.doMock('ui/new_platform', () => {
   };
 });
 
-jest.doMock('ui/metadata', () => ({
-  metadata: {
-    branch: 'my-metadata-branch',
-    version: 'my-metadata-version',
-  },
-}));
-
 jest.doMock('ui/capabilities', () => ({
   uiCapabilities: {
     visualize: {

src/legacy/core_plugins/kibana/public/dashboard/panel/panel_state.test.ts

@@ -18,12 +18,6 @@
  */
 
 jest.mock('ui/chrome', () => ({ getKibanaVersion: () => '6.0.0' }), { virtual: true });
-jest.mock('ui/metadata', () => ({
-  metadata: {
-    branch: 'my-metadata-branch',
-    version: 'my-metadata-version',
-  },
-}));
 
 import { DEFAULT_PANEL_HEIGHT, DEFAULT_PANEL_WIDTH } from '../dashboard_constants';
 import { SavedDashboardPanel } from '../types';

src/legacy/core_plugins/status_page/public/lib/load_status.test.mocks.js

@@ -27,11 +27,3 @@ jest.doMock('ui/new_platform', () => ({
     }
   },
 }));
-
-// Make importing the ui/notify module work in jest
-jest.doMock('ui/metadata', () => ({
-  metadata: {
-    branch: 'my-metadata-branch',
-    version: 'my-metadata-version'
-  }
-}));

src/legacy/core_plugins/tests_bundle/find_source_files.js

@@ -36,6 +36,7 @@ const findSourceFiles = async (patterns, cwd = fromRoot('.')) => {
         '**/_*.js',
         '**/*.test.js',
         '**/*.test.mocks.js',
+        '**/__mocks__/**/*',
       ],
       symlinks: findSourceFiles.symlinks,
       statCache: findSourceFiles.statCache,

src/legacy/ui/public/__mocks__/metadata.ts

@@ -0,0 +1,25 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { metadata as metadataImpl } from '../metadata';
+
+export const metadata: typeof metadataImpl = {
+  branch: 'jest-metadata-mock-branch',
+  version: '42.23.26',
+};

src/legacy/ui/public/chrome/__mocks__/index.js

@@ -0,0 +1,38 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { uiSettingsServiceMock } from '../../../../../core/public/mocks';
+
+const uiSettingsClient = {
+  ...uiSettingsServiceMock.createSetupContract(),
+  getUpdate$: () => ({
+    subscribe: jest.fn(),
+  }),
+};
+
+const chrome = {
+  getBasePath: () => '/test/base/path',
+  addBasePath: path => path,
+  getInjected: jest.fn(),
+  getUiSettingsClient: () => uiSettingsClient,
+  getXsrfToken: () => 'kbn-xsrf-token',
+};
+
+// eslint-disable-next-line import/no-default-export
+export default chrome;

src/legacy/ui/public/__mocks__/ui/chrome.js → src/legacy/ui/public/kfetch/__mocks__/index.ts

@@ -16,3 +16,5 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+
+export const kfetch = () => Promise.resolve();

x-pack/dev-tools/jest/create_jest_config.js

@@ -34,6 +34,9 @@ export function createJestConfig({
       `<rootDir>/dev-tools/jest/setup/polyfills.js`,
       `<rootDir>/dev-tools/jest/setup/enzyme.js`,
     ],
+    setupFilesAfterEnv: [
+      `${kibanaDirectory}/src/dev/jest/setup/mocks.js`,
+    ],
     testMatch: [
       '**/*.test.{js,ts,tsx}'
     ],

x-pack/plugins/apm/public/components/app/ErrorGroupDetails/DetailView/index.test.tsx

@@ -10,6 +10,8 @@ import React from 'react';
 import { mockMoment } from '../../../../utils/testHelpers';
 import { DetailView } from './index';
 
+jest.mock('ui/kfetch');
+
 describe('DetailView', () => {
   beforeEach(() => {
     // Avoid timezone issues

x-pack/plugins/apm/public/components/app/Main/__test__/Home.test.js

@@ -8,6 +8,8 @@ import { shallow } from 'enzyme';
 import React from 'react';
 import { Home } from '../Home';
 
+jest.mock('ui/kfetch');
+
 describe('Home component', () => {
   it('should render', () => {
     expect(shallow(<Home />)).toMatchSnapshot();