Skip to content

[Fleet] Add support for select type in integrations #152550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jillguyonnet merged 14 commits into from
Mar 9, 2023
Merged

[Fleet] Add support for select type in integrations #152550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
798f4d5
[Fleet] Add support for select type in integrations
jillguyonnet Mar 2, 2023
1aac360
Fix linting issues
jillguyonnet Mar 2, 2023
3c9e055
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
kibanamachine Mar 2, 2023
1f53fa2
Add options property to registry vars
jillguyonnet Mar 8, 2023
b2d5fce
Use options category
jillguyonnet Mar 8, 2023
d61c937
Fix linting error
jillguyonnet Mar 8, 2023
a586480
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
kibanamachine Mar 8, 2023
6ba4907
Make options optional
jillguyonnet Mar 8, 2023
717baae
Add validation test cases
jillguyonnet Mar 8, 2023
647aad0
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
kibanamachine Mar 8, 2023
3f03a3f
Add validation unit test
jillguyonnet Mar 8, 2023
116185e
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
kibanamachine Mar 8, 2023
df3ec99
Amend validation
jillguyonnet Mar 8, 2023
3f950b7
[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…
kibanamachine Mar 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions x-pack/plugins/fleet/common/services/validate_package_policy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -945,4 +945,69 @@ describe('Fleet - validatePackagePolicyConfig', () => {
expect(res).toBeNull();
});
});

describe('Select', () => {
it('should return an error message if the value is not an option value', () => {
const res = validatePackagePolicyConfig(
{
type: 'select',
value: 'c',
},
{
name: 'myvariable',
type: 'select',
options: [
{ value: 'a', text: 'A' },
{ value: 'b', text: 'B' },
],
},
'myvariable',
safeLoad
);

expect(res).toEqual(['Invalid value for select type']);
});

it('should accept a select with a valid value', () => {
const res = validatePackagePolicyConfig(
{
type: 'select',
value: 'b',
},
{
name: 'myvariable',
type: 'select',
options: [
{ value: 'a', text: 'A' },
{ value: 'b', text: 'B' },
],
},
'myvariable',
safeLoad
);

expect(res).toBeNull();
});

it('should accept a select with undefined value', () => {
const res = validatePackagePolicyConfig(
{
type: 'select',
value: undefined,
},
{
name: 'myvariable',
type: 'select',
options: [
{ value: 'a', text: 'A' },
{ value: 'b', text: 'B' },
],
},
'myvariable',
safeLoad
);

expect(res).toBeNull();
});
});
});
10 changes: 10 additions & 0 deletions x-pack/plugins/fleet/common/services/validate_package_policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,16 @@ export const validatePackagePolicyConfig = (
}
}

if (varDef.type === 'select' && parsedValue) {
if (!varDef.options?.map((o) => o.value).includes(parsedValue)) {
errors.push(
i18n.translate('xpack.fleet.packagePolicyValidation.invalidSelectValueErrorMessage', {
defaultMessage: 'Invalid value for select type',
})
);
}
}

return errors.length ? errors : null;
};

Expand Down
3 changes: 3 additions & 0 deletions x-pack/plugins/fleet/common/types/models/epm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,7 @@ export type RegistryVarType =
| 'integer'
| 'bool'
| 'password'
| 'select'
| 'text'
| 'yaml'
| 'string'
Expand All @@ -390,6 +391,7 @@ export enum RegistryVarsEntryKeys {
required = 'required',
show_user = 'show_user',
multi = 'multi',
options = 'options',
default = 'default',
os = 'os',
}
Expand All @@ -405,6 +407,7 @@ export interface RegistryVarsEntry {
[RegistryVarsEntryKeys.required]?: boolean;
[RegistryVarsEntryKeys.show_user]?: boolean;
[RegistryVarsEntryKeys.multi]?: boolean;
[RegistryVarsEntryKeys.options]?: Array<{ value: string; text: string }>;
[RegistryVarsEntryKeys.default]?: string | string[] | boolean;
[RegistryVarsEntryKeys.os]?: {
[key: string]: {
Expand Down
8 changes: 7 additions & 1 deletion ...create_package_policy_page/components/steps/components/package_policy_input_var_field.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
EuiFieldPassword,
EuiCodeBlock,
EuiTextArea,
EuiSelect,
} from '@elastic/eui';
import styled from 'styled-components';

Expand Down Expand Up @@ -58,7 +59,7 @@ export const PackagePolicyInputVarField: React.FunctionComponent<{
isEditPage = false,
}) => {
const [isDirty, setIsDirty] = useState<boolean>(false);
const { multi, required, type, title, name, description } = varDef;
const { multi, required, type, title, name, description, options } = varDef;
const isInvalid = (isDirty || forceShowErrors) && !!varErrors;
const errors = isInvalid ? varErrors : null;
const fieldLabel = title || name;
Expand Down Expand Up @@ -154,6 +155,10 @@ export const PackagePolicyInputVarField: React.FunctionComponent<{
disabled={frozen}
/>
);
case 'select':
return (
<EuiSelect options={options} value={value} onChange={(e) => onChange(e.target.value)} />
);
default:
return (
<EuiFieldText
Expand All @@ -178,6 +183,7 @@ export const PackagePolicyInputVarField: React.FunctionComponent<{
isEditPage,
isInvalid,
fieldLabel,
options,
Copy link
Copy Markdown
Member Author

@jillguyonnet jillguyonnet Mar 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was suspicious about memoizing an array since it would be compared by reference, but I'm not sure at all if that could be an issue in this case. I didn't see any strangeness with local testing. Does anyone know?

]);

// Boolean cannot be optional by default set to false
Expand Down