Added capability to have customLocator attribute arrays; Updated chai-as-promised to v7; Fixed codecept.workers test; Fixed linting in codecept.playwright test; Fixed locator_test to.be.thrown call (#3348)

Author: aruiz-caritsqa

docs/plugins.md

@@ -1,10 +1,3 @@
----
-permalink: plugins
-sidebarDepth: 
-sidebar: auto
-title: Plugins
----
-
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## allure
@@ -512,6 +505,46 @@ I.seeElement('=user'); // matches => [data-qa=user]
 I.click('=sign-up'); // matches => [data-qa=sign-up]
 ```
 
+Using `data-qa` OR `data-test` attribute with `=` prefix:
+
+```js
+// in codecept.conf.js
+plugins: {
+ customLocator: {
+   enabled: true,
+   prefix: '=',
+   attribute: ['data-qa', 'data-test'],
+   strategy: 'xpath'
+ }
+}
+```
+
+In a test:
+
+```js
+I.seeElement('=user'); // matches => //*[@data-qa=user or @data-test=user]
+I.click('=sign-up'); // matches => //*[data-qa=sign-up or @data-test=sign-up]
+```
+
+```js
+// in codecept.conf.js
+plugins: {
+ customLocator: {
+   enabled: true,
+   prefix: '=',
+   attribute: ['data-qa', 'data-test'],
+   strategy: 'css'
+ }
+}
+```
+
+In a test:
+
+```js
+I.seeElement('=user'); // matches => [data-qa=user],[data-test=user]
+I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up]
+```
+
 ### Parameters
 
 -   `config`  

lib/plugin/customLocator.js

@@ -70,23 +70,70 @@ const defaultConfig = {
  * I.seeElement('=user'); // matches => [data-qa=user]
  * I.click('=sign-up'); // matches => [data-qa=sign-up]
  * ```
+ *
+ * Using `data-qa` OR `data-test` attribute with `=` prefix:
+ *
+ * ```js
+ * // in codecept.conf.js
+ * plugins: {
+ *  customLocator: {
+ *    enabled: true,
+ *    prefix: '=',
+ *    attribute: ['data-qa', 'data-test'],
+ *    strategy: 'xpath'
+ *  }
+ * }
+ * ```
+ *
+ * In a test:
+ *
+ * ```js
+ * I.seeElement('=user'); // matches => //*[@data-qa=user or @data-test=user]
+ * I.click('=sign-up'); // matches => //*[data-qa=sign-up or @data-test=sign-up]
+ * ```
+ *
+ * ```js
+ * // in codecept.conf.js
+ * plugins: {
+ *  customLocator: {
+ *    enabled: true,
+ *    prefix: '=',
+ *    attribute: ['data-qa', 'data-test'],
+ *    strategy: 'css'
+ *  }
+ * }
+ * ```
+ *
+ * In a test:
+ *
+ * ```js
+ * I.seeElement('=user'); // matches => [data-qa=user],[data-test=user]
+ * I.click('=sign-up'); // matches => [data-qa=sign-up],[data-test=sign-up]
+ * ```
  */
 module.exports = (config) => {
-  config = Object.assign(defaultConfig, config);
+  config = { ...defaultConfig, ...config };
 
   Locator.addFilter((value, locatorObj) => {
     if (typeof value !== 'string') return;
     if (!value.startsWith(config.prefix)) return;
 
+    if (!['String', 'Array'].includes(config.attribute.constructor.name)) return;
+
     const val = value.substr(config.prefix.length);
 
     if (config.strategy.toLowerCase() === 'xpath') {
-      locatorObj.value = `.//*[@${config.attribute}=${xpathLocator.literal(val)}]`;
+      locatorObj.value = `.//*[${
+        [].concat(config.attribute)
+          .map((attr) => `@${attr}=${xpathLocator.literal(val)}`)
+          .join(' or ')}]`;
       locatorObj.type = 'xpath';
     }
 
     if (config.strategy.toLowerCase() === 'css') {
-      locatorObj.value = `[${config.attribute}=${val}]`;
+      locatorObj.value = [].concat(config.attribute)
+        .map((attr) => `[${attr}=${val}]`)
+        .join(',');
       locatorObj.type = 'css';
     }
 

package.json

@@ -90,7 +90,7 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "^1.0.2",
+    "@codeceptjs/detox-helper": "^1.0.2",    
     "@codeceptjs/mock-request": "^0.3.1",
     "@faker-js/faker": "^5.5.3",
     "@pollyjs/adapter-puppeteer": "^5.1.0",
@@ -101,7 +101,7 @@
     "@wdio/selenium-standalone-service": "^5.16.10",
     "@wdio/utils": "^5.23.0",
     "apollo-server-express": "^2.25.3",
-    "chai-as-promised": "^5.2.0",
+    "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
     "contributor-faces": "^1.0.3",
     "documentation": "^12.3.0",

test/data/sandbox/codecept.workers-custom-output-folder-name.conf.js

@@ -9,7 +9,8 @@ exports.config = {
     },
   },
   include: {},
-  bootstrap: {},
+  // eslint-disable-next-line no-empty-function
+  async bootstrap() {},
   mocha: {},
   name: 'sandbox',
 };

test/unit/locator_test.js

@@ -202,13 +202,13 @@ describe('Locator', () => {
   it('should throw an error when xpath with round brackets is nested', () => {
     expect(() => {
       Locator.build('tr').find('(./td)[@id="id"]');
-    }, /round brackets/).to.be.thrown;
+    }).to.throw('round brackets');
   });
 
   it('should throw an error when locator with specific position is nested', () => {
     expect(() => {
       Locator.build('tr').withChild(Locator.build('td').first());
-    }, /round brackets/).to.be.thrown;
+    }).to.throw('round brackets');
   });
 
   it('should not select element by deep nested siblings', () => {

test/unit/plugin/customLocator_test.js

@@ -53,4 +53,36 @@ describe('customLocator', () => {
     expect(l.isCSS()).to.be.true;
     expect(l.simplify()).to.eql('[data-test=user]');
   });
+
+  it('add a custom locator with array $ -> data-qa, data-qa-id', () => {
+    customLocatorPlugin({
+      prefix: '$',
+      attribute: ['data-qa', 'data-qa-id'],
+      showActual: true,
+    });
+    const l = new Locator('$user-id');
+    expect(l.isXPath()).to.be.true;
+    expect(l.toXPath()).to.eql('.//*[@data-qa=\'user-id\' or @data-qa-id=\'user-id\']');
+    expect(l.toString()).to.eql('.//*[@data-qa=\'user-id\' or @data-qa-id=\'user-id\']');
+  });
+
+  it('add a custom locator array with CSS', () => {
+    customLocatorPlugin({
+      prefix: '$',
+      attribute: ['data-test', 'data-test-id'],
+      strategy: 'css',
+    });
+    const l = new Locator('$user');
+    expect(l.isCSS()).to.be.true;
+    expect(l.simplify()).to.eql('[data-test=user],[data-test-id=user]');
+  });
+
+  it('should return initial locator value when it does not start with specified prefix', () => {
+    customLocatorPlugin({
+      prefix: '$',
+      attribute: 'data-test',
+    });
+    const l = new Locator('=user');
+    expect(l.simplify()).to.eql('=user');
+  });
 });