save file step (#132)

Author: ALegchilov

.gitignore

@@ -2,6 +2,7 @@ node_modules/
 lib/
 coverage/
 test-e2e/report.*
+test-e2e/downloads/
 .idea/
 traces/
 video/

CHANGELOG.md

@@ -10,6 +10,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :pencil: - chore
 :microscope: - experimental
 
+## [0.54.0]
+- :rocket: added _I save file to {string} by clicking {string}_ step
+
 ## [0.53.0]
 - :rocket: added _I grant {string} permission_ step
 - :rocket: added _I revoke browser permissions_ step

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/steps-playwright",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "steps to interact with playwright",
   "main": "./index.js",
   "scripts": {
@@ -26,11 +26,11 @@
   },
   "homepage": "https://github.com/qavajs/steps-playwright#readme",
   "devDependencies": {
-    "@cucumber/cucumber": "^11.0.0",
+    "@cucumber/cucumber": "^11.0.1",
     "@qavajs/cli": "^0.40.0",
-    "@qavajs/console-formatter": "^0.7.2",
+    "@qavajs/console-formatter": "^0.8.0",
     "@qavajs/html-formatter": "^0.18.1",
-    "@qavajs/memory": "^1.8.0",
+    "@qavajs/memory": "^1.9.0",
     "@qavajs/webstorm-adapter": "^8.0.0",
     "@types/chai": "^4.3.17",
     "@types/express": "^4.17.21",
@@ -46,6 +46,6 @@
   },
   "dependencies": {
     "@playwright/test": "^1.47.0",
-    "@qavajs/po-playwright": "^0.16.0"
+    "@qavajs/po-playwright": "^0.16.1"
   }
 }

package.json

@@ -325,6 +325,21 @@ When('I scroll in {string} until {string} to be visible', async function (scroll
     }
 });
 
+/**
+ * Save a file to relative path
+ * @param {string} pathAlias - file path
+ * @param {string} initiatorAlias - alias of an element triggering downloading process
+ * @example I save file to './folder/file.pdf' by clicking 'Download Button'
+ */
+When('I save file to {string} by clicking {string}', async function (pathAlias: string, initiatorAlias: string) {
+    const downloadPromise = page.waitForEvent('download');
+    const element = await getElement(await getValue(initiatorAlias));
+    const path = await getValue(pathAlias);
+    await element.click();
+    const download = await downloadPromise;
+    await download.saveAs(path);
+});
+
 /**
  * Provide file url to upload input
  * @param {string} alias - element to upload file

src/actions.ts

@@ -77,6 +77,7 @@
 <div id="mouseEvent" style="height: 200px; width: 200px; background-color: #0f9e9e"></div>
 <input id="keyboardEvent" style="height: 200px; width: 200px; background-color: #0f9e9e"></input>
 <button id="location" onclick="getLocation()">No location</button>
+<a id="download" href="data:text/plain;charset=utf-8,Hello%20World!" download="hello.txt">Click to download</a>
 <script>
     const locationButton = document.getElementById("location");
     function getLocation() {

test-e2e/apps/actions.html

@@ -257,3 +257,7 @@ Feature: actions
     When I refresh page
     When I click 'Location Button'
     When I expect text of 'Location Button' to equal 'No location'
+
+  Scenario: save file
+    When I save file to '$downloadPath' by clicking 'Download Button'
+    When I expect file '$downloadPath' to exist

test-e2e/features/actions.feature

@@ -41,4 +41,6 @@ export default class Memory {
     location = 'geolocation';
 
     canada = { latitude: 62.39, longitude: -96.81};
+
+    downloadPath = './test-e2e/downloads/text.txt';
 }

test-e2e/memory/index.ts

@@ -61,6 +61,7 @@ export default class App {
     FetchButton = $('#fetchButton');
     FetchResult = $('#fetchResult');
     LocationButton = $('#location');
+    DownloadButton = $('#download');
 
     // Electron
     OpenNewWindowElectronButton = $('#electronButton');

test-e2e/page_object/index.ts

@@ -1,8 +1,8 @@
 import { Then } from '@cucumber/cucumber';
 import memory from '@qavajs/memory';
 import { Page, expect } from '@playwright/test';
-import {getElement} from "../../src/transformers";
-import {getValidation} from "@qavajs/validation";
+import {getValue} from "../../src/transformers";
+import * as fs from "fs";
 
 declare global {
     var page: Page;
@@ -41,3 +41,8 @@ Then('I set {int} ms delayed mock for {string} request', async function (delay:
         }), delay);
     });
 })
+
+Then('I expect file {string} to exist', async function (path: string){
+    const filePresence = fs.existsSync(await getValue(path));
+    expect(filePresence).toBeTruthy();
+});