Add more tests (#2293)

* Add tests

* Add tests

* Add focus tests

* Add tests

* Improve reliability

* Fix

* Add link

* Add comment

* Apply PR changes

* Rename and move files

* Rename

__tests__/cardActionMiddleware.js

@@ -4,7 +4,7 @@ import { imageSnapshotOptions, timeouts } from './constants.json';
 
 import allOutgoingActivitiesSent from './setup/conditions/allOutgoingActivitiesSent';
 import minNumActivitiesShown from './setup/conditions/minNumActivitiesShown.js';
-import suggestedActionsShowed from './setup/conditions/suggestedActionsShowed';
+import suggestedActionsShown from './setup/conditions/suggestedActionsShown';
 import uiConnected from './setup/conditions/uiConnected';
 
 // selenium-webdriver API doc:
@@ -31,7 +31,7 @@ test('card action "openUrl"', async () => {
   await driver.wait(uiConnected(), timeouts.directLine);
   await pageObjects.sendMessageViaSendBox('card-actions', { waitForSend: true });
 
-  await driver.wait(suggestedActionsShowed(), timeouts.directLine);
+  await driver.wait(suggestedActionsShown(), timeouts.directLine);
 
   const openUrlButton = await driver.findElement(By.css('[role="form"] ul > li:first-child button'));
 

__tests__/clockSkew.js

@@ -84,7 +84,7 @@ describe('Clock skew', () => {
 
     // Make sure the clock skew is set correctly.
     // If it is not set, the result could be false-positive.
-    expect(pageObjects.getStore()).resolves.toHaveProperty('clockSkewAdjustment', 120000);
+    await expect(pageObjects.getStore()).resolves.toHaveProperty('clockSkewAdjustment', 120000);
 
     await pageObjects.sendMessageViaSendBox('echo This outgoing activity should be the last in the list.', {
       waitForSend: false
@@ -94,7 +94,7 @@ describe('Clock skew', () => {
 
     const lastActivity = await driver.findElement(By.css('[role="list"] > li:last-child p'));
 
-    expect(lastActivity.getText()).resolves.toBe('echo This outgoing activity should be the last in the list.');
+    await expect(lastActivity.getText()).resolves.toBe('echo This outgoing activity should be the last in the list.');
 
     // Skip the echoback for 2nd user-originated activity, so we don't apply server timestamp to it. It will be visually appear as "sending".
     // Even the 2nd user-originated activity didn't apply server timestamp, the insertion-sort algorithm should put bot-originated activity below it.

__tests__/focus.js

@@ -0,0 +1,48 @@
+import { Key } from 'selenium-webdriver';
+
+import { timeouts } from './constants.json';
+import sendBoxTextBoxFocused from './setup/conditions/sendBoxTextBoxFocused';
+import suggestedActionsShown from './setup/conditions/suggestedActionsShown';
+import uiConnected from './setup/conditions/uiConnected';
+
+// selenium-webdriver API doc:
+// https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/index_exports_WebDriver.html
+
+jest.setTimeout(timeouts.test);
+
+// Verification of fix of #1971, https://github.com/microsoft/BotFramework-WebChat/issues/1971
+test('should not focus send box after clicking on send button', async () => {
+  const { driver, pageObjects } = await setupWebDriver();
+
+  await driver.wait(uiConnected(), timeouts.directLine);
+
+  await pageObjects.typeOnSendBox('echo 123');
+  await pageObjects.clickSendButton();
+
+  await expect(sendBoxTextBoxFocused().fn(driver)).resolves.toBeFalsy();
+});
+
+// Verification of fix of #1971, https://github.com/microsoft/BotFramework-WebChat/issues/1971
+test('should not focus send box after clicking on suggested actions', async () => {
+  const { driver, pageObjects } = await setupWebDriver();
+
+  await driver.wait(uiConnected(), timeouts.directLine);
+  await pageObjects.sendMessageViaSendBox('suggested-actions');
+
+  await driver.wait(suggestedActionsShown(), timeouts.directLine);
+
+  await pageObjects.clickSuggestedActionButton(0);
+
+  await expect(sendBoxTextBoxFocused().fn(driver)).resolves.toBeFalsy();
+});
+
+// Verification of fix of #1971, https://github.com/microsoft/BotFramework-WebChat/issues/1971
+test('should focus send box after pressing ENTER to send message', async () => {
+  const { driver, pageObjects } = await setupWebDriver();
+
+  await driver.wait(uiConnected(), timeouts.directLine);
+
+  await pageObjects.typeOnSendBox('echo 123', Key.RETURN);
+
+  await expect(sendBoxTextBoxFocused().fn(driver)).resolves.toBeTruthy();
+});

__tests__/inputHint.js

@@ -1,8 +1,8 @@
 import { timeouts } from './constants.json';
 
-import isRecognizingSpeech from './setup/pageObjects/isRecognizingSpeech';
 import minNumActivitiesShown from './setup/conditions/minNumActivitiesShown';
-import speechSynthesisPending from './setup/conditions/speechSynthesisPending';
+import speechRecognitionStartCalled from './setup/conditions/speechRecognitionStartCalled';
+import speechSynthesisUtterancePended from './setup/conditions/speechSynthesisUtterancePended';
 import uiConnected from './setup/conditions/uiConnected';
 
 // selenium-webdriver API doc:
@@ -25,11 +25,11 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      await driver.wait(speechSynthesisPending(), timeouts.ui);
+      await driver.wait(speechSynthesisUtterancePended(), timeouts.ui);
       await pageObjects.startSpeechSynthesize();
       await pageObjects.endSpeechSynthesize();
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeTruthy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeTruthy();
     });
 
     test('should not turn on microphone if initiated via typing', async () => {
@@ -45,7 +45,7 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
   });
 
@@ -63,11 +63,11 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      await driver.wait(speechSynthesisPending(), timeouts.ui);
+      await driver.wait(speechSynthesisUtterancePended(), timeouts.ui);
       await pageObjects.startSpeechSynthesize();
       await pageObjects.endSpeechSynthesize();
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
 
     test('should not turn on microphone if initiated via typing', async () => {
@@ -83,7 +83,7 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
   });
 
@@ -101,11 +101,11 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      await driver.wait(speechSynthesisPending(), timeouts.ui);
+      await driver.wait(speechSynthesisUtterancePended(), timeouts.ui);
       await pageObjects.startSpeechSynthesize();
       await pageObjects.endSpeechSynthesize();
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
 
     test('should turn off microphone if initiated via typing', async () => {
@@ -121,7 +121,7 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
   });
 
@@ -139,11 +139,11 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      await driver.wait(speechSynthesisPending(), timeouts.ui);
+      await driver.wait(speechSynthesisUtterancePended(), timeouts.ui);
       await pageObjects.startSpeechSynthesize();
       await pageObjects.endSpeechSynthesize();
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
 
     test('should not turn on microphone if initiated via typing', async () => {
@@ -159,7 +159,7 @@ describe('input hint', () => {
 
       await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
-      expect(isRecognizingSpeech(driver)).resolves.toBeFalsy();
+      await expect(speechRecognitionStartCalled().fn(driver)).resolves.toBeFalsy();
     });
   });
 });

__tests__/scrollToBottom.js

@@ -4,7 +4,7 @@ import { imageSnapshotOptions, timeouts } from './constants.json';
 
 import minNumActivitiesShown from './setup/conditions/minNumActivitiesShown';
 import scrollToBottomCompleted from './setup/conditions/scrollToBottomCompleted';
-import suggestedActionsShowed from './setup/conditions/suggestedActionsShowed';
+import suggestedActionsShown from './setup/conditions/suggestedActionsShown';
 import uiConnected from './setup/conditions/uiConnected';
 
 // selenium-webdriver API doc:
@@ -21,7 +21,7 @@ test('should stick to bottom if submitting an Adaptive Card while suggested acti
   await driver.wait(minNumActivitiesShown(2), timeouts.directLine);
 
   await pageObjects.sendMessageViaSendBox('suggested-actions', { waitForSend: true });
-  await driver.wait(suggestedActionsShowed(), timeouts.directLine);
+  await driver.wait(suggestedActionsShown(), timeouts.directLine);
   await driver.wait(scrollToBottomCompleted(), timeouts.scrollToBottom);
 
   const submitButton = await driver.findElement(By.css('button.ac-pushButton:nth-of-type(2)'));

__tests__/setup/conditions/negate.js

@@ -0,0 +1,5 @@
+import { Condition } from 'selenium-webdriver';
+
+export default function negateCondition(condition) {
+  return new Condition(`Negate of ${condition.name}`, async (...args) => !(await condition.fn(...args)));
+}

__tests__/setup/conditions/sendBoxTextBoxFocused.js

@@ -0,0 +1,22 @@
+import { By, Condition } from 'selenium-webdriver';
+
+import getSendBoxTextBox, { CSS_SELECTOR } from '../elements/getSendBoxTextBox';
+
+export default function sendBoxTextBoxFocused() {
+  return new Condition('Send box text box to be focused', async driver => {
+    // Make sure the send box text box is visible
+    await getSendBoxTextBox(driver);
+
+    try {
+      await driver.findElement(By.css(CSS_SELECTOR + ':focus'));
+
+      return true;
+    } catch (err) {
+      if (err.name === 'NoSuchElementError') {
+        return false;
+      }
+
+      throw err;
+    }
+  });
+}

__tests__/setup/conditions/speechRecognitionStartCalled.js

@@ -0,0 +1,9 @@
+import { Condition } from 'selenium-webdriver';
+
+// Checks if Web Chat has called "speechRecognition.start()" and pending for a series of speech events.
+
+export default function speechRecognitionStartCalled() {
+  return new Condition('SpeechRecognition.start to be called', driver =>
+    driver.executeScript(() => window.WebSpeechMock.speechRecognitionStartCalled())
+  );
+}

__tests__/setup/conditions/speechSynthesisUtterancePended.js

@@ -0,0 +1,7 @@
+import { Condition } from 'selenium-webdriver';
+
+export default function speechSynthesisUtterancePended() {
+  return new Condition('Speech synthesis utterance to be pended to synthesize', driver =>
+    driver.executeScript(() => window.WebSpeechMock.speechSynthesisUtterancePended())
+  );
+}

__tests__/setup/conditions/suggestedActionsShowed.js → __tests__/setup/conditions/suggestedActionsShown.js

@@ -1,5 +1,5 @@
 import { By, until } from 'selenium-webdriver';
 
-export default function suggestedActionsShowed() {
+export default function suggestedActionsShown() {
   return until.elementLocated(By.css('[role="form"] ul'));
 }

__tests__/setup/elements/getSendBoxTextBox.js

@@ -0,0 +1,9 @@
+import { By } from 'selenium-webdriver';
+
+const CSS_SELECTOR = '[role="form"] > * > form > input[type="text"]';
+
+export default async function getSendBoxTextBox(driver) {
+  return await driver.findElement(By.css(CSS_SELECTOR));
+}
+
+export { CSS_SELECTOR };

__tests__/setup/elements/getSendButton.js

@@ -0,0 +1,5 @@
+import { By } from 'selenium-webdriver';
+
+export default async function getSendButton(driver) {
+  return await driver.findElement(By.css('[role="form"] button[title="Send"]'));
+}

__tests__/setup/elements/getSuggestedActionButtons.js

@@ -0,0 +1,5 @@
+import { By } from 'selenium-webdriver';
+
+export default async function getSuggestedActionButtons(driver) {
+  return await driver.findElements(By.css('[role="form"] > :nth-child(2) ul > li button'));
+}

__tests__/setup/pageObjects/clickMicrophoneButton.js

@@ -0,0 +1,7 @@
+import getMicrophoneButton from '../elements/getMicrophoneButton';
+
+export default async function clickMicrophoneButton(driver) {
+  const microphoneButton = await getMicrophoneButton(driver);
+
+  await microphoneButton.click();
+}

__tests__/setup/pageObjects/clickSendButton.js

@@ -0,0 +1,5 @@
+import getSendButton from '../elements/getSendButton';
+
+export default async function clickSendButton(driver) {
+  (await getSendButton(driver)).click();
+}

__tests__/setup/pageObjects/clickSuggestedActionButton.js

@@ -0,0 +1,7 @@
+import getSuggestedActionButtons from '../elements/getSuggestedActionButtons';
+
+export default async function clickSuggestedActionButton(driver, index) {
+  const suggestedActions = await getSuggestedActionButtons(driver);
+
+  await suggestedActions[index].click();
+}

__tests__/setup/pageObjects/getNumActivitiesShown.js

@@ -0,0 +1,5 @@
+import { By } from 'selenium-webdriver';
+
+export default async function getNumActivitiesShown(driver) {
+  return (await driver.findElements(By.css(`[role="listitem"]`))).length;
+}

__tests__/setup/pageObjects/getSendBoxText.js

@@ -0,0 +1,7 @@
+import getSendBoxTextBox from '../elements/getSendBoxTextBox';
+
+export default async function getSendBoxText(driver) {
+  const textBox = await getSendBoxTextBox(driver);
+
+  return await textBox.getAttribute('value');
+}