Skip to content

Commit

Permalink
improve tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@mshustov
mshustov committed Jul 27, 2020
1 parent d3e4d35 commit 9ebb333
Showing 1 changed file with 124 additions and 69 deletions.
193 changes: 124 additions & 69 deletions src/core/server/elasticsearch/integration_tests/auditor.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
import { InternalCoreStart } from '../../internal_types';
import {
createRootWithCorePlugins,
createTestServers,
Expand All @@ -28,113 +29,167 @@ describe('Elasticsearch integration with Auditor', () => {
let servers: TestUtils;
let esServer: TestElasticsearchUtils;
let root: ReturnType<typeof createRootWithCorePlugins>;
let internalStart: InternalCoreStart;
const auditor = { add: jest.fn(), withAuditScope: jest.fn() };
const auditorFactory = jest.fn().mockReturnValue(auditor);

beforeAll(async () => {
servers = createTestServers({
adjustTimeout: (t) => jest.setTimeout(t),
});
esServer = await servers.startES();
});

beforeEach(async () => {
root = createRootWithCorePlugins();
});
const internalSetup = await root.setup();

afterEach(async () => {
await root.shutdown();
internalSetup.auditTrail.register({ asScoped: auditorFactory });
internalStart = await root.start();
});

afterAll(async () => {
await root.shutdown();
await esServer.stop();
});

describe('Legacy client', () => {
it('logs elasticsearch requests done on behalf on the current & internal user', async () => {
const internalSetup = await root.setup();
const auditor = { add: jest.fn(), withAuditScope: jest.fn() };
const auditorFactory = jest.fn().mockReturnValueOnce(auditor);
afterEach(() => {
auditor.add.mockClear();
auditorFactory.mockClear();
});

describe('Legacy', () => {
describe('client', () => {
it('do not logs requests performed with un-scoped client', async () => {
await internalStart.elasticsearch.legacy.client.callAsInternalUser('ping');
expect(auditorFactory).toHaveBeenCalledTimes(0);
expect(auditor.add).toHaveBeenCalledTimes(0);
});

it('ScopedClusterClient.callAsInternalUser() writes into auditor', async () => {
const client = internalStart.elasticsearch.legacy.client.asScoped(
httpServerMock.createKibanaRequest()
);

await client.callAsInternalUser('ping');
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'ping',
type: 'legacy.elasticsearch.call.internalUser',
});
});

it('ScopedClusterClient.callAsCurrentUser() writes into auditor', async () => {
const client = internalStart.elasticsearch.legacy.client.asScoped(
httpServerMock.createKibanaRequest()
);

await client.callAsCurrentUser('ping');
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'ping',
type: 'legacy.elasticsearch.call.currentUser',
});
});
});

describe('custom client', () => {
it('do not logs requests performed with un-scoped client', async () => {
const customClient = internalStart.elasticsearch.legacy.createClient('custom');

await customClient.callAsInternalUser('ping');
expect(auditorFactory).toHaveBeenCalledTimes(0);
expect(auditor.add).toHaveBeenCalledTimes(0);
});

it('ScopedClusterClient.callAsInternalUser() writes into auditor', async () => {
const customClient = internalStart.elasticsearch.legacy.createClient('custom');
const client = customClient.asScoped(httpServerMock.createKibanaRequest());

await client.callAsInternalUser('ping');
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'ping',
type: 'legacy.elasticsearch.call.internalUser',
});
});

it('ScopedClusterClient.callAsCurrentUser() writes into auditor', async () => {
const customClient = internalStart.elasticsearch.legacy.createClient('custom');
const client = customClient.asScoped(httpServerMock.createKibanaRequest());

await client.callAsCurrentUser('ping');
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'ping',
type: 'legacy.elasticsearch.call.currentUser',
});
});
});
});

describe('client', () => {
it('do not logs requests performed with un-scoped client', async () => {
await internalStart.elasticsearch.client.asInternalUser.ping();
expect(auditorFactory).toHaveBeenCalledTimes(0);
expect(auditor.add).toHaveBeenCalledTimes(0);
});

internalSetup.auditTrail.register({ asScoped: auditorFactory });
const internalStart = await root.start();
it('ScopedClusterClient.asInternalUser writes into auditor', async () => {
const client = internalStart.elasticsearch.client.asScoped(
httpServerMock.createKibanaRequest()
);
expect(auditorFactory).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledTimes(0);

await client.asCurrentUser.ping();
await client.asInternalUser.ping();
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'HEAD /',
type: 'elasticsearch.call.currentUser',
type: 'elasticsearch.call.internalUser',
});
});

auditor.add.mockReset();
await client.asInternalUser.ping();
it('ScopedClusterClient.asCurrentUser writes into auditor', async () => {
const client = internalStart.elasticsearch.client.asScoped(
httpServerMock.createKibanaRequest()
);

await client.asCurrentUser.ping();
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'HEAD /',
type: 'elasticsearch.call.internalUser',
type: 'elasticsearch.call.currentUser',
});
});
});

it('ScopedClusterClient.asInternalUser() writes into auditor', async () => {
const internalSetup = await root.setup();
const firstAuditor = { add: jest.fn(), withAuditScope: jest.fn() };
const secondAuditor = { add: jest.fn(), withAuditScope: jest.fn() };
const auditorFactory = jest
.fn()
.mockReturnValueOnce(firstAuditor)
.mockReturnValueOnce(secondAuditor);

internalSetup.auditTrail.register({ asScoped: auditorFactory });
const internalStart = await root.start();
const firstClient = internalStart.elasticsearch.client.asScoped(
httpServerMock.createKibanaRequest()
);

const secondClient = internalStart.elasticsearch.client.asScoped(
httpServerMock.createKibanaRequest()
);
describe('custom client', () => {
it('do not logs requests performed with un-scoped client', async () => {
const customClient = internalStart.elasticsearch.createClient('custom');

await firstClient.asInternalUser.ping();
expect(firstAuditor.add).toHaveBeenCalledTimes(1);
expect(secondAuditor.add).toHaveBeenCalledTimes(0);
await customClient.asInternalUser.ping();
expect(auditorFactory).toHaveBeenCalledTimes(0);
expect(auditor.add).toHaveBeenCalledTimes(0);
});

await secondClient.asInternalUser.ping();
it('ScopedClusterClient writes into auditor', async () => {
const customClient = internalStart.elasticsearch.createClient('custom');
const client = customClient.asScoped(httpServerMock.createKibanaRequest());

expect(firstAuditor.add).toHaveBeenCalledTimes(1);
expect(secondAuditor.add).toHaveBeenCalledTimes(1);
await client.asInternalUser.ping();
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'HEAD /',
type: 'elasticsearch.call.internalUser',
});
});

it('ScopedClusterClient.asCurrentUser() writes into auditor', async () => {
const internalSetup = await root.setup();
const firstAuditor = { add: jest.fn(), withAuditScope: jest.fn() };
const secondAuditor = { add: jest.fn(), withAuditScope: jest.fn() };
const auditorFactory = jest
.fn()
.mockReturnValueOnce(firstAuditor)
.mockReturnValueOnce(secondAuditor);

internalSetup.auditTrail.register({ asScoped: auditorFactory });
const internalStart = await root.start();
const firstClient = internalStart.elasticsearch.client.asScoped(
httpServerMock.createKibanaRequest()
);

const secondClient = internalStart.elasticsearch.client.asScoped(
httpServerMock.createKibanaRequest()
);
const customClient = internalStart.elasticsearch.createClient('custom');
const client = customClient.asScoped(httpServerMock.createKibanaRequest());

await firstClient.asCurrentUser.ping();
expect(firstAuditor.add).toHaveBeenCalledTimes(1);
expect(secondAuditor.add).toHaveBeenCalledTimes(0);

await secondClient.asCurrentUser.ping();

expect(firstAuditor.add).toHaveBeenCalledTimes(1);
expect(secondAuditor.add).toHaveBeenCalledTimes(1);
await client.asCurrentUser.ping();
expect(auditor.add).toHaveBeenCalledTimes(1);
expect(auditor.add).toHaveBeenCalledWith({
message: 'HEAD /',
type: 'elasticsearch.call.currentUser',
});
});
});
});

0 comments on commit 9ebb333

Please sign in to comment.