playwright-ts-automationframework 1.0.2 → 1.0.4

package/README.md

@@ -10,38 +10,31 @@ Project Setup:
 2.	Open Terminal >> New Terminal
 3.	Type Command ‘npm init playwright’ and hit enter.
 4.	Enter all information in terminal asked in terminal and press enter such as language as Typescript going to use in this project, Test case folder folder.
-5.	Project structure will look like below.
- 
-![Alt text](image.png)
 
-6.	Again Open terminal. In terminal type below command and hit enter button.
+5.	Again Open terminal. In terminal type below command and hit enter button.
 ‘npm install playwright-ts-automationframework’.
  It will download the playwright typescript framework library and save in node modules folder. Also you will see entry is added in package.json file.
-7.	Install other necessary libraries using below commands in same way.
-a.	npm install typescript
-8.	After installation all the libraries name with version will get added in package.json file.
+6.	Install other necessary libraries using below commands in same way.
+    a.	npm install typescript
+7.	After installation all the libraries name with version will get added in package.json file.
 
- ![Alt text](image-1.png)
 
 Page folder: 
 1.	Create a folder with name ‘pages’ in the project level.
 2.	Create a file with name MethodBase.pom.ts and class name as MethodBase in page folder which extends the Assertion class from framework library.
 3.	Add constructor with parameter as page and pass this page instance to the parent class.
- 
-![Alt text](image-2.png)
-
 4.	Now you can create each page class which extends MethodBase Class. This means methodBase class will be parent of each page class.
 5.	Create LoginPage.pom.ts class which extends methodBase class. Add constructor to it with page object.
-
- ![Alt text](image-3.png)
-
 6.	Let us add some controls for login page and method to it. In this framework we write in the format of Object of WebControl which accepts first parameter as playwright locator and second parameter as control description. Let us try to automate one basic test case for OrangeHRM and try to create objects and method for it.
 7.	URL: https://opensource-demo.orangehrmlive.com/web/index.php/auth/login
 
 
     usernameTxtbx = new WebControl(this.page.locator("xpath=//input[@name='username']"), "Username textbox");
+
     passwordTxtbx = new WebControl(this.page.locator("xpath=//input[@name='password']"), "Password textbox");
+    
     loginBtn = new WebControl(this.page.locator("xpath=//button[@type='submit']"), "Login button");
+    
     dashboardBtn = new WebControl(this.page.locator("xpath=//span[text()='Dashboard']"), "Dashboard tab button");
 
 
@@ -49,7 +42,7 @@ Page folder:
 
 
 
-async doLogin(username: string, password: string)
+    async doLogin(username: string, password: string)
     {
         await this.type(this.usernameTxtbx, username);
         await this.type(this.passwordTxtbx, password);
@@ -63,37 +56,35 @@ async doLogin(username: string, password: string)
 
 
 9.	Code will look like below.
- 
-![Alt text](image-4.png)
-
 10.	Let us create test file with name ‘login.spec.ts’ test cases in tests folder. We will create beforeEach and afterEach in which we will initialize browser, SetTCID and Execution Completed logging method.
 11.	We will Add Test cases and call the method from page objects and will send parameters from test cases.
 12.	
-13.	import { test } from '@playwright/test';
-14.	import { LoginPage } from '../pages/loginPage.pom';
-15.	import { BasePage } from 'playwright-ts-automationframework';
-16.	
-17.	let loginPage: LoginPage;
-18.	
-19.	test.beforeEach( async ({ page, baseURL }, testinfo) => {
-20.	    loginPage = new LoginPage(page);
-21.	    BasePage.setTestCaseID(testinfo);
-22.	    await loginPage.initializeBrowser(baseURL);
-23.	})
-24.	
-25.	test('Verify login with valid credentials', async ({ page }) => {
-26.	    await loginPage.doLogin("Admin", "admin123");
-27.	    await loginPage.verifyLoginSuccessful();
-28.	});
-29.	
-30.	test.afterEach( async ({ page, baseURL }, testinfo) => {
-31.	    BasePage.executionCompleted(testinfo);
-32.	})
-33.	
+    import { test } from '@playwright/test';
+    import { LoginPage } from '../pages/loginPage.pom';
+    import { BasePage } from 'playwright-ts-automationframework';
+
+    let loginPage: LoginPage;
+
+	test.beforeEach( async ({ page, baseURL }, testinfo) => {
+	    loginPage = new LoginPage(page);
+	    BasePage.setTestCaseID(testinfo);
+	    await loginPage.initializeBrowser(baseURL);
+	})
+	
+	test('Verify login with valid credentials', async ({ page }) => {
+	    await loginPage.doLogin("Admin", "admin123");
+	    await loginPage.verifyLoginSuccessful();
+	});
+	
+	test.afterEach( async ({ page, baseURL }, testinfo) => {
+	    BasePage.executionCompleted(testinfo);
+	})
+	
 
 12. Last Step we need to perform, we need to add two json files at project level 
 a. ExecutionSettings.json
 Execution Settings will contain all the information related to the execution of application such as environment, emailRecivers, senderEmail, senderPassword.
+
 {
     "environment": "#{environment}#",
     "emailRecievers": "#{emailRecievers}#",
@@ -105,6 +96,8 @@ Execution Settings will contain all the information related to the execution of
 
 b. AppConfigurations.json
 AppConfigurations.json file will contain all the configurations related to the QA, PROD or Staging. JSON file will look like below.
+
+
 {
 "QA":
     {
@@ -142,13 +135,7 @@ AppConfigurations.json file will contain all the configurations related to the Q
 
 
 13. Open to playwright.config.ts and navigate to use section. Set BaseURL and add headless flag as false in file.
- 
- ![Alt text](image-5.png)
-
 14. Make sure you have installed below extension in your visual Studio code.
 https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright 
 15. Navigate to Testing Tab in Left side tree. Expand login.spec.ts, select run button in front of test case.
- 
- ![Alt text](image-6.png)
-
 16. This will execute the test case and result will be appeared there.

package/lib/core/actions.core.d.ts

@@ -247,6 +247,17 @@ export declare class Actions extends BasePage {
        * let alertMsg = getAlertDialogMessage();
        */
     getAlertDialogMessage(): Promise<Page>;
+    /**
+       * Return all elements for given search criteria.
+       *
+       * @param WebControl Control on which user want to click.
+       *
+       * Example:
+       *
+       * dateColumn = new WebControl(this.page.locator('#date'), 'Date Column values');
+       *
+       * findAll(dateColumn);
+       */
     findAll(control: WebControl): Promise<import("playwright-core").Locator[]>;
     /**
        * Read the web URL
@@ -320,4 +331,10 @@ export declare class Actions extends BasePage {
     * sleep(10);
     */
     sleep(milliseconds?: number): Promise<unknown>;
+    /**
+        * Close the browser instance
+        *
+        * closeBrowser();
+        */
+    closeBrowser(): Promise<void>;
 }

package/lib/core/actions.core.js

@@ -619,6 +619,17 @@ var Actions = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+       * Return all elements for given search criteria.
+       *
+       * @param WebControl Control on which user want to click.
+       *
+       * Example:
+       *
+       * dateColumn = new WebControl(this.page.locator('#date'), 'Date Column values');
+       *
+       * findAll(dateColumn);
+       */
     Actions.prototype.findAll = function (control) {
         return __awaiter(this, void 0, void 0, function () {
             var allElements;
@@ -824,6 +835,21 @@ var Actions = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+        * Close the browser instance
+        *
+        * closeBrowser();
+        */
+    Actions.prototype.closeBrowser = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.page.close()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return Actions;
 }(basePage_core_1.BasePage));
 exports.Actions = Actions;

package/lib/core/configuration.core.js

@@ -52,13 +52,13 @@ var Configuration = /** @class */ (function () {
     });
     Object.defineProperty(Configuration, "configurationData", {
         get: function () {
-            if (Configuration.environment.toUpperCase() == "QA") {
+            if (Configuration.environment.toUpperCase().includes("QA")) {
                 return appConfigurations.QA;
             }
-            else if (Configuration.environment.toUpperCase() == "STAGE") {
+            else if (Configuration.environment.toUpperCase().includes("STAG")) {
                 return appConfigurations.STAGE;
             }
-            else if (Configuration.environment.toUpperCase() == "PROD") {
+            else if (Configuration.environment.toUpperCase().includes("PROD")) {
                 return appConfigurations.PROD;
             }
             else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-ts-automationframework",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",