Added backslash escaping to stringEscape and added test coverage for sendKeys command emitting in selianize to verify it. Updated snapshots accordingly.

Author: David Haeffner

packages/code-export-java-junit/__test__/src/__snapshots__/index.spec.js.snap

@@ -41,7 +41,7 @@ public class LoginTest {
     driver.findElement(By.id(\\"username\\")).sendKeys(\\"tomsmith\\");
     driver.findElement(By.id(\\"password\\")).sendKeys(\\"SuperSecretPassword!\\");
     driver.findElement(By.cssSelector(\\"#login button\\")).click();
-    assertThat(driver.findElement(By.cssSelector(\\".flash.success\\")).getText(), is(\\"You logged into a secure area!\\\\n×\\"));
+    assertThat(driver.findElement(By.cssSelector(\\".flash.success\\")).getText(), is(\\"You logged into a secure area!\\\\\\\\\\\\\\\\n×\\"));
   }
   @Test
   public void invalidcredentials() {
@@ -50,7 +50,7 @@ public class LoginTest {
     driver.findElement(By.id(\\"username\\")).sendKeys(\\"blah\\");
     driver.findElement(By.id(\\"password\\")).sendKeys(\\"blah\\");
     driver.findElement(By.cssSelector(\\"#login button\\")).click();
-    assertThat(driver.findElement(By.id(\\"flash\\")).getText(), is(\\"Your username is invalid!\\\\n×\\"));
+    assertThat(driver.findElement(By.id(\\"flash\\")).getText(), is(\\"Your username is invalid!\\\\\\\\\\\\\\\\n×\\"));
   }
 }
 "
@@ -388,7 +388,7 @@ public class LoginTest {
     driver.findElement(By.id(\\"username\\")).sendKeys(\\"tomsmith\\");
     driver.findElement(By.id(\\"password\\")).sendKeys(\\"SuperSecretPassword!\\");
     driver.findElement(By.cssSelector(\\"#login button\\")).click();
-    assertThat(driver.findElement(By.cssSelector(\\".flash.success\\")).getText(), is(\\"You logged into a secure area!\\\\n×\\"));
+    assertThat(driver.findElement(By.cssSelector(\\".flash.success\\")).getText(), is(\\"You logged into a secure area!\\\\\\\\\\\\\\\\n×\\"));
   }
 }
 "

packages/code-export-javascript-mocha/__test__/src/__snapshots__/index.spec.js.snap

@@ -22,15 +22,15 @@ describe('login', function() {
     await driver.findElement(By.id(\\"username\\")).sendKeys(\\"tomsmith\\")
     await driver.findElement(By.id(\\"password\\")).sendKeys(\\"SuperSecretPassword!\\")
     await driver.findElement(By.css(\\"#login button\\")).click()
-    assert(await driver.findElement(By.css(\\".flash.success\\")).getText() == \\"You logged into a secure area!\\\\n×\\")
+    assert(await driver.findElement(By.css(\\".flash.success\\")).getText() == \\"You logged into a secure area!\\\\\\\\\\\\\\\\n×\\")
   })
   it('invalid credentials', async function() {
     await driver.get(\\"http://the-internet.herokuapp.com/login\\")
     await driver.setRect(1440, 1177)
     await driver.findElement(By.id(\\"username\\")).sendKeys(\\"blah\\")
     await driver.findElement(By.id(\\"password\\")).sendKeys(\\"blah\\")
     await driver.findElement(By.css(\\"#login button\\")).click()
-    assert(await driver.findElement(By.id(\\"flash\\")).getText() == \\"Your username is invalid!\\\\n×\\")
+    assert(await driver.findElement(By.id(\\"flash\\")).getText() == \\"Your username is invalid!\\\\\\\\\\\\\\\\n×\\")
   })
 })
 "
@@ -258,7 +258,7 @@ describe('login', function() {
     await driver.findElement(By.id(\\"username\\")).sendKeys(\\"tomsmith\\")
     await driver.findElement(By.id(\\"password\\")).sendKeys(\\"SuperSecretPassword!\\")
     await driver.findElement(By.css(\\"#login button\\")).click()
-    assert(await driver.findElement(By.css(\\".flash.success\\")).getText() == \\"You logged into a secure area!\\\\n×\\")
+    assert(await driver.findElement(By.css(\\".flash.success\\")).getText() == \\"You logged into a secure area!\\\\\\\\\\\\\\\\n×\\")
   })
 })
 "

packages/code-export-python-pytest/__test__/src/__snapshots__/index.spec.js.snap

@@ -26,15 +26,15 @@ class TestLogin():
     self.driver.find_element(By.ID, \\"username\\").send_keys(\\"tomsmith\\")
     self.driver.find_element(By.ID, \\"password\\").send_keys(\\"SuperSecretPassword!\\")
     self.driver.find_element(By.CSS_SELECTOR, \\"#login button\\").click()
-    assert self.driver.find_element(By.CSS_SELECTOR, \\".flash.success\\").text == \\"You logged into a secure area!\\\\n×\\"
+    assert self.driver.find_element(By.CSS_SELECTOR, \\".flash.success\\").text == \\"You logged into a secure area!\\\\\\\\\\\\\\\\n×\\"
   
   def test_invalidcredentials(self):
     self.driver.get(\\"http://the-internet.herokuapp.com/login\\")
     self.driver.set_window_size(1440, 1177)
     self.driver.find_element(By.ID, \\"username\\").send_keys(\\"blah\\")
     self.driver.find_element(By.ID, \\"password\\").send_keys(\\"blah\\")
     self.driver.find_element(By.CSS_SELECTOR, \\"#login button\\").click()
-    assert self.driver.find_element(By.ID, \\"flash\\").text == \\"Your username is invalid!\\\\n×\\"
+    assert self.driver.find_element(By.ID, \\"flash\\").text == \\"Your username is invalid!\\\\\\\\\\\\\\\\n×\\"
   
 "
 `;
@@ -268,7 +268,7 @@ class TestLogin():
     self.driver.find_element(By.ID, \\"username\\").send_keys(\\"tomsmith\\")
     self.driver.find_element(By.ID, \\"password\\").send_keys(\\"SuperSecretPassword!\\")
     self.driver.find_element(By.CSS_SELECTOR, \\"#login button\\").click()
-    assert self.driver.find_element(By.CSS_SELECTOR, \\".flash.success\\").text == \\"You logged into a secure area!\\\\n×\\"
+    assert self.driver.find_element(By.CSS_SELECTOR, \\".flash.success\\").text == \\"You logged into a secure area!\\\\\\\\\\\\\\\\n×\\"
   
 "
 `;

packages/selianize/__tests__/__snapshots__/command.spec.js.snap

@@ -34,3 +34,5 @@ exports[`command code emitter should emit \`set window size\` command 1`] = `
       console.log('Unable to resize window. Skipping.'); 
     };"
 `;
+
+exports[`keys preprocessor should not unescape escaped characters 1`] = `"await driver.wait(until.elementLocated(By.id(\`t\`)), configuration.timeout);await driver.findElement(By.id(\`t\`)).then(element => {return element.sendKeys(\`AAAAAA\\\\\\\\\\\\\\\\\\\\\\\\\\\\\`BBBBBB\`);});"`;

packages/selianize/__tests__/command.spec.js

@@ -20,8 +20,17 @@ import {
   Commands,
   ControlFlowCommandNames,
 } from '../../selenium-ide/src/neo/models/Command'
+import { stringEscape } from '@seleniumhq/side-utils'
 
 describe('keys preprocessor', () => {
+  it('should not unescape escaped characters', () => {
+    const command = {
+      command: 'sendKeys',
+      target: 'id=t',
+      value: stringEscape('AAAAAA\\`BBBBBB'), // eslint-disable-line
+    }
+    return expect(CommandEmitter.emit(command)).resolves.toMatchSnapshot()
+  })
   it('should not affect hardcoded strings', () => {
     const command = {
       command: 'sendKeys',

packages/side-utils/__test__/src/string-escape/index.spec.js

@@ -7,6 +7,9 @@ describe('String escape', () => {
   it('should escape backticks', () => {
     expect(stringEscape('AAAAA`BBBBB')).toEqual('AAAAA\\`BBBBB')
   })
+  it('should escape backslashes', () => {
+    expect(stringEscape('AAAAA\\`BBBBB')).toEqual('AAAAA\\\\\\`BBBBB') // eslint-disable-line
+  })
   it('should escape single-quotes', () => {
     expect(stringEscape("AAAAA'BBBBB")).toEqual("AAAAA\\'BBBBB")
   })

packages/side-utils/src/string-escape/index.js

@@ -1,6 +1,6 @@
 module.exports = (input, terminatingCharacter) => {
   if (!input) return ''
-  return input.replace(/[`'"\\\n\r\u2028\u2029]/g, character => {
+  return input.replace(/[`'"\\\n\r\u2028\u2029\u005c]/g, character => {
     switch (character) {
       case `"`:
       case `'`:
@@ -16,6 +16,8 @@ module.exports = (input, terminatingCharacter) => {
         return '\\u2028'
       case '\u2029':
         return '\\u2029'
+      case '\u005c':
+        return '\\\\'
       default:
         return character
     }