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.

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

[Security Solution][Endpoint][Policy] Remove GET policy list api route #123873

Merged
merged 2 commits into from
Jan 27, 2022
Merged

[Security Solution][Endpoint][Policy] Remove GET policy list api route #123873

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35d7718
[Security Solution][Endpoint][Policy] Remove GET policy list api route
parkiino Jan 26, 2022
176654e
remove test
parkiino Jan 27, 2022
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
18 changes: 0 additions & 18 deletions x-pack/plugins/security_solution/common/endpoint/schema/policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,3 @@ export const GetAgentPolicySummaryRequestSchema = {
policy_id: schema.nullable(schema.string()),
}),
};

const ListWithKuerySchema = schema.object({
page: schema.maybe(schema.number({ defaultValue: 1 })),
pageSize: schema.maybe(schema.number({ defaultValue: 20 })),
sort: schema.maybe(schema.string()),
sortOrder: schema.maybe(schema.oneOf([schema.literal('desc'), schema.literal('asc')])),
showUpgradeable: schema.maybe(schema.boolean()),
kuery: schema.maybe(
schema.oneOf([
schema.string(),
schema.any(), // KueryNode
])
),
});

export const GetEndpointPackagePolicyRequestSchema = {
query: ListWithKuerySchema,
};
90 changes: 1 addition & 89 deletions x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,7 @@ import {
createRouteHandlerContext,
} from '../../mocks';
import { createMockAgentClient, createMockAgentService } from '../../../../../fleet/server/mocks';
import { PACKAGE_POLICY_SAVED_OBJECT_TYPE } from '../../../../../fleet/common';
import {
getHostPolicyResponseHandler,
getAgentPolicySummaryHandler,
getPolicyListHandler,
} from './handlers';
import { getHostPolicyResponseHandler, getAgentPolicySummaryHandler } from './handlers';
import {
KibanaResponseFactory,
SavedObjectsClientContract,
Expand All @@ -38,7 +33,6 @@ import { AgentClient, AgentService } from '../../../../../fleet/server/services'
import { get } from 'lodash';
// eslint-disable-next-line @kbn/eslint/no-restricted-paths
import { ScopedClusterClientMock } from '../../../../../../../src/core/server/elasticsearch/client/mocks';
import { PackagePolicyServiceInterface } from '../../../../../fleet/server';

describe('test policy response handler', () => {
let endpointAppContextService: EndpointAppContextService;
Expand Down Expand Up @@ -242,88 +236,6 @@ describe('test policy response handler', () => {
});
});
});
describe('test GET policy list handler', () => {
let mockPackagePolicyService: jest.Mocked<PackagePolicyServiceInterface>;
let policyHandler: ReturnType<typeof getPolicyListHandler>;

beforeEach(() => {
const endpointAppContextServiceStartContract =
createMockEndpointAppContextServiceStartContract();

mockScopedClient = elasticsearchServiceMock.createScopedClusterClient();
mockSavedObjectClient = savedObjectsClientMock.create();
mockResponse = httpServerMock.createResponseFactory();

if (endpointAppContextServiceStartContract.packagePolicyService) {
mockPackagePolicyService =
endpointAppContextServiceStartContract.packagePolicyService as jest.Mocked<PackagePolicyServiceInterface>;
} else {
expect(endpointAppContextServiceStartContract.packagePolicyService).toBeTruthy();
}

mockPackagePolicyService.list.mockImplementation(() => {
return Promise.resolve({
items: [],
total: 0,
page: 1,
perPage: 10,
});
});
endpointAppContextService = new EndpointAppContextService();
endpointAppContextService.setup(createMockEndpointAppContextServiceSetupContract());
endpointAppContextService.start(endpointAppContextServiceStartContract);
policyHandler = getPolicyListHandler({
logFactory: loggingSystemMock.create(),
service: endpointAppContextService,
config: () => Promise.resolve(createMockConfig()),
experimentalFeatures: parseExperimentalConfigValue(createMockConfig().enableExperimental),
});
});

afterEach(() => endpointAppContextService.stop());

it('should return a list of endpoint package policies', async () => {
const mockRequest = httpServerMock.createKibanaRequest({
query: {},
});

await policyHandler(
createRouteHandlerContext(mockScopedClient, mockSavedObjectClient),
mockRequest,
mockResponse
);
expect(mockPackagePolicyService.list).toHaveBeenCalled();
expect(mockPackagePolicyService.list.mock.calls[0][1]).toEqual({
kuery: `${PACKAGE_POLICY_SAVED_OBJECT_TYPE}.package.name: endpoint`,
perPage: undefined,
sortField: undefined,
});
expect(mockResponse.ok).toBeCalled();
expect(mockResponse.ok.mock.calls[0][0]?.body).toEqual({
items: [],
total: 0,
page: 1,
perPage: 10,
});
});

it('should add endpoint-specific kuery to the requests kuery', async () => {
const mockRequest = httpServerMock.createKibanaRequest({
query: { kuery: 'some query' },
});

await policyHandler(
createRouteHandlerContext(mockScopedClient, mockSavedObjectClient),
mockRequest,
mockResponse
);
expect(mockPackagePolicyService.list.mock.calls[0][1]).toEqual({
kuery: `(some query) and ${PACKAGE_POLICY_SAVED_OBJECT_TYPE}.package.name: endpoint`,
perPage: undefined,
sortField: undefined,
});
});
});
});

/**
Expand Down
33 changes: 0 additions & 33 deletions x-pack/plugins/security_solution/server/endpoint/routes/policy/handlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,10 @@ import { policyIndexPattern } from '../../../../common/endpoint/constants';
import {
GetPolicyResponseSchema,
GetAgentPolicySummaryRequestSchema,
GetEndpointPackagePolicyRequestSchema,
} from '../../../../common/endpoint/schema/policy';
import { EndpointAppContext } from '../../types';
import { getAgentPolicySummary, getPolicyResponseByAgentId } from './service';
import { GetAgentSummaryResponse } from '../../../../common/endpoint/types';
import { wrapErrorIfNeeded } from '../../utils';
import { PACKAGE_POLICY_SAVED_OBJECT_TYPE } from '../../../../../fleet/common';

export const getHostPolicyResponseHandler = function (): RequestHandler<
undefined,
Expand Down Expand Up @@ -65,33 +62,3 @@ export const getAgentPolicySummaryHandler = function (
});
};
};

export const getPolicyListHandler = function (
endpointAppContext: EndpointAppContext
): RequestHandler<
undefined,
TypeOf<typeof GetEndpointPackagePolicyRequestSchema.query>,
undefined
> {
return async (context, request, response) => {
const soClient = context.core.savedObjects.client;
const fleetServices = endpointAppContext.service.getScopedFleetServices(request);
const endpointFilteredKuery = `${
request?.query?.kuery ? `(${request.query.kuery}) and ` : ''
}${PACKAGE_POLICY_SAVED_OBJECT_TYPE}.package.name: endpoint`;
try {
const listResponse = await fleetServices.packagePolicy.list(soClient, {
...request.query,
perPage: request.query.pageSize,
sortField: request.query.sort,
kuery: endpointFilteredKuery,
});

return response.ok({
body: listResponse,
});
} catch (error) {
throw wrapErrorIfNeeded(error);
}
};
};
21 changes: 1 addition & 20 deletions x-pack/plugins/security_solution/server/endpoint/routes/policy/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,10 @@ import { EndpointAppContext } from '../../types';
import {
GetPolicyResponseSchema,
GetAgentPolicySummaryRequestSchema,
GetEndpointPackagePolicyRequestSchema,
} from '../../../../common/endpoint/schema/policy';
import {
getHostPolicyResponseHandler,
getAgentPolicySummaryHandler,
getPolicyListHandler,
} from './handlers';
import { getHostPolicyResponseHandler, getAgentPolicySummaryHandler } from './handlers';
import {
AGENT_POLICY_SUMMARY_ROUTE,
BASE_POLICY_ROUTE,
BASE_POLICY_RESPONSE_ROUTE,
} from '../../../../common/endpoint/constants';
import { withEndpointAuthz } from '../with_endpoint_authz';
Expand Down Expand Up @@ -54,17 +48,4 @@ export function registerPolicyRoutes(router: IRouter, endpointAppContext: Endpoi
getAgentPolicySummaryHandler(endpointAppContext)
)
);

router.get(
{
path: BASE_POLICY_ROUTE,
validate: GetEndpointPackagePolicyRequestSchema,
options: { authRequired: true },
},
withEndpointAuthz(
{ all: ['canAccessEndpointManagement'] },
logger,
getPolicyListHandler(endpointAppContext)
)
);
}