From 661d4107d33a444ca39758fad8e0be0c2d6b96c8 Mon Sep 17 00:00:00 2001 From: Tyler Smalley Date: Tue, 15 Sep 2020 10:34:39 -0700 Subject: [PATCH] Adds @kbn/utils package (#76518) Moves common utility functions to obtain the repository root, paths (config/data), and Kibana package.json to a @kbn/utils package. Moving these existing functions allows them to be used in production, in other packages because of Kibana. Signed-off-by: Tyler Smalley --- .github/CODEOWNERS | 1 + .../external-plugin-functional-tests.asciidoc | 2 +- package.json | 2 + packages/kbn-dev-utils/package.json | 1 + packages/kbn-dev-utils/src/index.ts | 2 +- .../src/plugin_list/discover_plugins.ts | 2 +- .../src/plugin_list/generate_plugin_list.ts | 2 +- .../src/plugin_list/run_plugin_list_cli.ts | 3 +- .../kbn-dev-utils/src/precommit_hook/cli.ts | 2 +- .../src/precommit_hook/get_git_dir.ts | 2 +- .../serializers/absolute_path_serializer.ts | 2 +- packages/kbn-optimizer/README.md | 3 +- packages/kbn-optimizer/src/cli.ts | 3 +- .../basic_optimization.test.ts | 3 +- .../src/optimizer/cache_keys.test.ts | 3 +- .../kbn-optimizer/src/optimizer/cache_keys.ts | 2 +- .../handle_optimizer_completion.test.ts | 2 +- .../src/optimizer/optimizer_config.test.ts | 3 +- .../kbn-plugin-generator/src/ask_questions.ts | 2 +- packages/kbn-plugin-generator/src/cli.ts | 3 +- .../integration_tests/generate_plugin.test.ts | 3 +- .../kbn-plugin-generator/src/plugin_types.ts | 2 +- .../src/render_template.ts | 3 +- .../src/integration_tests/build.test.ts | 3 +- .../src/load_kibana_platform_plugin.ts | 8 +-- .../kbn-plugin-helpers/src/tasks/optimize.ts | 2 +- packages/kbn-pm/package.json | 1 + packages/kbn-release-notes/package.json | 1 + packages/kbn-release-notes/src/cli.ts | 3 +- packages/kbn-storybook/lib/constants.js | 6 +- packages/kbn-storybook/lib/dll.js | 3 +- packages/kbn-storybook/lib/storybook_entry.js | 3 +- .../kbn-storybook/lib/webpack.dll.config.js | 3 +- packages/kbn-storybook/package.json | 1 + .../storybook_config/webpack.config.js | 3 +- packages/kbn-test/package.json | 1 + .../run_failed_tests_reporter_cli.ts | 3 +- .../__tests__/integration/basic.js | 2 +- .../__tests__/integration/failure_hooks.js | 2 +- .../lib/failure_metadata.ts | 2 +- .../lib/mocha/decorate_mocha_ui.js | 2 +- .../lib/mocha/setup_mocha.js | 2 +- .../lib/suite_tracker.test.ts | 2 +- .../lib/suite_tracker.ts | 2 +- packages/kbn-ui-shared-deps/webpack.config.js | 2 +- packages/kbn-utils/README.md | 3 + packages/kbn-utils/package.json | 18 ++++++ packages/kbn-utils/src/index.ts | 22 ++++++++ .../kbn-utils/src/package_json/index.test.ts | 31 ++++++++++ packages/kbn-utils/src/package_json/index.ts | 27 +++++++++ .../kbn-utils/src}/path/index.test.ts | 0 .../kbn-utils/src}/path/index.ts | 8 +-- .../src/repo_root.ts | 0 packages/kbn-utils/tsconfig.json | 11 ++++ packages/kbn-utils/yarn.lock | 1 + src/cli/cluster/cluster_manager.ts | 2 +- src/cli/cluster/run_kbn_optimizer.ts | 2 +- src/cli/serve/serve.js | 2 +- src/cli_keystore/get_keystore.js | 2 +- src/cli_plugin/install/index.js | 2 +- src/cli_plugin/remove/index.js | 2 +- .../environment/create_data_folder.test.ts | 2 +- .../server/environment/create_data_folder.ts | 2 +- .../server/environment/environment_service.ts | 2 +- .../server/environment/resolve_uuid.test.ts | 2 +- src/core/server/environment/resolve_uuid.ts | 2 +- src/core/server/legacy/legacy_service.ts | 2 +- src/core/server/plugins/plugin_context.ts | 3 +- src/core/server/plugins/types.ts | 2 +- src/core/server/server.api.md | 2 +- src/core/server/server.ts | 2 +- src/dev/build/lib/build.test.ts | 3 +- src/dev/build/lib/config.test.ts | 3 +- .../tasks/build_kibana_platform_plugins.ts | 3 +- .../nodejs/extract_node_builds_task.test.ts | 2 +- .../verify_existing_node_builds_task.test.ts | 2 +- src/dev/constants.ts | 4 -- src/dev/eslint/lint_files.ts | 2 +- .../license_checker/run_check_licenses_cli.ts | 2 +- src/dev/mocha/run_mocha_cli.js | 2 +- src/dev/notice/cli.js | 2 +- .../installed_packages.test.ts | 2 +- .../precommit_hook/get_files_for_commit.js | 2 +- src/dev/run_check_file_casing.js | 2 +- src/dev/run_check_lockfile_symlinks.js | 2 +- src/dev/storybook/commands/clean.ts | 2 +- src/dev/storybook/run_storybook_cli.ts | 2 +- .../get_ts_project_for_absolute_path.ts | 2 +- src/dev/typescript/project.ts | 2 +- src/dev/typescript/projects.ts | 2 +- .../typescript/run_check_ts_projects_cli.ts | 2 +- src/plugins/data/server/server.api.md | 1 + src/plugins/telemetry/server/config.ts | 3 +- test/functional/services/remote/webdriver.ts | 2 +- .../server/routes/shareables/download.test.ts | 15 ++--- .../shareables/mock_shareable_workpad.json | 0 .../plugins/monitoring/server/config.test.ts | 20 +++++-- x-pack/tasks/build.ts | 3 +- .../apps/dashboard/reporting/download_csv.ts | 2 +- .../reporting_and_security/constants.ts | 2 +- .../common/config.ts | 2 +- .../spaces_api_integration/common/config.ts | 2 +- yarn.lock | 56 +++++++++++++++++-- 103 files changed, 302 insertions(+), 115 deletions(-) create mode 100644 packages/kbn-utils/README.md create mode 100644 packages/kbn-utils/package.json create mode 100644 packages/kbn-utils/src/index.ts create mode 100644 packages/kbn-utils/src/package_json/index.test.ts create mode 100644 packages/kbn-utils/src/package_json/index.ts rename {src/core/server => packages/kbn-utils/src}/path/index.test.ts (100%) rename {src/core/server => packages/kbn-utils/src}/path/index.ts (94%) rename packages/{kbn-dev-utils => kbn-utils}/src/repo_root.ts (100%) create mode 100644 packages/kbn-utils/tsconfig.json create mode 120000 packages/kbn-utils/yarn.lock delete mode 100644 x-pack/plugins/canvas/server/routes/shareables/mock_shareable_workpad.json diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 03a4f9520c2ba..38eb678bdc587 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -129,6 +129,7 @@ /packages/kbn-test/ @elastic/kibana-operations /packages/kbn-ui-shared-deps/ @elastic/kibana-operations /packages/kbn-es-archiver/ @elastic/kibana-operations +/packages/kbn-utils/ @elastic/kibana-operations /src/legacy/server/keystore/ @elastic/kibana-operations /src/legacy/server/pid/ @elastic/kibana-operations /src/legacy/server/sass/ @elastic/kibana-operations diff --git a/docs/developer/plugin/external-plugin-functional-tests.asciidoc b/docs/developer/plugin/external-plugin-functional-tests.asciidoc index 7e5b5b79d06e9..b39d576d85268 100644 --- a/docs/developer/plugin/external-plugin-functional-tests.asciidoc +++ b/docs/developer/plugin/external-plugin-functional-tests.asciidoc @@ -13,7 +13,7 @@ To get started copy and paste this example to `test/functional/config.js`: ["source","js"] ----------- import { resolve } from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { MyServiceProvider } from './services/my_service'; import { MyAppPageProvider } from './services/my_app_page'; diff --git a/package.json b/package.json index 141c579e3e9d0..8bbbaa341adf5 100644 --- a/package.json +++ b/package.json @@ -287,6 +287,7 @@ "@types/hoek": "^4.1.3", "@types/inert": "^5.1.2", "@types/jest": "^25.2.3", + "@types/jest-when": "^2.7.1", "@types/joi": "^13.4.2", "@types/jquery": "^3.3.31", "@types/js-yaml": "^3.11.1", @@ -411,6 +412,7 @@ "jest-cli": "^25.5.4", "jest-environment-jsdom-thirteen": "^1.0.1", "jest-raw-loader": "^1.0.1", + "jest-when": "^2.7.2", "jimp": "^0.14.0", "jquery": "^3.5.0", "js-levenshtein": "^1.1.6", diff --git a/packages/kbn-dev-utils/package.json b/packages/kbn-dev-utils/package.json index 4f6f995f38f31..a3fe8178822aa 100644 --- a/packages/kbn-dev-utils/package.json +++ b/packages/kbn-dev-utils/package.json @@ -11,6 +11,7 @@ }, "dependencies": { "@babel/core": "^7.11.1", + "@kbn/utils": "1.0.0", "axios": "^0.19.0", "chalk": "^4.1.0", "cheerio": "0.22.0", diff --git a/packages/kbn-dev-utils/src/index.ts b/packages/kbn-dev-utils/src/index.ts index 2871fe2ffcf4a..8217999b01128 100644 --- a/packages/kbn-dev-utils/src/index.ts +++ b/packages/kbn-dev-utils/src/index.ts @@ -17,6 +17,7 @@ * under the License. */ +export { REPO_ROOT } from '@kbn/utils'; export { withProcRunner, ProcRunner } from './proc_runner'; export * from './tooling_log'; export * from './serializers'; @@ -33,7 +34,6 @@ export { KBN_P12_PATH, KBN_P12_PASSWORD, } from './certs'; -export { REPO_ROOT } from './repo_root'; export { KbnClient } from './kbn_client'; export * from './run'; export * from './axios'; diff --git a/packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts b/packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts index 783d584656b17..5d92ddb600aa9 100644 --- a/packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts +++ b/packages/kbn-dev-utils/src/plugin_list/discover_plugins.ts @@ -22,8 +22,8 @@ import Fs from 'fs'; import MarkdownIt from 'markdown-it'; import cheerio from 'cheerio'; +import { REPO_ROOT } from '@kbn/utils'; -import { REPO_ROOT } from '../repo_root'; import { simpleKibanaPlatformPluginDiscovery } from '../simple_kibana_platform_plugin_discovery'; import { extractAsciidocInfo } from './extract_asciidoc_info'; diff --git a/packages/kbn-dev-utils/src/plugin_list/generate_plugin_list.ts b/packages/kbn-dev-utils/src/plugin_list/generate_plugin_list.ts index 43dac1cb7d418..e1a1323553113 100644 --- a/packages/kbn-dev-utils/src/plugin_list/generate_plugin_list.ts +++ b/packages/kbn-dev-utils/src/plugin_list/generate_plugin_list.ts @@ -20,8 +20,8 @@ import Path from 'path'; import normalizePath from 'normalize-path'; +import { REPO_ROOT } from '@kbn/utils'; -import { REPO_ROOT } from '../repo_root'; import { Plugins } from './discover_plugins'; function* printPlugins(plugins: Plugins, includes: string[]) { diff --git a/packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts b/packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts index 553eb1dd8afa0..613f9c9c26411 100644 --- a/packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts +++ b/packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts @@ -19,10 +19,9 @@ import Path from 'path'; import Fs from 'fs'; +import { REPO_ROOT } from '@kbn/utils'; import { run } from '../run'; -import { REPO_ROOT } from '../repo_root'; - import { discoverPlugins } from './discover_plugins'; import { generatePluginList } from './generate_plugin_list'; diff --git a/packages/kbn-dev-utils/src/precommit_hook/cli.ts b/packages/kbn-dev-utils/src/precommit_hook/cli.ts index a83e8c2b193d9..28347f379150f 100644 --- a/packages/kbn-dev-utils/src/precommit_hook/cli.ts +++ b/packages/kbn-dev-utils/src/precommit_hook/cli.ts @@ -20,9 +20,9 @@ import Path from 'path'; import { chmod, writeFile } from 'fs'; import { promisify } from 'util'; +import { REPO_ROOT } from '@kbn/utils'; import { run } from '../run'; -import { REPO_ROOT } from '../repo_root'; import { SCRIPT_SOURCE } from './script_source'; import { getGitDir } from './get_git_dir'; diff --git a/packages/kbn-dev-utils/src/precommit_hook/get_git_dir.ts b/packages/kbn-dev-utils/src/precommit_hook/get_git_dir.ts index 5ca7d67d0d4ea..f75c86f510095 100644 --- a/packages/kbn-dev-utils/src/precommit_hook/get_git_dir.ts +++ b/packages/kbn-dev-utils/src/precommit_hook/get_git_dir.ts @@ -19,7 +19,7 @@ import execa from 'execa'; -import { REPO_ROOT } from '../repo_root'; +import { REPO_ROOT } from '@kbn/utils'; // Retrieves the correct location for the .git dir for // every git setup (including git worktree) diff --git a/packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts b/packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts index 4008cf852c3a8..cc6b8334d76cf 100644 --- a/packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts +++ b/packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts @@ -17,7 +17,7 @@ * under the License. */ -import { REPO_ROOT } from '../repo_root'; +import { REPO_ROOT } from '@kbn/utils'; export function createAbsolutePathSerializer( rootPath: string = REPO_ROOT, diff --git a/packages/kbn-optimizer/README.md b/packages/kbn-optimizer/README.md index 13be836f0ea88..a666907f02678 100644 --- a/packages/kbn-optimizer/README.md +++ b/packages/kbn-optimizer/README.md @@ -69,7 +69,8 @@ To run the optimizer from code, you can import the [`OptimizerConfig`][Optimizer Example: ```ts import { runOptimizer, OptimizerConfig, logOptimizerState } from '@kbn/optimizer'; -import { REPO_ROOT, ToolingLog } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { ToolingLog } from '@kbn/dev-utils'; const log = new ToolingLog({ level: 'verbose', diff --git a/packages/kbn-optimizer/src/cli.ts b/packages/kbn-optimizer/src/cli.ts index 542dc7255f22f..dcfb56be66efd 100644 --- a/packages/kbn-optimizer/src/cli.ts +++ b/packages/kbn-optimizer/src/cli.ts @@ -21,7 +21,8 @@ import 'source-map-support/register'; import Path from 'path'; -import { run, REPO_ROOT, createFlagError, CiStatsReporter } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { run, createFlagError, CiStatsReporter } from '@kbn/dev-utils'; import { logOptimizerState } from './log_optimizer_state'; import { OptimizerConfig } from './optimizer'; diff --git a/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts b/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts index 12f037f5080fc..de3838eb92975 100644 --- a/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts +++ b/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts @@ -25,7 +25,8 @@ import { inspect } from 'util'; import cpy from 'cpy'; import del from 'del'; import { toArray, tap, filter } from 'rxjs/operators'; -import { ToolingLog, REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { ToolingLog } from '@kbn/dev-utils'; import { runOptimizer, OptimizerConfig, OptimizerUpdate, logOptimizerState } from '@kbn/optimizer'; const TMP_DIR = Path.resolve(__dirname, '../__fixtures__/__tmp__'); diff --git a/packages/kbn-optimizer/src/optimizer/cache_keys.test.ts b/packages/kbn-optimizer/src/optimizer/cache_keys.test.ts index 47d01347a8f7d..1b4c9b117c4c3 100644 --- a/packages/kbn-optimizer/src/optimizer/cache_keys.test.ts +++ b/packages/kbn-optimizer/src/optimizer/cache_keys.test.ts @@ -20,7 +20,8 @@ import Path from 'path'; import jestDiff from 'jest-diff'; -import { REPO_ROOT, createAbsolutePathSerializer } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { createAbsolutePathSerializer } from '@kbn/dev-utils'; import { reformatJestDiff, getOptimizerCacheKey, diffCacheKey } from './cache_keys'; import { OptimizerConfig } from './optimizer_config'; diff --git a/packages/kbn-optimizer/src/optimizer/cache_keys.ts b/packages/kbn-optimizer/src/optimizer/cache_keys.ts index d0aaad979485d..8dde67683a739 100644 --- a/packages/kbn-optimizer/src/optimizer/cache_keys.ts +++ b/packages/kbn-optimizer/src/optimizer/cache_keys.ts @@ -23,7 +23,7 @@ import { promisify } from 'util'; import Chalk from 'chalk'; import execa from 'execa'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import stripAnsi from 'strip-ansi'; import jestDiff from 'jest-diff'; diff --git a/packages/kbn-optimizer/src/optimizer/handle_optimizer_completion.test.ts b/packages/kbn-optimizer/src/optimizer/handle_optimizer_completion.test.ts index 3cc58e744a7b9..6edcde56e26de 100644 --- a/packages/kbn-optimizer/src/optimizer/handle_optimizer_completion.test.ts +++ b/packages/kbn-optimizer/src/optimizer/handle_optimizer_completion.test.ts @@ -18,7 +18,7 @@ */ import * as Rx from 'rxjs'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { Update } from '../common'; diff --git a/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts b/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts index afc2dc8952c87..fd887e8c2c012 100644 --- a/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts +++ b/packages/kbn-optimizer/src/optimizer/optimizer_config.test.ts @@ -32,7 +32,8 @@ jest.mock('os', () => { }); import Path from 'path'; -import { REPO_ROOT, createAbsolutePathSerializer } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { createAbsolutePathSerializer } from '@kbn/dev-utils'; import { OptimizerConfig, ParsedOptions } from './optimizer_config'; import { parseThemeTags } from '../common'; diff --git a/packages/kbn-plugin-generator/src/ask_questions.ts b/packages/kbn-plugin-generator/src/ask_questions.ts index b598396187245..732e22b0e2225 100644 --- a/packages/kbn-plugin-generator/src/ask_questions.ts +++ b/packages/kbn-plugin-generator/src/ask_questions.ts @@ -19,7 +19,7 @@ import Path from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import inquirer from 'inquirer'; export interface Answers { diff --git a/packages/kbn-plugin-generator/src/cli.ts b/packages/kbn-plugin-generator/src/cli.ts index f6966a245e46f..14c910a943fd5 100644 --- a/packages/kbn-plugin-generator/src/cli.ts +++ b/packages/kbn-plugin-generator/src/cli.ts @@ -21,7 +21,8 @@ import Path from 'path'; import Fs from 'fs'; import execa from 'execa'; -import { REPO_ROOT, run, createFailError, createFlagError } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { run, createFailError, createFlagError } from '@kbn/dev-utils'; import { snakeCase } from './casing'; import { askQuestions, getDefaultAnswers } from './ask_questions'; diff --git a/packages/kbn-plugin-generator/src/integration_tests/generate_plugin.test.ts b/packages/kbn-plugin-generator/src/integration_tests/generate_plugin.test.ts index b48113afc0ca7..25669b65e1ac9 100644 --- a/packages/kbn-plugin-generator/src/integration_tests/generate_plugin.test.ts +++ b/packages/kbn-plugin-generator/src/integration_tests/generate_plugin.test.ts @@ -21,7 +21,8 @@ import Path from 'path'; import del from 'del'; import execa from 'execa'; -import { REPO_ROOT, createAbsolutePathSerializer } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { createAbsolutePathSerializer } from '@kbn/dev-utils'; import globby from 'globby'; const GENERATED_DIR = Path.resolve(REPO_ROOT, `plugins`); diff --git a/packages/kbn-plugin-generator/src/plugin_types.ts b/packages/kbn-plugin-generator/src/plugin_types.ts index ae5201f4e8dbb..778e33353a2aa 100644 --- a/packages/kbn-plugin-generator/src/plugin_types.ts +++ b/packages/kbn-plugin-generator/src/plugin_types.ts @@ -19,7 +19,7 @@ import Path from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; export interface PluginType { thirdParty: boolean; diff --git a/packages/kbn-plugin-generator/src/render_template.ts b/packages/kbn-plugin-generator/src/render_template.ts index 894088c119651..ecb168042b1c2 100644 --- a/packages/kbn-plugin-generator/src/render_template.ts +++ b/packages/kbn-plugin-generator/src/render_template.ts @@ -23,7 +23,8 @@ import { promisify } from 'util'; import vfs from 'vinyl-fs'; import prettier from 'prettier'; -import { REPO_ROOT, transformFileStream } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { transformFileStream } from '@kbn/dev-utils'; import ejs from 'ejs'; import { Minimatch } from 'minimatch'; diff --git a/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts b/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts index be23d8dbde646..5c1ecc4ee4ee4 100644 --- a/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts +++ b/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts @@ -21,7 +21,8 @@ import Path from 'path'; import Fs from 'fs'; import execa from 'execa'; -import { createStripAnsiSerializer, REPO_ROOT, createReplaceSerializer } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { createStripAnsiSerializer, createReplaceSerializer } from '@kbn/dev-utils'; import extract from 'extract-zip'; import del from 'del'; import globby from 'globby'; diff --git a/packages/kbn-plugin-helpers/src/load_kibana_platform_plugin.ts b/packages/kbn-plugin-helpers/src/load_kibana_platform_plugin.ts index 8f48670e49de4..8ed20a26649e7 100644 --- a/packages/kbn-plugin-helpers/src/load_kibana_platform_plugin.ts +++ b/packages/kbn-plugin-helpers/src/load_kibana_platform_plugin.ts @@ -19,12 +19,8 @@ import Path from 'path'; -import { - REPO_ROOT, - parseKibanaPlatformPlugin, - KibanaPlatformPlugin, - createFailError, -} from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { parseKibanaPlatformPlugin, KibanaPlatformPlugin, createFailError } from '@kbn/dev-utils'; export type Plugin = KibanaPlatformPlugin; diff --git a/packages/kbn-plugin-helpers/src/tasks/optimize.ts b/packages/kbn-plugin-helpers/src/tasks/optimize.ts index 6cfeda8b2d81b..fc1bf48cc0e36 100644 --- a/packages/kbn-plugin-helpers/src/tasks/optimize.ts +++ b/packages/kbn-plugin-helpers/src/tasks/optimize.ts @@ -21,7 +21,7 @@ import Fs from 'fs'; import Path from 'path'; import { promisify } from 'util'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { OptimizerConfig, runOptimizer, logOptimizerState } from '@kbn/optimizer'; import { BuildContext } from '../build_context'; diff --git a/packages/kbn-pm/package.json b/packages/kbn-pm/package.json index 914ca2fd65fa2..1fb94e4c92ce1 100644 --- a/packages/kbn-pm/package.json +++ b/packages/kbn-pm/package.json @@ -66,6 +66,7 @@ "write-pkg": "^4.0.0" }, "dependencies": { + "@kbn/utils": "1.0.0", "tslib": "^2.0.0" } } diff --git a/packages/kbn-release-notes/package.json b/packages/kbn-release-notes/package.json index 12d0122f9a4d3..f8971fa02aa87 100644 --- a/packages/kbn-release-notes/package.json +++ b/packages/kbn-release-notes/package.json @@ -8,6 +8,7 @@ "kbn:watch": "tsc --watch" }, "dependencies": { + "@kbn/utils": "1.0.0", "@kbn/dev-utils": "1.0.0", "axios": "^0.19.2", "cheerio": "0.22.0", diff --git a/packages/kbn-release-notes/src/cli.ts b/packages/kbn-release-notes/src/cli.ts index 7dcfa38078391..dff59d79cb2b2 100644 --- a/packages/kbn-release-notes/src/cli.ts +++ b/packages/kbn-release-notes/src/cli.ts @@ -21,7 +21,8 @@ import Fs from 'fs'; import Path from 'path'; import { inspect } from 'util'; -import { run, createFlagError, createFailError, REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { run, createFlagError, createFailError } from '@kbn/dev-utils'; import { FORMATS, SomeFormat } from './formats'; import { diff --git a/packages/kbn-storybook/lib/constants.js b/packages/kbn-storybook/lib/constants.js index 9d216d347eada..4d8ca0adbfe17 100644 --- a/packages/kbn-storybook/lib/constants.js +++ b/packages/kbn-storybook/lib/constants.js @@ -17,10 +17,10 @@ * under the License. */ -const { resolve, dirname } = require('path'); +const { resolve } = require('path'); +const { REPO_ROOT } = require('@kbn/utils'); -exports.REPO_ROOT = dirname(require.resolve('../../../package.json')); -exports.ASSET_DIR = resolve(exports.REPO_ROOT, 'built_assets/storybook'); +exports.ASSET_DIR = resolve(REPO_ROOT, 'built_assets/storybook'); exports.CURRENT_CONFIG = resolve(exports.ASSET_DIR, 'current.config.js'); exports.STORY_ENTRY_PATH = resolve(exports.ASSET_DIR, 'stories.entry.js'); exports.DLL_DIST_DIR = resolve(exports.ASSET_DIR, 'dll'); diff --git a/packages/kbn-storybook/lib/dll.js b/packages/kbn-storybook/lib/dll.js index a9154ca972120..55bc8e43a02ec 100644 --- a/packages/kbn-storybook/lib/dll.js +++ b/packages/kbn-storybook/lib/dll.js @@ -20,7 +20,8 @@ const { resolve } = require('path'); const { existsSync } = require('fs'); -const { REPO_ROOT, DLL_DIST_DIR } = require('./constants'); +const { REPO_ROOT } = require('@kbn/utils'); +const { DLL_DIST_DIR } = require('./constants'); exports.buildDll = async ({ rebuildDll, log, procRunner }) => { if (rebuildDll) { diff --git a/packages/kbn-storybook/lib/storybook_entry.js b/packages/kbn-storybook/lib/storybook_entry.js index 8b8aa4126ad88..fc970b1ff9d2a 100644 --- a/packages/kbn-storybook/lib/storybook_entry.js +++ b/packages/kbn-storybook/lib/storybook_entry.js @@ -27,11 +27,12 @@ const { promisify } = require('util'); const watch = require('glob-watcher'); const mkdirp = require('mkdirp'); // eslint-disable-line const glob = require('fast-glob'); +const { REPO_ROOT } = require('@kbn/utils'); const mkdirpAsync = promisify(mkdirp); const writeFileAsync = promisify(Fs.writeFile); -const { REPO_ROOT, STORY_ENTRY_PATH } = require('./constants'); +const { STORY_ENTRY_PATH } = require('./constants'); const STORE_ENTRY_DIR = dirname(STORY_ENTRY_PATH); exports.generateStorybookEntry = ({ log, storyGlobs }) => { diff --git a/packages/kbn-storybook/lib/webpack.dll.config.js b/packages/kbn-storybook/lib/webpack.dll.config.js index 18dbe3bd049d3..6e3b4d41bd7f0 100644 --- a/packages/kbn-storybook/lib/webpack.dll.config.js +++ b/packages/kbn-storybook/lib/webpack.dll.config.js @@ -20,8 +20,9 @@ const webpack = require('webpack'); const path = require('path'); const MiniCssExtractPlugin = require('mini-css-extract-plugin'); +const { REPO_ROOT } = require('@kbn/utils'); -const { DLL_NAME, REPO_ROOT, DLL_DIST_DIR } = require('./constants'); +const { DLL_NAME, DLL_DIST_DIR } = require('./constants'); // This is the Webpack config for the DLL of CSS and JS assets that are // not expected to change during development. This saves compile and run diff --git a/packages/kbn-storybook/package.json b/packages/kbn-storybook/package.json index 9f12cd1f46c68..5271ddb96d842 100644 --- a/packages/kbn-storybook/package.json +++ b/packages/kbn-storybook/package.json @@ -6,6 +6,7 @@ "dependencies": { "@kbn/babel-preset": "1.0.0", "@kbn/dev-utils": "1.0.0", + "@kbn/utils": "1.0.0", "@storybook/addon-actions": "^5.3.19", "@storybook/addon-console": "^1.2.1", "@storybook/addon-info": "^5.3.19", diff --git a/packages/kbn-storybook/storybook_config/webpack.config.js b/packages/kbn-storybook/storybook_config/webpack.config.js index d505c4f9a0448..60b6b6add66d1 100644 --- a/packages/kbn-storybook/storybook_config/webpack.config.js +++ b/packages/kbn-storybook/storybook_config/webpack.config.js @@ -22,7 +22,8 @@ const webpack = require('webpack'); const webpackMerge = require('webpack-merge'); const { stringifyRequest } = require('loader-utils'); const CopyWebpackPlugin = require('copy-webpack-plugin'); -const { REPO_ROOT, DLL_DIST_DIR } = require('../lib/constants'); +const { REPO_ROOT } = require('@kbn/utils'); +const { DLL_DIST_DIR } = require('../lib/constants'); // eslint-disable-next-line import/no-unresolved const { currentConfig } = require('../../../built_assets/storybook/current.config'); diff --git a/packages/kbn-test/package.json b/packages/kbn-test/package.json index c84b0a93311bb..8a4ff55dcf68f 100644 --- a/packages/kbn-test/package.json +++ b/packages/kbn-test/package.json @@ -13,6 +13,7 @@ "@babel/cli": "^7.10.5", "@kbn/babel-preset": "1.0.0", "@kbn/dev-utils": "1.0.0", + "@kbn/utils": "1.0.0", "@types/joi": "^13.4.2", "@types/lodash": "^4.14.159", "@types/parse-link-header": "^1.0.0", diff --git a/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts b/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts index 3dfb1ea44d9e7..93616ce78a04a 100644 --- a/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts +++ b/packages/kbn-test/src/failed_tests_reporter/run_failed_tests_reporter_cli.ts @@ -19,7 +19,8 @@ import Path from 'path'; -import { REPO_ROOT, run, createFailError, createFlagError } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { run, createFailError, createFlagError } from '@kbn/dev-utils'; import globby from 'globby'; import { getFailures, TestFailure } from './get_failures'; diff --git a/packages/kbn-test/src/functional_test_runner/__tests__/integration/basic.js b/packages/kbn-test/src/functional_test_runner/__tests__/integration/basic.js index 133f4d2feb53e..a010d9f0b038e 100644 --- a/packages/kbn-test/src/functional_test_runner/__tests__/integration/basic.js +++ b/packages/kbn-test/src/functional_test_runner/__tests__/integration/basic.js @@ -21,7 +21,7 @@ import { spawnSync } from 'child_process'; import { resolve } from 'path'; import expect from '@kbn/expect'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; const SCRIPT = resolve(REPO_ROOT, 'scripts/functional_test_runner.js'); const BASIC_CONFIG = require.resolve('../fixtures/simple_project/config.js'); diff --git a/packages/kbn-test/src/functional_test_runner/__tests__/integration/failure_hooks.js b/packages/kbn-test/src/functional_test_runner/__tests__/integration/failure_hooks.js index 12e28d2702c5a..fa4ef88fd3e70 100644 --- a/packages/kbn-test/src/functional_test_runner/__tests__/integration/failure_hooks.js +++ b/packages/kbn-test/src/functional_test_runner/__tests__/integration/failure_hooks.js @@ -22,7 +22,7 @@ import { resolve } from 'path'; import stripAnsi from 'strip-ansi'; import expect from '@kbn/expect'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; const SCRIPT = resolve(REPO_ROOT, 'scripts/functional_test_runner.js'); const FAILURE_HOOKS_CONFIG = require.resolve('../fixtures/failure_hooks/config.js'); diff --git a/packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts b/packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts index fdf8b3c0ddfa8..e5c60f1d208b1 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts +++ b/packages/kbn-test/src/functional_test_runner/lib/failure_metadata.ts @@ -19,7 +19,7 @@ import Path from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { Lifecycle } from './lifecycle'; diff --git a/packages/kbn-test/src/functional_test_runner/lib/mocha/decorate_mocha_ui.js b/packages/kbn-test/src/functional_test_runner/lib/mocha/decorate_mocha_ui.js index 5d3d8fe7d759b..92137a8c4f841 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/mocha/decorate_mocha_ui.js +++ b/packages/kbn-test/src/functional_test_runner/lib/mocha/decorate_mocha_ui.js @@ -17,7 +17,7 @@ * under the License. */ import { relative } from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { createAssignmentProxy } from './assignment_proxy'; import { wrapFunction } from './wrap_function'; import { wrapRunnableArgs } from './wrap_runnable_args'; diff --git a/packages/kbn-test/src/functional_test_runner/lib/mocha/setup_mocha.js b/packages/kbn-test/src/functional_test_runner/lib/mocha/setup_mocha.js index 3ac7a50cd28ea..39eb69a151918 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/mocha/setup_mocha.js +++ b/packages/kbn-test/src/functional_test_runner/lib/mocha/setup_mocha.js @@ -19,7 +19,7 @@ import Mocha from 'mocha'; import { relative } from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { loadTestFiles } from './load_test_files'; import { filterSuitesByTags } from './filter_suites_by_tags'; diff --git a/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts b/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts index f879408bf2beb..5350b2709843d 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts +++ b/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.test.ts @@ -21,7 +21,7 @@ import fs from 'fs'; import { join, resolve } from 'path'; jest.mock('fs'); -jest.mock('@kbn/dev-utils', () => { +jest.mock('@kbn/utils', () => { return { REPO_ROOT: '/dev/null/root' }; }); diff --git a/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.ts b/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.ts index b346be2d58dad..6cbd74467106f 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.ts +++ b/packages/kbn-test/src/functional_test_runner/lib/suite_tracker.ts @@ -19,7 +19,7 @@ import fs from 'fs'; import { dirname, relative, resolve } from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { Lifecycle } from './lifecycle'; diff --git a/packages/kbn-ui-shared-deps/webpack.config.js b/packages/kbn-ui-shared-deps/webpack.config.js index fa80dfdeef20f..b7d4e929ac93f 100644 --- a/packages/kbn-ui-shared-deps/webpack.config.js +++ b/packages/kbn-ui-shared-deps/webpack.config.js @@ -21,7 +21,7 @@ const Path = require('path'); const MiniCssExtractPlugin = require('mini-css-extract-plugin'); const CompressionPlugin = require('compression-webpack-plugin'); -const { REPO_ROOT } = require('@kbn/dev-utils'); +const { REPO_ROOT } = require('@kbn/utils'); const webpack = require('webpack'); const UiSharedDeps = require('./index'); diff --git a/packages/kbn-utils/README.md b/packages/kbn-utils/README.md new file mode 100644 index 0000000000000..fd132e4312487 --- /dev/null +++ b/packages/kbn-utils/README.md @@ -0,0 +1,3 @@ +# @kbn/utils + +Shared server-side utilities shared across packages and plugins. \ No newline at end of file diff --git a/packages/kbn-utils/package.json b/packages/kbn-utils/package.json new file mode 100644 index 0000000000000..2ad742650f74d --- /dev/null +++ b/packages/kbn-utils/package.json @@ -0,0 +1,18 @@ +{ + "name": "@kbn/utils", + "main": "./target/index.js", + "version": "1.0.0", + "license": "Apache-2.0", + "private": true, + "scripts": { + "build": "tsc", + "kbn:bootstrap": "yarn build", + "kbn:watch": "yarn build --watch" + }, + "dependencies": { + "@kbn/config-schema": "1.0.0" + }, + "devDependencies": { + "typescript": "4.0.2" + } +} diff --git a/packages/kbn-utils/src/index.ts b/packages/kbn-utils/src/index.ts new file mode 100644 index 0000000000000..7a894d72d5624 --- /dev/null +++ b/packages/kbn-utils/src/index.ts @@ -0,0 +1,22 @@ +/* + * 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. + */ + +export * from './package_json'; +export * from './path'; +export * from './repo_root'; diff --git a/packages/kbn-utils/src/package_json/index.test.ts b/packages/kbn-utils/src/package_json/index.test.ts new file mode 100644 index 0000000000000..afc84102999fe --- /dev/null +++ b/packages/kbn-utils/src/package_json/index.test.ts @@ -0,0 +1,31 @@ +/* + * 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 path from 'path'; +import { kibanaPackageJSON } from './'; + +it('parses package.json', () => { + expect(kibanaPackageJSON.name).toEqual('kibana'); +}); + +it('includes __dirname and __filename', () => { + const root = path.resolve(__dirname, '../../../../'); + expect(kibanaPackageJSON.__filename).toEqual(path.resolve(root, 'package.json')); + expect(kibanaPackageJSON.__dirname).toEqual(root); +}); diff --git a/packages/kbn-utils/src/package_json/index.ts b/packages/kbn-utils/src/package_json/index.ts new file mode 100644 index 0000000000000..f439c0100e193 --- /dev/null +++ b/packages/kbn-utils/src/package_json/index.ts @@ -0,0 +1,27 @@ +/* + * 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 { dirname, resolve } from 'path'; +import { REPO_ROOT } from '../repo_root'; + +export const kibanaPackageJSON = { + __filename: resolve(REPO_ROOT, 'package.json'), + __dirname: dirname(resolve(REPO_ROOT, 'package.json')), + ...require(resolve(REPO_ROOT, 'package.json')), +}; diff --git a/src/core/server/path/index.test.ts b/packages/kbn-utils/src/path/index.test.ts similarity index 100% rename from src/core/server/path/index.test.ts rename to packages/kbn-utils/src/path/index.test.ts diff --git a/src/core/server/path/index.ts b/packages/kbn-utils/src/path/index.ts similarity index 94% rename from src/core/server/path/index.ts rename to packages/kbn-utils/src/path/index.ts index 7c1a81643fbc8..a7eddca5f2fde 100644 --- a/src/core/server/path/index.ts +++ b/packages/kbn-utils/src/path/index.ts @@ -20,7 +20,7 @@ import { join } from 'path'; import { accessSync, constants } from 'fs'; import { TypeOf, schema } from '@kbn/config-schema'; -import { fromRoot } from '../utils'; +import { REPO_ROOT } from '../repo_root'; const isString = (v: any): v is string => typeof v === 'string'; @@ -28,19 +28,19 @@ const CONFIG_PATHS = [ process.env.KBN_PATH_CONF && join(process.env.KBN_PATH_CONF, 'kibana.yml'), process.env.KIBANA_PATH_CONF && join(process.env.KIBANA_PATH_CONF, 'kibana.yml'), process.env.CONFIG_PATH, // deprecated - fromRoot('config/kibana.yml'), + join(REPO_ROOT, 'config/kibana.yml'), ].filter(isString); const CONFIG_DIRECTORIES = [ process.env.KBN_PATH_CONF, process.env.KIBANA_PATH_CONF, - fromRoot('config'), + join(REPO_ROOT, 'config'), '/etc/kibana', ].filter(isString); const DATA_PATHS = [ process.env.DATA_PATH, // deprecated - fromRoot('data'), + join(REPO_ROOT, 'data'), '/var/lib/kibana', ].filter(isString); diff --git a/packages/kbn-dev-utils/src/repo_root.ts b/packages/kbn-utils/src/repo_root.ts similarity index 100% rename from packages/kbn-dev-utils/src/repo_root.ts rename to packages/kbn-utils/src/repo_root.ts diff --git a/packages/kbn-utils/tsconfig.json b/packages/kbn-utils/tsconfig.json new file mode 100644 index 0000000000000..e9dd6313e6f79 --- /dev/null +++ b/packages/kbn-utils/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target", + "declaration": true, + "declarationMap": true + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-utils/yarn.lock b/packages/kbn-utils/yarn.lock new file mode 120000 index 0000000000000..3f82ebc9cdbae --- /dev/null +++ b/packages/kbn-utils/yarn.lock @@ -0,0 +1 @@ +../../yarn.lock \ No newline at end of file diff --git a/src/cli/cluster/cluster_manager.ts b/src/cli/cluster/cluster_manager.ts index eb7db8dac7cb6..b1d1335eb1888 100644 --- a/src/cli/cluster/cluster_manager.ts +++ b/src/cli/cluster/cluster_manager.ts @@ -21,7 +21,7 @@ import { resolve } from 'path'; import { format as formatUrl } from 'url'; import opn from 'opn'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { FSWatcher } from 'chokidar'; import * as Rx from 'rxjs'; import { startWith, mapTo, filter, map, take, tap } from 'rxjs/operators'; diff --git a/src/cli/cluster/run_kbn_optimizer.ts b/src/cli/cluster/run_kbn_optimizer.ts index c231437da3943..8196cad4a99c7 100644 --- a/src/cli/cluster/run_kbn_optimizer.ts +++ b/src/cli/cluster/run_kbn_optimizer.ts @@ -19,12 +19,12 @@ import Chalk from 'chalk'; import moment from 'moment'; +import { REPO_ROOT } from '@kbn/utils'; import { ToolingLog, pickLevelFromFlags, ToolingLogTextWriter, parseLogLevel, - REPO_ROOT, } from '@kbn/dev-utils'; import { runOptimizer, OptimizerConfig, logOptimizerState } from '@kbn/optimizer'; diff --git a/src/cli/serve/serve.js b/src/cli/serve/serve.js index c08f3aec64335..eeb5564667ec4 100644 --- a/src/cli/serve/serve.js +++ b/src/cli/serve/serve.js @@ -23,9 +23,9 @@ import { statSync } from 'fs'; import { resolve } from 'path'; import url from 'url'; +import { getConfigPath } from '@kbn/utils'; import { IS_KIBANA_DISTRIBUTABLE } from '../../legacy/utils'; import { fromRoot } from '../../core/server/utils'; -import { getConfigPath } from '../../core/server/path'; import { bootstrap } from '../../core/server'; import { readKeystore } from './read_keystore'; diff --git a/src/cli_keystore/get_keystore.js b/src/cli_keystore/get_keystore.js index e181efe9196b8..b97efbb2cbf4d 100644 --- a/src/cli_keystore/get_keystore.js +++ b/src/cli_keystore/get_keystore.js @@ -21,7 +21,7 @@ import { existsSync } from 'fs'; import { join } from 'path'; import { Logger } from '../cli_plugin/lib/logger'; -import { getConfigDirectory, getDataPath } from '../core/server/path'; +import { getConfigDirectory, getDataPath } from '@kbn/utils'; export function getKeystore() { const configKeystore = join(getConfigDirectory(), 'kibana.keystore'); diff --git a/src/cli_plugin/install/index.js b/src/cli_plugin/install/index.js index bc7e95b8489f0..eff14906853c1 100644 --- a/src/cli_plugin/install/index.js +++ b/src/cli_plugin/install/index.js @@ -17,10 +17,10 @@ * under the License. */ +import { getConfigPath } from '@kbn/utils'; import { pkg } from '../../core/server/utils'; import { install } from './install'; import { Logger } from '../lib/logger'; -import { getConfigPath } from '../../core/server/path'; import { parse, parseMilliseconds } from './settings'; import { logWarnings } from '../lib/log_warnings'; diff --git a/src/cli_plugin/remove/index.js b/src/cli_plugin/remove/index.js index c3bd96086db9b..b9c37c0cf802b 100644 --- a/src/cli_plugin/remove/index.js +++ b/src/cli_plugin/remove/index.js @@ -17,10 +17,10 @@ * under the License. */ +import { getConfigPath } from '@kbn/utils'; import { remove } from './remove'; import { Logger } from '../lib/logger'; import { parse } from './settings'; -import { getConfigPath } from '../../core/server/path'; import { logWarnings } from '../lib/log_warnings'; function processCommand(command, options) { diff --git a/src/core/server/environment/create_data_folder.test.ts b/src/core/server/environment/create_data_folder.test.ts index 2a480a7a3954f..25c1d57996e0d 100644 --- a/src/core/server/environment/create_data_folder.test.ts +++ b/src/core/server/environment/create_data_folder.test.ts @@ -17,7 +17,7 @@ * under the License. */ -import { PathConfigType } from '../path'; +import { PathConfigType } from '@kbn/utils'; import { createDataFolder } from './create_data_folder'; import { mkdir } from './fs'; import { loggingSystemMock } from '../logging/logging_system.mock'; diff --git a/src/core/server/environment/create_data_folder.ts b/src/core/server/environment/create_data_folder.ts index 641d95cbf9411..f90e9f93694eb 100644 --- a/src/core/server/environment/create_data_folder.ts +++ b/src/core/server/environment/create_data_folder.ts @@ -17,9 +17,9 @@ * under the License. */ +import { PathConfigType } from '@kbn/utils'; import { mkdir } from './fs'; import { Logger } from '../logging'; -import { PathConfigType } from '../path'; export async function createDataFolder({ pathConfig, diff --git a/src/core/server/environment/environment_service.ts b/src/core/server/environment/environment_service.ts index caa4f34bcfaa7..b051dfbe4c7f2 100644 --- a/src/core/server/environment/environment_service.ts +++ b/src/core/server/environment/environment_service.ts @@ -18,10 +18,10 @@ */ import { take } from 'rxjs/operators'; +import { PathConfigType, config as pathConfigDef } from '@kbn/utils'; import { CoreContext } from '../core_context'; import { Logger } from '../logging'; import { IConfigService } from '../config'; -import { PathConfigType, config as pathConfigDef } from '../path'; import { HttpConfigType, config as httpConfigDef } from '../http'; import { PidConfigType, config as pidConfigDef } from './pid_config'; import { resolveInstanceUuid } from './resolve_uuid'; diff --git a/src/core/server/environment/resolve_uuid.test.ts b/src/core/server/environment/resolve_uuid.test.ts index d162c9d8e364b..c6e8465507123 100644 --- a/src/core/server/environment/resolve_uuid.test.ts +++ b/src/core/server/environment/resolve_uuid.test.ts @@ -18,10 +18,10 @@ */ import { join } from 'path'; +import { PathConfigType } from '@kbn/utils'; import { loggingSystemMock } from '../logging/logging_system.mock'; import { readFile, writeFile } from './fs'; import { resolveInstanceUuid, UUID_7_6_0_BUG } from './resolve_uuid'; -import { PathConfigType } from '../path'; import { HttpConfigType } from '../http'; jest.mock('uuid', () => ({ diff --git a/src/core/server/environment/resolve_uuid.ts b/src/core/server/environment/resolve_uuid.ts index 0267e06939997..a640319e30af4 100644 --- a/src/core/server/environment/resolve_uuid.ts +++ b/src/core/server/environment/resolve_uuid.ts @@ -19,8 +19,8 @@ import uuid from 'uuid'; import { join } from 'path'; +import { PathConfigType } from '@kbn/utils'; import { readFile, writeFile } from './fs'; -import { PathConfigType } from '../path'; import { HttpConfigType } from '../http'; import { Logger } from '../logging'; diff --git a/src/core/server/legacy/legacy_service.ts b/src/core/server/legacy/legacy_service.ts index 6e6d5cfc24340..1ad874fef6920 100644 --- a/src/core/server/legacy/legacy_service.ts +++ b/src/core/server/legacy/legacy_service.ts @@ -20,6 +20,7 @@ import { combineLatest, ConnectableObservable, EMPTY, Observable, Subscription } from 'rxjs'; import { first, map, publishReplay, tap } from 'rxjs/operators'; +import { PathConfigType } from '@kbn/utils'; import { CoreService } from '../../types'; import { Config } from '../config'; import { CoreContext } from '../core_context'; @@ -27,7 +28,6 @@ import { CspConfigType, config as cspConfig } from '../csp'; import { DevConfig, DevConfigType, config as devConfig } from '../dev'; import { BasePathProxyServer, HttpConfig, HttpConfigType, config as httpConfig } from '../http'; import { Logger } from '../logging'; -import { PathConfigType } from '../path'; import { findLegacyPluginSpecs, logLegacyThirdPartyPluginDeprecationWarning } from './plugins'; import { ILegacyInternals, diff --git a/src/core/server/plugins/plugin_context.ts b/src/core/server/plugins/plugin_context.ts index 55e63941523ee..8d17300965680 100644 --- a/src/core/server/plugins/plugin_context.ts +++ b/src/core/server/plugins/plugin_context.ts @@ -19,8 +19,8 @@ import { map, shareReplay } from 'rxjs/operators'; import { combineLatest } from 'rxjs'; +import { PathConfigType, config as pathConfig } from '@kbn/utils'; import { pick, deepFreeze } from '@kbn/std'; - import { CoreContext } from '../core_context'; import { PluginWrapper } from './plugin'; import { PluginsServiceSetupDeps, PluginsServiceStartDeps } from './plugins_service'; @@ -30,7 +30,6 @@ import { PluginOpaqueId, SharedGlobalConfigKeys, } from './types'; -import { PathConfigType, config as pathConfig } from '../path'; import { KibanaConfigType, config as kibanaConfig } from '../kibana_config'; import { ElasticsearchConfigType, diff --git a/src/core/server/plugins/types.ts b/src/core/server/plugins/types.ts index 517261b5bc9bb..34d5e044222eb 100644 --- a/src/core/server/plugins/types.ts +++ b/src/core/server/plugins/types.ts @@ -20,12 +20,12 @@ import { Observable } from 'rxjs'; import { Type } from '@kbn/config-schema'; import { RecursiveReadonly } from '@kbn/utility-types'; +import { PathConfigType } from '@kbn/utils'; import { ConfigPath, EnvironmentMode, PackageInfo, ConfigDeprecationProvider } from '../config'; import { LoggerFactory } from '../logging'; import { KibanaConfigType } from '../kibana_config'; import { ElasticsearchConfigType } from '../elasticsearch/elasticsearch_config'; -import { PathConfigType } from '../path'; import { CoreSetup, CoreStart } from '..'; /** diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 96239d8ada54f..1207a71eb5ae3 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -106,6 +106,7 @@ import { NodesInfoParams } from 'elasticsearch'; import { NodesStatsParams } from 'elasticsearch'; import { ObjectType } from '@kbn/config-schema'; import { Observable } from 'rxjs'; +import { PathConfigType } from '@kbn/utils'; import { PeerCertificate } from 'tls'; import { PingParams } from 'elasticsearch'; import { PutScriptParams } from 'elasticsearch'; @@ -2843,6 +2844,5 @@ export const validBodyOutput: readonly ["data", "stream"]; // src/core/server/legacy/types.ts:135:16 - (ae-forgotten-export) The symbol "LegacyPluginSpec" needs to be exported by the entry point index.d.ts // src/core/server/plugins/types.ts:272:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts // src/core/server/plugins/types.ts:272:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts -// src/core/server/plugins/types.ts:274:3 - (ae-forgotten-export) The symbol "PathConfigType" needs to be exported by the entry point index.d.ts ``` diff --git a/src/core/server/server.ts b/src/core/server/server.ts index 8015b184f6130..c689e2cb70cc9 100644 --- a/src/core/server/server.ts +++ b/src/core/server/server.ts @@ -17,6 +17,7 @@ * under the License. */ +import { config as pathConfig } from '@kbn/utils'; import { mapToObject } from '@kbn/std'; import { ConfigService, Env, RawConfigurationProvider, coreDeprecationProvider } from './config'; import { CoreApp } from './core_app'; @@ -40,7 +41,6 @@ import { config as elasticsearchConfig } from './elasticsearch'; import { config as httpConfig } from './http'; import { config as loggingConfig } from './logging'; import { config as devConfig } from './dev'; -import { config as pathConfig } from './path'; import { config as kibanaConfig } from './kibana_config'; import { savedObjectsConfig, savedObjectsMigrationConfig } from './saved_objects'; import { config as uiSettingsConfig } from './ui_settings'; diff --git a/src/dev/build/lib/build.test.ts b/src/dev/build/lib/build.test.ts index 9fdf21cee6567..7ccd5b8e13a2c 100644 --- a/src/dev/build/lib/build.test.ts +++ b/src/dev/build/lib/build.test.ts @@ -17,7 +17,8 @@ * under the License. */ -import { REPO_ROOT, createAbsolutePathSerializer } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { createAbsolutePathSerializer } from '@kbn/dev-utils'; import { Config } from './config'; import { Build } from './build'; diff --git a/src/dev/build/lib/config.test.ts b/src/dev/build/lib/config.test.ts index 0539adc840a6a..bb4d4c000e9d5 100644 --- a/src/dev/build/lib/config.test.ts +++ b/src/dev/build/lib/config.test.ts @@ -19,7 +19,8 @@ import { resolve } from 'path'; -import { createAbsolutePathSerializer, REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { createAbsolutePathSerializer } from '@kbn/dev-utils'; import pkg from '../../../../package.json'; import { Config } from './config'; diff --git a/src/dev/build/tasks/build_kibana_platform_plugins.ts b/src/dev/build/tasks/build_kibana_platform_plugins.ts index 48625078e9bd1..44b441ad898c3 100644 --- a/src/dev/build/tasks/build_kibana_platform_plugins.ts +++ b/src/dev/build/tasks/build_kibana_platform_plugins.ts @@ -17,7 +17,8 @@ * under the License. */ -import { CiStatsReporter, REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { CiStatsReporter } from '@kbn/dev-utils'; import { runOptimizer, OptimizerConfig, diff --git a/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts b/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts index a5b9e01714f38..cd197db251093 100644 --- a/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts +++ b/src/dev/build/tasks/nodejs/extract_node_builds_task.test.ts @@ -20,12 +20,12 @@ import { readFileSync } from 'fs'; import Path from 'path'; +import { REPO_ROOT } from '@kbn/utils'; import { ToolingLog, ToolingLogCollectingWriter, createAbsolutePathSerializer, createRecursiveSerializer, - REPO_ROOT, } from '@kbn/dev-utils'; import { Config } from '../../lib'; diff --git a/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts b/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts index 1a850890a33fe..9b03dcd828cf9 100644 --- a/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts +++ b/src/dev/build/tasks/nodejs/verify_existing_node_builds_task.test.ts @@ -20,12 +20,12 @@ import Path from 'path'; import Fs from 'fs'; +import { REPO_ROOT } from '@kbn/utils'; import { ToolingLog, ToolingLogCollectingWriter, createAnyInstanceSerializer, createRecursiveSerializer, - REPO_ROOT, } from '@kbn/dev-utils'; import { Config, Platform } from '../../lib'; diff --git a/src/dev/constants.ts b/src/dev/constants.ts index d1b89719c69b7..9ce18ffdc9bcd 100644 --- a/src/dev/constants.ts +++ b/src/dev/constants.ts @@ -17,10 +17,6 @@ * under the License. */ -import { dirname } from 'path'; - -export const REPO_ROOT = dirname(require.resolve('../../package.json')); - // Files in directories of this name will be treated as Jest integration tests with instances of // Elasticsearch and the Kibana server. export const RESERVED_DIR_JEST_INTEGRATION_TESTS = 'integration_tests'; diff --git a/src/dev/eslint/lint_files.ts b/src/dev/eslint/lint_files.ts index ba16163fc9bd3..ebd6bedb5f56c 100644 --- a/src/dev/eslint/lint_files.ts +++ b/src/dev/eslint/lint_files.ts @@ -19,9 +19,9 @@ import { CLIEngine } from 'eslint'; +import { REPO_ROOT } from '@kbn/utils'; import { createFailError, ToolingLog } from '@kbn/dev-utils'; import { File } from '../file'; -import { REPO_ROOT } from '../constants'; /** * Lints a list of files with eslint. eslint reports are written to the log diff --git a/src/dev/license_checker/run_check_licenses_cli.ts b/src/dev/license_checker/run_check_licenses_cli.ts index 0267a1a90d4fe..70ebb43c788f9 100644 --- a/src/dev/license_checker/run_check_licenses_cli.ts +++ b/src/dev/license_checker/run_check_licenses_cli.ts @@ -17,12 +17,12 @@ * under the License. */ +import { REPO_ROOT } from '@kbn/utils'; import { run } from '@kbn/dev-utils'; import { getInstalledPackages } from '../npm'; import { LICENSE_WHITELIST, DEV_ONLY_LICENSE_WHITELIST, LICENSE_OVERRIDES } from './config'; import { assertLicensesValid } from './valid'; -import { REPO_ROOT } from '../constants'; run( async ({ log, flags }) => { diff --git a/src/dev/mocha/run_mocha_cli.js b/src/dev/mocha/run_mocha_cli.js index 7a750371ec55b..475e1750a92b9 100644 --- a/src/dev/mocha/run_mocha_cli.js +++ b/src/dev/mocha/run_mocha_cli.js @@ -17,7 +17,7 @@ * under the License. */ -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import getopts from 'getopts'; import globby from 'globby'; diff --git a/src/dev/notice/cli.js b/src/dev/notice/cli.js index 34217ef48a33b..ea0f884bb1ea0 100644 --- a/src/dev/notice/cli.js +++ b/src/dev/notice/cli.js @@ -22,9 +22,9 @@ import { resolve } from 'path'; import getopts from 'getopts'; import dedent from 'dedent'; +import { REPO_ROOT } from '@kbn/utils'; import { ToolingLog, pickLevelFromFlags } from '@kbn/dev-utils'; -import { REPO_ROOT } from '../constants'; import { generateNoticeFromSource } from './generate_notice_from_source'; const unknownFlags = []; diff --git a/src/dev/npm/integration_tests/installed_packages.test.ts b/src/dev/npm/integration_tests/installed_packages.test.ts index 58c954cbc12f7..3aeb5b106c2ec 100644 --- a/src/dev/npm/integration_tests/installed_packages.test.ts +++ b/src/dev/npm/integration_tests/installed_packages.test.ts @@ -21,8 +21,8 @@ import { resolve, sep } from 'path'; import { uniq } from 'lodash'; +import { REPO_ROOT } from '@kbn/utils'; import { getInstalledPackages, InstalledPackage } from '../installed_packages'; -import { REPO_ROOT } from '../../constants'; const FIXTURE1_ROOT = resolve(__dirname, '__fixtures__/fixture1'); diff --git a/src/dev/precommit_hook/get_files_for_commit.js b/src/dev/precommit_hook/get_files_for_commit.js index dc5560be0d1ad..e700b58782174 100644 --- a/src/dev/precommit_hook/get_files_for_commit.js +++ b/src/dev/precommit_hook/get_files_for_commit.js @@ -20,7 +20,7 @@ import SimpleGit from 'simple-git'; import { fromNode as fcb } from 'bluebird'; -import { REPO_ROOT } from '../constants'; +import { REPO_ROOT } from '@kbn/utils'; import { File } from '../file'; /** diff --git a/src/dev/run_check_file_casing.js b/src/dev/run_check_file_casing.js index bdbf1827897e7..3acff74430abe 100644 --- a/src/dev/run_check_file_casing.js +++ b/src/dev/run_check_file_casing.js @@ -19,9 +19,9 @@ import globby from 'globby'; +import { REPO_ROOT } from '@kbn/utils'; import { run } from '@kbn/dev-utils'; import { File } from './file'; -import { REPO_ROOT } from './constants'; import { checkFileCasing } from './precommit_hook/check_file_casing'; run(async ({ log }) => { diff --git a/src/dev/run_check_lockfile_symlinks.js b/src/dev/run_check_lockfile_symlinks.js index 5ebb7952e2cf3..c4e040c4bffa3 100644 --- a/src/dev/run_check_lockfile_symlinks.js +++ b/src/dev/run_check_lockfile_symlinks.js @@ -21,9 +21,9 @@ import { existsSync, lstatSync, readFileSync, readlinkSync } from 'fs'; import globby from 'globby'; import { dirname } from 'path'; +import { REPO_ROOT } from '@kbn/utils'; import { run, createFailError } from '@kbn/dev-utils'; -import { REPO_ROOT } from './constants'; import { File } from './file'; import { matchesAnyGlob } from './globs'; diff --git a/src/dev/storybook/commands/clean.ts b/src/dev/storybook/commands/clean.ts index 328c4d9e2c23c..539757d0e7ad2 100644 --- a/src/dev/storybook/commands/clean.ts +++ b/src/dev/storybook/commands/clean.ts @@ -18,7 +18,7 @@ */ import { ToolingLog } from '@kbn/dev-utils'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { join } from 'path'; import del from 'del'; diff --git a/src/dev/storybook/run_storybook_cli.ts b/src/dev/storybook/run_storybook_cli.ts index 7f97cff91aaaa..b1e8d882e5352 100644 --- a/src/dev/storybook/run_storybook_cli.ts +++ b/src/dev/storybook/run_storybook_cli.ts @@ -19,7 +19,7 @@ import { join } from 'path'; import { run, createFlagError } from '@kbn/dev-utils'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { storybookAliases } from './aliases'; import { clean } from './commands/clean'; diff --git a/src/dev/typescript/get_ts_project_for_absolute_path.ts b/src/dev/typescript/get_ts_project_for_absolute_path.ts index 54d7e950834a4..0057263660b77 100644 --- a/src/dev/typescript/get_ts_project_for_absolute_path.ts +++ b/src/dev/typescript/get_ts_project_for_absolute_path.ts @@ -18,7 +18,7 @@ */ import { relative, resolve } from 'path'; -import { REPO_ROOT } from '../constants'; +import { REPO_ROOT } from '@kbn/utils'; import { File } from '../file'; import { Project } from './project'; import { PROJECTS } from './projects'; diff --git a/src/dev/typescript/project.ts b/src/dev/typescript/project.ts index 4cf87d812a0b3..811c1792f1988 100644 --- a/src/dev/typescript/project.ts +++ b/src/dev/typescript/project.ts @@ -23,7 +23,7 @@ import { basename, dirname, relative, resolve } from 'path'; import { IMinimatch, Minimatch } from 'minimatch'; import { parseConfigFileTextToJson } from 'typescript'; -import { REPO_ROOT } from '../constants'; +import { REPO_ROOT } from '@kbn/utils'; function makeMatchers(directory: string, patterns: string[]) { return patterns.map( diff --git a/src/dev/typescript/projects.ts b/src/dev/typescript/projects.ts index e18c82b5b9e96..a1a94b668173d 100644 --- a/src/dev/typescript/projects.ts +++ b/src/dev/typescript/projects.ts @@ -19,7 +19,7 @@ import glob from 'glob'; import { resolve } from 'path'; -import { REPO_ROOT } from '../constants'; +import { REPO_ROOT } from '@kbn/utils'; import { Project } from './project'; export const PROJECTS = [ diff --git a/src/dev/typescript/run_check_ts_projects_cli.ts b/src/dev/typescript/run_check_ts_projects_cli.ts index b0c125ea47829..a095bef047711 100644 --- a/src/dev/typescript/run_check_ts_projects_cli.ts +++ b/src/dev/typescript/run_check_ts_projects_cli.ts @@ -22,8 +22,8 @@ import { resolve } from 'path'; import execa from 'execa'; import { run } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; -const REPO_ROOT = resolve(__dirname, '../../../'); import { File } from '../file'; import { PROJECTS } from './projects'; diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md index ac37512927c9e..5fa9821ef7ea5 100644 --- a/src/plugins/data/server/server.api.md +++ b/src/plugins/data/server/server.api.md @@ -117,6 +117,7 @@ import { NodesHotThreadsParams } from 'elasticsearch'; import { NodesInfoParams } from 'elasticsearch'; import { NodesStatsParams } from 'elasticsearch'; import { Observable } from 'rxjs'; +import { PathConfigType } from '@kbn/utils'; import { PingParams } from 'elasticsearch'; import { Plugin as Plugin_2 } from 'src/core/server'; import { PluginInitializerContext as PluginInitializerContext_2 } from 'src/core/server'; diff --git a/src/plugins/telemetry/server/config.ts b/src/plugins/telemetry/server/config.ts index ae9b70bb9f367..f547bf55091a7 100644 --- a/src/plugins/telemetry/server/config.ts +++ b/src/plugins/telemetry/server/config.ts @@ -18,8 +18,7 @@ */ import { schema, TypeOf } from '@kbn/config-schema'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { getConfigPath } from '../../../core/server/path'; +import { getConfigPath } from '@kbn/utils'; import { ENDPOINT_VERSION } from '../common/constants'; export const configSchema = schema.object({ diff --git a/test/functional/services/remote/webdriver.ts b/test/functional/services/remote/webdriver.ts index b00b7bb5bf971..2999197a9faa3 100644 --- a/test/functional/services/remote/webdriver.ts +++ b/test/functional/services/remote/webdriver.ts @@ -37,7 +37,7 @@ import { Executor } from 'selenium-webdriver/lib/http'; import { getLogger } from 'selenium-webdriver/lib/logging'; import { installDriver } from 'ms-chromium-edge-driver'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { pollForLogEntry$ } from './poll_for_log_entry'; import { createStdoutSocket } from './create_stdout_stream'; import { preventParallelCalls } from './prevent_parallel_calls'; diff --git a/x-pack/plugins/canvas/server/routes/shareables/download.test.ts b/x-pack/plugins/canvas/server/routes/shareables/download.test.ts index 1edf9f52e164a..8c0203eaf1042 100644 --- a/x-pack/plugins/canvas/server/routes/shareables/download.test.ts +++ b/x-pack/plugins/canvas/server/routes/shareables/download.test.ts @@ -4,9 +4,10 @@ * you may not use this file except in compliance with the Elastic License. */ -jest.mock('fs'); - import fs from 'fs'; +import { when } from 'jest-when'; +import { SHAREABLE_RUNTIME_FILE } from '../../../shareable_runtime/constants'; + import { kibanaResponseFactory, RequestHandlerContext, RequestHandler } from 'src/core/server'; import { httpServerMock } from 'src/core/server/mocks'; import { initializeDownloadShareableWorkpadRoute } from './download'; @@ -14,7 +15,6 @@ import { getMockedRouterDeps } from '../test_helpers'; const mockRouteContext = {} as RequestHandlerContext; const path = `api/canvas/workpad/find`; -const mockRuntime = 'Canvas shareable runtime'; describe('Download Canvas shareables runtime', () => { let routeHandler: RequestHandler; @@ -31,17 +31,18 @@ describe('Download Canvas shareables runtime', () => { }); it(`returns 200 with canvas shareables runtime`, async () => { + const content = 'Canvas shareable runtime'; + const spy = jest.spyOn(fs, 'readFileSync').mockImplementation(); + when(spy).calledWith(SHAREABLE_RUNTIME_FILE).mockReturnValue(content); + const request = httpServerMock.createKibanaRequest({ method: 'get', path, }); - const readFileSyncMock = fs.readFileSync as jest.Mock; - readFileSyncMock.mockReturnValueOnce(mockRuntime); - const response = await routeHandler(mockRouteContext, request, kibanaResponseFactory); expect(response.status).toBe(200); - expect(response.payload).toMatchInlineSnapshot(`"Canvas shareable runtime"`); + expect(response.payload).toMatchInlineSnapshot(`"${content}"`); }); }); diff --git a/x-pack/plugins/canvas/server/routes/shareables/mock_shareable_workpad.json b/x-pack/plugins/canvas/server/routes/shareables/mock_shareable_workpad.json deleted file mode 100644 index e69de29bb2d1d..0000000000000 diff --git a/x-pack/plugins/monitoring/server/config.test.ts b/x-pack/plugins/monitoring/server/config.test.ts index 44f1826cde4c6..56e744c3b703a 100644 --- a/x-pack/plugins/monitoring/server/config.test.ts +++ b/x-pack/plugins/monitoring/server/config.test.ts @@ -3,14 +3,22 @@ * or more contributor license agreements. Licensed under the Elastic License; * you may not use this file except in compliance with the Elastic License. */ + +import fs from 'fs'; +import { when } from 'jest-when'; + import { createConfig, configSchema } from './config'; -jest.mock('fs', () => { - const original = jest.requireActual('fs'); - return { - ...original, - readFileSync: jest.fn().mockImplementation((path: string) => `contents-of-${path}`), - }; +const MOCKED_PATHS = [ + '/proc/self/cgroup', + 'packages/kbn-dev-utils/certs/ca.crt', + 'packages/kbn-dev-utils/certs/elasticsearch.crt', + 'packages/kbn-dev-utils/certs/elasticsearch.key', +]; + +beforeEach(() => { + const spy = jest.spyOn(fs, 'readFileSync').mockImplementation(); + MOCKED_PATHS.forEach((file) => when(spy).calledWith(file).mockReturnValue(`contents-of-${file}`)); }); describe('config schema', () => { diff --git a/x-pack/tasks/build.ts b/x-pack/tasks/build.ts index 085f63206507f..41bf9587cad1e 100644 --- a/x-pack/tasks/build.ts +++ b/x-pack/tasks/build.ts @@ -10,7 +10,8 @@ import { writeFileSync } from 'fs'; import { promisify } from 'util'; import { pipeline } from 'stream'; -import { ToolingLog, REPO_ROOT, transformFileStream, transformFileWithBabel } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; +import { ToolingLog, transformFileStream, transformFileWithBabel } from '@kbn/dev-utils'; import gulp from 'gulp'; import del from 'del'; import fancyLog from 'fancy-log'; diff --git a/x-pack/test/functional/apps/dashboard/reporting/download_csv.ts b/x-pack/test/functional/apps/dashboard/reporting/download_csv.ts index 5c41945cb88d8..87f94855672a9 100644 --- a/x-pack/test/functional/apps/dashboard/reporting/download_csv.ts +++ b/x-pack/test/functional/apps/dashboard/reporting/download_csv.ts @@ -4,7 +4,7 @@ * you may not use this file except in compliance with the Elastic License. */ -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import expect from '@kbn/expect'; import fs from 'fs'; import path from 'path'; diff --git a/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts b/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts index 590ef6325dd51..c1a518507ec37 100644 --- a/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts +++ b/x-pack/test/reporting_api_integration/reporting_and_security/constants.ts @@ -4,7 +4,7 @@ * you may not use this file except in compliance with the Elastic License. */ -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import path from 'path'; export const OSS_KIBANA_ARCHIVE_PATH = path.resolve( diff --git a/x-pack/test/saved_object_api_integration/common/config.ts b/x-pack/test/saved_object_api_integration/common/config.ts index 61884f521cfaf..32ece6aa6437a 100644 --- a/x-pack/test/saved_object_api_integration/common/config.ts +++ b/x-pack/test/saved_object_api_integration/common/config.ts @@ -6,7 +6,7 @@ import path from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { FtrConfigProviderContext } from '@kbn/test/types/ftr'; import { services } from './services'; diff --git a/x-pack/test/spaces_api_integration/common/config.ts b/x-pack/test/spaces_api_integration/common/config.ts index 89fa07566ecba..b1da9931f3c9b 100644 --- a/x-pack/test/spaces_api_integration/common/config.ts +++ b/x-pack/test/spaces_api_integration/common/config.ts @@ -6,7 +6,7 @@ import path from 'path'; -import { REPO_ROOT } from '@kbn/dev-utils'; +import { REPO_ROOT } from '@kbn/utils'; import { TestInvoker } from './lib/types'; // @ts-ignore diff --git a/yarn.lock b/yarn.lock index cf84f91775cd6..92072225f7145 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4044,6 +4044,13 @@ dependencies: "@types/jest" "*" +"@types/jest-when@^2.7.1": + version "2.7.1" + resolved "https://registry.yarnpkg.com/@types/jest-when/-/jest-when-2.7.1.tgz#0b04a33a48a17370c390e9830a975822b3ac5e32" + integrity sha512-PRrGzDkU859cdkFL2KwWN4fRLRDGIUkRNT0StbthhKmj+naU4wImpoJeMnhjprvSou4pKAzU0dKfdQvjceJVhg== + dependencies: + "@types/jest" "*" + "@types/jest@*", "@types/jest@^25.2.3": version "25.2.3" resolved "https://registry.yarnpkg.com/@types/jest/-/jest-25.2.3.tgz#33d27e4c4716caae4eced355097a47ad363fdcaf" @@ -7833,6 +7840,16 @@ builtin-status-codes@^3.0.0: resolved "https://registry.yarnpkg.com/builtin-status-codes/-/builtin-status-codes-3.0.0.tgz#85982878e21b98e1c66425e03d0174788f569ee8" integrity sha1-hZgoeOIbmOHGZCXgPQF0eI9Wnug= +bunyan@^1.8.12: + version "1.8.14" + resolved "https://registry.yarnpkg.com/bunyan/-/bunyan-1.8.14.tgz#3d8c1afea7de158a5238c7cb8a66ab6b38dd45b4" + integrity sha512-LlahJUxXzZLuw/hetUQJmRgZ1LF6+cr5TPpRj6jf327AsiIq2jhYEH4oqUUkVKTor+9w2BT3oxVwhzE5lw9tcg== + optionalDependencies: + dtrace-provider "~0.8" + moment "^2.19.3" + mv "~2" + safe-json-stringify "~1" + bytes@1: version "1.0.0" resolved "https://registry.yarnpkg.com/bytes/-/bytes-1.0.0.tgz#3569ede8ba34315fab99c3e92cb04c7220de1fa8" @@ -11156,6 +11173,13 @@ dragselect@1.13.1: resolved "https://registry.yarnpkg.com/dragselect/-/dragselect-1.13.1.tgz#aa4166e1164b51ed5ee0cd89e0c5310a9c35be6a" integrity sha512-spfUz6/sNnlY4fF/OxPBwaKLa5hVz6V+fq5XhVuD+h47RAkA75TMkfvr4AoWUh5Ufq3V1oIAbfu+sjc9QbewoA== +dtrace-provider@~0.8: + version "0.8.8" + resolved "https://registry.yarnpkg.com/dtrace-provider/-/dtrace-provider-0.8.8.tgz#2996d5490c37e1347be263b423ed7b297fb0d97e" + integrity sha512-b7Z7cNtHPhH9EJhNNbbeqTcXB8LGFFZhq1PGgEvpeHlzd36bhbdTWoE/Ba/YguqpBSlAPKnARWhVlhunCMwfxg== + dependencies: + nan "^2.14.0" + duplexer2@^0.1.4, duplexer2@~0.1.4: version "0.1.4" resolved "https://registry.yarnpkg.com/duplexer2/-/duplexer2-0.1.4.tgz#8b12dab878c0d69e3e7891051662a32fc6bddcc1" @@ -12479,7 +12503,7 @@ expect.js@~0.2.0: resolved "https://registry.yarnpkg.com/expect.js/-/expect.js-0.2.0.tgz#1028533d2c1c363f74a6796ff57ec0520ded2be1" integrity sha1-EChTPSwcNj90pnlv9X7AUg3tK+E= -expect@^24.9.0: +expect@^24.8.0, expect@^24.9.0: version "24.9.0" resolved "https://registry.yarnpkg.com/expect/-/expect-24.9.0.tgz#b75165b4817074fa4a157794f46fe9f1ba15b6ca" integrity sha512-wvVAx8XIol3Z5m9zvZXiyZOQ+sRJqNTIm6sGjdWlaZIeupQGO3WbYI+15D/AmEwZywL6wtJkbAbJtzkOfBuR0Q== @@ -17726,6 +17750,14 @@ jest-watcher@^25.5.0: jest-util "^25.5.0" string-length "^3.1.0" +jest-when@^2.7.2: + version "2.7.2" + resolved "https://registry.yarnpkg.com/jest-when/-/jest-when-2.7.2.tgz#b7b4225e8882bd84a1cfd09216b2c63d22f892bd" + integrity sha512-GuVzimG0wW18A5JlYwhHrvuwmWRAQpsnilRVdJktvrZX5V0++al1f/iwITE7+Cud8Rbw/U2eka4tyy7kvxIWnw== + dependencies: + bunyan "^1.8.12" + expect "^24.8.0" + jest-worker@^24.9.0: version "24.9.0" resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-24.9.0.tgz#5dbfdb5b2d322e98567898238a9697bcce67b3e5" @@ -20215,7 +20247,7 @@ moment-timezone@^0.5.27: resolved "https://registry.yarnpkg.com/moment/-/moment-2.24.0.tgz#0d055d53f5052aa653c9f6eb68bb5d12bf5c2b5b" integrity sha512-bV7f+6l2QigeBBZSM/6yTNq4P2fNpSWj/0e7jQcy87A8e7o2nAfP/34/2ky5Vw4B9S446EtIhodAzkFCcR4dQg== -moment@^2.27.0: +moment@^2.19.3, moment@^2.27.0: version "2.27.0" resolved "https://registry.yarnpkg.com/moment/-/moment-2.27.0.tgz#8bff4e3e26a236220dfe3e36de756b6ebaa0105d" integrity sha512-al0MUK7cpIcglMv3YF13qSgdAIqxHTO7brRtaz3DlSULbqfazqkc5kEjNrLDOM7fsjshoFIihnU8snrP7zUvhQ== @@ -20375,6 +20407,15 @@ mute-stream@0.0.8: resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.8.tgz#1630c42b2251ff81e2a283de96a5497ea92e5e0d" integrity sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA== +mv@~2: + version "2.1.1" + resolved "https://registry.yarnpkg.com/mv/-/mv-2.1.1.tgz#ae6ce0d6f6d5e0a4f7d893798d03c1ea9559b6a2" + integrity sha1-rmzg1vbV4KT32JN5jQPB6pVZtqI= + dependencies: + mkdirp "~0.5.1" + ncp "~2.0.0" + rimraf "~2.4.0" + nan@^2.12.1, nan@^2.13.2: version "2.14.0" resolved "https://registry.yarnpkg.com/nan/-/nan-2.14.0.tgz#7818f722027b2459a86f0295d434d1fc2336c52c" @@ -20429,7 +20470,7 @@ natural-compare@^1.4.0: resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" integrity sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc= -ncp@^2.0.0: +ncp@^2.0.0, ncp@~2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/ncp/-/ncp-2.0.0.tgz#195a21d6c46e361d2fb1281ba38b91e9df7bdbb3" integrity sha1-GVoh1sRuNh0vsSgbo4uR6d9727M= @@ -25223,6 +25264,13 @@ rimraf@~2.0.2: optionalDependencies: graceful-fs "~1.1" +rimraf@~2.4.0: + version "2.4.5" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.4.5.tgz#ee710ce5d93a8fdb856fb5ea8ff0e2d75934b2da" + integrity sha1-7nEM5dk6j9uFb7Xqj/Di11k0sto= + dependencies: + glob "^6.0.1" + ripemd160@^2.0.0, ripemd160@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/ripemd160/-/ripemd160-2.0.1.tgz#0f4584295c53a3628af7e6d79aca21ce57d1c6e7" @@ -25391,7 +25439,7 @@ safe-json-parse@~1.0.1: resolved "https://registry.yarnpkg.com/safe-json-parse/-/safe-json-parse-1.0.1.tgz#3e76723e38dfdda13c9b1d29a1e07ffee4b30b57" integrity sha1-PnZyPjjf3aE8mx0poeB//uSzC1c= -safe-json-stringify@^1.2.0: +safe-json-stringify@^1.2.0, safe-json-stringify@~1: version "1.2.0" resolved "https://registry.yarnpkg.com/safe-json-stringify/-/safe-json-stringify-1.2.0.tgz#356e44bc98f1f93ce45df14bcd7c01cda86e0afd" integrity sha512-gH8eh2nZudPQO6TytOvbxnuhYBOvDBBLW52tz5q6X58lJcd/tkmqFR+5Z9adS8aJtURSXWThWy/xJtJwixErvg==