@actionlogementservices/wdio-test-context 1.0.1 → 1.1.0

package/README.md

@@ -1,12 +1,14 @@
 # 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 
+## Installation
 
 - In your webdriverio test project:
 
@@ -24,7 +26,7 @@ A framework to add test context to webdriverio end to end tests.
 
   ```js
   // import your own function to generate dynamic data
-  import { generateRandomData } from './generate-random-data.js'; 
+  import { generateRandomData } from './generate-random-data.js';
   import { TestContext } from '@actionlogementservices/wdio-test-context';
 
   // to enable intellisense with your own data
@@ -36,16 +38,17 @@ A framework to add test context to webdriverio end to end tests.
       .setDataGenerator(generateRandomData) // optional : add your own dynamic data
       .setDefaultDataset('test') // default dataset name when DATASET env var is not specified
       .setEnvironment('local', {
+        //define parameters for your environment
         frontUrl: 'https://test.lvh.me',
         backOfficeUrl: 'https://test-backoffice.lvh.me:4432',
-        sso: true,
+        sso: true
       })
       .setEnvironment('staging', {
         frontUrl: 'https://staging.domain.com',
-        backOfficeUrl: 'https://staging-backoffice.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:
@@ -61,16 +64,41 @@ A framework to add test context to webdriverio end to end tests.
     // dates random
     const customDate = faker.date.between({ from: '1995-01-01', to: '2001-01-01' });
     return {
-      customDate,
+      customDate
     };
   }
 
   export { generateRandomData };
   ```
 
+- Configure optionnaly a **RabbitMQ client** if you plan to send some RabbitMQ message within your tests:
+
+  > **NOTE**
+  >
+  > - If you have secrets in your connection string, you need to
+  >
+  >   - create a `.env.{your_environment_name}.local` file (for instance `.env.staging.local`) with your secret configuration parameters.
+  >   - add the following entries to your `.gitignore`:
+  >
+  >     `.env.local`<br>`.env.*.local`
+
+  ```js
+  export const testContext = /** @type {TestContextModel & TestContext} */ (
+    new TestContext()
+      .setEnvironment(
+        'local',
+        {
+          frontUrl: 'https://test.lvh.me',
+        },
+        {
+          amqp: String.raw`amqps://${process.env.RMQ_USER}:${process.env.RMQ_PWD}@your-host:5671/your-vhost`,
+        }
+      )
+  ```
+
 - Configure webdriverio: in your wdio.conf.js:
 
-    ```js
+  ```js
   import { AdoReporter, TestContextWorkerService } from '@actionlogementservices/wdio-test-context';
   import { testContext } from './data/test-context.js';
 
@@ -79,25 +107,158 @@ A framework to add test context to webdriverio end to end tests.
     reporters: [[AdoReporter, {}]],
     services: [[TestContextWorkerService, { testContext, logLevel: 'debug' }]],
     ...
+  }
+  ```
+
+## Notes on secrets
+
+If you have **secrets** in your parameter values, you need to
+
+- create a `.env.{your_environment_name}.local` file (for instance `.env.staging.local`) with your secret configuration parameters:
+
+  ```sh
+  DB_PWD="MySyperStrongPassword"
+  CLIENT_SECRET="MySuperSafeSecret"
+  ```
+
+- references the secret in the environment.js like this:
+
+  ```js
+  .setEnvironment('staging', {
+    sql: 'Server=YourServer;Password=${process.env.DB_PWD};...'
+  ```
+
+- to add the following entries to your `.gitignore` to prevent storing secret values in your repository:
+
+  ```sh
+  .env.local
+  .env.*.local
   ```
 
 ## Use the test context in the spec file
 
-- Somewhere in your spec files: 
+### To access the mail service
+
+- Access the `mailService` property:
 
   ```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');
+    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');
+    });
+  }
+  ```
+
+### To execute SQL queries
+
+- You need to define a **parameter** in `your environment.js` that contains the **sql connection string**. In the following exemple it is named `sqlBO`.
+
+  ```js
+  export const testContext = /** @type {TestContextModel & TestContext} */ (
+    new TestContext()
+      .setEnvironment(
+        'local',
+        {
+          frontUrl: 'https://test.lvh.me',
+          sqlBO: String.raw`Driver={ODBC Driver 17 for SQL Server};Server=(localdb)\MSSQLLocalDB;Database=YourDatabase;Trusted_Connection=yes;`,
+        }
+      )
+  ```
+
+  > **NOTES on SQL connection string**
+  >
+  > - If you plan to use `(localdb)` or **Windows authentication** this requires an **ODBC driver** with a specific connection string syntax : `Driver={...}`. You also need to check which Microsoft SQL Server **ODBC driver** is installed on your system with the `ODBC Data Sources` control panel.
+  > - For Microsoft Sql Server instance without Windows Authentication, there is no need to use an ODBC driver. In such case remove the `Driver={...}` portion of the connection string.
+  > - You **can not** mix both syntax in the same environment.
+  > - In the previous example, `(localdb)` is used with the `ODBC Driver 17 for SQL Server` which is installed.
+
+- Somewhere in you spec files
+
+  ```js
+  import { testContext } from '../../environments.js';
+
+  describe(`Before starting the test, we`, () => {
+
+  it('check the sql version', async () => {
+    const result = await testContext.executeSql('sqlBO', (sql) => sql.query('SELECT @@Version'));
+    ...
+  });
+  ```
+
+### To publish AMQP message
+
+- You need to define a **parameter** in `your environment.js` that contains the **amqp connection string**. In the following exemple it is named `amqpBO`.
+
+  ```js
+  export const testContext = /** @type {TestContextModel & TestContext} */ (
+    new TestContext()
+      .setEnvironment(
+        'local',
+        {
+          frontUrl: 'https://test.lvh.me',
+          amqpBO: String.raw`Driver={ODBC Driver 17 for SQL Server};Server=(localdb)\MSSQLLocalDB;Database=YourDatabase;Trusted_Connection=yes;`,
+        }
+      )
+  ```
+
+- Somewhere in you spec files
+
+  ```js
+  import { testContext } from '../../environments.js';
+
+  describe(`Before starting the test, we`, () => {
+
+  it('send an amqp message', async () => {
+    const result = await testContext.publishMessage('amqpBO',
+      'exchange',             // your exchange name
+      'routingKey',           // your routing key
+      'type',                 // your message type
+      { test: true },         // your message payload
+      testContext.user.email  // something to correlate/track you message
+    );
+    expect(result).toBe(true);
+  });
+  ```
+
+### To run a VTOM job
+
+- You need to define a **parameter** in `your environment.js` that contains the **VTOM configuration**. In the following exemple it is named `vtomBO`.
+
+  ```js
+  export const testContext = /** @type {TestContextModel & TestContext} */ (
+    new TestContext()
+      .setEnvironment(
+        'local',
+        {
+          frontUrl: 'https://test.lvh.me',
+          vtomBO: {
+            url: 'https://...',
+            apiKey: 'abcdef',
+            environement: 'DEV'
+          },
+        }
+      )
+  ```
+
+- Somewhere in you spec files
+
+  ```js
+  import { testContext } from '../../environments.js';
+
+  describe(`Before starting the test, we`, () => {
+
+  it('run a vtom job', async () => {
+    const result = await testContext.runVtomJob('vtomBO', 'app', 'job');
+    expect(result).toBe(true);
   });
   ```
 

package/doc/src-page-objects_page.md

@@ -128,7 +128,7 @@ __*return*__ | `Promise.<string>` | *the corresponding inner html*
 
 ---
 
-### `getOptions(css, timeout) ► Promise.<Array.<string>>`
+### `getSelectOptions(css, childrenCount, timeout) ► Promise.<Array.<string>>`
 
 ![modifier: public](images/badges/modifier-public.png)
 
@@ -138,12 +138,13 @@ Waits during the specified (or default) timeout **before throwing error**.
 Parameters | Type | Description
 --- | --- | ---
 __css__ | `string` | *css selector of the select*
+__childrenCount__ | `number` | *optional count of children to wait for (default 1)*
 __timeout__ | `number` | *optional timeout before throwing error*
 __*return*__ | `Promise.<Array.<string>>` | *the corresponding values*
 
 ---
 
-### `getSelectedText(css, timeout) ► Promise.<string>`
+### `getSelectSelectedText(css, childrenCount, timeout) ► Promise.<string>`
 
 ![modifier: public](images/badges/modifier-public.png)
 
@@ -153,12 +154,13 @@ Waits during the specified (or default) timeout **before throwing error**.
 Parameters | Type | Description
 --- | --- | ---
 __css__ | `string` | *css selector of the select*
+__childrenCount__ | `number` | *optional count of children to wait for (default 1)*
 __timeout__ | `number` | *optional timeout before throwing error*
 __*return*__ | `Promise.<string>` | *the corresponding text*
 
 ---
 
-### `getSelectedValue(css, timeout) ► Promise.<string>`
+### `getSelectSelectedValue(css, childrenCount, timeout) ► Promise.<string>`
 
 ![modifier: public](images/badges/modifier-public.png)
 
@@ -168,6 +170,7 @@ Waits during the specified (or default) timeout **before throwing error**.
 Parameters | Type | Description
 --- | --- | ---
 __css__ | `string` | *css selector of the select*
+__childrenCount__ | `number` | *optional count of children to wait for (default 1)*
 __timeout__ | `number` | *optional timeout before throwing error*
 __*return*__ | `Promise.<string>` | *the corresponding text*
 
@@ -335,7 +338,7 @@ __*return*__ | `Promise.<boolean>` | *true if condition is fullfilled*
 
 Parameters | Type | Description
 --- | --- | ---
-__css__ | `string` | *css selector*
+__css__ | `string` | *css selector that contains children*
 __childrenCount__ | `number` | *optional count of children to wait for (default 1)*
 __timeout__ | `number` | *optional timeout before throwing error*
 __*return*__ | `Promise.<boolean>` | *true if condition is fullfilled*

package/doc/src_amqp-client.md

@@ -0,0 +1,28 @@
+# Module `amqp-client`
+
+![category:private](https://img.shields.io/badge/category-private-blue.svg?style=flat-square)
+
+**Amqp client** to send message on a Amqp broker.
+Accessible through the **publishMessage** method of the TestContext instance.
+
+[Source file](../src/amqp-client.js)
+
+## Functions
+
+### `publishMessage(connectionString, exchange, routingKey, type, payload, correlationId) ► Promise.<boolean>`
+
+![modifier: public](images/badges/modifier-public.png) ![modifier: static](images/badges/modifier-static.png)
+
+Publishes the message to the specified exchange of the specified amqp server.
+
+Parameters | Type | Description
+--- | --- | ---
+__connectionString__ | `string` | *connection string*
+__exchange__ | `string` | *name of the exchange*
+__routingKey__ | `string` | *routing key*
+__type__ | `string` | *type of the message*
+__payload__ | `T` | *message payload*
+__correlationId__ | `string` | *correlation id for message tracking*
+__*return*__ | `Promise.<boolean>` | **
+
+---

package/doc/src_ca-loader.md

@@ -0,0 +1,17 @@
+# Module `ca-loader`
+
+![category:internal](https://img.shields.io/badge/category-internal-009663.svg?style=flat-square)
+
+CA certificates loader.
+
+[Source file](../src/ca-loader.js)
+
+## Functions
+
+### `loadCACertificates()`
+
+![modifier: public](images/badges/modifier-public.png) ![modifier: static](images/badges/modifier-static.png)
+
+Loads CA certificats if there are present in a ca folder.
+
+---

package/doc/src_sql-client.md

@@ -0,0 +1,24 @@
+# Module `sql-client`
+
+![category:private](https://img.shields.io/badge/category-private-blue.svg?style=flat-square)
+
+**Sql client** to execute query on Miscrosoft SQL Server.
+Accessible through the **executeSql** method of the TestContext instance.
+
+[Source file](../src/sql-client.js)
+
+## Functions
+
+### `executeSql(connectionString, requestFunction) ► Promise.<T>`
+
+![modifier: public](images/badges/modifier-public.png) ![modifier: static](images/badges/modifier-static.png)
+
+Executes the provided function passing the sql request object.
+
+Parameters | Type | Description
+--- | --- | ---
+__connectionString__ | `string` | *sql server connection string*
+__requestFunction__ | `(sql: import('mssql').Request) => T` | *function using the sql request object*
+__*return*__ | `Promise.<T>` | *sql query result*
+
+---

package/doc/src_test-context.md

@@ -38,7 +38,7 @@ 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*
+__environmentOptions__ | `import('./types.d.ts').EnvironmentOptions` | *custom options (like sql or rabbitMQ clients)*
 __*return*__ | [TestContext](src_test-context.md) | **
 
 ---
@@ -128,6 +128,53 @@ Records the current created user.
 
 ---
 
+### `publishMessage(parameterName, exchange, routingKey, type, payload, correlationId) ► Promise.<boolean>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Published the amqp message to the specified exchange.
+
+Parameters | Type | Description
+--- | --- | ---
+__parameterName__ | `string` | *name of the environment parameter that defines the amqp connection string*
+__exchange__ | `string` | *name of the exchange*
+__routingKey__ | `string` | *routing key*
+__type__ | `string` | *type of the message*
+__payload__ | `T` | *message payload*
+__correlationId__ | `string` | *correlation id for message tracking*
+__*return*__ | `Promise.<boolean>` | **
+
+---
+
+### `executeSql(parameterName, sqlOperation) ► Promise.<T>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Executes the specified sql operation.
+
+Parameters | Type | Description
+--- | --- | ---
+__parameterName__ | `string` | *name of the environment parameter that defines the sql connection string*
+__sqlOperation__ | `(sql: import('mssql').Request) => T` | *function using the sql request object*
+__*return*__ | `Promise.<T>` | *sql query result*
+
+---
+
+### `runVtomJob(parameterName, appName, jobName) ► Promise.<boolean>`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Runs the specified vtom job.
+
+Parameters | Type | Description
+--- | --- | ---
+__parameterName__ | `string` | *name of the environment parameter that defines the vtom configuration*
+__appName__ | `string` | *vtom application name*
+__jobName__ | `string` | *vtom job name*
+__*return*__ | `Promise.<boolean>` | *true if successful execution*
+
+---
+
 ### `_generateRandomUser(mailService) ► TestUser`
 
 ![modifier: private](images/badges/modifier-private.png)
@@ -160,6 +207,7 @@ Name | Type | Description
 --- | --- | ---
 __user__ | `TestUser` | *Test user @type {TestUser}*
 __mailService__ | [MailService](src_mail-service.md) | *Mail service @type {MailService}*
+__defaultEnvironmentName__ | `undefined` | *Retrieves the default (i.e. the first) environment name.*
 __environmentName__ | `undefined` | *Retrieves the name of the current environment.*
 __environment__ | `undefined` | *Retrieves the configuration of the current environment.*
 __dataset__ | `undefined` | *The current dataset.*

package/doc/src_vtom-client.md

@@ -0,0 +1,53 @@
+# Module `vtom-client`
+
+![category:private](https://img.shields.io/badge/category-private-blue.svg?style=flat-square)
+
+**Vtom client** to run Vtom job.
+Accessible through the **runVtomJob** method of the TestContext instance.
+
+[Source file](../src/vtom-client.js)
+
+## Functions
+
+### `wait(ms)`
+
+![modifier: public](images/badges/modifier-public.png)
+
+
+
+Parameters | Type | Description
+--- | --- | ---
+__ms__ | `number` | *number of milliseconds to wait*
+
+---
+
+### `createClient(baseURL, apiKey) ► import('axios').AxiosInstance`
+
+![modifier: public](images/badges/modifier-public.png)
+
+Creates the http client.
+
+Parameters | Type | Description
+--- | --- | ---
+__baseURL__ | `string` | *api base url*
+__apiKey__ | `string` | *vtom api key*
+__*return*__ | `import('axios').AxiosInstance` | *}*
+
+---
+
+### `runVtomJob(apiUrl, apiKey, environment, appName, jobName) ► Promise.<boolean>`
+
+![modifier: public](images/badges/modifier-public.png) ![modifier: static](images/badges/modifier-static.png)
+
+Runs the specified vtom job.
+
+Parameters | Type | Description
+--- | --- | ---
+__apiUrl__ | `string` | *vtom base api url*
+__apiKey__ | `string` | *vtom api key*
+__environment__ | `string` | *vtom environment*
+__appName__ | `string` | *vtom application name*
+__jobName__ | `string` | *vtom job name*
+__*return*__ | `Promise.<boolean>` | **
+
+---

package/doc/toc.md

@@ -2,6 +2,22 @@
 
 ## Table of contents
 
+* ![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._
+  * [ca-loader](src_ca-loader.md) - _CA certificates loader._
+  * [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:private](https://img.shields.io/badge/category-private-blue.svg?style=flat-square)
+  * [amqp-client](src_amqp-client.md) - _**Amqp client** to send message on a Amqp broker.
+Accessible through the **publishMessage** method of the TestContext instance._
+  * [sql-client](src_sql-client.md) - _**Sql client** to execute query on Miscrosoft SQL Server.
+Accessible through the **executeSql** method of the TestContext instance._
+  * [vtom-client](src_vtom-client.md) - _**Vtom client** to run Vtom job.
+Accessible through the **runVtomJob** method of the TestContext instance._
+
 * ![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._
@@ -10,13 +26,6 @@ Accessible through the **mailService property** of the TestContext instance._
   * [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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@actionlogementservices/wdio-test-context",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A framework to add test context to webdriverio end to end tests.",
   "main": "src/index.js",
   "type": "module",
@@ -44,13 +44,19 @@
   },
   "dependencies": {
     "@faker-js/faker": "^9.6.0",
+    "amqplib": "^0.10.7",
+    "axios": "^1.8.4",
     "azure-devops-node-api": "^14.1.0",
     "chalk": "^5.4.1",
+    "dotenv-flow": "^4.1.0",
     "glob": "^11.0.1",
     "jspdf": "^3.0.1",
     "lodash.merge": "^4.6.2",
     "moment": "^2.30.1",
-    "nodemailer": "^6.10.0"
+    "msnodesqlv8": "^4.5.0",
+    "mssql": "^11.0.1",
+    "nodemailer": "^6.10.0",
+    "syswide-cas": "^5.3.0"
   },
   "peerDependencies": {
     "@wdio/globals": "^9.12.1"

package/src/amqp-client.js

@@ -0,0 +1,49 @@
+/**
+ * **Amqp client** to send message on a Amqp broker.
+ * Accessible through the **publishMessage** method of the TestContext instance.
+ * @module
+ * @category private
+ */
+
+import amqp from 'amqplib';
+
+import { logger } from './logger.js';
+
+const appId = 'wdio-test';
+
+/**
+ * Publishes the message to the specified exchange of the specified amqp server.
+ * @template T
+ * @param {string} connectionString connection string
+ * @param {string} exchange name of the exchange
+ * @param {string} routingKey routing key
+ * @param {string} type type of the message
+ * @param {T} payload message payload
+ * @param {string} correlationId correlation id for message tracking
+ * @returns {Promise<boolean>}
+ */
+export async function publishMessage(connectionString, exchange, routingKey, type, payload, correlationId) {
+  let connection;
+  let channel;
+  try {
+    connection = await amqp.connect(connectionString, { clientProperties: { connection_name: appId } });
+    channel = await connection.createChannel();
+    const content = Buffer.from(JSON.stringify(payload));
+    /** @type {import('amqplib').Options.Publish} */ const options = {
+      appId,
+      contentType: 'application/json',
+      correlationId,
+      timestamp: Date.now(),
+      type
+    };
+    const result = channel.publish(exchange, routingKey, content, options);
+    if (result) logger.debug('Amqp message sent.');
+    return result;
+  } catch (error) {
+    logger.detailError(error);
+    throw new Error(`Amqp error: '${error.message}'!`);
+  } finally {
+    if (channel) channel.close();
+    if (connection) connection.close();
+  }
+}

package/src/ca-loader.js

@@ -0,0 +1,24 @@
+/**
+ * CA certificates loader.
+ * @module
+ * @category internal
+ */
+
+import path from 'node:path';
+
+import { glob } from 'glob';
+import { addCAs } from 'syswide-cas';
+
+/**
+ * Loads CA certificats if there are present in a ca folder.
+ */
+export function loadCACertificates() {
+  const caFiles = glob.sync('**/*.crt', {
+    absolute: true,
+    cwd: path.join(process.cwd(), 'ca'),
+    nodir: true
+  });
+  if (caFiles && caFiles.length > 0) {
+    addCAs(caFiles);
+  }
+}

package/src/sql-client.js

@@ -0,0 +1,34 @@
+/**
+ * **Sql client** to execute query on Miscrosoft SQL Server.
+ * Accessible through the **executeSql** method of the TestContext instance.
+ * @module
+ * @category private
+ */
+
+import { logger } from './logger.js';
+
+// import sql from 'mssql'
+
+/**
+ * Executes the provided function passing the sql request object.
+ * @template T
+ * @param {string} connectionString sql server connection string
+ * @param {(sql: import('mssql').Request) => T} requestFunction function using the sql request object
+ * @returns {Promise<T>} sql query result
+ */
+export async function executeSql(connectionString, requestFunction) {
+  const isOdbcDriver = connectionString.includes('Driver=');
+  const sqlConfiguration = isOdbcDriver ? { driver: 'msnodesqlv8', connectionString } : connectionString;
+  const sqlPackageName = isOdbcDriver ? 'mssql/msnodesqlv8.js' : 'mssql';
+  const { default: sql } = await import(sqlPackageName);
+  const pool = new sql.ConnectionPool(sqlConfiguration);
+  try {
+    const client = await pool.connect();
+    const result = await requestFunction(client.request());
+    logger.debug(`Sql query executed.`);
+    return result;
+  } catch (error) {
+    logger.detailError(error);
+    throw new Error(`Sql error: '${error.message}'!`);
+  }
+}

package/src/test-context.js

@@ -7,18 +7,23 @@
 import fs from 'node:fs';
 import path from 'node:path';
 
+import dotenvFlow from 'dotenv-flow';
 import { faker } from '@faker-js/faker/locale/fr';
 import merge from 'lodash.merge';
 import { SevereServiceError } from 'webdriverio';
 
 import { MailService } from './mail-service.js';
 import { logger } from './logger.js';
+import { executeSql } from './sql-client.js';
+import { publishMessage } from './amqp-client.js';
+import { loadCACertificates } from './ca-loader.js';
+import { runVtomJob } from './vtom-client.js';
 
-/** @typedef {import('./types.js').TestEnvironmentConfiguration} TestEnvironmentConfiguration */
-/** @typedef {import('./types.js').TestUser} TestUser */
-/** @typedef {import('./types.js').MailProviderName} MailProviderName */
-/** @typedef {import('./types.js').DataGenerator} DataGenerator */
-/** @typedef {import('./types.js').LogLevel} LogLevel */
+/** @typedef {import('./types.d.ts').TestEnvironmentConfiguration} TestEnvironmentConfiguration */
+/** @typedef {import('./types.d.ts').TestUser} TestUser */
+/** @typedef {import('./types.d.ts').MailProviderName} MailProviderName */
+/** @typedef {import('./types.d.ts').DataGenerator} DataGenerator */
+/** @typedef {import('./types.d.ts').LogLevel} LogLevel */
 
 export const defaultDatasetName = 'default';
 const defaultRecordedUsersFilename = 'users.json';
@@ -44,7 +49,7 @@ export class TestContext {
    * Implements a test context with environments and dataset in webdriverio.
    * @param {string} name name of the environment (defined by TARGET_ENV environment variable)
    * @param {Record<string, any>} parameters custom parameters (like 'url')
-   * @param {import('./types.js').EnvironmentOptions} [environmentOptions] custom options
+   * @param {import('./types.d.ts').EnvironmentOptions} [environmentOptions] custom options (like sql or rabbitMQ clients)
    * @returns {TestContext}
    */
   setEnvironment(name, parameters, environmentOptions) {
@@ -98,6 +103,11 @@ export class TestContext {
    * @returns {TestContext}
    */
   initialize() {
+    loadCACertificates();
+    // dotenv-flow configuration
+    dotenvFlow.config({
+      node_env: process.env.TARGET_ENV || this.defaultEnvironmentName
+    });
     // email provider
     this.mailService = new MailService(this._mailProviderName ?? defaultMailProviderName);
     // data folder
@@ -143,14 +153,22 @@ export class TestContext {
   }
 
   /**
-   * Retrieves the name of the current environment.
+   * Retrieves the default (i.e. the first) environment name.
    * @returns {string}
    */
-  get environmentName() {
+  get defaultEnvironmentName() {
     if (this._environments.size === 0)
       throw new SevereServiceError('At least one environment must be set! Check your environment.js file.');
-    const firstEnvironmentName = this._environments.keys().next().value;
-    return (process.env.TARGET_ENV || firstEnvironmentName).toLowerCase();
+    return this._environments.keys().next().value;
+  }
+
+  /**
+   * Retrieves the name of the current environment.
+   * @returns {string}
+   */
+  get environmentName() {
+    const defaultEnvironmentName = this.defaultEnvironmentName;
+    return (process.env.TARGET_ENV || defaultEnvironmentName).toLowerCase();
   }
 
   /**
@@ -245,4 +263,44 @@ export class TestContext {
     users.push({ environment, dataset, date, lastname, firstname, gender, email, password });
     fs.writeFileSync(this._recordedUsersFilepath, JSON.stringify(users));
   }
+
+  /**
+   * Published the amqp message to the specified exchange.
+   * @template T
+   * @param {string} parameterName name of the environment parameter that defines the amqp connection string
+   * @param {string} exchange name of the exchange
+   * @param {string} routingKey routing key
+   * @param {string} type type of the message
+   * @param {T} payload message payload
+   * @param {string} correlationId correlation id for message tracking
+   * @returns {Promise<boolean>}
+   */
+  async publishMessage(parameterName, exchange, routingKey, type, payload, correlationId) {
+    const connectionString = this.getParameter(parameterName, true);
+    return publishMessage(connectionString, exchange, routingKey, type, payload, correlationId);
+  }
+
+  /**
+   * Executes the specified sql operation.
+   * @template T
+   * @param {string} parameterName name of the environment parameter that defines the sql connection string
+   * @param {(sql: import('mssql').Request) => T} sqlOperation function using the sql request object
+   * @returns {Promise<T>} sql query result
+   */
+  async executeSql(parameterName, sqlOperation) {
+    const connectionString = this.getParameter(parameterName, true);
+    return executeSql(connectionString, sqlOperation);
+  }
+
+  /**
+   * Runs the specified vtom job.
+   * @param {string} parameterName name of the environment parameter that defines the vtom configuration
+   * @param {string} appName vtom application name
+   * @param {string} jobName vtom job name
+   * @returns {Promise<boolean>} true if successful execution
+   */
+  async runVtomJob(parameterName, appName, jobName) {
+    const { url, apiKey, environment } = this.getParameter(parameterName, true);
+    return runVtomJob(url, apiKey, environment, appName, jobName);
+  }
 }

package/src/types.d.ts

@@ -48,7 +48,7 @@ export type TestEnvironmentConfiguration = {
   /** options of the environment */ options: EnvironmentOptions;
 };
 
-/** Custom options for the environement */
+/** Custom options for the environment */
 export type EnvironmentOptions = {
   /** Retrieve dataset **per environment** rather than globally. Dataset are global if not specified. */
   perEnvironmentData?: boolean;

package/src/vtom-client.js

@@ -0,0 +1,99 @@
+/**
+ * **Vtom client** to run Vtom job.
+ * Accessible through the **runVtomJob** method of the TestContext instance.
+ * @module
+ * @category private
+ */
+
+import https from 'node:https';
+import { constants } from 'node:crypto';
+
+import axios from 'axios';
+
+import { logger } from './logger.js';
+
+/** @typedef {(environment: string, appName: string, jobName: string) => Promise<import('axios').AxiosResponse>} VtomApiCall */
+
+/** @param {number} ms number of milliseconds to wait */
+const wait = ms => new Promise(resolve => setTimeout(resolve, ms));
+
+/**
+ * Creates the http client.
+ * @param {string} baseURL api base url
+ * @param {string} apiKey vtom api key
+ * @returns {import('axios').AxiosInstance}
+ */
+function createClient(baseURL, apiKey) {
+  const httpsAgent = new https.Agent({
+    rejectUnauthorized: false,
+    secureOptions: constants.SSL_OP_LEGACY_SERVER_CONNECT
+  });
+  return axios.create({
+    httpsAgent,
+    headers: {
+      'X-API-KEY': apiKey,
+      'Content-Type': 'application/json'
+    },
+    baseURL
+  });
+}
+
+/**
+ * Runs the specified vtom job.
+ * @param {string} apiUrl vtom base api url
+ * @param {string} apiKey vtom api key
+ * @param {string} environment vtom environment
+ * @param {string} appName vtom application name
+ * @param {string} jobName vtom job name
+ * @returns {Promise<boolean>}
+ */
+export async function runVtomJob(apiUrl, apiKey, environment, appName, jobName) {
+  const client = createClient(apiUrl, apiKey);
+  try {
+    // stop job
+    logger.debug(`Stopping vtom job '${jobName}'...`);
+    await doAction(client, 'ChangeStatus', 'Finished')(environment, appName, jobName);
+    // run job
+    logger.debug(`Running vtom job '${jobName}'...`);
+    await doAction(client, 'ChangeStatus', 'Running')(environment, appName, jobName);
+    let jobStatus;
+    let maxCount = 20;
+    // check status every 5s
+    do {
+      const { data } = await getJobStatus(client)(environment, appName, jobName);
+      jobStatus = data?.status;
+      if (jobStatus === 'Finished') {
+        logger.info(`Vtom job '${jobName}' finished.`);
+        return true;
+      }
+      await wait(5000);
+      logger.debug(`Checking vtom job status (${maxCount}=${jobStatus})...`);
+      maxCount--;
+    } while (jobStatus !== 'Finished' && maxCount > 0);
+    return false;
+  } catch (error) {
+    logger.detailError(error);
+    throw new Error(`Vtom error: '${error.message}'!`);
+  }
+}
+
+/**
+ * Calls the vtom job action endpoint.
+ * @param {import('axios').AxiosInstance} client
+ * @param {'ChangeStatus'} type
+ * @param {'Running' | 'Finished'} status
+ * @returns {VtomApiCall}
+ */
+const doAction = (client, type, status) => (environment, appName, jobName) =>
+  client.post(
+    `/${environment}/applications/${appName}/jobs/${jobName}/action`,
+    JSON.stringify({ comment: `wdio-test: ${type}('${status}')`, type, status })
+  );
+
+/**
+ * Calls the vtom job status endpoint.
+ * @param {import('axios').AxiosInstance} client
+ * @returns {VtomApiCall}
+ */
+const getJobStatus = client => (environment, appName, jobName) =>
+  client.get(`/${environment}/applications/${appName}/jobs/${jobName}/status`);

package/src/wdio/test-context-worker-service.js

@@ -46,7 +46,8 @@ export default class TestContextWorkerService {
    * @param {string[]} _specs
    * @param {string} _cid
    */
-  beforeSession(_config, _capabilities, _specs, _cid) {
+  async beforeSession(_config, _capabilities, _specs, _cid) {
+    logger.info(`Using '${this._context.environmentName}' test environement.`);
     logger.debug(
       inspect(filterPrivateProperty(this._context), {
         colors: true,