-
Notifications
You must be signed in to change notification settings - Fork 365
Enhance form element selectors #9598
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
jrafanie
merged 5 commits into
ManageIQ:master
from
asirvadAbrahamVarghese:enhance-form-element-selectors
Sep 10, 2025
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
00fd83e
Enhanced element selector commands for improved readability
asirvadAbrahamVarghese 72cf661
Revised element_selectors section in README
asirvadAbrahamVarghese 4bf8dcb
Selecting by ID through attribute syntax
asirvadAbrahamVarghese 0c0b963
Added custom selector for form textarea element
asirvadAbrahamVarghese 84dcf23
Included textarea selector command in README
asirvadAbrahamVarghese File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,104 @@ | ||
| /* eslint-disable no-undef */ | ||
|
|
||
| /** | ||
| * Retrieves a form footer button by its name and type. | ||
| * Retrieves a form footer button by its text content and type using an object parameter. | ||
| * | ||
| * @param {string} name - The name or text content of the button. | ||
| * @param {string} [type='button'] - The HTML button type (e.g., 'button', 'submit', 'reset'). Defaults to 'button'. | ||
| * @param {Object} options - The options object. | ||
| * @param {string} options.buttonText - The text content of the button (required). | ||
| * @param {string} [options.buttonType='button'] - The HTML button type (e.g., 'button', 'submit', 'reset'). Defaults to 'button'. | ||
| * @returns {Element} The matched button element. | ||
| * @throws {Error} If buttonName is not provided. | ||
| * | ||
| * Example: | ||
| * cy.getFormFooterButtonByType('Save Changes'); | ||
| * cy.getFormFooterButtonByType('Reset', 'reset'); | ||
| * cy.getFormFooterButtonByTypeWithText({ buttonText: 'Save Changes' }); | ||
| * cy.getFormFooterButtonByTypeWithText({ buttonText: 'Submit', buttonType: 'submit' }); | ||
| */ | ||
| Cypress.Commands.add('getFormFooterButtonByType', (name, type = 'button') => | ||
| cy.contains(`#main-content .bx--btn-set button[type="${type}"]`, name) | ||
| Cypress.Commands.add( | ||
| 'getFormFooterButtonByTypeWithText', | ||
| ({ buttonType = 'button', buttonText } = {}) => { | ||
| if (!buttonText) { | ||
| cy.logAndThrowError('buttonName is required'); | ||
| } | ||
| return cy.contains( | ||
| `#main-content .bx--btn-set button[type="${buttonType}"]`, | ||
| buttonText | ||
| ); | ||
| } | ||
| ); | ||
|
|
||
| /** | ||
| * Retrieves a form input field by its ID and type. | ||
| * Retrieves a form input field by its ID and type using an object parameter. | ||
| * | ||
| * @param {string} inputId - The ID of the input field. | ||
| * @param {string} [type='text'] - The HTML input type (e.g., 'text', 'email', 'password'). Defaults to 'text'. | ||
| * @param {Object} options - The options object. | ||
| * @param {string} options.inputId - The ID of the input field (required). | ||
| * @param {string} [options.inputType='text'] - The HTML input inputType (e.g., 'text', 'email', 'password'). Defaults to 'text'. | ||
| * @returns {Element} The matched input field element. | ||
| * @throws {Error} If inputId is not provided. | ||
| * | ||
| * Example: | ||
| * cy.getFormInputFieldById('name'); | ||
| * cy.getFormInputFieldById('name', 'text'); | ||
| * cy.getFormInputFieldByIdAndType({ inputId: 'name' }); | ||
| * cy.getFormInputFieldByIdAndType({ inputId: 'password', inputType: 'password' }); | ||
| */ | ||
| Cypress.Commands.add('getFormInputFieldById', (inputId, type = 'text') => | ||
| cy.get(`#main-content .bx--form input#${inputId}[type="${type}"]`) | ||
| Cypress.Commands.add( | ||
| 'getFormInputFieldByIdAndType', | ||
| ({ inputId, inputType = 'text' }) => { | ||
| if (!inputId) { | ||
| cy.logAndThrowError('inputId is required'); | ||
| } | ||
| return cy.get( | ||
| `#main-content .bx--form input[id="${inputId}"][type="${inputType}"]` | ||
| ); | ||
| } | ||
| ); | ||
|
|
||
| /** | ||
| * Retrieves a form label associated with a specific input field by its ID. | ||
| * Retrieves a form label associated with a specific input field by its 'for' attribute. | ||
| * | ||
| * @param {string} inputId - The ID of the input field. | ||
| * @param {Object} options - The options object. | ||
| * @param {string} options.forValue - The value of the 'for' attribute that matches the input field's ID (required). | ||
| * @returns {Element} The matched label element. | ||
| * @throws {Error} If forValue is not provided. | ||
| * | ||
| * Example: | ||
| * cy.getFormLabelByInputId('name'); | ||
| * cy.getFormLabelByForAttribute({ forValue: 'name' }); | ||
| */ | ||
| Cypress.Commands.add('getFormLabelByInputId', (inputId) => | ||
| cy.get(`#main-content .bx--form label[for="${inputId}"]`) | ||
| ); | ||
| Cypress.Commands.add('getFormLabelByForAttribute', ({ forValue }) => { | ||
| if (!forValue) { | ||
| cy.logAndThrowError('forValue is required'); | ||
| } | ||
| return cy.get(`#main-content .bx--form label[for="${forValue}"]`); | ||
| }); | ||
|
|
||
| /** | ||
| * Retrieves a form select field by its ID. | ||
| * Retrieves a form select field by its ID using an object parameter. | ||
| * | ||
| * @param {string} selectId - The ID of the select field. | ||
| * @param {Object} options - The options object. | ||
| * @param {string} options.selectId - The ID of the select field (required). | ||
| * @returns {Element} The matched select field element. | ||
| * @throws {Error} If selectId is not provided. | ||
| * | ||
| * Example: | ||
| * cy.getFormSelectFieldById('select-scan-limit'); | ||
| * cy.getFormSelectFieldById({ selectId: 'select-scan-limit' }); | ||
| */ | ||
| Cypress.Commands.add('getFormSelectFieldById', (selectId) => | ||
| cy.get(`#main-content .bx--form select#${selectId}`) | ||
| ); | ||
| Cypress.Commands.add('getFormSelectFieldById', ({ selectId }) => { | ||
| if (!selectId) { | ||
| cy.logAndThrowError('selectId is required'); | ||
| } | ||
| return cy.get(`#main-content .bx--form select[id="${selectId}"]`); | ||
| }); | ||
|
|
||
| /** | ||
| * Retrieves a form textarea field by its ID using an object parameter. | ||
| * | ||
| * @param {Object} options - The options object. | ||
| * @param {string} options.textareaId - The ID of the textarea field (required). | ||
| * @returns {Element} The matched textarea field element. | ||
| * @throws {Error} If textareaId is not provided. | ||
| * | ||
| * Example: | ||
| * cy.getFormTextareaById({ textareaId: 'default.auth_key' }); | ||
| */ | ||
| Cypress.Commands.add('getFormTextareaById', ({ textareaId }) => { | ||
| if (!textareaId) { | ||
| cy.logAndThrowError('textareaId is required'); | ||
| } | ||
| return cy.get(`#main-content .bx--form textarea[id="${textareaId}"]`); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a follow up, we call the function WithText, perhaps buttonText would be a better term to use in the error message.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops...