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

[Security Solution][Endpoint] changes to Endpoint metadata API in support of space awareness #193490

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
2ae90ab
update fleet services factory to initialize certain clients lazyly
paul-tavares Sep 19, 2024
9c2b48e
New saved objects factory service
paul-tavares Sep 19, 2024
d4c5bcd
Enhance Endpoint app context service to provide access to new SO clie…
paul-tavares Sep 19, 2024
f592bd2
Merge remote-tracking branch 'upstream/main' into task/olm-8538-endpo…
paul-tavares Sep 19, 2024
6e3792b
Add TODO reminders to delete old SO modules
paul-tavares Sep 19, 2024
29cf484
Refactor EndpointMetadataService construction arguments
paul-tavares Sep 19, 2024
2e82049
Refactor EndpointFleetServicesFactory constructor arguments to use ne…
paul-tavares Sep 19, 2024
e898fab
Refactor EndpointAppContextServices `.start()` contract
paul-tavares Sep 19, 2024
4888a03
Merge remote-tracking branch 'upstream/main' into task/olm-8538-endpo…
paul-tavares Sep 20, 2024
360e1ad
Update Fleet server mocks and add new one for FleetStartContract (plu…
paul-tavares Sep 20, 2024
11124e4
Update mocks for Endpoint App Context services
paul-tavares Sep 20, 2024
fe2644a
Refactor EndpointFleetServicesFactory and remove SO client property a…
paul-tavares Sep 20, 2024
d36cf23
Delete internal so client utilities (old)
paul-tavares Sep 20, 2024
a133744
Refactor Metadata service - move all dependencies to constructor and …
paul-tavares Sep 23, 2024
75ba84f
Improve mocks
paul-tavares Sep 23, 2024
096ef90
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Sep 23, 2024
e75e531
Merge remote-tracking branch 'upstream/main' into task/olm-8538-endpo…
paul-tavares Sep 23, 2024
f4a064a
Merge branch 'main' into task/olm-8538-endpoint-list-details-space-aware
paul-tavares Sep 24, 2024
3df719e
Merge remote-tracking branch 'origin/task/olm-8538-endpoint-list-deta…
paul-tavares Sep 24, 2024
f7c796b
Fix fleet mock
paul-tavares Sep 24, 2024
96f9149
Fix several tests and mocks
paul-tavares Sep 24, 2024
a5a3b60
Move fixes to tests and mocks due to refactor
paul-tavares Sep 25, 2024
e396381
Merge remote-tracking branch 'upstream/main' into task/olm-8538-endpo…
paul-tavares Sep 25, 2024
afc21ef
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Sep 25, 2024
2a55e44
Fix types in `cloud_defend`, `cloud_security_posture` and `observabil…
paul-tavares Sep 25, 2024
4f2f64f
Fix additional mocks in tests files
paul-tavares Sep 25, 2024
3e443f9
Merge remote-tracking branch 'origin/task/olm-8538-endpoint-list-deta…
paul-tavares Sep 25, 2024
3e418a8
adjust Cloud Defend and Cloud posture plugins use of fleet start cont…
paul-tavares Sep 25, 2024
a9bab9f
Merge remote-tracking branch 'upstream/main' into task/olm-8538-endpo…
paul-tavares Sep 25, 2024
7231903
[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'
kibanamachine Sep 25, 2024
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
4 changes: 1 addition & 3 deletions x-pack/plugins/cloud_defend/server/plugin.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,13 @@ const createMockFleetStartContract = (): DeeplyMockedKeys<FleetStartContract> =>
fromRequest: jest.fn(async (_) => createFleetAuthzMock()),
},
fleetSetupCompleted: jest.fn().mockResolvedValue(undefined),
// @ts-expect-error 2322
agentService: createMockAgentService(),
// @ts-expect-error 2322
packageService: createMockPackageService(),
agentPolicyService: createMockAgentPolicyService(),
registerExternalCallback: jest.fn((..._: ExternalCallback) => {}),
packagePolicyService: createPackagePolicyServiceMock(),
createArtifactsClient: jest.fn().mockReturnValue(createArtifactsClientMock()),
};
} as unknown as DeeplyMockedKeys<FleetStartContract>;
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we replace this createMockFleetStartContract with the newly created createFleetStartContractMock imported from fleet/server/mocks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback @opauloh . Just pushed the changes you suggested.

};

describe('Cloud Defend Plugin', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,13 @@ const createMockFleetStartContract = (): DeeplyMockedKeys<FleetStartContract> =>
fromRequest: jest.fn(async (_) => createFleetAuthzMock()),
},
fleetSetupCompleted: jest.fn().mockResolvedValue(undefined),
// @ts-expect-error 2322
agentService: createMockAgentService(),
// @ts-expect-error 2322
packageService: createMockPackageService(),
agentPolicyService: createMockAgentPolicyService(),
registerExternalCallback: jest.fn((..._: ExternalCallback) => {}),
packagePolicyService: createPackagePolicyServiceMock(),
createArtifactsClient: jest.fn().mockReturnValue(createArtifactsClientMock()),
};
} as unknown as DeeplyMockedKeys<FleetStartContract>;
Copy link
Contributor

Choose a reason for hiding this comment

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

Same question about importing the mock from the fleet

};

describe('Cloud Security Posture Plugin', () => {
Expand Down
40 changes: 37 additions & 3 deletions x-pack/plugins/fleet/server/mocks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,17 @@ import { cloudMock } from '@kbn/cloud-plugin/public/mocks';
import { SPACES_EXTENSION_ID } from '@kbn/core-saved-objects-server';
import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server';

import type { DeeplyMockedKeys } from '@kbn/utility-types-jest';

import { createFleetActionsClientMock } from '../services/actions/mocks';

import { createFleetFilesClientFactoryMock } from '../services/files/mocks';

import { createArtifactsClientMock } from '../services/artifacts/mocks';

import type { PackagePolicyClient } from '../services/package_policy_service';
import type { AgentPolicyServiceInterface } from '../services';
import type { FleetAppContext } from '../plugin';
import type { FleetAppContext, FleetStartContract } from '../plugin';
import { createMockTelemetryEventsSender } from '../telemetry/__mocks__';
import type { FleetConfigType } from '../../common/types';
import type { ExperimentalFeatures } from '../../common/experimental_features';
Expand All @@ -35,6 +43,8 @@ import { packageServiceMock } from '../services/epm/package_service.mock';
import type { UninstallTokenServiceInterface } from '../services/security/uninstall_token_service';
import type { MessageSigningServiceInterface } from '../services/security';

import { getPackageSpecTagId } from '../services/epm/kibana/assets/tag_assets';

import { PackagePolicyMocks } from './package_policy.mocks';

// Export all mocks from artifacts
Expand Down Expand Up @@ -238,7 +248,7 @@ export const createMockAgentClient = () => agentServiceMock.createClient();
*/
export const createMockPackageService = () => packageServiceMock.create();

export function createMessageSigningServiceMock(): MessageSigningServiceInterface {
export function createMessageSigningServiceMock(): jest.Mocked<MessageSigningServiceInterface> {
return {
isEncryptionAvailable: true,
generateKeyPair: jest.fn(),
Expand All @@ -253,7 +263,7 @@ export function createMessageSigningServiceMock(): MessageSigningServiceInterfac
};
}

export function createUninstallTokenServiceMock(): UninstallTokenServiceInterface {
export function createUninstallTokenServiceMock(): DeeplyMockedKeys<UninstallTokenServiceInterface> {
return {
getToken: jest.fn(),
getTokenMetadata: jest.fn(),
Expand All @@ -269,3 +279,27 @@ export function createUninstallTokenServiceMock(): UninstallTokenServiceInterfac
scoped: jest.fn().mockImplementation(() => createUninstallTokenServiceMock()),
};
}

export const createFleetStartContractMock = (): DeeplyMockedKeys<FleetStartContract> => {
const fleetAuthzMock = createFleetAuthzMock();
const fleetArtifactsClient = createArtifactsClientMock();
const fleetActionsClient = createFleetActionsClientMock();

const startContract: DeeplyMockedKeys<FleetStartContract> = {
fleetSetupCompleted: jest.fn(async () => {}),
authz: { fromRequest: jest.fn(async (_) => fleetAuthzMock) },
packageService: createMockPackageService(),
agentService: createMockAgentService(),
packagePolicyService: createPackagePolicyServiceMock(),
agentPolicyService: createMockAgentPolicyService(),
registerExternalCallback: jest.fn(),
createArtifactsClient: jest.fn((_) => fleetArtifactsClient),
createFilesClient: createFleetFilesClientFactoryMock(),
messageSigningService: createMessageSigningServiceMock(),
uninstallTokenService: createUninstallTokenServiceMock(),
createFleetActionsClient: jest.fn((_) => fleetActionsClient),
getPackageSpecTagId: jest.fn(getPackageSpecTagId),
};

return startContract;
};
10 changes: 8 additions & 2 deletions x-pack/plugins/fleet/server/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ import {
AGENT_POLICY_SAVED_OBJECT_TYPE,
LEGACY_AGENT_POLICY_SAVED_OBJECT_TYPE,
} from '../common/constants';

import { getFilesClientFactory } from './services/files/get_files_client_factory';

import type { MessageSigningServiceInterface } from './services/security';
Expand All @@ -98,7 +99,12 @@ import { registerEncryptedSavedObjects, registerSavedObjects } from './saved_obj
import { registerRoutes } from './routes';

import type { ExternalCallback, FleetRequestHandlerContext } from './types';
import type { AgentPolicyServiceInterface, AgentService, PackageService } from './services';
import type {
AgentPolicyServiceInterface,
AgentService,
ArtifactsClientInterface,
PackageService,
} from './services';
import {
agentPolicyService,
AgentServiceImpl,
Expand Down Expand Up @@ -236,7 +242,7 @@ export interface FleetStartContract {
* Create a Fleet Artifact Client instance
* @param packageName
*/
createArtifactsClient: (packageName: string) => FleetArtifactsClient;
createArtifactsClient: (packageName: string) => ArtifactsClientInterface;

/**
* Create a Fleet Files client instance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* 2.0.
*/

import type { DeeplyMockedKeys } from '@kbn/utility-types-jest';

import type { AgentClient, AgentService } from './agent_service';

const createClientMock = (): jest.Mocked<AgentClient> => ({
Expand All @@ -15,7 +17,7 @@ const createClientMock = (): jest.Mocked<AgentClient> => ({
getLatestAgentAvailableVersion: jest.fn(),
});

const createServiceMock = (): jest.Mocked<AgentService> => ({
const createServiceMock = (): DeeplyMockedKeys<AgentService> => ({
asInternalUser: createClientMock(),
asScoped: jest.fn().mockReturnValue(createClientMock()),
});
Expand Down
4 changes: 3 additions & 1 deletion x-pack/plugins/fleet/server/services/artifacts/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import { errors } from '@elastic/elasticsearch';
import { elasticsearchServiceMock } from '@kbn/core/server/mocks';
import type { SearchHit, ESSearchResponse } from '@kbn/es-types';

import type { DeeplyMockedKeys } from '@kbn/utility-types-jest';

import type {
Artifact,
ArtifactElasticsearchProperties,
Expand All @@ -20,7 +22,7 @@ import type {
} from './types';
import { newArtifactToElasticsearchProperties } from './mappings';

export const createArtifactsClientMock = (): jest.Mocked<ArtifactsClientInterface> => {
export const createArtifactsClientMock = (): DeeplyMockedKeys<ArtifactsClientInterface> => {
return {
getArtifact: jest.fn().mockResolvedValue(generateArtifactMock()),
createArtifact: jest.fn().mockResolvedValue(generateArtifactMock()),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
* 2.0.
*/

import type { DeeplyMockedKeys } from '@kbn/utility-types-jest';

import type { PackageClient, PackageService } from './package_service';

const createClientMock = (): jest.Mocked<PackageClient> => ({
Expand All @@ -21,8 +23,8 @@ const createClientMock = (): jest.Mocked<PackageClient> => ({
reinstallEsAssets: jest.fn(),
});

const createServiceMock = (): PackageService => ({
asScoped: jest.fn(createClientMock),
const createServiceMock = (): DeeplyMockedKeys<PackageService> => ({
asScoped: jest.fn((_) => createClientMock()),
asInternalUser: createClientMock(),
});

Expand Down
10 changes: 10 additions & 0 deletions x-pack/plugins/fleet/server/services/files/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ import { Readable } from 'stream';

import type { estypes } from '@elastic/elasticsearch';

import type { DeeplyMockedKeys } from '@kbn/utility-types-jest';

import type {
FilesClientFactory,
FleetFile,
FleetFromHostFileClientInterface,
FleetToHostFileClientInterface,
Expand Down Expand Up @@ -153,3 +156,10 @@ export const createHapiReadableStreamMock = (): HapiReadableStream => {

return readable;
};

export const createFleetFilesClientFactoryMock = (): DeeplyMockedKeys<FilesClientFactory> => {
return {
toHost: jest.fn((_) => createFleetToHostFilesClientMock()),
fromHost: jest.fn((_) => createFleetFromHostFilesClientMock()),
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import { ElasticsearchClient } from '@kbn/core-elasticsearch-server';
import { FleetStartContract } from '@kbn/fleet-plugin/server';
import { FleetArtifactsClient } from '@kbn/fleet-plugin/server/services';
import { ArtifactsClientInterface } from '@kbn/fleet-plugin/server/services';
import { TaskManagerSetupContract } from '@kbn/task-manager-plugin/server';
import { CoreStart, Logger } from '@kbn/core/server';
import { getApmArtifactClient } from '../fleet/source_maps';
Expand Down Expand Up @@ -141,7 +141,7 @@ async function getArtifactsForPage({
kuery,
}: {
page: number;
apmArtifactClient: FleetArtifactsClient;
apmArtifactClient: ArtifactsClientInterface;
kuery: string;
}) {
return await apmArtifactClient.listArtifacts({
Expand All @@ -163,7 +163,7 @@ async function paginateArtifacts({
}: {
taskState?: TaskState;
page: number;
apmArtifactClient: FleetArtifactsClient;
apmArtifactClient: ArtifactsClientInterface;
kuery: string;
logger: Logger;
internalESClient: ElasticsearchClient;
Expand Down
Loading