Custom path for data directory configuration is ignored (#157659)

Fixes #142865 ## Summary The user can set a path for local data storage through CLI or `kibana.yml`, but this setting was not implemented and the default `data` directory was being used. There are a few instances of hard coded `data/xxx` paths in the codebase for babel, ci and testing which are not applicable to production. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <[email protected]>
elastic · May 17, 2023 · 8338289 · 8338289
1 parent 14c8acc
commit 8338289
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 10 deletions.
diff --git a/packages/kbn-utils/src/path/__fixtures__/kibana.yml b/packages/kbn-utils/src/path/__fixtures__/kibana.yml
@@ -0,0 +1 @@
+path.data: /path/from/yml
diff --git a/packages/kbn-utils/src/path/index.test.ts b/packages/kbn-utils/src/path/index.test.ts
@@ -6,8 +6,9 @@
  * Side Public License, v 1.
  */
 
+import { join } from 'path';
 import { accessSync, constants } from 'fs';
-import { getConfigPath, getDataPath, getLogsPath, getConfigDirectory } from '.';
+import { getConfigPath, getDataPath, getLogsPath, getConfigDirectory, buildDataPaths } from '.';
 import { REPO_ROOT } from '@kbn/repo-info';
 
 expect.addSnapshotSerializer(
@@ -46,3 +47,52 @@ describe('Default path finder', () => {
     expect(() => accessSync(configPath, constants.R_OK)).not.toThrow();
   });
 });
+
+describe('Custom data path finder', () => {
+  const originalArgv = process.argv;
+
+  beforeEach(() => {
+    process.argv = originalArgv;
+  });
+
+  it('overrides path.data when provided as command line argument', () => {
+    process.argv = ['--foo', 'bar', '--path.data', '/some/data/path', '--baz', 'xyz'];
+
+    /*
+     * Test buildDataPaths since getDataPath returns the first valid directory and
+     * custom paths do not exist in environment. Custom directories are built during env init.
+     */
+    expect(buildDataPaths()).toMatchInlineSnapshot(`
+      Array [
+        <absolute path>/some/data/path,
+        <absolute path>/data,
+        "/var/lib/kibana",
+      ]
+    `);
+  });
+
+  it('ignores the path.data flag when no value is provided', () => {
+    process.argv = ['--foo', 'bar', '--path.data', '--baz', 'xyz'];
+
+    expect(buildDataPaths()).toMatchInlineSnapshot(`
+      Array [
+        <absolute path>/data,
+        "/var/lib/kibana",
+      ]
+    `);
+  });
+
+  it('overrides path.when when provided by kibana.yml', () => {
+    process.env.KBN_PATH_CONF = join(__dirname, '__fixtures__');
+
+    expect(buildDataPaths()).toMatchInlineSnapshot(`
+      Array [
+        <absolute path>/path/from/yml,
+        <absolute path>/data,
+        "/var/lib/kibana",
+      ]
+    `);
+
+    delete process.env.KBN_PATH_CONF;
+  });
+});
diff --git a/packages/kbn-utils/src/path/index.ts b/packages/kbn-utils/src/path/index.ts
@@ -10,23 +10,25 @@ import { join } from 'path';
 import { accessSync, constants } from 'fs';
 import { TypeOf, schema } from '@kbn/config-schema';
 import { REPO_ROOT } from '@kbn/repo-info';
+import { getConfigFromFiles } from '@kbn/config';
+import getopts from 'getopts';
 
 const isString = (v: any): v is string => typeof v === 'string';
 
-const CONFIG_PATHS = [
-  process.env.KBN_PATH_CONF && join(process.env.KBN_PATH_CONF, 'kibana.yml'),
-  join(REPO_ROOT, 'config/kibana.yml'),
-  '/etc/kibana/kibana.yml',
-].filter(isString);
+const buildConfigPaths = () => {
+  return [
+    process.env.KBN_PATH_CONF && join(process.env.KBN_PATH_CONF, 'kibana.yml'),
+    join(REPO_ROOT, 'config/kibana.yml'),
+    '/etc/kibana/kibana.yml',
+  ].filter(isString);
+};
 
 const CONFIG_DIRECTORIES = [
   process.env.KBN_PATH_CONF,
   join(REPO_ROOT, 'config'),
   '/etc/kibana',
 ].filter(isString);
 
-const DATA_PATHS = [join(REPO_ROOT, 'data'), '/var/lib/kibana'].filter(isString);
-
 const LOGS_PATHS = [join(REPO_ROOT, 'logs'), '/var/log/kibana'].filter(isString);
 
 function findFile(paths: string[]) {
@@ -41,11 +43,29 @@ function findFile(paths: string[]) {
   return availablePath || paths[0];
 }
 
+export const buildDataPaths = (): string[] => {
+  const configDataPath = getConfigFromFiles([getConfigPath()]).path?.data;
+  const argv = process.argv.slice(2);
+  const options = getopts(argv, {
+    string: ['pathData'],
+    alias: {
+      pathData: 'path.data',
+    },
+  });
+
+  return [
+    !!options.pathData && join(REPO_ROOT, options.pathData),
+    configDataPath && join(REPO_ROOT, configDataPath),
+    join(REPO_ROOT, 'data'),
+    '/var/lib/kibana',
+  ].filter(isString);
+};
+
 /**
  * Get the path of kibana.yml
  * @internal
  */
-export const getConfigPath = () => findFile(CONFIG_PATHS);
+export const getConfigPath = () => findFile(buildConfigPaths());
 
 /**
  * Get the directory containing configuration files
@@ -57,7 +77,7 @@ export const getConfigDirectory = () => findFile(CONFIG_DIRECTORIES);
  * Get the directory containing runtime data
  * @internal
  */
-export const getDataPath = () => findFile(DATA_PATHS);
+export const getDataPath = () => findFile(buildDataPaths());
 
 /**
  * Get the directory containing logs

diff --git a/packages/kbn-utils/tsconfig.json b/packages/kbn-utils/tsconfig.json
@@ -13,6 +13,7 @@
   "kbn_references": [
     "@kbn/config-schema",
     "@kbn/repo-info",
+    "@kbn/config",
   ],
   "exclude": [
     "target/**/*",