fix: support secret value for some methods (#3837)

kobenguyent · web-flow · commit 39382f5a4dc2 · 2023-08-26T07:19:26.000+02:00
diff --git a/docs/helpers/Appium.md b/docs/helpers/Appium.md
@@ -941,7 +941,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][5]** value to check.
+-   `value` **([string][5] \| [object][10])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSee
@@ -1171,7 +1171,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][5] \| [object][10])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][5]** value to check.
+-   `value` **([string][5] \| [object][10])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### see
diff --git a/docs/helpers/Nightmare.md b/docs/helpers/Nightmare.md
@@ -305,7 +305,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][3]** value to check.
+-   `value` **([string][3] | [object][4])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -956,7 +956,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][3]** value to check.
+-   `value` **([string][3] | [object][4])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInSource
diff --git a/docs/helpers/Playwright.md b/docs/helpers/Playwright.md
@@ -711,7 +711,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][8]** value to check.
+-   `value` **([string][8] | [object][5])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -1835,7 +1835,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][8] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][8]** value to check.
+-   `value` **([string][8] | [object][5])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
diff --git a/docs/helpers/Protractor.md b/docs/helpers/Protractor.md
@@ -441,7 +441,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][9] | [object][10])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][9]** value to check.
+-   `value` **([string][9] | [object][10])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -1225,7 +1225,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][9] | [object][10])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][9]** value to check.
+-   `value` **([string][9] | [object][10])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
diff --git a/docs/helpers/Puppeteer.md b/docs/helpers/Puppeteer.md
@@ -589,7 +589,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][6]** value to check.
+-   `value` **([string][6] | [object][4])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -1618,7 +1618,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][6] | [object][4])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][6]** value to check.
+-   `value` **([string][6] | [object][4])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
diff --git a/docs/helpers/TestCafe.md b/docs/helpers/TestCafe.md
@@ -355,7 +355,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][4]** value to check.
+-   `value` **([string][4] | [object][5])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -926,7 +926,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][4]** value to check.
+-   `value` **([string][4] | [object][5])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInSource
diff --git a/docs/helpers/WebDriver.md b/docs/helpers/WebDriver.md
@@ -757,7 +757,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 #### Parameters
 
 -   `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][17]** value to check.
+-   `value` **([string][17] | [object][16])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### dontSeeInSource
@@ -1783,7 +1783,7 @@ I.seeInField('#searchform input','Search');
 #### Parameters
 
 -   `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
--   `value` **[string][17]** value to check.
+-   `value` **([string][17] | [object][16])** value to check.
     ⚠️ returns a _promise_ which is synchronized internally by recorder
 
 ### seeInPopup
diff --git a/docs/webapi/dontSeeInField.mustache b/docs/webapi/dontSeeInField.mustache
@@ -7,5 +7,5 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 ```
 
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {string} value value to check.
+@param {CodeceptJS.StringOrSecret} value value to check.
 ⚠️ returns a _promise_ which is synchronized internally by recorder
diff --git a/docs/webapi/seeInField.mustache b/docs/webapi/seeInField.mustache
@@ -8,5 +8,5 @@ I.seeInField('form input[type=hidden]','hidden_value');
 I.seeInField('#searchform input','Search');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {string} value value to check.
+@param {CodeceptJS.StringOrSecret} value value to check.
 ⚠️ returns a _promise_ which is synchronized internally by recorder
diff --git a/lib/helper/Appium.js b/lib/helper/Appium.js
@@ -1433,8 +1433,9 @@ class Appium extends Webdriver {
    *
    */
   async dontSeeInField(field, value) {
-    if (this.isWeb) return super.dontSeeInField(field, value);
-    return super.dontSeeInField(parseLocator.call(this, field), value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    if (this.isWeb) return super.dontSeeInField(field, _value);
+    return super.dontSeeInField(parseLocator.call(this, field), _value);
   }
 
   /**
@@ -1565,8 +1566,9 @@ class Appium extends Webdriver {
    *
    */
   async seeInField(field, value) {
-    if (this.isWeb) return super.seeInField(field, value);
-    return super.seeInField(parseLocator.call(this, field), value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    if (this.isWeb) return super.seeInField(field, _value);
+    return super.seeInField(parseLocator.call(this, field), _value);
   }
 
   /**
diff --git a/lib/helper/Nightmare.js b/lib/helper/Nightmare.js
@@ -702,14 +702,16 @@ class Nightmare extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
-    return proceedSeeInField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'assert', field, _value);
   }
 
   /**
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
-    return proceedSeeInField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'negate', field, _value);
   }
 
   /**
diff --git a/lib/helper/Playwright.js b/lib/helper/Playwright.js
@@ -1633,14 +1633,16 @@ class Playwright extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
-    return proceedSeeInField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'assert', field, _value);
   }
 
   /**
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
-    return proceedSeeInField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'negate', field, _value);
   }
 
   /**
diff --git a/lib/helper/Protractor.js b/lib/helper/Protractor.js
@@ -631,14 +631,16 @@ class Protractor extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
-    return proceedSeeInField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'assert', field, _value);
   }
 
   /**
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
-    return proceedSeeInField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'negate', field, _value);
   }
 
   /**
diff --git a/lib/helper/Puppeteer.js b/lib/helper/Puppeteer.js
@@ -1353,14 +1353,16 @@ class Puppeteer extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
-    return proceedSeeInField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'assert', field, _value);
   }
 
   /**
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
-    return proceedSeeInField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'negate', field, _value);
   }
 
   /**
diff --git a/lib/helper/TestCafe.js b/lib/helper/TestCafe.js
@@ -727,27 +727,29 @@ class TestCafe extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
+    const _value = (typeof value === 'boolean') ? value : value.toString();
     // const expectedValue = findElements.call(this, this.context, field).value;
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
     const el = await els.nth(0);
 
     return this.t
-      .expect(await el.value).eql(value)
+      .expect(await el.value).eql(_value)
       .catch(mapError);
   }
 
   /**
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
+    const _value = (typeof value === 'boolean') ? value : value.toString();
     // const expectedValue = findElements.call(this, this.context, field).value;
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
     const el = await els.nth(0);
 
     return this.t
-      .expect(el.value).notEql(value)
+      .expect(el.value).notEql(_value)
       .catch(mapError);
   }
 
diff --git a/lib/helper/WebDriver.js b/lib/helper/WebDriver.js
@@ -1348,15 +1348,17 @@ class WebDriver extends Helper {
    *
    */
   async seeInField(field, value) {
-    return proceedSeeField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeField.call(this, 'assert', field, _value);
   }
 
   /**
    * {{> dontSeeInField }}
    *
    */
   async dontSeeInField(field, value) {
-    return proceedSeeField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeField.call(this, 'negate', field, _value);
   }
 
   /**
diff --git a/test/helper/Playwright_test.js b/test/helper/Playwright_test.js
@@ -12,6 +12,7 @@ const AssertionFailedError = require('../../lib/assert/error');
 const webApiTests = require('./webapi');
 const FileSystem = require('../../lib/helper/FileSystem');
 const { deleteDir } = require('../../lib/utils');
+const Secret = require('../../lib/secret');
 global.codeceptjs = require('../../lib');
 
 let I;
@@ -414,6 +415,16 @@ describe('Playwright', function () {
       await I.seeInField('checkbox[]', 'see test three');
     });
 
+    it('should check values are the secret type in checkboxes', async () => {
+      await I.amOnPage('/form/field_values');
+      await I.dontSeeInField('checkbox[]', Secret.secret('not seen one'));
+      await I.seeInField('checkbox[]', Secret.secret('see test one'));
+      await I.dontSeeInField('checkbox[]', Secret.secret('not seen two'));
+      await I.seeInField('checkbox[]', Secret.secret('see test two'));
+      await I.dontSeeInField('checkbox[]', Secret.secret('not seen three'));
+      await I.seeInField('checkbox[]', Secret.secret('see test three'));
+    });
+
     it('should check values with boolean', async () => {
       await I.amOnPage('/form/field_values');
       await I.seeInField('checkbox1', true);
diff --git a/test/helper/Puppeteer_test.js b/test/helper/Puppeteer_test.js
@@ -10,6 +10,7 @@ const Puppeteer = require('../../lib/helper/Puppeteer');
 const AssertionFailedError = require('../../lib/assert/error');
 const webApiTests = require('./webapi');
 const FileSystem = require('../../lib/helper/FileSystem');
+const Secret = require('../../lib/secret');
 global.codeceptjs = require('../../lib');
 
 let I;
@@ -447,6 +448,16 @@ describe('Puppeteer', function () {
       await I.seeInField('checkbox[]', 'see test three');
     });
 
+    it('should check values are the secret type in checkboxes', async () => {
+      await I.amOnPage('/form/field_values');
+      await I.dontSeeInField('checkbox[]', Secret.secret('not seen one'));
+      await I.seeInField('checkbox[]', Secret.secret('see test one'));
+      await I.dontSeeInField('checkbox[]', Secret.secret('not seen two'));
+      await I.seeInField('checkbox[]', Secret.secret('see test two'));
+      await I.dontSeeInField('checkbox[]', Secret.secret('not seen three'));
+      await I.seeInField('checkbox[]', Secret.secret('see test three'));
+    });
+
     it('should check values with boolean', async () => {
       await I.amOnPage('/form/field_values');
       await I.seeInField('checkbox1', true);
diff --git a/test/helper/WebDriver_test.js b/test/helper/WebDriver_test.js
@@ -7,6 +7,7 @@ const TestHelper = require('../support/TestHelper');
 const WebDriver = require('../../lib/helper/WebDriver');
 const AssertionFailedError = require('../../lib/assert/error');
 const webApiTests = require('./webapi');
+const Secret = require('../../lib/secret');
 global.codeceptjs = require('../../lib');
 
 const siteUrl = TestHelper.siteUrl();
@@ -143,6 +144,16 @@ describe('WebDriver', function () {
       await wd.seeInField('checkbox[]', 'see test three');
     });
 
+    it('should check values are the secret type in checkboxes', async () => {
+      await wd.amOnPage('/form/field_values');
+      await wd.dontSeeInField('checkbox[]', Secret.secret('not seen one'));
+      await wd.seeInField('checkbox[]', Secret.secret('see test one'));
+      await wd.dontSeeInField('checkbox[]', Secret.secret('not seen two'));
+      await wd.seeInField('checkbox[]', Secret.secret('see test two'));
+      await wd.dontSeeInField('checkbox[]', Secret.secret('not seen three'));
+      await wd.seeInField('checkbox[]', Secret.secret('see test three'));
+    });
+
     it('should check values with boolean', async () => {
       await wd.amOnPage('/form/field_values');
       await wd.seeInField('checkbox1', true);

Original file line number	Diff line number	Diff line change
`@@ -1433,8 +1433,9 @@ class Appium extends Webdriver {`
`1433`	`1433`	`*`
`1434`	`1434`	`*/`
`1435`	`1435`	`async dontSeeInField(field, value) {`
`1436`		`- if (this.isWeb) return super.dontSeeInField(field, value);`
`1437`		`- return super.dontSeeInField(parseLocator.call(this, field), value);`
	`1436`	`+ const _value = (typeof value === 'boolean') ? value : value.toString();`
	`1437`	`+ if (this.isWeb) return super.dontSeeInField(field, _value);`
	`1438`	`+ return super.dontSeeInField(parseLocator.call(this, field), _value);`
`1438`	`1439`	`}`
`1439`	`1440`
`1440`	`1441`	`/**`
`@@ -1565,8 +1566,9 @@ class Appium extends Webdriver {`
`1565`	`1566`	`*`
`1566`	`1567`	`*/`
`1567`	`1568`	`async seeInField(field, value) {`
`1568`		`- if (this.isWeb) return super.seeInField(field, value);`
`1569`		`- return super.seeInField(parseLocator.call(this, field), value);`
	`1569`	`+ const _value = (typeof value === 'boolean') ? value : value.toString();`
	`1570`	`+ if (this.isWeb) return super.seeInField(field, _value);`
	`1571`	`+ return super.seeInField(parseLocator.call(this, field), _value);`
`1570`	`1572`	`}`
`1571`	`1573`
`1572`	`1574`	`/**`