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

[SIEM][Detections Engine] - Add rule markdown field to rule create, detail, and edit flows #60108

Merged
merged 14 commits into from
Mar 17, 2020
Merged

[SIEM][Detections Engine] - Add rule markdown field to rule create, detail, and edit flows #60108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
95bcdec
adding new note markdown value to create and edit pages
yctercero Mar 12, 2020
5ac1836
add markdown to details page and update unit tests
yctercero Mar 13, 2020
1662e70
updated snapshots, re-ran integration tests
yctercero Mar 13, 2020
7a4eaf4
Merge branch 'master' of github.com:yctercero/kibana into rule_markdo…
yctercero Mar 13, 2020
0dda6d9
Merge branch 'master' of github.com:yctercero/kibana into rule_markdo…
yctercero Mar 13, 2020
82c71c3
updated details panel to remain constant heights on toggle and add sc…
yctercero Mar 14, 2020
58a893c
removed empty dead tests and comments, updated some unit tests, ran u…
yctercero Mar 15, 2020
88210f1
updated helper to the more concise version suggested by frank
yctercero Mar 15, 2020
03fcaa7
Merge branch 'master' of github.com:yctercero/kibana into rule_markdo…
yctercero Mar 16, 2020
16c32dc
Merge branch 'master' of github.com:yctercero/kibana into rule_markdo…
yctercero Mar 16, 2020
9ac25ca
removed dead snapshots, still debugging cypress tests locally
yctercero Mar 16, 2020
78e8878
updates 'Creates and activates new rule' with the new layout changes
MadameSheema Mar 16, 2020
80c634d
Merge branch 'master' into rule_markdown_de_fe
elasticmachine Mar 16, 2020
fe50183
added test files to circular dep check exception, updated some helper…
yctercero Mar 17, 2020
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
108 changes: 53 additions & 55 deletions x-pack/legacy/plugins/siem/cypress/integration/signal_detection_rules.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,30 @@
import { newRule } from '../objects/rule';

import {
ABOUT_DESCRIPTION,
ABOUT_EXPECTED_URLS,
ABOUT_FALSE_POSITIVES,
ABOUT_MITRE,
ABOUT_RISK,
ABOUT_RULE_DESCRIPTION,
ABOUT_SEVERITY,
ABOUT_STEP,
ABOUT_TAGS,
ABOUT_TIMELINE,
ABOUT_URLS,
DEFINITION_CUSTOM_QUERY,
DEFINITION_DESCRIPTION,
DEFINITION_INDEX_PATTERNS,
DEFINITION_STEP,
RULE_NAME_HEADER,
SCHEDULE_DESCRIPTION,
SCHEDULE_LOOPBACK,
SCHEDULE_RUNS,
SCHEDULE_STEP,
ABOUT_RULE_DESCRIPTION,
} from '../screens/rule_details';
import {
CUSTOM_RULES_BTN,
ELASTIC_RULES_BTN,
RISK_SCORE,
RULE_NAME,
RULES_TABLE,
RULES_ROW,
RULES_TABLE,
SEVERITY,
} from '../screens/signal_detection_rules';

Expand Down Expand Up @@ -127,10 +127,25 @@ describe('Signal detection rules', () => {

goToRuleDetails();

cy.get(RULE_NAME_HEADER)
.invoke('text')
.should('eql', `${newRule.name} Beta`);

let expectedUrls = '';
newRule.referenceUrls.forEach(url => {
expectedUrls = expectedUrls + url;
});
let expectedFalsePositives = '';
newRule.falsePositivesExamples.forEach(falsePositive => {
expectedFalsePositives = expectedFalsePositives + falsePositive;
});
let expectedTags = '';
newRule.tags.forEach(tag => {
expectedTags = expectedTags + tag;
});
let expectedMitre = '';
newRule.mitre.forEach(mitre => {
expectedMitre = expectedMitre + mitre.tactic;
mitre.techniques.forEach(technique => {
expectedMitre = expectedMitre + technique;
});
});
const expectedIndexPatterns = [
'apm-*-transaction*',
'auditbeat-*',
Expand All @@ -139,77 +154,60 @@ describe('Signal detection rules', () => {
'packetbeat-*',
'winlogbeat-*',
];
cy.get(DEFINITION_INDEX_PATTERNS).then(patterns => {
cy.wrap(patterns).each((pattern, index) => {
cy.wrap(pattern)
.invoke('text')
.should('eql', expectedIndexPatterns[index]);
});
});
cy.get(DEFINITION_DESCRIPTION)
.eq(DEFINITION_CUSTOM_QUERY)

cy.get(RULE_NAME_HEADER)
.invoke('text')
.should('eql', `${newRule.customQuery} `);
cy.get(ABOUT_DESCRIPTION)
.eq(ABOUT_RULE_DESCRIPTION)
.should('eql', `${newRule.name} Beta`);

cy.get(ABOUT_RULE_DESCRIPTION)
.invoke('text')
.should('eql', newRule.description);
cy.get(ABOUT_DESCRIPTION)
cy.get(ABOUT_STEP)
.eq(ABOUT_SEVERITY)
.invoke('text')
.should('eql', newRule.severity);
cy.get(ABOUT_DESCRIPTION)
cy.get(ABOUT_STEP)
.eq(ABOUT_RISK)
.invoke('text')
.should('eql', newRule.riskScore);
cy.get(ABOUT_DESCRIPTION)
cy.get(ABOUT_STEP)
.eq(ABOUT_TIMELINE)
.invoke('text')
.should('eql', 'Default blank timeline');

let expectedUrls = '';
newRule.referenceUrls.forEach(url => {
expectedUrls = expectedUrls + url;
});
cy.get(ABOUT_DESCRIPTION)
.eq(ABOUT_EXPECTED_URLS)
cy.get(ABOUT_STEP)
.eq(ABOUT_URLS)
.invoke('text')
.should('eql', expectedUrls);

let expectedFalsePositives = '';
newRule.falsePositivesExamples.forEach(falsePositive => {
expectedFalsePositives = expectedFalsePositives + falsePositive;
});
cy.get(ABOUT_DESCRIPTION)
cy.get(ABOUT_STEP)
.eq(ABOUT_FALSE_POSITIVES)
.invoke('text')
.should('eql', expectedFalsePositives);

let expectedMitre = '';
newRule.mitre.forEach(mitre => {
expectedMitre = expectedMitre + mitre.tactic;
mitre.techniques.forEach(technique => {
expectedMitre = expectedMitre + technique;
});
});
cy.get(ABOUT_DESCRIPTION)
cy.get(ABOUT_STEP)
.eq(ABOUT_MITRE)
.invoke('text')
.should('eql', expectedMitre);

let expectedTags = '';
newRule.tags.forEach(tag => {
expectedTags = expectedTags + tag;
});
cy.get(ABOUT_DESCRIPTION)
cy.get(ABOUT_STEP)
.eq(ABOUT_TAGS)
.invoke('text')
.should('eql', expectedTags);
cy.get(SCHEDULE_DESCRIPTION)

cy.get(DEFINITION_INDEX_PATTERNS).then(patterns => {
cy.wrap(patterns).each((pattern, index) => {
cy.wrap(pattern)
.invoke('text')
.should('eql', expectedIndexPatterns[index]);
});
});
cy.get(DEFINITION_STEP)
.eq(DEFINITION_CUSTOM_QUERY)
.invoke('text')
.should('eql', `${newRule.customQuery} `);

cy.get(SCHEDULE_STEP)
.eq(SCHEDULE_RUNS)
.invoke('text')
.should('eql', '5m');
cy.get(SCHEDULE_DESCRIPTION)
cy.get(SCHEDULE_STEP)
.eq(SCHEDULE_LOOPBACK)
.invoke('text')
.should('eql', '1m');
Expand Down
28 changes: 14 additions & 14 deletions x-pack/legacy/plugins/siem/cypress/screens/rule_details.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,35 @@
* you may not use this file except in compliance with the Elastic License.
*/

export const ABOUT_DESCRIPTION = '[data-test-subj="aboutRule"] .euiDescriptionList__description';
export const ABOUT_FALSE_POSITIVES = 4;

export const ABOUT_EXPECTED_URLS = 4;
export const ABOUT_MITRE = 5;

export const ABOUT_FALSE_POSITIVES = 5;
export const ABOUT_RULE_DESCRIPTION = '[data-test-subj=stepAboutRuleDetailsToggleDescriptionText]';

export const ABOUT_MITRE = 6;
export const ABOUT_RISK = 1;

export const ABOUT_RULE_DESCRIPTION = 0;
export const ABOUT_SEVERITY = 0;

export const ABOUT_RISK = 2;
export const ABOUT_STEP = '[data-test-subj="aboutRule"] .euiDescriptionList__description';

export const ABOUT_SEVERITY = 1;
export const ABOUT_TAGS = 6;

export const ABOUT_TAGS = 7;
export const ABOUT_TIMELINE = 2;

export const ABOUT_TIMELINE = 3;
export const ABOUT_URLS = 3;

export const DEFINITION_CUSTOM_QUERY = 1;

export const DEFINITION_DESCRIPTION =
'[data-test-subj="definition"] .euiDescriptionList__description';

export const DEFINITION_INDEX_PATTERNS =
'[data-test-subj="definition"] .euiDescriptionList__description .euiBadge__text';
'[data-test-subj=definitionRule] [data-test-subj="listItemColumnStepRuleDescription"] .euiDescriptionList__description .euiBadge__text';

export const DEFINITION_STEP =
'[data-test-subj=definitionRule] [data-test-subj="listItemColumnStepRuleDescription"] .euiDescriptionList__description';

export const RULE_NAME_HEADER = '[data-test-subj="header-page-title"]';

export const SCHEDULE_DESCRIPTION = '[data-test-subj="schedule"] .euiDescriptionList__description';
export const SCHEDULE_STEP = '[data-test-subj="schedule"] .euiDescriptionList__description';

export const SCHEDULE_RUNS = 0;

Expand Down
10 changes: 10 additions & 0 deletions x-pack/legacy/plugins/siem/dev_tools/circular_deps/run_check_circular_deps_cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ run(
[resolve(__dirname, '../../public'), resolve(__dirname, '../../common')],
{
fileExtensions: ['ts', 'js', 'tsx'],
excludeRegExp: [
'test.ts$',
'test.tsx$',
'containers/detection_engine/rules/types.ts$',
'core/public/chrome/chrome_service.tsx$',
'src/core/server/types.ts$',
'src/core/server/saved_objects/types.ts$',
'src/core/public/overlays/banners/banners_service.tsx$',
'src/core/public/saved_objects/saved_objects_client.ts$',
],
}
);

Expand Down
2 changes: 2 additions & 0 deletions x-pack/legacy/plugins/siem/public/containers/detection_engine/rules/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export const NewRuleSchema = t.intersection([
threat: t.array(t.unknown),
to: t.string,
updated_by: t.string,
note: t.string,
}),
]);

Expand Down Expand Up @@ -86,6 +87,7 @@ export const RuleSchema = t.intersection([
status_date: t.string,
timeline_id: t.string,
timeline_title: t.string,
note: t.string,
version: t.number,
}),
]);
Expand Down
Loading