@actionlogementservices/wdio-test-context 1.0.0

package/doc/src_ado-client.md

@@ -0,0 +1,55 @@
+# Module `ado-client`
+
+![category:internal](https://img.shields.io/badge/category-internal-009663.svg?style=flat-square)
+
+Azure DevOps rest client to push test results.
+
+[Source file](../src/ado-client.js)
+
+## Functions
+
+### `isNullOrEmpty()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+
+
+---
+
+### `getConnectionInfo() ► ConnectionInfo`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Retrieves Azure DevOps connection information.
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | `ConnectionInfo` | **
+
+---
+
+### `getApis(connectionInfo) ► Promise.<Apis>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Gets all necessary REST API clients.
+See https://github.com/Microsoft/azure-devops-node-api and https://docs.microsoft.com/en-us/rest/api/azure/devops/
+
+Parameters | Type | Description
+--- | --- | ---
+__connectionInfo__ | `ConnectionInfo` | **
+__*return*__ | `Promise.<Apis>` | **
+
+---
+
+### `createAdoTestRun(testRun)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Creates the Azure DevOps TestRun.
+
+Parameters | Type | Description
+--- | --- | ---
+__testRun__ | `RunModel` | **
+
+---

package/doc/src_logger.md

@@ -0,0 +1,183 @@
+# Module `logger`
+
+![category:internal](https://img.shields.io/badge/category-internal-009663.svg?style=flat-square)
+
+Internal logger.
+
+[Source file](../src/logger.js)
+
+## Functions
+
+### `logError()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+console implementation @type {(message: string) => void}
+
+---
+
+### `logWarn()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+console implementation @type {(message: string) => void}
+
+---
+
+### `logInfo()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+console implementation @type {(message: string) => void}
+
+---
+
+### `logDebug()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+console implementation @type {(message: string) => void}
+
+---
+
+### `log()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+console implementation @type {(message: string) => void}
+
+---
+
+### `bold()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+
+
+---
+
+## Constants
+
+### `logger`
+
+![modifier: public](images/badges/modifier-public.png) ![modifier: static](images/badges/modifier-static.png)
+
+The common logger instance.
+
+#### Value
+
+```javascript
+new Logger('error')
+```
+
+---
+
+# Class `Logger`
+
+
+
+## Methods
+
+### `setLogLevel(logLevel)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Sets the logging level.
+
+Parameters | Type | Description
+--- | --- | ---
+__logLevel__ | `import('./types').LogLevel` | *logging level*
+
+---
+
+### `info(message)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs an **informational** message.
+
+Parameters | Type | Description
+--- | --- | ---
+__message__ | `string` | *the message to log*
+
+---
+
+### `log(message)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs a message.
+
+Parameters | Type | Description
+--- | --- | ---
+__message__ | `string` | *the message to log*
+
+---
+
+### `warn(message)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs a **warning** message.
+
+Parameters | Type | Description
+--- | --- | ---
+__message__ | `string` | *the message to log*
+
+---
+
+### `error(message)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs an **error** message.
+
+Parameters | Type | Description
+--- | --- | ---
+__message__ | `string` | *the message to log*
+
+---
+
+### `debug(message)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs a **debug** message
+
+Parameters | Type | Description
+--- | --- | ---
+__message__ | `string` | *the message to log*
+
+---
+
+### `detailError(detailedError)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs an **error** message based on the specified error object.
+
+Parameters | Type | Description
+--- | --- | ---
+__detailedError__ | `Error` | *the error object to log*
+
+---
+
+### `warnError(text, meaningfulErrorInfo)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Logs an **warning** message based on the specified error object.
+
+Parameters | Type | Description
+--- | --- | ---
+__text__ | `string` | *the text message to log*
+__meaningfulErrorInfo__ | `Object` | *the meaningfull error info to log*
+
+---
+
+## Members
+
+Name | Type | Description
+--- | --- | ---
+___logMethodFactory__ | `Map<'error' \| 'warn' \| 'info' \| 'debug' \| 'log', (message: string) => void>` | **
+___level__ | `Number` | **

package/doc/src_mail-service.md

@@ -0,0 +1,54 @@
+# Module `mail-service`
+
+![category:public](https://img.shields.io/badge/category-public-FF5000.svg?style=flat-square)
+
+**Mail service** to send and retrieve mail from various provider.
+Accessible through the **mailService property** of the TestContext instance.
+
+[Source file](../src/mail-service.js)
+
+# Class `MailService`
+
+
+
+## Methods
+
+### `sendMessage(from, to, subject, html) ► Promise.<void>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Sends a mail.
+
+Parameters | Type | Description
+--- | --- | ---
+__from__ | `string` | *sender*
+__to__ | `string` | *recipient*
+__subject__ | `string` | *subject of the mail*
+__html__ | `string` | *html body string of the mail*
+__*return*__ | `Promise.<void>` | **
+
+---
+
+### `waitForMessage(email, from, subject) ► Promise.<string>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Waits for an email from the specified sender and containing the specified subject
+and gets its content.
+
+Parameters | Type | Description
+--- | --- | ---
+__email__ | `string` | *recipient email*
+__from__ | `string` | *sender*
+__subject__ | `string` | *subject of email*
+__*return*__ | `Promise.<string>` | *content of email*
+
+---
+
+## Members
+
+Name | Type | Description
+--- | --- | ---
+__provider__ | `MailProvider` | *disposable email provider @type {MailProvider}*
+__name__ | `string` | *Provider name*
+__domains__ | `Array.<string>` | *Emails domains exposed by the provider.*

package/doc/src_pdf-generator.md

@@ -0,0 +1,35 @@
+# Module `pdf-generator`
+
+![category:public](https://img.shields.io/badge/category-public-FF5000.svg?style=flat-square)
+
+**Pdf file generator**.
+
+[Source file](../src/pdf-generator.js)
+
+## Functions
+
+### `generatePdf(filename, context) ► Promise.<string>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Generates a pdf file with specified name and context data.
+
+Parameters | Type | Description
+--- | --- | ---
+__filename__ | `string` | *file name*
+__context__ | `import('./test-context.js').TestContext` | *test context*
+__*return*__ | `Promise.<string>` | *the file path*
+
+---
+
+### `deletePdf(filepath)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Deletes the specified file.
+
+Parameters | Type | Description
+--- | --- | ---
+__filepath__ | `string` | *pdf file path*
+
+---

package/doc/src_test-context.md

@@ -0,0 +1,173 @@
+# Module `test-context`
+
+![category:public](https://img.shields.io/badge/category-public-FF5000.svg?style=flat-square)
+
+**Test Context** to be populated and passed to WDIO specs.
+
+[Source file](../src/test-context.js)
+
+## Constants
+
+### `defaultMailProviderName`
+
+![modifier: public](images/badges/modifier-public.png)
+
+
+
+#### Value
+
+```javascript
+'maildrop'
+```
+
+---
+
+# Class `TestContext`
+
+Implements **Test Context** with data to pass to WDIO specs.
+
+## Methods
+
+### `setEnvironment(name, parameters, environmentOptions) ► TestContext`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Implements a test context with environments and dataset in webdriverio.
+
+Parameters | Type | Description
+--- | --- | ---
+__name__ | `string` | *name of the environment (defined by TARGET_ENV environment variable)*
+__parameters__ | `Record.<string, any>` | *custom parameters (like &#x27;url&#x27;)*
+__environmentOptions__ | `import('./types.js').EnvironmentOptions` | *custom options*
+__*return*__ | [TestContext](src_test-context.md) | **
+
+---
+
+### `setDataGenerator(dataGenerator) ► TestContext`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Defines a custom function that adds data to the current dataset
+
+Parameters | Type | Description
+--- | --- | ---
+__dataGenerator__ | `DataGenerator` | **
+__*return*__ | [TestContext](src_test-context.md) | **
+
+---
+
+### `setDefaultDataset(name) ► TestContext`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Defines the **default dataset** when no DATASET environment variable is specified.
+
+Parameters | Type | Description
+--- | --- | ---
+__name__ | `string` | *name ot the default dataset*
+__*return*__ | [TestContext](src_test-context.md) | **
+
+---
+
+### `setMailProvider(name) ► TestContext`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Defines the **disposable email provider**. Overriden by MAILPROVIDER environment variable. **maildrop** is default value.
+
+Parameters | Type | Description
+--- | --- | ---
+__name__ | `MailProviderName` | *name of the disposable mail service provider*
+__*return*__ | [TestContext](src_test-context.md) | **
+
+---
+
+### `setLogLevel(level)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Sets the logging level.
+
+Parameters | Type | Description
+--- | --- | ---
+__level__ | `LogLevel` | *logging level*
+
+---
+
+### `initialize() ► TestContext`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Initializes the data of the test context.
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | [TestContext](src_test-context.md) | **
+
+---
+
+### `getParameter(name, mandatory) ► any`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Retrieves the specified parameter of the current environment.
+
+Parameters | Type | Description
+--- | --- | ---
+__name__ | `string` | **
+__mandatory__ | `boolean` | **
+__*return*__ | `any` | **
+
+---
+
+### `recordTestUser()`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Records the current created user.
+
+---
+
+### `_generateRandomUser(mailService) ► TestUser`
+
+![modifier: private](images/badges/modifier-private.png)
+
+Generates a random user.
+
+Parameters | Type | Description
+--- | --- | ---
+__mailService__ | [MailService](src_mail-service.md) | **
+__*return*__ | `TestUser` | **
+
+---
+
+### `_getPreviouslyRecordedUser(email) ► TestUser`
+
+![modifier: private](images/badges/modifier-private.png)
+
+Retrieves the previously recorded user.
+
+Parameters | Type | Description
+--- | --- | ---
+__email__ | `string` | **
+__*return*__ | `TestUser` | **
+
+---
+
+## Members
+
+Name | Type | Description
+--- | --- | ---
+__user__ | `TestUser` | *Test user @type {TestUser}*
+__mailService__ | [MailService](src_mail-service.md) | *Mail service @type {MailService}*
+__environmentName__ | `undefined` | *Retrieves the name of the current environment.*
+__environment__ | `undefined` | *Retrieves the configuration of the current environment.*
+__dataset__ | `undefined` | *The current dataset.*
+__isDefaultDataset__ | `undefined` | *Is the current dataset the default one.*
+___environments__ | `Map<string, TestEnvironmentConfiguration>` | *Test environments @private @type {Map&lt;string, TestEnvironmentConfiguration&gt;}*
+___mailProviderName__ | `MailProviderName` | *Mail provider name @private @type {MailProviderName}*
+___dataFolder__ | `string` | *data folder @private @type {string}*
+___logFolder__ | `string` | *log folder @private @type {string}*
+___recordedUsersFilepath__ | `string` | *data folder @private @type {string}*
+___dataGenerator__ | `DataGenerator` | *custom data generator @private @type {DataGenerator}*
+___defaultDatasetName__ | `string` | *default dataset name @private @type {string}*

package/doc/toc.md

@@ -0,0 +1,22 @@
+# Code documentation
+
+## Table of contents
+
+* ![category:public](https://img.shields.io/badge/category-public-FF5000.svg?style=flat-square)
+  * [mail-service](src_mail-service.md) - _**Mail service** to send and retrieve mail from various provider.
+Accessible through the **mailService property** of the TestContext instance._
+  * [page-objects/page](src-page-objects_page.md) - _Base page object for WDIO page objects._
+  * [pdf-generator](src_pdf-generator.md) - _**Pdf file generator**._
+  * [test-context](src_test-context.md) - _**Test Context** to be populated and passed to WDIO specs._
+  * [wdio/ado-reporter](src-wdio_ado-reporter.md) - _**WDIO Reporter** to handle Azure DevOps Test Run generation._
+
+* ![category:internal](https://img.shields.io/badge/category-internal-009663.svg?style=flat-square)
+  * [ado-client](src_ado-client.md) - _Azure DevOps rest client to push test results._
+  * [logger](src_logger.md) - _Internal logger._
+  * [page-objects/guerrillamail.page](src-page-objects_guerrillamail.page.md) - _Page-object on top of Guerilla Mail._
+  * [page-objects/maildrop.page](src-page-objects_maildrop.page.md) - _Page-object on top of maildrop._
+  * [page-objects/yopmail.page](src-page-objects_yopmail.page.md) - _Page-object on top of YOPmail._
+
+* ![category:other](https://img.shields.io/badge/category-other-9f9f9f.svg?style=flat-square)
+  * [wdio/test-context-worker-service](src-wdio_test-context-worker-service.md) - _Module wdio/test-context-worker-service_
+

package/eslint.config.js

@@ -0,0 +1,100 @@
+import arrayFunc from 'eslint-plugin-array-func';
+import promise from 'eslint-plugin-promise';
+import unicorn from 'eslint-plugin-unicorn';
+import prettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+
+export default [
+  eslint.configs.recommended,
+  arrayFunc.configs.recommended,
+  promise.configs['flat/recommended'],
+  unicorn.configs.recommended,
+  prettierRecommended,
+  eslintConfigPrettier,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.builtin,
+        ...globals.nodeBuiltin,
+        ...globals.node
+      },
+      ecmaVersion: 'latest',
+      sourceType: 'module'
+    },
+
+    rules: {
+      'no-var': 2,
+      'prefer-const': 1,
+      'no-shadow': 2,
+      'no-unused-vars': [
+        2,
+        {
+          vars: 'local',
+          args: 'none'
+        }
+      ],
+      'no-use-before-define': 0,
+      'no-console': 1,
+      'no-alert': 1,
+      'consistent-return': 0,
+      'default-case': 2,
+      'dot-notation': 2,
+      eqeqeq: 2,
+      'guard-for-in': 1,
+      'no-caller': 2,
+      'no-else-return': 2,
+      'no-eq-null': 2,
+      'no-eval': 2,
+      'no-extend-native': 2,
+      'no-extra-bind': 2,
+      'no-implied-eval': 2,
+      'no-lone-blocks': 2,
+      'no-loop-func': 2,
+      'no-multi-str': 2,
+      'no-native-reassign': 2,
+      'no-new': 2,
+      'no-new-func': 2,
+      'no-new-wrappers': 2,
+      'no-octal-escape': 2,
+      'no-param-reassign': 0,
+      'no-proto': 2,
+      'no-script-url': 2,
+      'no-self-compare': 2,
+      'no-sequences': 2,
+      'no-throw-literal': 2,
+      'no-useless-concat': 1,
+      radix: 0,
+      'vars-on-top': 2,
+      yoda: 2,
+      camelcase: [
+        2,
+        {
+          properties: 'never'
+        }
+      ],
+      'func-names': 0,
+      'new-cap': ['error', { newIsCapExceptions: ['jsPDF'] }],
+      'no-nested-ternary': 2,
+      'no-new-object': 2,
+      'no-underscore-dangle': 0,
+      'one-var': [2, 'never'],
+      'spaced-comment': [
+        1,
+        'always',
+        {
+          exceptions: ['*']
+        }
+      ],
+      'no-return-assign': ['error', 'except-parens'],
+
+      'array-func/prefer-array-from': 0,
+      'promise/no-promise-in-callback': 0,
+
+      'unicorn/prefer-spread': 0,
+      'unicorn/prefer-number-properties': 0,
+      'unicorn/prefer-node-protocol': 0
+    }
+  }
+];

package/jsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "checkJs": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": ["node", "@wdio/globals/types"]
+  },
+  "exclude": ["node_modules"]
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@actionlogementservices/wdio-test-context",
+  "version": "1.0.0",
+  "description": "A framework to add test context to webdriverio end to end tests.",
+  "main": "src/index.js",
+  "type": "module",
+  "types": "src/types.d.ts",
+  "exports": {
+    ".": "./src/index.js",
+    "./types": "./src/types.d.ts"
+  },
+  "scripts": {
+    "prettier": "prettier \"./src/**/*.js\" --write",
+    "eslint": "eslint \"./src/**/*.js\"",
+    "doc": "jsdoc -c ./.jsdoc.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/actionlogementservices/wdio-test-context.git"
+  },
+  "keywords": [
+    "wdio"
+  ],
+  "author": "Action Logement Services",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/actionlogementservices/wdio-test-context/issues"
+  },
+  "homepage": "https://github.com/actionlogementservices/wdio-test-context#readme",
+  "devDependencies": {
+    "@eslint/js": "^9.23.0",
+    "@wdio/spec-reporter": "^9.11.0",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-array-func": "^5.0.2",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-unicorn": "^57.0.0",
+    "globals": "^16.0.0",
+    "jsdoc": "^4.0.4",
+    "jsdoc-escape-at": "^1.0.1",
+    "kis-jsdoc-plugin": "^2.2.1",
+    "prettier": "^3.5.3"
+  },
+  "dependencies": {
+    "@faker-js/faker": "^9.6.0",
+    "azure-devops-node-api": "^14.1.0",
+    "chalk": "^5.4.1",
+    "glob": "^11.0.1",
+    "jspdf": "^3.0.1",
+    "lodash.merge": "^4.6.2",
+    "moment": "^2.30.1",
+    "nodemailer": "^6.10.0"
+  },
+  "peerDependencies": {
+    "@wdio/globals": "^9.12.1"
+  }
+}