Replaced repeated element selectors with custom getter commands

Author: asirvadAbrahamVarghese

cypress/e2e/ui/Settings/Application-Settings/edit_collect_logs.cy.js

@@ -12,21 +12,23 @@ const textConstants = {
   zoneAccordItem: /^Zone:/,
   serverAccordItem: /^Server:/,
 
+  // Config options
+  editToolbarButton: 'Edit',
+
   // Buttons
   saveButton: 'Save',
   cancelButton: 'Cancel',
   resetButton: 'Reset',
 
+  // Common element IDs
+  protocolSelectFieldId: 'log_protocol',
+
   // Dropdown values
   dropdownBlankValue: 'BLANK_VALUE',
   sambaDropdownValue: 'FileDepotSmb',
 
-  // Common selectors
-  buttonSelector: (type) => `#main-content .bx--btn-set button[type="${type}"]`,
-
   // Button types
   submitButtonType: 'submit',
-  normalButtonType: 'button',
 
   // Component route url
   componentRouteUrl: '/ops/explorer',
@@ -42,6 +44,7 @@ const textConstants = {
 const {
   diagnosticsAccordionItem,
   dropdownBlankValue,
+  editToolbarButton,
   sambaDropdownValue,
   saveButton,
   cancelButton,
@@ -56,9 +59,8 @@ const {
   flashTypeSuccess,
   flashMessageSettingsSaved,
   flashMessageOperationCanceled,
-  buttonSelector,
   submitButtonType,
-  normalButtonType,
+  protocolSelectFieldId,
 } = textConstants;
 
 function interceptAndAwaitApi({
@@ -99,12 +101,7 @@ function invokeAndAwaitEditEventForServer({ currentApiIntercepts }) {
   interceptAndAwaitApi({
     alias: 'editEventForServer',
     urlPattern: /\/ops\/x_button\/[^/]+\?pressed=.*log_depot_edit/, // matches both /ops/x_button/1?pressed=log_depot_edit & /ops/x_button/2?pressed=zone_log_depot_edit endpoints
-    triggerFn: () =>
-      cy
-        .get(
-          '.miq-toolbar-actions .miq-toolbar-group button[id$="log_depot_edit"]' // matches both buttons log_depot_edit & zone_log_depot_edit
-        )
-        .click(),
+    triggerFn: () => cy.toolbar(editToolbarButton),
     currentApiIntercepts,
   });
 }
@@ -126,18 +123,16 @@ function resetProtocolDropdown({
   invokeAndAwaitEditEventForServer({ currentApiIntercepts });
 
   // Resetting Protocol dropdown value
-  cy.get('#log-depot-settings .bx--select select#log_protocol').then(
-    ($select) => {
-      const currentValue = $select.val();
-      // If the value is not default one(BLANK_VALUE), then setting it to blank
-      if (currentValue !== dropdownBlankValue) {
-        cy.wrap($select).select(dropdownBlankValue);
-        cy.contains(buttonSelector(submitButtonType), saveButton).click();
-        // Validating confirmation flash message
-        cy.expect_flash(flashTypeSuccess, flashMessageSettingsSaved);
-      }
+  cy.getFormSelectFieldById(protocolSelectFieldId).then(($select) => {
+    const currentValue = $select.val();
+    // If the value is not default one(BLANK_VALUE), then setting it to blank
+    if (currentValue !== dropdownBlankValue) {
+      cy.wrap($select).select(dropdownBlankValue);
+      cy.getFormFooterButtonByType(saveButton, submitButtonType).click();
+      // Validating confirmation flash message
+      cy.expect_flash(flashTypeSuccess, flashMessageSettingsSaved);
     }
-  );
+  });
 }
 
 function goToCollectLogsNavbarAndOpenEditForm(registeredApiIntercepts) {
@@ -153,45 +148,35 @@ function goToCollectLogsNavbarAndOpenEditForm(registeredApiIntercepts) {
 
 function cancelButtonValidation() {
   // Click cancel button in the form
-  cy.contains(buttonSelector(normalButtonType), cancelButton)
-    .should('be.enabled')
-    .click();
+  cy.getFormFooterButtonByType(cancelButton).should('be.enabled').click();
   // Validating confirmation flash message
   cy.expect_flash(flashTypeSuccess, flashMessageOperationCanceled);
 }
 
 function resetButtonValidation() {
   // Confirm Reset button is disabled initially
-  cy.contains(buttonSelector(normalButtonType), resetButton).should(
-    'be.disabled'
-  );
+  cy.getFormFooterButtonByType(resetButton).should('be.disabled');
 
   // Selecting Samba option from dropdown
-  cy.get('#log-depot-settings .bx--select select#log_protocol').select(
-    sambaDropdownValue
-  );
+  cy.getFormSelectFieldById(protocolSelectFieldId).select(sambaDropdownValue);
   // Confirm Reset button is enabled once dropdown value is changed and then click on Reset
-  cy.contains(buttonSelector(normalButtonType), resetButton)
-    .should('be.enabled')
-    .click();
+  cy.getFormFooterButtonByType(resetButton).should('be.enabled').click();
   // Confirm dropdown has the old value
-  cy.get('#log-depot-settings .bx--select select#log_protocol').should(
+  cy.getFormSelectFieldById(protocolSelectFieldId).should(
     'have.value',
     dropdownBlankValue
   );
 }
 
 function saveButtonValidation() {
   // Confirm Save button is disabled initially
-  cy.contains(buttonSelector(submitButtonType), saveButton).should(
+  cy.getFormFooterButtonByType(saveButton, submitButtonType).should(
     'be.disabled'
   );
   // Selecting Samba option from dropdown
-  cy.get('#log-depot-settings .bx--select select#log_protocol').select(
-    sambaDropdownValue
-  );
+  cy.getFormSelectFieldById(protocolSelectFieldId).select(sambaDropdownValue);
   // Confirm Save button is enabled once dropdown value is changed and then click on Save
-  cy.contains(buttonSelector(submitButtonType), saveButton)
+  cy.getFormFooterButtonByType(saveButton, submitButtonType)
     .should('be.enabled')
     .click();
   // Validating confirmation flash message
@@ -207,6 +192,7 @@ describe('Automate Collect logs Edit form operations', () => {
   beforeEach(() => {
     registeredApiIntercepts = {};
     cy.login();
+    cy.wait(500);
     // Navigate to Application settings and Select Diagnostics
     cy.menu(settingsMenuOption, appSettingsMenuOption);
     interceptAndAwaitApi({