codeceptjs 3.6.4-beta.2 → 3.6.5-beta.1

package/lib/data/dataScenarioConfig.js

@@ -1,84 +1,84 @@
 class DataScenarioConfig {
   constructor(scenarios) {
-    this.scenarios = scenarios;
+    this.scenarios = scenarios
   }
 
   /**
-     * Declares that test throws error.
-     * Can pass an Error object or regex matching expected message.
-     *
-     * @param {*} err
-     */
+   * Declares that test throws error.
+   * Can pass an Error object or regex matching expected message.
+   *
+   * @param {*} err
+   */
   throws(err) {
-    this.scenarios.forEach(scenario => scenario.throws(err));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.throws(err))
+    return this
   }
 
   /**
-     * Declares that test should fail.
-     * If test passes - throws an error.
-     * Can pass an Error object or regex matching expected message.
-     *
-     */
+   * Declares that test should fail.
+   * If test passes - throws an error.
+   * Can pass an Error object or regex matching expected message.
+   *
+   */
   fails() {
-    this.scenarios.forEach(scenario => scenario.fails());
-    return this;
+    this.scenarios.forEach((scenario) => scenario.fails())
+    return this
   }
 
   /**
-     * Retry this test for x times
-     *
-     * @param {*} retries
-     */
+   * Retry this test for x times
+   *
+   * @param {*} retries
+   */
   retry(retries) {
-    this.scenarios.forEach(scenario => scenario.retry(retries));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.retry(retries))
+    return this
   }
 
   /**
-     * Set timeout for this test
-     * @param {*} timeout
-     */
+   * Set timeout for this test
+   * @param {*} timeout
+   */
   timeout(timeout) {
-    this.scenarios.forEach(scenario => scenario.timeout(timeout));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.timeout(timeout))
+    return this
   }
 
   /**
-     * Configures a helper.
-     * Helper name can be omitted and values will be applied to first helper.
-     */
+   * Configures a helper.
+   * Helper name can be omitted and values will be applied to first helper.
+   */
   config(helper, obj) {
-    this.scenarios.forEach(scenario => scenario.config(helper, obj));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.config(helper, obj))
+    return this
   }
 
   /**
-     * Append a tag name to scenario title
-     * @param {*} tagName
-     */
+   * Append a tag name to scenario title
+   * @param {*} tagName
+   */
   tag(tagName) {
-    this.scenarios.forEach(scenario => scenario.tag(tagName));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.tag(tagName))
+    return this
   }
 
   /**
-     * Pass in additional objects to inject into test
-     * @param {*} obj
-     */
+   * Pass in additional objects to inject into test
+   * @param {*} obj
+   */
   inject(obj) {
-    this.scenarios.forEach(scenario => scenario.inject(obj));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.inject(obj))
+    return this
   }
 
   /**
-     * Dynamically injects dependencies, see https://codecept.io/pageobjects/#dynamic-injection
-     * @param {*} dependencies
-     */
+   * Dynamically injects dependencies, see https://codecept.io/pageobjects/#dynamic-injection
+   * @param {*} dependencies
+   */
   injectDependencies(dependencies) {
-    this.scenarios.forEach(scenario => scenario.injectDependencies(dependencies));
-    return this;
+    this.scenarios.forEach((scenario) => scenario.injectDependencies(dependencies))
+    return this
   }
 }
 
-module.exports = DataScenarioConfig;
+module.exports = DataScenarioConfig

package/lib/data/dataTableArgument.js

@@ -7,60 +7,60 @@ class DataTableArgument {
   constructor(gherkinDataTable) {
     this.rawData = gherkinDataTable.rows.map((row) => {
       return row.cells.map((cell) => {
-        return cell.value;
-      });
-    });
+        return cell.value
+      })
+    })
   }
 
   /** Returns the table as a 2-D array
-  * @returns {string[][]}
-  */
+   * @returns {string[][]}
+   */
   raw() {
-    return this.rawData.slice(0);
+    return this.rawData.slice(0)
   }
 
   /** Returns the table as a 2-D array, without the first row
-  * @returns {string[][]}
-  */
+   * @returns {string[][]}
+   */
   rows() {
-    const copy = this.raw();
-    copy.shift();
-    return copy;
+    const copy = this.raw()
+    copy.shift()
+    return copy
   }
 
   /** Returns an array of objects where each row is converted to an object (column header is the key)
-  * @returns {any[]}
-  */
+   * @returns {any[]}
+   */
   hashes() {
-    const copy = this.raw();
-    const header = copy.shift();
+    const copy = this.raw()
+    const header = copy.shift()
     return copy.map((row) => {
-      const r = {};
-      row.forEach((cell, index) => r[header[index]] = cell);
-      return r;
-    });
+      const r = {}
+      row.forEach((cell, index) => (r[header[index]] = cell))
+      return r
+    })
   }
 
   /** Returns an object where each row corresponds to an entry
    * (first column is the key, second column is the value)
-  * @returns {Record<string, string>}
-  */
+   * @returns {Record<string, string>}
+   */
   rowsHash() {
-    const rows = this.raw();
-    const everyRowHasTwoColumns = rows.every((row) => row.length === 2);
+    const rows = this.raw()
+    const everyRowHasTwoColumns = rows.every((row) => row.length === 2)
     if (!everyRowHasTwoColumns) {
-      throw new Error('rowsHash can only be called on a data table where all rows have exactly two columns');
+      throw new Error('rowsHash can only be called on a data table where all rows have exactly two columns')
     }
     /** @type {Record<string, string>} */
-    const result = {};
-    rows.forEach((x) => (result[x[0]] = x[1]));
-    return result;
+    const result = {}
+    rows.forEach((x) => (result[x[0]] = x[1]))
+    return result
   }
 
   /** Transposed the data */
   transpose() {
-    this.rawData = this.rawData[0].map((x, i) => this.rawData.map((y) => y[i]));
+    this.rawData = this.rawData[0].map((x, i) => this.rawData.map((y) => y[i]))
   }
 }
 
-module.exports = DataTableArgument;
+module.exports = DataTableArgument

package/lib/data/table.js

@@ -4,40 +4,46 @@
 class DataTable {
   /** @param {Array<*>} array */
   constructor(array) {
-    this.array = array;
-    this.rows = new Array(0);
+    this.array = array
+    this.rows = new Array(0)
   }
 
   /** @param {Array<*>} array */
   add(array) {
-    if (array.length !== this.array.length) throw new Error(`There is too many elements in given data array. Please provide data in this format: ${this.array}`);
-    const tempObj = {};
-    let arrayCounter = 0;
+    if (array.length !== this.array.length)
+      throw new Error(
+        `There is too many elements in given data array. Please provide data in this format: ${this.array}`,
+      )
+    const tempObj = {}
+    let arrayCounter = 0
     this.array.forEach((elem) => {
-      tempObj[elem] = array[arrayCounter];
-      tempObj.toString = () => JSON.stringify(tempObj);
-      arrayCounter++;
-    });
-    this.rows.push({ skip: false, data: tempObj });
+      tempObj[elem] = array[arrayCounter]
+      tempObj.toString = () => JSON.stringify(tempObj)
+      arrayCounter++
+    })
+    this.rows.push({ skip: false, data: tempObj })
   }
 
   /** @param {Array<*>} array */
   xadd(array) {
-    if (array.length !== this.array.length) throw new Error(`There is too many elements in given data array. Please provide data in this format: ${this.array}`);
-    const tempObj = {};
-    let arrayCounter = 0;
+    if (array.length !== this.array.length)
+      throw new Error(
+        `There is too many elements in given data array. Please provide data in this format: ${this.array}`,
+      )
+    const tempObj = {}
+    let arrayCounter = 0
     this.array.forEach((elem) => {
-      tempObj[elem] = array[arrayCounter];
-      tempObj.toString = () => JSON.stringify(tempObj);
-      arrayCounter++;
-    });
-    this.rows.push({ skip: true, data: tempObj });
+      tempObj[elem] = array[arrayCounter]
+      tempObj.toString = () => JSON.stringify(tempObj)
+      arrayCounter++
+    })
+    this.rows.push({ skip: true, data: tempObj })
   }
 
   /** @param {Function} func */
   filter(func) {
-    return this.rows.filter(row => func(row.data));
+    return this.rows.filter((row) => func(row.data))
   }
 }
 
-module.exports = DataTable;
+module.exports = DataTable

package/lib/helper/AI.js

@@ -1,8 +1,14 @@
-const Helper = require('@codeceptjs/helper');
-const ai = require('../ai');
-const standardActingHelpers = require('../plugin/standardActingHelpers');
-const Container = require('../container');
-const { splitByChunks, minifyHtml } = require('../html');
+const Helper = require('@codeceptjs/helper')
+const ora = require('ora-classic')
+const fs = require('fs')
+const path = require('path')
+const ai = require('../ai')
+const standardActingHelpers = require('../plugin/standardActingHelpers')
+const Container = require('../container')
+const { splitByChunks, minifyHtml } = require('../html')
+const { beautify } = require('../utils')
+const output = require('../output')
+const { registerVariable } = require('../pause')
 
 /**
  * AI Helper for CodeceptJS.
@@ -10,6 +16,8 @@ const { splitByChunks, minifyHtml } = require('../html');
  * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
  * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
  *
+ * Use it only in development mode. It is recommended to run it only inside pause() mode.
+ *
  * ## Configuration
  *
  * This helper should be configured in codecept.json or codecept.conf.js
@@ -18,22 +26,22 @@ const { splitByChunks, minifyHtml } = require('../html');
  */
 class AI extends Helper {
   constructor(config) {
-    super(config);
-    this.aiAssistant = ai;
+    super(config)
+    this.aiAssistant = ai
 
     this.options = {
       chunkSize: 80000,
-    };
-    this.options = { ...this.options, ...config };
+    }
+    this.options = { ...this.options, ...config }
   }
 
   _beforeSuite() {
-    const helpers = Container.helpers();
+    const helpers = Container.helpers()
 
     for (const helperName of standardActingHelpers) {
       if (Object.keys(helpers).indexOf(helperName) > -1) {
-        this.helper = helpers[helperName];
-        break;
+        this.helper = helpers[helperName]
+        break
       }
     }
   }
@@ -50,30 +58,34 @@ class AI extends Helper {
    * @returns {Promise<string>} - A Promise that resolves to the generated responses from the GPT model, joined by newlines.
    */
   async askGptOnPage(prompt) {
-    const html = await this.helper.grabSource();
+    const html = await this.helper.grabSource()
 
-    const htmlChunks = splitByChunks(html, this.options.chunkSize);
+    const htmlChunks = splitByChunks(html, this.options.chunkSize)
 
-    if (htmlChunks.length > 1) this.debug(`Splitting HTML into ${htmlChunks.length} chunks`);
+    if (htmlChunks.length > 1) this.debug(`Splitting HTML into ${htmlChunks.length} chunks`)
 
-    const responses = [];
+    const responses = []
 
     for (const chunk of htmlChunks) {
       const messages = [
         { role: 'user', content: prompt },
         { role: 'user', content: `Within this HTML: ${minifyHtml(chunk)}` },
-      ];
+      ]
 
-      if (htmlChunks.length > 1) messages.push({ role: 'user', content: 'If action is not possible on this page, do not propose anything, I will send another HTML fragment' });
+      if (htmlChunks.length > 1)
+        messages.push({
+          role: 'user',
+          content: 'If action is not possible on this page, do not propose anything, I will send another HTML fragment',
+        })
 
-      const response = await this.aiAssistant.createCompletion(messages);
+      const response = await this._processAIRequest(messages)
 
-      console.log(response);
+      output.print(response)
 
-      responses.push(response);
+      responses.push(response)
     }
 
-    return responses.join('\n\n');
+    return responses.join('\n\n')
   }
 
   /**
@@ -89,36 +101,103 @@ class AI extends Helper {
    * @returns {Promise<string>} - A Promise that resolves to the generated response from the GPT model.
    */
   async askGptOnPageFragment(prompt, locator) {
-    const html = await this.helper.grabHTMLFrom(locator);
+    const html = await this.helper.grabHTMLFrom(locator)
 
     const messages = [
       { role: 'user', content: prompt },
       { role: 'user', content: `Within this HTML: ${minifyHtml(html)}` },
-    ];
+    ]
 
-    const response = await this.aiAssistant.createCompletion(messages);
+    const response = await this._processAIRequest(messages)
 
-    console.log(response);
+    output.print(response)
 
-    return response;
+    return response
   }
 
   /**
-   * Send a general request to ChatGPT and return response.
+   * Send a general request to AI and return response.
    * @param {string} prompt
    * @returns {Promise<string>} - A Promise that resolves to the generated response from the GPT model.
    */
   async askGptGeneralPrompt(prompt) {
-    const messages = [
-      { role: 'user', content: prompt },
-    ];
+    const messages = [{ role: 'user', content: prompt }]
 
-    const response = await this.aiAssistant.createCompletion(messages);
+    const response = await this._processAIRequest(messages)
 
-    console.log(response);
+    output.print(response)
+
+    return response
+  }
+
+  /**
+   * Generates PageObject for current page using AI.
+   *
+   * It saves the PageObject to the output directory. You can review the page object and adjust it as needed and move to pages directory.
+   * Prompt can be customized in a global config file.
+   *
+   * ```js
+   * // create page object for whole page
+   * I.askForPageObject('home');
+   *
+   * // create page object with extra prompt
+   * I.askForPageObject('home', 'implement signIn(username, password) method');
+   *
+   * // create page object for a specific element
+   * I.askForPageObject('home', null, '.detail');
+   * ```
+   *
+   * Asks for a page object based on the provided page name, locator, and extra prompt.
+   *
+   * @async
+   * @param {string} pageName - The name of the page to retrieve the object for.
+   * @param {string|null} [extraPrompt=null] - An optional extra prompt for additional context or information.
+   * @param {string|null} [locator=null] - An optional locator to find a specific element on the page.
+   * @returns {Promise<Object>} A promise that resolves to the requested page object.
+   */
+  async askForPageObject(pageName, extraPrompt = null, locator = null) {
+    const html = locator ? await this.helper.grabHTMLFrom(locator) : await this.helper.grabSource()
+
+    const spinner = ora(' Processing AI request...').start()
+    await this.aiAssistant.setHtmlContext(html)
+    const response = await this.aiAssistant.generatePageObject(extraPrompt, locator)
+    spinner.stop()
+
+    if (!response[0]) {
+      output.error('No response from AI')
+      return ''
+    }
+
+    const code = beautify(response[0])
+
+    output.print('----- Generated PageObject ----')
+    output.print(code)
+    output.print('-------------------------------')
+
+    const fileName = path.join(output_dir, `${pageName}Page-${Date.now()}.js`)
+
+    output.print(output.styles.bold(`Page object for ${pageName} is saved to ${output.styles.bold(fileName)}`))
+    fs.writeFileSync(fileName, code)
+
+    try {
+      registerVariable('page', require(fileName))
+      output.success('Page object registered for this session as `page` variable')
+      output.print('Use `=>page.methodName()` in shell to run methods of page object')
+      output.print('Use `click(page.locatorName)` to check locators of page object')
+    } catch (err) {
+      output.error('Error while registering page object')
+      output.error(err.message)
+    }
+
+    return code
+  }
 
-    return response;
+  async _processAIRequest(messages) {
+    const spinner = ora(' Processing AI request...').start()
+    const response = await this.aiAssistant.createCompletion(messages)
+    spinner.stop()
+    return response
   }
 }
 
-module.exports = AI;
+module.exports = AI