Merge pull request #9531 from asirvadAbrahamVarghese/enhance-select-accordion-item

Scope accordion-item search to expanded panel only

Author: jrafanie

cypress/README.md

@@ -33,6 +33,7 @@ ManageIQ implements the following cypress extensions:
 
 * `cy.accordion(title)` - open an accordion panel. `title`: String for the accordion title for the accordion panel to open.
 * `cy.accordionItem(name)` - click on a record in the accordion panel. `name`: String for the record to click in the accordion panel.
+* `cy.selectAccordionItem(accordionPath)` - navigates the expanded accordion panel(use cy.accordion to expand an accordion panel) and then expand the nodes along the given path and click the final target item. `accordionPath`: A mixed array of strings and/or regex patterns that represent the path to the intended target node. e.g. Simple string path: `cy.selectAccordionItem(['Datastore', 'My-Domain', 'My-Namespace']);`, Path with regular expressions: `cy.selectAccordionItem([/^ManageIQ Region:/, /^Zone:/, /^Server:/]);`, Mixed path with strings and regular expressions: `cy.selectAccordionItem([/^ManageIQ Region:/, 'Zones', /^Zone:/]);`                                             
 
 ##### gtl
 

cypress/e2e/ui/validate-select-accordion-item.cy.js

@@ -1,12 +1,25 @@
 /* eslint-disable no-undef */
 
-describe('Validate clickItem', () => {
+/* @RemoveLater: Remove this test suite once the command is confirmed to be stable */
+describe('Validate select accordion item', () => {
   beforeEach(() => {
     cy.login();
     cy.menu('Settings', 'Application Settings');
   });
 
-  it('should fail when an invalid node label is passed', (done) => {
+  it('should search nodes only within expanded tree', () => {
+    // expand Diagnostics tree
+    cy.accordion('Diagnostics');
+    // should open the path under Diagnostics even if
+    // an identical one exists under Settings
+    cy.selectAccordionItem([
+      /^ManageIQ Region:/,
+      /^Zone:/,
+      /^Server:/,
+    ]);
+  });
+
+  it('should fail when an invalid target node label is passed', (done) => {
     cy.accordion('Access Control');
 
     cy.on('fail', (err) => {
@@ -17,7 +30,22 @@ describe('Validate clickItem', () => {
     cy.selectAccordionItem([
       'ManageIQ Region: Region 0 [0]',
       'Tenants',
-      'No Company', // This label does not exist
+      'No Company', // This target node is not valid
+    ]);
+  });
+
+  it('should fail when an invalid intermediate node label is passed', (done) => {
+    cy.accordion('Access Control');
+
+    cy.on('fail', (err) => {
+      expect(err.message).to.include('not found');
+      done();
+    });
+
+    cy.selectAccordionItem([
+      'ManageIQ Region: Region 0 [0]',
+      'Tenants Section', // This intermediate node is not valid
+      'My Company',
     ]);
   });
 

cypress/support/commands/explorer.js

@@ -33,7 +33,7 @@ Cypress.Commands.add('accordionItem', (name) => {
  * If the path is not found, it will throw an error.
  */
 Cypress.Commands.add('selectAccordionItem', (accordionPath) => {
-  cy.get('li.list-group-item').then(($items) => {
+  cy.get('div.panel-collapse.collapse.in li.list-group-item').then(($items) => {
     // Converting jQuery collection to an array for easier manipulation
     const listItems = [...$items];
 
@@ -49,7 +49,7 @@ Cypress.Commands.add('selectAccordionItem', (accordionPath) => {
       const isClickableNode = accordionPathIndex === accordionPath.length - 1;
 
       for (let i = searchStartIndex; i < listItems.length; i++) {
-        /* To remove */
+        /* @RemoveLater: Remove logger once the command is confirmed to be stable */
         Cypress.log({
           name: 'selectAccordionItem',
           message: `Loop index: ${i} & Searching for label: ${accordionLabel}`,
@@ -66,7 +66,7 @@ Cypress.Commands.add('selectAccordionItem', (accordionPath) => {
         }
 
         if (isMatch) {
-          /* To remove */
+          /* @RemoveLater: Remove logger once the command is confirmed to be stable */
           Cypress.log({
             name: 'selectAccordionItem',
             message: `Matched "${liText}" at index ${i}`,
@@ -106,7 +106,15 @@ Cypress.Commands.add('selectAccordionItem', (accordionPath) => {
         }
       }
       // If we reach here, it means the label was not found
-      throw new Error(`Accordion item: "${accordionLabel}" not found`);
+      const errorMessage = `${
+        isClickableNode ? 'Target' : 'Intermediate'
+      } node - "${accordionLabel}" was not found`;
+      Cypress.log({
+        name: 'error',
+        displayName: '❗ CypressError:',
+        message: errorMessage,
+      });
+      throw new Error(errorMessage);
     };
 
     // Start the recursive call from the first label in the given path