[Ingest] Support show_user package registry flag (#60338) (#60419)

* Support registry `show_user` var definition property (elastic/package-registry#266) * Add tests Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
elastic · Mar 17, 2020 · ed9a1f1 · ed9a1f1
1 parent 9c47579
commit ed9a1f1
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 6 deletions.
diff --git a/x-pack/plugins/ingest_manager/common/types/models/epm.ts b/x-pack/plugins/ingest_manager/common/types/models/epm.ts
@@ -186,6 +186,7 @@ export interface RegistryVarsEntry {
   description?: string;
   type: string;
   required?: boolean;
+  show_user?: boolean;
   multi?: boolean;
   default?: string | string[];
   os?: {

diff --git a/...nager/sections/agent_config/create_datasource_page/components/datasource_input_config.tsx b/...nager/sections/agent_config/create_datasource_page/components/datasource_input_config.tsx
@@ -15,6 +15,7 @@ import {
   EuiTitle,
 } from '@elastic/eui';
 import { DatasourceInput, RegistryVarsEntry } from '../../../../types';
+import { isAdvancedVar } from '../services';
 import { DatasourceInputVarField } from './datasource_input_var_field';
 
 export const DatasourceInputConfig: React.FunctionComponent<{
@@ -30,10 +31,10 @@ export const DatasourceInputConfig: React.FunctionComponent<{
 
   if (packageInputVars) {
     packageInputVars.forEach(varDef => {
-      if (varDef.required && !varDef.default) {
-        requiredVars.push(varDef);
-      } else {
+      if (isAdvancedVar(varDef)) {
         advancedVars.push(varDef);
+      } else {
+        requiredVars.push(varDef);
       }
     });
   }

diff --git a/...ections/agent_config/create_datasource_page/components/datasource_input_stream_config.tsx b/...ections/agent_config/create_datasource_page/components/datasource_input_stream_config.tsx
@@ -16,6 +16,7 @@ import {
   EuiButtonEmpty,
 } from '@elastic/eui';
 import { DatasourceInputStream, RegistryStream, RegistryVarsEntry } from '../../../../types';
+import { isAdvancedVar } from '../services';
 import { DatasourceInputVarField } from './datasource_input_var_field';
 
 export const DatasourceInputStreamConfig: React.FunctionComponent<{
@@ -31,10 +32,10 @@ export const DatasourceInputStreamConfig: React.FunctionComponent<{
 
   if (packageInputStream.vars && packageInputStream.vars.length) {
     packageInputStream.vars.forEach(varDef => {
-      if (varDef.required && !varDef.default) {
-        requiredVars.push(varDef);
-      } else {
+      if (isAdvancedVar(varDef)) {
         advancedVars.push(varDef);
+      } else {
+        requiredVars.push(varDef);
       }
     });
   }

diff --git a/...pplications/ingest_manager/sections/agent_config/create_datasource_page/services/index.ts b/...pplications/ingest_manager/sections/agent_config/create_datasource_page/services/index.ts
@@ -0,0 +1,6 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+export { isAdvancedVar } from './is_advanced_var';
diff --git a/...est_manager/sections/agent_config/create_datasource_page/services/is_advanced_var.test.ts b/...est_manager/sections/agent_config/create_datasource_page/services/is_advanced_var.test.ts
@@ -0,0 +1,62 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { isAdvancedVar } from './is_advanced_var';
+
+describe('Ingest Manager - isAdvancedVar', () => {
+  it('returns true for vars that should be show under advanced options', () => {
+    expect(
+      isAdvancedVar({
+        name: 'mock_var',
+        type: 'text',
+        required: true,
+        default: 'default string',
+      })
+    ).toBe(true);
+
+    expect(
+      isAdvancedVar({
+        name: 'mock_var',
+        type: 'text',
+        default: 'default string',
+      })
+    ).toBe(true);
+
+    expect(
+      isAdvancedVar({
+        name: 'mock_var',
+        type: 'text',
+      })
+    ).toBe(true);
+  });
+
+  it('returns false for vars that should be show by default', () => {
+    expect(
+      isAdvancedVar({
+        name: 'mock_var',
+        type: 'text',
+        required: true,
+        default: 'default string',
+        show_user: true,
+      })
+    ).toBe(false);
+
+    expect(
+      isAdvancedVar({
+        name: 'mock_var',
+        type: 'text',
+        required: true,
+      })
+    ).toBe(false);
+
+    expect(
+      isAdvancedVar({
+        name: 'mock_var',
+        type: 'text',
+        show_user: true,
+      })
+    ).toBe(false);
+  });
+});
diff --git a/...s/ingest_manager/sections/agent_config/create_datasource_page/services/is_advanced_var.ts b/...s/ingest_manager/sections/agent_config/create_datasource_page/services/is_advanced_var.ts
@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { RegistryVarsEntry } from '../../../../types';
+
+export const isAdvancedVar = (varDef: RegistryVarsEntry): boolean => {
+  if (varDef.show_user || (varDef.required && !varDef.default)) {
+    return false;
+  }
+  return true;
+};