Skip to content

Commit

Permalink
updated lists plugin exception item nested entry type and tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@yctercero
yctercero committed Jul 21, 2020
1 parent c74b214 commit b20c066
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 35 deletions.
4 changes: 2 additions & 2 deletions x-pack/plugins/lists/common/schemas/types/default_entries_array.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { getEntriesArrayMock, getEntryMatchMock, getEntryNestedMock } from './en
// different entry types, it returns 5 of these. To make more readable,
// extracted here.
const returnedSchemaError =
'"Array<({| field: string, operator: "excluded" | "included", type: "match", value: string |} | {| field: string, operator: "excluded" | "included", type: "match_any", value: DefaultStringArray |} | {| field: string, list: {| id: string, type: "binary" | "boolean" | "byte" | "date" | "date_nanos" | "date_range" | "double" | "double_range" | "float" | "float_range" | "geo_point" | "geo_shape" | "half_float" | "integer" | "integer_range" | "ip" | "ip_range" | "keyword" | "long" | "long_range" | "shape" | "short" | "text" |}, operator: "excluded" | "included", type: "list" |} | {| field: string, operator: "excluded" | "included", type: "exists" |} | {| entries: Array<{| field: string, operator: "excluded" | "included", type: "match", value: string |}>, field: string, type: "nested" |})>"';
'"Array<({| field: string, operator: "excluded" | "included", type: "match", value: string |} | {| field: string, operator: "excluded" | "included", type: "match_any", value: DefaultStringArray |} | {| field: string, list: {| id: string, type: "binary" | "boolean" | "byte" | "date" | "date_nanos" | "date_range" | "double" | "double_range" | "float" | "float_range" | "geo_point" | "geo_shape" | "half_float" | "integer" | "integer_range" | "ip" | "ip_range" | "keyword" | "long" | "long_range" | "shape" | "short" | "text" |}, operator: "excluded" | "included", type: "list" |} | {| field: string, operator: "excluded" | "included", type: "exists" |} | {| entries: Array<({| field: string, operator: "excluded" | "included", type: "match", value: string |} | {| field: string, operator: "excluded" | "included", type: "match_any", value: DefaultStringArray |} | {| field: string, operator: "excluded" | "included", type: "exists" |})>, field: string, type: "nested" |})>"';

describe('default_entries_array', () => {
test('it should validate an empty array', () => {
Expand All @@ -31,7 +31,7 @@ describe('default_entries_array', () => {
});

test('it should validate an array of regular and nested entries', () => {
const payload: EntriesArray = getEntriesArrayMock();
const payload: EntriesArray = [...getEntriesArrayMock()];
const decoded = DefaultEntryArray.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand Down
89 changes: 57 additions & 32 deletions x-pack/plugins/lists/common/schemas/types/entries.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import {
describe('Entries', () => {
describe('entriesMatch', () => {
test('it should validate an entry', () => {
const payload = getEntryMatchMock();
const payload = { ...getEntryMatchMock() };
const decoded = entriesMatch.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -41,7 +41,7 @@ describe('Entries', () => {
});

test('it should validate when operator is "included"', () => {
const payload = getEntryMatchMock();
const payload = { ...getEntryMatchMock() };
const decoded = entriesMatch.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -50,7 +50,7 @@ describe('Entries', () => {
});

test('it should validate when "operator" is "excluded"', () => {
const payload = getEntryMatchMock();
const payload = { ...getEntryMatchMock() };
payload.operator = 'excluded';
const decoded = entriesMatch.decode(payload);
const message = pipe(decoded, foldLeftRight);
Expand Down Expand Up @@ -90,19 +90,19 @@ describe('Entries', () => {
test('it should strip out extra keys', () => {
const payload: EntryMatch & {
extraKey?: string;
} = getEntryMatchMock();
} = { ...getEntryMatchMock() };
payload.extraKey = 'some value';
const decoded = entriesMatch.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual(getEntryMatchMock());
expect(message.schema).toEqual({ ...getEntryMatchMock() });
});
});

describe('entriesMatchAny', () => {
test('it should validate an entry', () => {
const payload = getEntryMatchAnyMock();
const payload = { ...getEntryMatchAnyMock() };
const decoded = entriesMatchAny.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -111,7 +111,7 @@ describe('Entries', () => {
});

test('it should validate when operator is "included"', () => {
const payload = getEntryMatchAnyMock();
const payload = { ...getEntryMatchAnyMock() };
const decoded = entriesMatchAny.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -120,7 +120,7 @@ describe('Entries', () => {
});

test('it should validate when operator is "excluded"', () => {
const payload = getEntryMatchAnyMock();
const payload = { ...getEntryMatchAnyMock() };
payload.operator = 'excluded';
const decoded = entriesMatchAny.decode(payload);
const message = pipe(decoded, foldLeftRight);
Expand Down Expand Up @@ -158,19 +158,19 @@ describe('Entries', () => {
test('it should strip out extra keys', () => {
const payload: EntryMatchAny & {
extraKey?: string;
} = getEntryMatchAnyMock();
} = { ...getEntryMatchAnyMock() };
payload.extraKey = 'some extra key';
const decoded = entriesMatchAny.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual(getEntryMatchAnyMock());
expect(message.schema).toEqual({ ...getEntryMatchAnyMock() });
});
});

describe('entriesExists', () => {
test('it should validate an entry', () => {
const payload = getEntryExistsMock();
const payload = { ...getEntryExistsMock() };
const decoded = entriesExists.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -179,7 +179,7 @@ describe('Entries', () => {
});

test('it should validate when "operator" is "included"', () => {
const payload = getEntryExistsMock();
const payload = { ...getEntryExistsMock() };
const decoded = entriesExists.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -188,7 +188,7 @@ describe('Entries', () => {
});

test('it should validate when "operator" is "excluded"', () => {
const payload = getEntryExistsMock();
const payload = { ...getEntryExistsMock() };
payload.operator = 'excluded';
const decoded = entriesExists.decode(payload);
const message = pipe(decoded, foldLeftRight);
Expand All @@ -200,13 +200,13 @@ describe('Entries', () => {
test('it should strip out extra keys', () => {
const payload: EntryExists & {
extraKey?: string;
} = getEntryExistsMock();
} = { ...getEntryExistsMock() };
payload.extraKey = 'some extra key';
const decoded = entriesExists.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual(getEntryExistsMock());
expect(message.schema).toEqual({ ...getEntryExistsMock() });
});

test('it should not validate when "type" is not "exists"', () => {
Expand All @@ -224,7 +224,7 @@ describe('Entries', () => {

describe('entriesList', () => {
test('it should validate an entry', () => {
const payload = getEntryListMock();
const payload = { ...getEntryListMock() };
const decoded = entriesList.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -233,7 +233,7 @@ describe('Entries', () => {
});

test('it should validate when operator is "included"', () => {
const payload = getEntryListMock();
const payload = { ...getEntryListMock() };
const decoded = entriesList.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand All @@ -242,7 +242,7 @@ describe('Entries', () => {
});

test('it should validate when "operator" is "excluded"', () => {
const payload = getEntryListMock();
const payload = { ...getEntryListMock() };
payload.operator = 'excluded';
const decoded = entriesList.decode(payload);
const message = pipe(decoded, foldLeftRight);
Expand Down Expand Up @@ -282,19 +282,19 @@ describe('Entries', () => {
test('it should strip out extra keys', () => {
const payload: EntryList & {
extraKey?: string;
} = getEntryListMock();
} = { ...getEntryListMock() };
payload.extraKey = 'some extra key';
const decoded = entriesList.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual(getEntryListMock());
expect(message.schema).toEqual({ ...getEntryListMock() });
});
});

describe('entriesNested', () => {
test('it should validate a nested entry', () => {
const payload = getEntryNestedMock();
const payload = { ...getEntryNestedMock() };
const decoded = entriesNested.decode(payload);
const message = pipe(decoded, foldLeftRight);

Expand Down Expand Up @@ -338,30 +338,55 @@ describe('Entries', () => {
expect(message.schema).toEqual({});
});

test('it should NOT validate when "entries" contains an entry item that is not type "match"', () => {
const payload: Omit<EntryNested, 'entries'> & {
entries: EntryMatchAny[];
} = { ...getEntryNestedMock(), entries: [getEntryMatchAnyMock()] };
test('it should validate when "entries" contains an entry item that is type "match"', () => {
const payload = { ...getEntryNestedMock(), entries: [{ ...getEntryMatchAnyMock() }] };
const decoded = entriesNested.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([
'Invalid value "match_any" supplied to "entries,type"',
'Invalid value "["some host name"]" supplied to "entries,value"',
]);
expect(message.schema).toEqual({});
expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual({
entries: [
{
field: 'host.name',
operator: 'included',
type: 'match_any',
value: ['some host name'],
},
],
field: 'host.name',
type: 'nested',
});
});

test('it should validate when "entries" contains an entry item that is type "exists"', () => {
const payload = { ...getEntryNestedMock(), entries: [{ ...getEntryExistsMock() }] };
const decoded = entriesNested.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual({
entries: [
{
field: 'host.name',
operator: 'included',
type: 'exists',
},
],
field: 'host.name',
type: 'nested',
});
});

test('it should strip out extra keys', () => {
const payload: EntryNested & {
extraKey?: string;
} = getEntryNestedMock();
} = { ...getEntryNestedMock() };
payload.extraKey = 'some extra key';
const decoded = entriesNested.decode(payload);
const message = pipe(decoded, foldLeftRight);

expect(getPaths(left(message.errors))).toEqual([]);
expect(message.schema).toEqual(getEntryNestedMock());
expect(message.schema).toEqual({ ...getEntryNestedMock() });
});
});
});
2 changes: 1 addition & 1 deletion x-pack/plugins/lists/common/schemas/types/entries.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export type EntryExists = t.TypeOf<typeof entriesExists>;

export const entriesNested = t.exact(
t.type({
entries: t.array(entriesMatch),
entries: t.array(t.union([entriesMatch, entriesMatchAny, entriesExists])),
field: t.string,
type: t.keyof({ nested: null }),
})
Expand Down

0 comments on commit b20c066

Please sign in to comment.