playwright-ts-automationframework 1.1.68 → 1.1.70

package/lib/src/core/assertion.core.d.ts

@@ -0,0 +1,269 @@
+import { Actions } from './actions.core';
+import { WebControl } from './webControl.core';
+import { Page } from '@playwright/test';
+/**
+ * All Verification methods required for test case verification.
+ * @author Ketan Pardeshi
+ * */
+export declare class Assertion extends Actions {
+    constructor(page: Page);
+    /**
+   * Verify two objects are equals.
+   * If both objects are equal test case gets passed else fails.
+   *
+   * @param object1 First object.
+   * @param object2 Second object.
+   * Example:
+   *
+   * verifyIsEquals("Invalid username", "Invalid username");
+   */
+    verifyIsEquals(object1: any, object2: any, controlDescription?: string): void;
+    verifyIsNotEquals(object1: any, object2: any, controlDescription?: string): void;
+    verifyIsEqualIgnorecase(object1: any, object2: any, controlDescription?: string, caseInsensitive?: boolean): void;
+    /**
+   * Verify first value contains substring as second.
+   * If expected value is present in actual value then test case gets passed else failed..
+   *
+   * @param expected First object which has .
+   * @param actual Second object.
+   * Example:
+   *
+   * verifyIsContains("Invalid username Test", "Invalid username");
+   */
+    verifyIsContains(actual: string, expected: string, controlDescription?: string): void;
+    /**
+   * Verify element's displayed/not displayed status as per expected value
+   * If expected element's displayed status is as per expected then test case gets passed else failed..
+   *
+   * @param control Control of which enable or disable status.
+   * @param expValue Expected value enabled as true or disabled as false.
+   * Example:
+   *
+   * loginBtn = new WebControl(this.page.locator('#login'), 'Login button');
+   *
+   * verifyIsDisplayed(loginBtn, true);
+   */
+    verifyIsDisplayed(control: WebControl, expectedIsDisplayed?: boolean): Promise<void>;
+    /**
+       * Verify element is not displayed
+       * If expected element's displayed status is false the test case gets passed else failed..
+       *
+       * @param control Control for which not displayed status need to verify.
+       * @param isAlreadyHidden Is control already hidden or need to wait to get hidden.
+       * Example:
+       *
+       * loginBtn = new WebControl(this.page.locator('#login'), 'Login button');
+       *
+       * verifyIsNotDisplayed(loginBtn, true);
+       */
+    verifyIsNotDisplayed(control: WebControl, isAlreadyHidden?: boolean): Promise<void>;
+    /**
+       * Verify attribute value of the control
+       * If elements attribute value is as per expected value then test case gets passed else failed..
+       *
+       * @param control Control for which attribute value need to verify.
+       * @param attributeName Attribute name.
+       * @param attributeValue Expected attribute value
+       
+       * Example:
+       *
+       * loginBtn = new WebControl(this.page.locator('#login'), 'Login button');
+       *
+       * verifyAttributeValue(loginBtn, "value", "Submit");
+       */
+    verifyAttributeValue(control: WebControl, attributeName: string, expectedAttributeValue: string): Promise<void>;
+    /**
+   * Verify element's attribute value contains expected value
+   * If element's attribute value contains expected value then test case gets passed else failed..
+   *
+   * @param control Control of which attribute value need to verify.
+   * @param attributeName Attribute name
+   * @param expectedText Expected partial value.
+   *
+   * Example:
+   *
+   * loginBtn = new WebControl(this.page.locator('#login'), 'Login button');
+   *
+   * verifyAttributeValueContains(loginBtn, "value", "Submit");
+   */
+    verifyAttributeValueContains(control: WebControl, attributeName: string, attributeValue: string): Promise<void>;
+    /**
+       * Verify element's enabled/disabled status as per expected value
+       * If expected element's enabled status is as per expected then test case gets passed else failed..
+       *
+       * @param control Control of which enable or disable status.
+       * @param expValue Expected value enabled as true or disabled as false.
+       * Example:
+       *
+       * loginBtn = new WebControl(this.page.locator('#login'), 'Login button');
+       *
+       * verifyIsEnabled(loginBtn, true);
+       */
+    verifyIsEnabled(control: WebControl, expValue?: boolean): Promise<void>;
+    verifyIsDisabled(control: WebControl, expValue?: boolean): Promise<void>;
+    /**
+     * The function `verifyIsSelected` asynchronously verifies if a web control is selected with an
+     * expected boolean value.
+     * @param {WebControl} control - The `control` parameter is a WebControl object that represents an
+     * element on a web page that you want to verify the selected status of.
+     * @param {boolean} [expValue=true] - The `expValue` parameter is a boolean value that represents the
+     * expected selection status of a web control. By default, it is set to `true`, meaning that the
+     * control is expected to be selected.
+     */
+    verifyIsSelected(control: WebControl, expValue?: boolean): Promise<void>;
+    /**
+   * Verify element's text as per expected value
+   * If expected element's text is as per expected value then test case gets passed else failed..
+   *
+   * @param control Control of which text need to verify.
+   * @param expectedText Expected value.
+   * Example:
+   *
+   * errorMsg = new WebControl(this.page.locator('#error'), 'Login Error message');
+   *
+   * verifyDisplayedText(loginBtn, "Invalid Username Test User");
+   */
+    verifyDisplayedText(control: WebControl, expectedText: string): Promise<void>;
+    /**
+   * Verify element's text contains partial expected value
+   * If expected element's text contains expected value then test case gets passed else failed..
+   *
+   * @param control Control of which text need to verify.
+   * @param expectedText Expected partial value.
+   * Example:
+   *
+   * errorMsg = new WebControl(this.page.locator('#error'), 'Login Error message');
+   *
+   * verifyDisplayedTextContains(loginBtn, "Invalid Username");
+   */
+    verifyDisplayedTextContains(control: WebControl, expectedText: string): Promise<void>;
+    /**
+      * Verify element's text does not contains expected value
+      * If expected element's text does not contains expected value then test case gets passed else failed..
+      *
+      * @param control Control of which text need to verify.
+      * @param expectedText Expected partial value.
+      * Example:
+      *
+      * errorMsg = new WebControl(this.page.locator('#error'), 'Login Error message');
+      *
+      * verifyDisplayedTextDoesNotContains(loginBtn, "Enter User");
+      */
+    verifyDisplayedTextDoesNotContains(control: WebControl, expectedText: string): Promise<void>;
+    /**
+   * Verify element's textbox is equal to expected value
+   * If expected element's textbox value to be expected value then test case gets passed else failed..
+   *
+   * @param control Textbox control.
+   * @param expectedText Expected value.
+   * Example:
+   *
+   * usernameTxtbx = new WebControl(this.page.locator('#username'), 'Username textbox');
+   *
+   * verifyTextboxValue(usernameTxtbx, "Test@Adactin");
+   */
+    verifyTextboxValue(control: WebControl, expectedText: string): Promise<void>;
+    verifyTextboxValueContains(control: WebControl, expectedText: string): Promise<void>;
+    /**
+  * Verify element's inner text is equal to expected value
+  * If expected element's inner value to be expected value then test case gets passed else failed..
+  *
+  * @param control Textbox control.
+  * @param expectedText Expected value.
+  * Example:
+  *
+  * usernameTxtbx = new WebControl(this.page.locator('#username'), 'Username textbox');
+  *
+  * verifyTextboxValue(usernameTxtbx, "Test@Adactin");
+  */
+    verifyInnerText(control: WebControl, expectedText: string): Promise<void>;
+    verifyInnerTextContains(control: WebControl, expectedText: string): Promise<void>;
+    /**
+  * Verify element's input text is equal to expected value
+  * If expected element's inner value to be expected value then test case gets passed else failed..
+  *
+  * @param control Textbox control.
+  * @param expectedText Expected value.
+  * Example:
+  *
+  * usernameTxtbx = new WebControl(this.page.locator('#username'), 'Username textbox');
+  *
+  * verifyTextboxValue(usernameTxtbx, "Test@Adactin");
+  */
+    verifyInputValue(control: WebControl, expectedText: string): Promise<void>;
+    verifyInputValueContains(control: WebControl, expectedText: string): Promise<void>;
+    /**
+   * Verify element's checkbox/radio value is equal to expected value
+   * If expected element's checkbox/radio value to be expected value then test case gets passed else failed..
+   *
+   * @param control Checkbox/radio control.
+   * @param expectedText Expected checkbox/radio value.
+   * Example:
+   *
+   * isMinor = new WebControl(this.page.locator('#isMinor'), 'Is Minor checkbox');
+   *
+   * verifyCheckboxValue(isMinor, true);
+   */
+    verifyCheckboxValue(control: WebControl, value: boolean): Promise<void>;
+    /**
+   * Verify element's tagname is equal to expected value
+   * If expected element's Tagname is equal to expected value then test case gets passed else failed..
+   *
+   * @param control Checkbox/radio control.
+   * @param expectedText Expected checkbox/radio value.
+   * Example:
+   *
+   * isMinor = new WebControl(this.page.locator('#isMinor'), 'Is Minor checkbox');
+   *
+   * verifyTagName(isMinor, "a");
+   */
+    verifyTagName(control: WebControl, expectedTagName: string): Promise<void>;
+    verifyListContainsValue(control: WebControl, valueToVerify: string): Promise<void>;
+    verifyListContainsMultipleValues(control: WebControl, listOfValueToVerify: string[], waitTillElementIsDisplayed?: boolean): Promise<void>;
+    verifyDropdownOptions(control: WebControl, listOfValueToVerify: string[], waitTillElementIsDisplayed?: boolean): Promise<void>;
+    verifyListForMultipleValues(control: WebControl, listOfValueToVerify: string[], waitTillElementIsDisplayed?: boolean): Promise<void>;
+    /**
+   * Verify Alert text is equal to expected value
+   * If alert text is equal to expected value then test case gets passed else failed..
+   *
+   * @param expectedText Expected alert text.
+   * Example:
+   *
+   * verifyAlertText("Password should be 8 digit.")
+   */
+    verifyAlertText(expectedText: string): Promise<void>;
+    /**
+       * Verify URL contains expected value
+       * If URL contains expected value then test case gets passed else failed..
+       *
+       * @param expectedText Expected partial URL.
+       * Example:
+       *
+       * verifyURLContains("google.com");
+       */
+    verifyURLContains(subString: string): Promise<void>;
+    /**
+   * Verify count of elements which matched the control
+   * If count of elements is equal to expected value then test case will get passed else failed..
+   *
+   * @param control Control element.
+   * @param expectedCount Expected count of elements matching criteria
+   * Example:
+   *
+   * checkboxes = new WebControl(this.page.locator("xpath=//a"), 'checkboxes');
+   * verifyCountOfElements(isMinor, 5);
+   */
+    verifyCountOfElements(control: WebControl, expectedCount: number): Promise<void>;
+    verifyCountOfElementsIsGreaterOrEqual(control: WebControl, expectedCount: number): Promise<void>;
+    verifyCountOfElementsIsLesseOrEqual(control: WebControl, expectedCount: number): Promise<void>;
+    /**
+   * Verify title of web page contains expected value
+   * If title contains expected value then test case will get passed else failed..
+   *
+   * @param expectedText Expected partial Title.
+   * Example:
+   *
+   * verifyPageTitleContains("Google");
+   */
+    verifyPageTitleContains(expectedText: string): Promise<void>;
+}