Skip to content
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.

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

[Fleet] Filter integrations/packages list shown depending on the policy_templates_behavior field #200605

Merged
merged 6 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions x-pack/plugins/fleet/common/services/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export {
isIntegrationPolicyTemplate,
getNormalizedInputs,
getNormalizedDataStreams,
filterPolicyTemplatesTiles,
} from './policy_template';
export { doesPackageHaveIntegrations } from './packages_with_integrations';
export type {
Expand Down
124 changes: 124 additions & 0 deletions x-pack/plugins/fleet/common/services/policy_template.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ import type {
RegistryPolicyIntegrationTemplate,
PackageInfo,
RegistryVarType,
PackageListItem,
} from '../types';

import {
isInputOnlyPolicyTemplate,
isIntegrationPolicyTemplate,
getNormalizedInputs,
getNormalizedDataStreams,
filterPolicyTemplatesTiles,
} from './policy_template';

describe('isInputOnlyPolicyTemplate', () => {
Expand Down Expand Up @@ -280,3 +282,125 @@ describe('getNormalizedDataStreams', () => {
expect(result?.[0].streams?.[0]?.vars).toEqual([datasetVar]);
});
});

describe('filterPolicyTemplatesTiles', () => {
const topPackagePolicy: PackageListItem = {
id: 'nginx',
integration: 'nginx',
title: 'Nginx',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
};

const childPolicyTemplates: PackageListItem[] = [
{
id: 'nginx-template1',
integration: 'nginx-template-1',
title: 'Nginx Template 1',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
{
id: 'nginx-template2',
integration: 'nginx-template-2',
title: 'Nginx Template 2',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
];
it('should return all tiles as undefined value', () => {
expect(filterPolicyTemplatesTiles(undefined, topPackagePolicy, childPolicyTemplates)).toEqual([
{
id: 'nginx',
integration: 'nginx',
title: 'Nginx',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
{
id: 'nginx-template1',
integration: 'nginx-template-1',
title: 'Nginx Template 1',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
{
id: 'nginx-template2',
integration: 'nginx-template-2',
title: 'Nginx Template 2',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
]);
});
it('should return all tiles', () => {
expect(filterPolicyTemplatesTiles('all', topPackagePolicy, childPolicyTemplates)).toEqual([
{
id: 'nginx',
integration: 'nginx',
title: 'Nginx',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
{
id: 'nginx-template1',
integration: 'nginx-template-1',
title: 'Nginx Template 1',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
{
id: 'nginx-template2',
integration: 'nginx-template-2',
title: 'Nginx Template 2',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
]);
});
it('should return just the combined policy tile', () => {
expect(
filterPolicyTemplatesTiles('combined_policy', topPackagePolicy, childPolicyTemplates)
).toEqual([
{
id: 'nginx',
integration: 'nginx',
title: 'Nginx',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
]);
});
it('should return just the individual policies (tiles)', () => {
expect(
filterPolicyTemplatesTiles('individual_policies', topPackagePolicy, childPolicyTemplates)
).toEqual([
{
id: 'nginx-template1',
integration: 'nginx-template-1',
title: 'Nginx Template 1',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
{
id: 'nginx-template2',
integration: 'nginx-template-2',
title: 'Nginx Template 2',
name: 'nginx',
version: '0.0.1',
status: 'not_installed',
},
]);
});
});
25 changes: 25 additions & 0 deletions x-pack/plugins/fleet/common/services/policy_template.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export function packageHasNoPolicyTemplates(packageInfo: PackageInfo): boolean {
)
);
}

export function isInputOnlyPolicyTemplate(
policyTemplate: RegistryPolicyTemplate
): policyTemplate is RegistryPolicyInputOnlyTemplate {
Expand Down Expand Up @@ -142,3 +143,27 @@ const createDefaultDatasetName = (
packageInfo: { name: string },
policyTemplate: { name: string }
): string => packageInfo.name + '.' + policyTemplate.name;

export function filterPolicyTemplatesTiles<T>(
templatesBehavior: string | undefined,
packagePolicy: T,
packagePolicyTemplates: T[]
): T[] {
switch (templatesBehavior || 'all') {
case 'combined_policy':
return [packagePolicy];
case 'individual_policies':
return [
...(packagePolicyTemplates && packagePolicyTemplates.length > 1
? packagePolicyTemplates
: []),
];
default:
return [
packagePolicy,
...(packagePolicyTemplates && packagePolicyTemplates.length > 1
? packagePolicyTemplates
: []),
];
}
}
1 change: 1 addition & 0 deletions x-pack/plugins/fleet/common/types/models/epm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@ export type RegistrySearchResult = Pick<
| 'icons'
| 'internal'
| 'data_streams'
| 'policy_templates_behavior'
| 'policy_templates'
| 'categories'
>;
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/fleet/common/types/models/package_spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export interface PackageSpecManifest {
conditions?: PackageSpecConditions;
icons?: PackageSpecIcon[];
screenshots?: PackageSpecScreenshot[];
policy_templates_behavior?: 'all' | 'combined_policy' | 'individual_policies';
policy_templates?: RegistryPolicyTemplate[];
vars?: RegistryVarsEntry[];
owner: { github?: string; type?: 'elastic' | 'partner' | 'community' };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { doesPackageHaveIntegrations, ExperimentalFeaturesService } from '../../
import {
isInputOnlyPolicyTemplate,
isIntegrationPolicyTemplate,
filterPolicyTemplatesTiles,
} from '../../../../../../../../common/services';

import {
Expand Down Expand Up @@ -83,30 +84,33 @@ const packageListToIntegrationsList = (packages: PackageList): PackageList => {
categories: getAllCategoriesFromIntegrations(pkg),
};

return [
...acc,
const integrationsPolicyTemplates = doesPackageHaveIntegrations(pkg)
? policyTemplates.map((policyTemplate) => {
const { name, title, description, icons } = policyTemplate;

const categories =
isIntegrationPolicyTemplate(policyTemplate) && policyTemplate.categories
? policyTemplate.categories
: [];
const allCategories = [...topCategories, ...categories];
return {
...restOfPackage,
id: `${restOfPackage.id}-${name}`,
integration: name,
title,
description,
icons: icons || restOfPackage.icons,
categories: uniq(allCategories),
};
})
: [];

const tiles = filterPolicyTemplatesTiles<PackageListItem>(
pkg.policy_templates_behavior,
topPackage,
...(doesPackageHaveIntegrations(pkg)
? policyTemplates.map((policyTemplate) => {
const { name, title, description, icons } = policyTemplate;

const categories =
isIntegrationPolicyTemplate(policyTemplate) && policyTemplate.categories
? policyTemplate.categories
: [];
const allCategories = [...topCategories, ...categories];
return {
...restOfPackage,
id: `${restOfPackage.id}-${name}`,
integration: name,
title,
description,
icons: icons || restOfPackage.icons,
categories: uniq(allCategories),
};
})
: []),
];
integrationsPolicyTemplates
);
return [...acc, ...tiles];
}, []);
};

Expand Down
Loading
Loading