Added command to validate form labels

Author: asirvadAbrahamVarghese

cypress/support/commands/constants/command_constants.js

@@ -0,0 +1,35 @@
+/*
+ * Form elements validation constants
+ * ==========================================================
+ */
+
+// Form label configuration keys
+export const LABEL_CONFIG_KEYS = {
+  FOR_VALUE: 'forValue',
+  EXPECTED_TEXT: 'expectedText',
+};
+
+// Form user input field configuration keys
+export const FIELD_CONFIG_KEYS = {
+  ID: 'id',
+  FIELD_TYPE: 'fieldType',
+  INPUT_FIELD_TYPE: 'inputFieldType',
+  SHOULD_BE_DISABLED: 'shouldBeDisabled',
+  EXPECTED_VALUE: 'expectedValue',
+};
+
+// Form field types
+export const FIELD_TYPES = {
+  INPUT: 'input',
+  SELECT: 'select',
+  TEXTAREA: 'textarea',
+};
+
+// Form button configuration keys
+export const BUTTON_CONFIG_KEYS = {
+  BUTTON_TEXT: 'buttonText',
+  BUTTON_TYPE: 'buttonType',
+  SHOULD_BE_DISABLED: 'shouldBeDisabled',
+};
+
+/* ========================================================== */

cypress/support/commands/form_elements_validation_commands.js

@@ -0,0 +1,73 @@
+// TODO: Use aliased import(@cypress-dir) once #9631 is merged
+import { LABEL_CONFIG_KEYS } from './constants/command_constants.js';
+
+/**
+ * Helper function to validate that config objects only contain valid keys
+ *
+ * @param {Object} config - The configuration object to validate
+ * @param {Object} validKeysObject - The object containing valid keys (e.g., LABEL_CONFIG_KEYS)
+ * @param {string} configType - The type of configuration being validated (for error messages)
+ */
+const validateConfigKeys = (config, validKeysObject, configType) => {
+  const validKeys = Object.values(validKeysObject);
+  
+  Object.keys(config).forEach(key => {
+    if (!validKeys.includes(key)) {
+      cy.logAndThrowError(
+        `Unknown key "${key}" in ${configType} config. Valid keys are: ${validKeys.join(', ')}`
+      );
+    }
+  });
+};
+
+/**
+ * Validates form field labels based on provided configurations
+ *
+ * @param {Array} labelConfigs - Array of label configuration objects
+ * @param {string} labelConfigs[].forValue - The 'for' attribute value of the label
+ * @param {string} [labelConfigs[].expectedText] - The expected text content of the label
+ *
+ * Example:
+ *   cy.validateFormLabels([
+ *     { [LABEL_CONFIG_KEYS.FOR_VALUE]: 'name', [LABEL_CONFIG_KEYS.EXPECTED_TEXT]: 'Name' },
+ *     { [LABEL_CONFIG_KEYS.FOR_VALUE]: 'email', [LABEL_CONFIG_KEYS.EXPECTED_TEXT]: 'Email Address' }
+ *   ]);
+ *
+ * Or using regular object keys:
+ *   cy.validateFormLabels([
+ *     { forValue: 'name', expectedText: 'Name' },
+ *     { forValue: 'email', expectedText: 'Email Address' }
+ *   ]);
+ *
+ * Both approaches work but using config-keys object(LABEL_CONFIG_KEYS) is recommended to avoid typos and unknown keys
+ */
+Cypress.Commands.add('validateFormLabels', (labelConfigs) => {
+  if (!Array.isArray(labelConfigs)) {
+    cy.logAndThrowError('labelConfigs must be an array');
+  }
+
+  if (!labelConfigs.length) {
+    cy.logAndThrowError('labelConfigs array cannot be empty');
+  }
+
+  labelConfigs.forEach((config) => {
+    validateConfigKeys(config, LABEL_CONFIG_KEYS, 'label');
+
+    const forValue = config[LABEL_CONFIG_KEYS.FOR_VALUE];
+    const expectedText = config[LABEL_CONFIG_KEYS.EXPECTED_TEXT];
+
+    if (!forValue) {
+      cy.logAndThrowError(
+        `${LABEL_CONFIG_KEYS.FOR_VALUE} is required for each label config`
+      );
+    }
+
+    const labelCheck = cy
+      .getFormLabelByForAttribute({ forValue })
+      .should('be.visible');
+
+    if (expectedText) {
+      labelCheck.and('contain.text', expectedText);
+    }
+  });
+});

cypress/support/e2e.js

@@ -44,6 +44,7 @@ import './commands/api_commands.js';
 import './commands/custom_logging_commands.js';
 import './commands/element_selectors.js';
 import './commands/explorer.js';
+import './commands/form_elements_validation_commands.js';
 import './commands/gtl.js';
 import './commands/login.js';
 import './commands/menu.js';