@actionlogementservices/wdio-test-context 1.0.0

package/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[*.md]
+trim_trailing_whitespace = false

package/.jsdoc.json

@@ -0,0 +1,35 @@
+{
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "include": ["./src"],
+    "exclude": ["node_modules"]
+  },
+  "opts": {
+    "template": "node_modules/kis-jsdoc-plugin/templates/markdown",
+    "encoding": "utf8",
+    "destination": "./doc/",
+    "recurse": true,
+    "includes": "public,private"
+  },
+  "plugins": ["node_modules/jsdoc-escape-at", "node_modules/kis-jsdoc-plugin"],
+  "templates": {
+    "markdown": {
+      "imageext": "png",
+      "tocfilename": "toc.md",
+      "tocOrder": {
+        "public": 1,
+        "internal": 2
+      },
+      "badgecolors": {
+        "public": "FF5000",
+        "internal": "009663",
+        "other": "9f9f9f"
+      },
+      "externallinks": {
+        "Promise": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"
+      }
+    }
+  }
+}

package/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "useTabs": false,
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 110,
+  "arrowParens": "avoid",
+  "bracketSameLine": true,
+  "htmlWhitespaceSensitivity": "ignore"
+}

package/README.md

@@ -0,0 +1,116 @@
+# wdio-test-context
+A framework to add test context to webdriverio end to end tests.
+- It uses JSON files (named dataset) and optional javascript function to add dynamic content to your dataset.
+- It consumes a disposable mail service (YOPmail, maildrop or Guerilla Mail) in order to check for new message.
+- It provides pdf generation to enable document uploads.
+- It provides an Azure DevOps webdriverio reporter.
+- It generates a screenshot when the test fails.
+
+## Installation 
+
+- In your webdriverio test project:
+
+  ```sh
+  npm install @actionlogementservices/wdio-test-context
+  ```
+
+- Create a `data` folder
+
+- Create JSON files in the `data` folder: this will be your datasets.
+
+- Create a `data/test-context.d.ts`: this will add intellisense when you use your test context data within the spec files.
+
+- Create a `data/test-context.js` file with the following code:
+
+  ```js
+  // import your own function to generate dynamic data
+  import { generateRandomData } from './generate-random-data.js'; 
+  import { TestContext } from '@actionlogementservices/wdio-test-context';
+
+  // to enable intellisense with your own data
+  /** @typedef {import('./test-context.d.ts').TestContextModel} TestContextModel */
+
+  /** @type {TestContextModel & TestContext} */
+  export const testContext = /** @type {TestContextModel & TestContext} */ (
+    new TestContext()
+      .setDataGenerator(generateRandomData) // optional : add your own dynamic data
+      .setDefaultDataset('test') // default dataset name when DATASET env var is not specified
+      .setEnvironment('local', {
+        frontUrl: 'https://test.lvh.me',
+        backOfficeUrl: 'https://test-backoffice.lvh.me:4432',
+        sso: true,
+      })
+      .setEnvironment('staging', {
+        frontUrl: 'https://staging.domain.com',
+        backOfficeUrl: 'https://staging-backoffice.domain.com',
+      })
+      .initialize()
+  );  
+  ```
+
+- Create optionnally `data/generate-random-data.js` to add dynamic data, file with the following code:
+
+  ```js
+  import { faker } from '@faker-js/faker/locale/fr';
+  import moment from 'moment';
+
+  /** @typedef {import('@actionlogementservices/wdio-test-context/types').DataGenerator} DataGenerator */
+
+  /** @type {DataGenerator} */
+  function generateRandomData(_context) {
+    // dates random
+    const customDate = faker.date.between({ from: '1995-01-01', to: '2001-01-01' });
+    return {
+      customDate,
+    };
+  }
+
+  export { generateRandomData };
+  ```
+
+- Configure webdriverio: in your wdio.conf.js:
+
+    ```js
+  import { AdoReporter, TestContextWorkerService } from '@actionlogementservices/wdio-test-context';
+  import { testContext } from './data/test-context.js';
+
+  export const config = {
+    ...
+    reporters: [[AdoReporter, {}]],
+    services: [[TestContextWorkerService, { testContext, logLevel: 'debug' }]],
+    ...
+  ```
+
+## Use the test context in the spec file
+
+- Somewhere in your spec files: 
+
+  ```js
+  import { testContext } from '../../environments.js';
+
+  describe(`[Inbox] - ${testContext.user.email} - I`, () => {
+  let confirmationLink;
+  it('receive a mail with confirmation code within 10s', async () => {
+    await browser.open(testContext.getParameter('frontUrl')); // to retrieve parameters
+    const from = 'no-reply@domain.com';
+    const subject = `Confirmation code`;
+    // to wait for email and to access test context data
+    const content = await testContext.mailService.waitForMessage(testContext.user.email, from, subject);
+    confirmationCode = getConfirmationCode(content);
+    expect(confirmationCode).toContain('123456');
+  });
+  ```
+
+## Run your test
+
+- Specify the dataset with the `DATASET` env var and the environment with the `TARGET_ENV` env var
+
+  ```sh
+  TARGET_ENV=staging DATASET=full-scenario npx wdio
+  or
+  TARGET_ENV=staging DATASET=full-scenario npm test
+  ```
+
+## Code documentation
+
+- Code is [documented here](./doc/toc.md).

package/doc/images/badges/modifier-abstract.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="55" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#477ca1" d="M0 0h0v20H0z"/>
+    <path fill="#477ca1" d="M0 0h55v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="275" y="140" transform="scale(.1)" textLength="450">abstract</text>
+  </g>
+</svg>

package/doc/images/badges/modifier-default.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="49" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#b90000" d="M0 0h0v20H0z"/>
+    <path fill="#b90000" d="M0 0h49v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="245" y="140" transform="scale(.1)" textLength="390">default</text>
+  </g>
+</svg>

package/doc/images/badges/modifier-private.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="49" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#e07a18" d="M0 0h0v20H0z"/>
+    <path fill="#e07a18" d="M0 0h49v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="245" y="140" transform="scale(.1)" textLength="390">private</text>
+  </g>
+</svg>

package/doc/images/badges/modifier-protected.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="63" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#009664" d="M0 0h0v20H0z"/>
+    <path fill="#009664" d="M0 0h63v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="315" y="140" transform="scale(.1)" textLength="530">protected</text>
+  </g>
+</svg>

package/doc/images/badges/modifier-public.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="43" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#2c732c" d="M0 0h0v20H0z"/>
+    <path fill="#2c732c" d="M0 0h43v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="215" y="140" transform="scale(.1)" textLength="330">public</text>
+  </g>
+</svg>

package/doc/images/badges/modifier-readonly.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="57" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#5b5b5b" d="M0 0h0v20H0z"/>
+    <path fill="#5b5b5b" d="M0 0h57v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="285" y="140" transform="scale(.1)" textLength="470">readonly</text>
+  </g>
+</svg>

package/doc/images/badges/modifier-static.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg"
+  xmlns:xlink="http://www.w3.org/1999/xlink" width="39" height="20">
+  <g shape-rendering="crispEdges">
+    <path fill="#36796f" d="M0 0h0v20H0z"/>
+    <path fill="#36796f" d="M0 0h39v20H0z"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="195" y="140" transform="scale(.1)" textLength="290">static</text>
+  </g>
+</svg>

package/doc/src-page-objects_guerrillamail.page.md

@@ -0,0 +1,69 @@
+# Module `page-objects/guerrillamail.page`
+
+![category:internal](https://img.shields.io/badge/category-internal-009663.svg?style=flat-square)
+
+Page-object on top of Guerilla Mail.
+
+[Source file](../src/page-objects/guerrillamail.page.js)
+
+# Class `GuerillamailPage`
+
+Implements a page-object on top of Guerilla Mail.
+
+## Methods
+
+### `openInbox(email)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to open the mailbox.
+
+Parameters | Type | Description
+--- | --- | ---
+__email__ | `string` | *disposable email*
+
+---
+
+### `retrieveDomains() ► Promise.<Array.<string>>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to retrieve domains exposed by the provider.
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | `Promise.<Array.<string>>` | **
+
+---
+
+### `getMessages() ► `
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to get emails.
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | `undefined` | **
+
+---
+
+### `getMessageContent(index) ► Promise.<string>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to get the specified message content.
+
+Parameters | Type | Description
+--- | --- | ---
+__index__ | `number` | **
+__*return*__ | `Promise.<string>` | **
+
+---
+
+## Members
+
+Name | Type | Description
+--- | --- | ---
+__name__ | `undefined` | *name of the provider*
+__domains__ | `undefined` | *domains exposed of the provider*

package/doc/src-page-objects_maildrop.page.md

@@ -0,0 +1,57 @@
+# Module `page-objects/maildrop.page`
+
+![category:internal](https://img.shields.io/badge/category-internal-009663.svg?style=flat-square)
+
+Page-object on top of maildrop.
+
+[Source file](../src/page-objects/maildrop.page.js)
+
+# Class `MaildropPage`
+
+Implements a page-object on top of maildrop.
+
+## Methods
+
+### `openInbox(email)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to open the mailbox.
+
+Parameters | Type | Description
+--- | --- | ---
+__email__ | `string` | *disposable email*
+
+---
+
+### `getMessages() ► `
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to get emails.
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | `undefined` | **
+
+---
+
+### `getMessageContent(index) ► Promise.<string>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+WDIO logic to get the specified message content.
+
+Parameters | Type | Description
+--- | --- | ---
+__index__ | `number` | **
+__*return*__ | `Promise.<string>` | **
+
+---
+
+## Members
+
+Name | Type | Description
+--- | --- | ---
+__name__ | `undefined` | *name of the provider*
+__domains__ | `undefined` | *domains exposed of the provider*