Merge pull request #9538 from asirvadAbrahamVarghese/update-readme-expect_alerts

Updated README and method-level docs for expect_alert commands

Author: jrafanie

cypress/README.md

@@ -69,3 +69,5 @@ ManageIQ implements the following cypress extensions:
 * `cy.expect_show_list_title(title)` - check the title on a show\_list screen matches the provided title. `title`: String for the title.
 * `cy.expect_search_box()` - check if searchbox is present on the screen.
 * `cy.expect_text(element, text)` - check if the text in the element found by doing cy.get on the element String matches the provided text. `element`: String for the Cypress selector to get a specific element on the screen. `text`: String for the text that should be found within the selected element.
+* `cy.expect_flash(flashType, containsText)` - command to validate flash messages. `flashType` is the type of flash (success, warning, error, info). `containsText` is the optional text that the flash-message should contain. e.g. `expect_flash('warning', 'cancelled');`
+* `cy.expect_browser_confirm_with_text({ confirmTriggerFn, containsText, proceed })` - command to validate browser confirm alerts. `confirmTriggerFn` is the function that triggers the confirm dialog. This function **must return a Cypress.Chainable**, like `cy.get(...).click()` so that Cypress can properly wait and chain .then() afterward. `containsText` is the optional text that the confirm alert should contain. `proceed` is the flag to determine whether to proceed with the confirm (true = OK, false = Cancel). e.g. `cy.expect_browser_confirm_with_text({containsText: 'sure to proceed?', proceed: true, confirmTriggerFn: () => { return cy.get('[data-testid="delete"]').click()}});`, `cy.expect_browser_confirm_with_text({ confirmTriggerFn: () => cy.contains('deleted').click()});`

cypress/support/assertions/expect_alerts.js

@@ -39,15 +39,15 @@ Cypress.Commands.add(
  *                                                                 This function **must return a Cypress.Chainable**, like `cy.get(...).click()`,
  *                                                                 so that Cypress can properly wait and chain `.then()` afterward.
  *                                                                 @example
- *                                                                 cy.expectBrowserConfirm({
+ *                                                                 cy.expect_browser_confirm_with_text({
  *                                                                    containsText: 'sure to proceed?',
  *                                                                    proceed: true,
  *                                                                    confirmTriggerFn: () => {
  *                                                                       return cy.get('[data-testid="delete"]').click()
  *                                                                    }
  *                                                                 });
  *                                                                 @example
- *                                                                 cy.expectBrowserConfirm({
+ *                                                                 cy.expect_browser_confirm_with_text({
  *                                                                    confirmTriggerFn: () => cy.contains('deleted').click()
  *                                                                 });
  * @param {string} [options.containsText] - Optional text that the confirm alert should contain.