Unit tests for public components opensearch-project#383

[BUG] Detector Edit | Custom rule are not selected on update rules opensearch-project#406

Signed-off-by: Jovan Cvetkovic <[email protected]>

cypress/fixtures/sample_index_settings.json

@@ -18,6 +18,9 @@
       },
       "ServiceName": {
         "type": "text"
+      },
+      "DnsQuestionName": {
+        "type": "text"
       }
     }
   },

cypress/integration/1_detectors.spec.js

@@ -5,35 +5,21 @@
 
 import { OPENSEARCH_DASHBOARDS_URL } from '../support/constants';
 import sample_index_settings from '../fixtures/sample_index_settings.json';
-import { recurse } from 'cypress-recurse';
+import dns_rule_data from '../fixtures/integration_tests/rule/create_dns_rule.json';
 
 const testMappings = {
   properties: {
-    'host-hostname': {
-      type: 'alias',
-      path: 'HostName',
-    },
-    'windows-message': {
-      type: 'alias',
-      path: 'Message',
-    },
-    'winlog-provider_name': {
-      type: 'alias',
-      path: 'Provider_Name',
-    },
-    'winlog-event_data-ServiceName': {
-      type: 'alias',
-      path: 'ServiceName',
-    },
-    'winlog-event_id': {
-      path: 'EventID',
+    'dns-question-name': {
       type: 'alias',
+      path: 'DnsQuestionName',
     },
   },
 };
 
+const cypressDNSRule = 'Cypress DNS Rule';
+
 describe('Detectors', () => {
-  const indexName = 'cypress-test-windows';
+  const indexName = 'cypress-test-dns';
   const detectorName = 'test detector';
 
   before(() => {
@@ -47,13 +33,15 @@ describe('Detectors', () => {
           query: {
             nested: {
               path: 'rule',
-              query: { bool: { must: [{ match: { 'rule.category': 'windows' } }] } },
+              query: { bool: { must: [{ match: { 'rule.category': 'dns' } }] } },
             },
           },
         })
         .should('have.property', 'status', 200)
     );
 
+    cy.createRule(dns_rule_data);
+
     cy.contains(detectorName).should('not.exist');
   });
 
@@ -95,28 +83,28 @@ describe('Detectors', () => {
     }).as('getSigmaRules');
 
     // Select threat detector type (Windows logs)
-    cy.get(`input[id="windows"]`).click({ force: true });
+    cy.get(`input[id="dns"]`).click({ force: true });
 
     cy.wait('@getSigmaRules').then(() => {
       // Open Detection rules accordion
       cy.get('[data-test-subj="detection-rules-btn"]').click({ force: true, timeout: 5000 });
 
-      cy.contains('table tr', 'Windows', {
+      cy.contains('table tr', 'DNS', {
         timeout: 120000,
       });
 
       // find search, type USB
-      cy.get(`input[placeholder="Search..."]`).ospSearch('USB Device Plugged');
+      cy.get(`input[placeholder="Search..."]`).ospSearch(cypressDNSRule);
 
       // Disable all rules
-      cy.contains('tr', 'USB Device Plugged', { timeout: 1000 });
+      cy.contains('tr', cypressDNSRule, { timeout: 1000 });
       cy.get('table th').within(() => {
         cy.get('button').first().click({ force: true });
       });
 
       // Enable single rule
-      cy.contains('table tr', 'USB Device Plugged').within(() => {
-        cy.get('button').eq(1).click({ force: true });
+      cy.contains('table tr', cypressDNSRule).within(() => {
+        cy.get('button').eq(1).click({ force: true, timeout: 2000 });
       });
     });
 
@@ -126,14 +114,6 @@ describe('Detectors', () => {
     // Check that correct page now showing
     cy.contains('Configure field mapping');
 
-    // Show 50 rows per page
-    cy.contains('Rows per page').click({ force: true });
-    cy.contains('50 rows').click({ force: true });
-
-    // Show 50 rows per page
-    cy.contains('Rows per page').click({ force: true });
-    cy.contains('50 rows').click({ force: true });
-
     // Select appropriate names to map fields to
     for (let field_name in testMappings.properties) {
       const mappedTo = testMappings.properties[field_name].path;
@@ -174,10 +154,6 @@ describe('Detectors', () => {
     // Confirm field mappings registered
     cy.contains('Field mapping');
 
-    // Show 50 rows per page
-    cy.contains('Rows per page').click({ force: true });
-    cy.contains('50 rows').click({ force: true });
-
     for (let field in testMappings.properties) {
       const mappedTo = testMappings.properties[field].path;
 
@@ -188,7 +164,7 @@ describe('Detectors', () => {
     // Confirm entries user has made
     cy.contains('Detector details');
     cy.contains(detectorName);
-    cy.contains('windows');
+    cy.contains('dns');
     cy.contains(indexName);
     cy.contains('Alert on test_trigger');
 
@@ -228,16 +204,10 @@ describe('Detectors', () => {
     });
 
     // Change detector name
-    const detectorNameText = 'test detector edited';
-    const detectorNameSelector = 'input[placeholder="Enter a name for the detector."]';
-    cy.get(detectorNameSelector).should('have.value', 'test detector');
-
-    recurse(
-      () => cy.get(detectorNameSelector).clear().type(detectorNameText),
-      ($input) => $input.val() === detectorNameText
-    ).then(() => {
-      cy.get(detectorNameSelector).should('have.value', 'test detector edited');
-    });
+    cy.get(`input[placeholder="Enter a name for the detector."]`)
+      .realClick()
+      .ospClear()
+      .realType('test detector edited');
 
     // Change detector description
     cy.get(`[data-test-subj="define-detector-detector-description"]`)
@@ -295,10 +265,10 @@ describe('Detectors', () => {
     });
 
     // Search for specific rule
-    cy.get(`input[placeholder="Search..."]`).ospSearch('USB Device');
+    cy.get(`input[placeholder="Search..."]`).ospSearch(cypressDNSRule);
 
     // Toggle single search result to unchecked
-    cy.contains('table tr', 'USB Device Plugged').within(() => {
+    cy.contains('table tr', cypressDNSRule).within(() => {
       // Of note, timeout can sometimes work instead of wait here, but is very unreliable from case to case.
       cy.wait(1000);
       cy.get('button').eq(1).click();
@@ -319,10 +289,10 @@ describe('Detectors', () => {
     });
 
     // Search for specific rule
-    cy.get(`input[placeholder="Search..."]`).ospSearch('USB');
+    cy.get(`input[placeholder="Search..."]`).ospSearch(cypressDNSRule);
 
     // Toggle single search result to checked
-    cy.contains('table tr', 'USB Device Plugged').within(() => {
+    cy.contains('table tr', cypressDNSRule).within(() => {
       cy.wait(2000);
       cy.get('button').eq(1).click({ force: true });
     });

cypress/integration/4_findings.spec.js

@@ -88,7 +88,9 @@ describe('Findings', () => {
     cy.get('.euiFlexItem--flexGrowZero > .euiButtonIcon').click({ force: true });
   });
 
-  it('displays finding details and create an index pattern from flyout', () => {
+  // TODO: this one triggers a button handler which goes throw condition and therefor is flaky
+  // find a better way to test this dialog, condition is based on `indexPatternId`
+  xit('displays finding details and create an index pattern from flyout', () => {
     // filter table to show only sample_detector findings
     cy.get(`input[placeholder="Search findings"]`).ospSearch('sample_detector');
 

package.json

@@ -32,7 +32,7 @@
   "resolutions": {
     "@types/react": "^16.9.8",
     "**/@types/angular": "1.6.50",
-    "**/@types/jest": "^24.0.9",
+    "**/@types/jest": "^29.3.1",
     "**/@types/react-dom": "^16.9.8",
     "eslint-utils": "^1.4.2",
     "path-parse": "^1.0.7",

public/pages/Detectors/components/UpdateRules/UpdateRules.tsx

@@ -67,9 +67,13 @@ export const UpdateDetectorRules: React.FC<UpdateDetectorRulesProps> = (props) =
     };
 
     const getRules = async (detector: Detector) => {
-      const enabledRuleIds = detector.inputs[0].detector_input.pre_packaged_rules.map(
+      let enabledRuleIds = detector.inputs[0].detector_input.pre_packaged_rules.map(
         (rule) => rule.id
       );
+      const enabledCustomRuleIds = detector.inputs[0].detector_input.custom_rules.map(
+        (rule) => rule.id
+      );
+      enabledRuleIds = enabledRuleIds.concat(enabledCustomRuleIds);
 
       const allRules = await rulesViewModelActor?.fetchRules(undefined, {
         bool: {

public/pages/Overview/utils/helper.test.ts

@@ -3,7 +3,6 @@ import {
   DateOpts,
   getAlertsVisualizationSpec,
   getChartTimeUnit,
-  getDomainRange,
   getFindingsVisualizationSpec,
   getOverviewVisualizationSpec,
   getTimeTooltip,
@@ -127,9 +126,10 @@ describe('helper utilities spec', () => {
 
   describe('tests parseDateString function', () => {
     it(' - function should return datetime in ms', () => {
-      const time = moment(10);
-      jest.spyOn(dateMath, 'parse').mockReturnValue(time);
-      expect(parseDateString(DEFAULT_DATE_RANGE.start)).toBe(time.milliseconds());
+      const mockTime = moment('2023-01-25T10:05:00');
+      jest.spyOn(dateMath, 'parse').mockReturnValue(mockTime);
+      jest.fn().mockImplementation('parseDateString', () => mockTime.milliseconds());
+      expect(parseDateString(DEFAULT_DATE_RANGE.start)).toBe(mockTime._d.getTime());
     });
   });
 

tsconfig.json

@@ -9,6 +9,6 @@
     "skipLibCheck": true,
     "esModuleInterop": true,
     "outDir": "./target",
-    "types": ["cypress", "node", "cypress-real-events"]
+    "types": ["cypress", "node", "cypress-real-events", "jest"]
   }
 }