Description

Encapsulate endpoints to reduce the sources of supporting information needed to read or write tests.

Through the experience of fixing 2 minor mistakes that I made in the first draft, I do see a benefit to my understanding from explicitly declaring entity keys for each interaction within a test.

1. Factor out multiple or parallel references in tests as helper functions which have semantic names:

   • visitVulnerabilityManagementEntityInSidePanel
   • interactAndWaitForVulnerabilityManagementEntity
   • interactAndWaitForVulnerabilityManagementEntities
   • interactAndWaitForVulnerabilityManagementSecondaryEntities

2. If only one test requires some container-specific information, consider pro and con to write it as inline string in the test, and then factor it out later if there is need to reuse it in other tests.

   • For example, api.vulnMgmt.graphqlOps.getFixableCvesForEntity has only 1 reference.

3. Delete a few redundant tests which had been skipped for a long time.

Changed files

1. Edit cypress/constants/apiEndpoints.js

   • Delete vulnMgmt object.
   • Move opnameForEntity, opnameForEntities, opnamePrefixForPrimaryAndSecondaryEntities objects to entities.js file.

2. Edit cypress/constants/VulnManagementPage.js

   • Delete sidepanel property of url object.
   • Delete applicationAndInfrastructureDropdown property of dashboardSelectors object.

3. Edit cypress/helpers/vulnmanagement/entities.js

   • Move opnameForEntity, opnameForEntities, opnamePrefixForPrimaryAndSecondaryEntities objects from apiEndpoints.js file.
   • Rename keyForEntity as typeOfEntity because it is the type in workflow state.
   • Add helper functions.

4. Edit cypress/integration/vulnmanagement/dashboard.test.js

   • Factor out local helper functions for menu items.
   • Call interactAndWaitForVulnerabilityManagementEntities function to wait on relevant request for entities list.
   • Move pathname assertions into helper functions.
   • Replace method chains with pseudo-selectors to reduce risk that cy.get gets DOM elements too soon, and therefore delete timeout options.
   • Replace parseInt function calls with :contains(value) pseudo-selector to reduce risk that cy.get gets DOM elements too soon.
   • Replace skip classic test for CVEs button with 3 tests for CVEs drop-down.
   • Delete 'should properly navigate to the policies list' test which is redundant with the first test.
   • Add test for Top Risky Nodes.

5. Edit cypress/integration/vulnmanagement/entitypages.test.js

   • Call helper functions to encapsulate intercept-visit-wait sandwich and optional static response for request.
   • Replace parseInt function calls with :contains(value) pseudo-selector to reduce risk that cy.get gets DOM elements too soon.
   • Delete skipped 'should filter deployment count in failing policies section in namespace findings by namespace' test because it is redundant with a test in namespacesListPages.test.js file.
   • Delete skipped 'should filter component count in images list and image overview by cve when coming from cve list' test because it is redundant with tests in imageCvesListPages.test.js file.
   • Replace api.vulnMgmt.graphqlOps.getFixableCvesForEntity with inline string.

6. Edit cypress/integration/vulnmanagement/imageSection/imageOverview.test.js

   • Get entity id from fixture file.
   • Call visitVulnerabilityManagementEntityInSidePanel function with static response argument for body from fixture file.

7. Edit cypress/integration/vulnmanagement/nodeSection/nodeOverview.test.js

   • Get entity id from fixture file.
   • Call visitVulnerabilityManagementEntityInSidePanel function with static response argument for body from fixture file.

Checklist

• Investigated and inspected CI test results
• Edited integration tests

Testing Performed

Ran changed tests one at a time in local deployment and used inspector with stagingdb for tests which fail because no vulnerabilities:

• vulnmanagement/dashboard.test.js
• vulnmanagement/entitypages.test.js
• vulnmanagement/imageSection/imageOverview.test.js
• vulnmanagement/nodeSection/nodeOverview.test.js