feat(webdriverio): Add webdriverio end to end test framework.

jitsi · tudor-phd · Jan 28, 2022 · Jan 31, 2022 · Feb 16, 2022 · Feb 24, 2022
commit a3171c533bd7c15ac2477900c37e2443e7ea9cd0
diff --git a/test/helpers/chromeSession.js b/test/helpers/chromeSession.js
@@ -1,11 +1,17 @@
 
-import { remote } from 'webdriverio'
+import { remote } from 'webdriverio';
+
+/**
+ * Function that creates a chrome session.
+ *
+ * @returns {void}
+ */
 export default function createChromeSession() {
     return remote({
         capabilities: {
             browserName: 'chrome',
             acceptInsecureCerts: true,
-            "goog:chromeOptions": {
+            'goog:chromeOptions': {
                 args: [
                     'use-fake-device-for-media-stream',
                     'use-fake-ui-for-media-stream',
@@ -14,8 +20,8 @@ export default function createChromeSession() {
                     'disable-infobars',
                     'autoplay-policy=no-user-gesture-required',
                     'auto-select-desktop-capture-source=Your Entire screen'
-                ],
+                ]
             }
         }
-    })
-}
+    });
+}
diff --git a/test/helpers/constants.js b/test/helpers/constants.js
@@ -1,28 +1,28 @@
 export const BASE_URL = process.env.BASE_URL || 'https://localhost:8080';
 
-export const BROWSERS = process.env.BROWSERS || ['chrome', 'firefox'];
+export const BROWSERS = process.env.BROWSERS || [ 'chrome', 'firefox' ];
 
 export const DEFAULT_CONFIG =
-"config.requireDisplayName=false"
-+ "&config.debug=true"
-+ "&config.testing.testMode=true"
-+ "&config.disableAEC=true"
-+ "&config.disableNS=true"
-+ "&config.enableTalkWhileMuted=false"
-+ "&config.callStatsID=false"
-+ "&config.alwaysVisibleToolbar=true"
-+ "&config.p2p.enabled=false"
-+ "&config.p2p.useStunTurn=false"
-+ "&config.pcStatsInterval=1500"
-+ "&config.prejoinConfig.enabled=false"
-+ "&config.gatherStats=true"
-+ "&config.disable1On1Mode=true"
-+ "&config.analytics.disabled=true"
-+ "&interfaceConfig.SHOW_CHROME_EXTENSION_BANNER=false"
-+ "&interfaceConfig.DISABLE_FOCUS_INDICATOR=true";
+'config.requireDisplayName=false'
++ '&config.debug=true'
++ '&config.testing.testMode=true'
++ '&config.disableAEC=true'
++ '&config.disableNS=true'
++ '&config.enableTalkWhileMuted=false'
++ '&config.callStatsID=false'
++ '&config.alwaysVisibleToolbar=true'
++ '&config.p2p.enabled=false'
++ '&config.p2p.useStunTurn=false'
++ '&config.pcStatsInterval=1500'
++ '&config.prejoinConfig.enabled=false'
++ '&config.gatherStats=true'
++ '&config.disable1On1Mode=true'
++ '&config.analytics.disabled=true'
++ '&interfaceConfig.SHOW_CHROME_EXTENSION_BANNER=false'
++ '&interfaceConfig.DISABLE_FOCUS_INDICATOR=true';
 
-export const FIRST_PARTICIPANT = "First participant";
-export const SECOND_PARTICIPANT = "Second participant";
-export const THIRD_PARTICIPANT = "Third participant";
+export const FIRST_PARTICIPANT = 'First participant';
+export const SECOND_PARTICIPANT = 'Second participant';
+export const THIRD_PARTICIPANT = 'Third participant';
 
-export const ENTER_KEY = "\uE007";
+export const ENTER_KEY = '\uE007';
diff --git a/test/helpers/createBrowserSession.js b/test/helpers/createBrowserSession.js
@@ -1,8 +1,12 @@
-
-import createFirefoxSession from "./firefoxSession";
-import createChromeSession from "./chromeSession";
+import createChromeSession from './chromeSession';
 import { BROWSERS } from './constants';
+import createFirefoxSession from './firefoxSession';
 
+/**
+ * Function that creates a browser session.
+ *
+ * @returns {void}
+ */
 export default function createBrowserSession() {
     for (let i = 0; i < BROWSERS.length; i++) {
         const browserName = BROWSERS[i];
@@ -15,5 +19,4 @@ export default function createBrowserSession() {
                 return
         }
     }
-
-}
+}
diff --git a/test/helpers/createMeetingRoom.js b/test/helpers/createMeetingRoom.js
@@ -1,3 +1,8 @@
+/**
+ * Create meeting room function.
+ *
+ * @returns {void}
+ */
 export default function createMeetingRoom(meetingUrl) {
-  browser.url(meetingUrl)
+    browser.url(meetingUrl);
 }
diff --git a/test/helpers/createMeetingUrl.js b/test/helpers/createMeetingUrl.js
@@ -1,6 +1,11 @@
-import { v4 as uuidv4 } from "uuid";
+import { v4 as uuidv4 } from 'uuid';
 import { BASE_URL, BROWSERS, DEFAULT_CONFIG } from './constants';
 
+/**
+ * Function that creates a meeting url.
+ *
+ * @returns {void}
+ */
 export default function createMeetingUrl() {
   for (let i = 0; i < BROWSERS.length; i++) {
     const browserName = BROWSERS[i];

diff --git a/test/helpers/firefoxSession.js b/test/helpers/firefoxSession.js
@@ -1,18 +1,24 @@
-import { remote } from 'webdriverio'
+import { remote } from 'webdriverio';
+
+/**
+ * Function that creates a firefox session.
+ *
+ * @returns {void}
+ */
 export default function createFirefoxSession() {
     return remote({
         capabilities: {
             browserName: 'firefox',
             acceptInsecureCerts: true,
-            "moz:firefoxOptions": {
-                "prefs": {
-                    "media.navigator.streams.fake": true,
-                    "media.navigator.permission.disabled": true,
-                    "media.peerconnection.ice.tcp": true,
-                    "intl.accept_languages": "en",
-                    "media.autoplay.default": 0
+            'moz:firefoxOptions': {
+                'prefs': {
+                    'media.navigator.streams.fake': true,
+                    'media.navigator.permission.disabled': true,
+                    'media.peerconnection.ice.tcp': true,
+                    'intl.accept_languages': 'en',
+                    'media.autoplay.default': 0
                 }
             }
         }
-    })
-};
+    });
+}
diff --git a/test/helpers/isParticipantModerator.js b/test/helpers/isParticipantModerator.js
@@ -1,5 +1,11 @@
+/**
+ * Function that checks if the participant is moderator.
+ *
+ * @returns {void}
+ */
 export default async function isParticipantModerator() {
-   await browser.execute(() => {
-        return window.APP.store.getState()['features/base/participants'].local.role === 'moderator'
-      });
-}
+  await browser.execute(() => {
+    return window.APP.store.getState()['features/base/participants'].local.role
+      === 'moderator';
+  });
+}
diff --git a/test/helpers/openParticipantsPane.js b/test/helpers/openParticipantsPane.js
@@ -1,11 +1,20 @@
-const ParticipantsPane = require("../page-objects/ParticipantsPane");
-const Toolbox = require("../page-objects/Toolbox")
+const ParticipantsPane = require('../page-objects/ParticipantsPane');
+const Toolbox = require('../page-objects/Toolbox');
+
+/**
+ * Open participants pane function.
+ *
+ * @returns {void}
+ */
 export default async function openParticipantsPane() {
     const toolbox = await Toolbox.ToolboxView;
+
     await expect(toolbox).toBeDisplayed();
-    const participantsButton = await Toolbox.ParticipantsPaneButton
+    const participantsButton = await Toolbox.ParticipantsPaneButton;
+
     await expect(participantsButton).toBeDisplayed();
     await participantsButton.click();
     const participantsPane = await ParticipantsPane.ParticipantsPaneView;
+
     await expect(participantsPane).toBeDisplayed();
 }
diff --git a/test/page-objects/ParticipantsPane.js b/test/page-objects/ParticipantsPane.js
@@ -6,6 +6,6 @@ class ParticipantsPane {
     // Participants pane object.
     get ParticipantsPaneView() {
         return $('.participants_pane');
-    };
+    }
 }
-module.exports = new ParticipantsPane();
+module.exports = new ParticipantsPane();
diff --git a/test/page-objects/PrejoinScreen.js b/test/page-objects/PrejoinScreen.js
@@ -14,4 +14,4 @@ class PrejoinScreen {
     }
 }
 
-module.exports = new PrejoinScreen();
+module.exports = new PrejoinScreen();
diff --git a/test/page-objects/SecurityDialog.js b/test/page-objects/SecurityDialog.js
@@ -6,12 +6,12 @@ class SecurityDialog {
     // Security dialog object.
     get SecurityDialogView() {
         return $('.security-dialog');
-    };
+    }
 
     // Lobby switch object.
     get LobbySwitch() {
         return $('[aria-label="cross"]');
-    };
+    }
 
     // Lobby enabled object. Check if lobby is enabled.
     get LobbyEnabled() {
@@ -24,4 +24,4 @@ class SecurityDialog {
     }
 }
 
-module.exports = new SecurityDialog();
+module.exports = new SecurityDialog();
diff --git a/test/page-objects/Toolbox.js b/test/page-objects/Toolbox.js
@@ -8,26 +8,26 @@ class Toolbox {
         const video = $('#largeVideo');
         video.moveTo();
         return $('.toolbox-content-items');
-    };
+    }
 
     // More action object.
     get MoreActionOption() {
         return $('.toolbox-button-wth-dialog div');
-    };
+    }
 
     // Overflow menu object.
     get OverflowMenu() {
         return $('#overflow-menu');
-    };
+    }
 
     // Security option button object.
     get SecurityOptionButton() {
         return $('[aria-label="Security options"]');
-    };
+    }
 
     // Participants pane button object.
     get ParticipantsPaneButton() {
         return $("[aria-label='Participants']");
-    };
+    }
 }
-module.exports = new Toolbox();
+module.exports = new Toolbox();
diff --git a/test/page-objects/notifications/LobbyNotification.js b/test/page-objects/notifications/LobbyNotification.js
@@ -6,21 +6,21 @@ class LobbyNotification {
     // Lobby notification object.
     get Notification() {
         return  $('#notifications-container');
-    };
+    }
 
     // View lobby button object.
     get ViewLobby() {
         return $('[data-testid="notify.viewLobby"]');
-    };
+    }
 
     // Admit lobby button object.
     get AdmitLobby() {
         return  $('[data-testid="lobby.admit"]');
-    };
+    }
 
     // Reject lobby button object.
     get RejectLobby() {
         return $('[data-testid="lobby.reject"]');
-    };
+    }
 }
-module.exports = new LobbyNotification();
+module.exports = new LobbyNotification();
diff --git a/test/page-objects/notifications/LobbyRejectNotification.js b/test/page-objects/notifications/LobbyRejectNotification.js
@@ -3,9 +3,9 @@
 */
 class LobbyRejectNotification {
 
-    //Lobby reject notification object
+    // Lobby reject notification object.
     get Notification() {
         return $('[data-testid="lobby.joinRejectedMessage"]');
-    };
+    }
 }
-module.exports = new LobbyRejectNotification();
+module.exports = new LobbyRejectNotification();
diff --git a/test/specs/lobbyAdmitParticipant.js b/test/specs/lobbyAdmitParticipant.js
@@ -15,30 +15,40 @@ import createMeetingRoom from "../helpers/createMeetingRoom";
 describe('Activate lobby and admit participant', () => {
     let meetingUrl;
     let Participant;
+
     it('should open jitsi-meet app and enable lobby by first participant', async () => {
         meetingUrl = await createMeetingUrl();
         await createMeetingRoom(meetingUrl)
         const prejoinTextInput = await $('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(FIRST_PARTICIPANT);
         await browser.keys(ENTER_KEY);
         const toolbox = await Toolbox.ToolboxView;
+
         await expect(toolbox).toBeDisplayed();
         const toolbarSecurityOption = await Toolbox.MoreActionOption;
+
         await expect(toolbarSecurityOption).toBeDisplayed();
         await toolbarSecurityOption.click();
         const overflowMenu = await Toolbox.OverflowMenu;
+
         await expect(overflowMenu).toBeDisplayed();
         const securityOptionsButton = await Toolbox.SecurityOptionButton;
+
         await expect(securityOptionsButton).toBeDisplayed();
         await securityOptionsButton.click();
         const securityDialog = await SecurityDialog.SecurityDialogView;
+
         await expect(securityDialog).toBeDisplayed();
         const lobbySwitch = await SecurityDialog.LobbySwitch;
+
         await expect(lobbySwitch).toBeDisplayed();
         await lobbySwitch.click();
         const lobbyEnabled = await SecurityDialog.LobbyEnabled;
+
         await expect(lobbyEnabled).toBeDisplayed();
         const securityDialogCloseButton = await SecurityDialog.SecurityDialogCloseButton;
+
         await expect(securityDialogCloseButton).toBeDisplayed();
         await securityDialogCloseButton.click();
     });
@@ -47,15 +57,19 @@ describe('Activate lobby and admit participant', () => {
         Participant = await createBrowserSession()
         await Participant.url(meetingUrl);
         const prejoinTextInput = await Participant.$('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(SECOND_PARTICIPANT);
         await Participant.keys(ENTER_KEY);
     });
     it('Moderator should admit the user that wants to join the meeting', async () => {
         const notification = await LobbyNotification.Notification;
+
         await expect(notification).toBeDisplayed();
         const lobbyAdmitBtn = await LobbyNotification.AdmitLobby;
+
         await expect(lobbyAdmitBtn).toBeDisplayed();
         const lobbyRejectBtn = await LobbyNotification.RejectLobby;
+
         await expect(lobbyRejectBtn).toBeDisplayed();
         await lobbyAdmitBtn.click();
         await openParticipantsPane();

diff --git a/test/specs/lobbyRejectParticipant.js b/test/specs/lobbyRejectParticipant.js
@@ -1,5 +1,4 @@
 const LobbyNotification = require("../page-objects/notifications/LobbyNotification");
-import { v4 as uuidv4 } from "uuid";
 //const LobbyRejectNotification = require("../page-objects/notifications/LobbyRejectNotification")
 const Toolbox = require("../page-objects/Toolbox");
 const SecurityDialog = require("../page-objects/SecurityDialog");
@@ -9,7 +8,6 @@ import {
     SECOND_PARTICIPANT
 } from "../helpers/constants"
 import createBrowserSession from "../helpers/createBrowserSession";
-import openParticipantsPane from "../helpers/openParticipantsPane";
 import createMeetingUrl from "../helpers/createMeetingUrl"
 import createMeetingRoom from "../helpers/createMeetingRoom";
 
@@ -20,51 +18,66 @@ describe('Activate lobby and admit participant', () => {
         meetingUrl = await createMeetingUrl();
         await createMeetingRoom(meetingUrl)
         const prejoinTextInput = await $('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(FIRST_PARTICIPANT);
         await browser.keys(ENTER_KEY);
         const toolbox = await Toolbox.ToolboxView;
+
         await expect(toolbox).toBeDisplayed();
         const toolbarSecurityOption = await Toolbox.MoreActionOption;
+
         await expect(toolbarSecurityOption).toBeDisplayed();
         await toolbarSecurityOption.click();
         const overflowMenu = await Toolbox.OverflowMenu;
+
         await expect(overflowMenu).toBeDisplayed();
         const securityOptionsButton = await Toolbox.SecurityOptionButton;
+
         await expect(securityOptionsButton).toBeDisplayed();
         await securityOptionsButton.click();
         const securityDialog = await SecurityDialog.SecurityDialogView;
+
         await expect(securityDialog).toBeDisplayed();
         const lobbySwitch = await SecurityDialog.LobbySwitch;
+
         await expect(lobbySwitch).toBeDisplayed();
         await lobbySwitch.click();
         const lobbyEnabled = await SecurityDialog.LobbyEnabled;
+
         await expect(lobbyEnabled).toBeDisplayed();
         const securityDialogCloseButton = await SecurityDialog.SecurityDialogCloseButton;
+
         await expect(securityDialogCloseButton).toBeDisplayed();
         await securityDialogCloseButton.click();
     });
     it('should open jitsi-meet with same room name where second participant wants to join', async () => {
         Participant = await createBrowserSession()
         await Participant.url(meetingUrl);
         const prejoinTextInput = await Participant.$('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(SECOND_PARTICIPANT);
         await Participant.keys(ENTER_KEY);
     });
     it('Moderator should reject the user that wants to join the meeting', async () => {
         const notification = await LobbyNotification.Notification;
+
         await expect(notification).toBeDisplayed();
         const lobbyAdmitBtn = await LobbyNotification.AdmitLobby;
+
         await expect(lobbyAdmitBtn).toBeDisplayed();
         const lobbyRejectBtn = await LobbyNotification.RejectLobby;
+
         await expect(lobbyRejectBtn).toBeDisplayed();
         await lobbyRejectBtn.click();
         // TODO: Find a solution to select Participant.LobbyNotification.Notidication
         // instead of Participant.$('#notifications-container').
         const rejectNotification = await Participant.$('#notifications-container');
+
         await expect(rejectNotification).toBeDisplayed();
         // TODO: Find a solution to select Participant.LobbyRejectNotification.Notidication
         // instead of Participant.$('[data-testid="lobby.joinRejectedMessage"]').
-        const rejectedMessage = await Participant.$('[data-testid="lobby.joinRejectedMessage"]')
+        const rejectedMessage = await Participant.$('[data-testid="lobby.joinRejectedMessage"]');
+
         await expect(rejectedMessage).toBeDisplayed();
         await browser.deleteSession();
         await Participant.deleteSession();

diff --git a/test/specs/viewLobby.js b/test/specs/viewLobby.js
@@ -1,16 +1,16 @@
-const LobbyNotification = require("../page-objects/notifications/LobbyNotification");
-const Toolbox = require("../page-objects/Toolbox");
-const ParticipantsPane = require("../page-objects/ParticipantsPane");
-const SecurityDialog = require("../page-objects/SecurityDialog");
+const LobbyNotification = require('../page-objects/notifications/LobbyNotification');
+const Toolbox = require('../page-objects/Toolbox');
+const ParticipantsPane = require('../page-objects/ParticipantsPane');
+const SecurityDialog = require('../page-objects/SecurityDialog');
 import {
     ENTER_KEY,
     FIRST_PARTICIPANT,
     SECOND_PARTICIPANT,
     THIRD_PARTICIPANT
-} from "../helpers/constants"
-import createBrowserSession from "../helpers/createBrowserSession";
-import createMeetingUrl from "../helpers/createMeetingUrl"
-import createMeetingRoom from "../helpers/createMeetingRoom";
+} from '../helpers/constants';
+import createBrowserSession from '../helpers/createBrowserSession';
+import createMeetingUrl from '../helpers/createMeetingUrl';
+import createMeetingRoom from '../helpers/createMeetingRoom';
 
 describe('Open jitsimeet app, enable lobby and view lobby', () => {
     let meetingUrl;
@@ -20,50 +20,64 @@ describe('Open jitsimeet app, enable lobby and view lobby', () => {
         meetingUrl = await createMeetingUrl();
         await createMeetingRoom(meetingUrl)
         const prejoinTextInput = await $('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(FIRST_PARTICIPANT);
         await browser.keys(ENTER_KEY);
         const toolbox = await Toolbox.ToolboxView;
+
         await expect(toolbox).toBeDisplayed();
         const toolbarSecurityOption = await Toolbox.MoreActionOption;
+
         await expect(toolbarSecurityOption).toBeDisplayed();
         await toolbarSecurityOption.click();
         const overflowMenu = await Toolbox.OverflowMenu;
+
         await expect(overflowMenu).toBeDisplayed();
         const securityOptionsButton = await Toolbox.SecurityOptionButton;
+
         await expect(securityOptionsButton).toBeDisplayed();
         await securityOptionsButton.click();
         const securityDialog = await SecurityDialog.SecurityDialogView;
+
         await expect(securityDialog).toBeDisplayed();
         const lobbySwitch = await SecurityDialog.LobbySwitch;
+
         await expect(lobbySwitch).toBeDisplayed();
         await lobbySwitch.click();
         const lobbyEnabled = await SecurityDialog.LobbyEnabled;
+
         await expect(lobbyEnabled).toBeDisplayed();
         const securityDialogCloseButton = await SecurityDialog.SecurityDialogCloseButton;
+
         await expect(securityDialogCloseButton).toBeDisplayed();
         await securityDialogCloseButton.click();
     });
     it('second participant should ask to join the meeting', async () => {
         Participant1 = await createBrowserSession()
         await Participant1.url(meetingUrl);
         const prejoinTextInput = await Participant1.$('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(SECOND_PARTICIPANT);
         await Participant1.keys(ENTER_KEY);
     });
     it('third participant should ask to join the meeting', async () => {
         Participant2 = await createBrowserSession()
         await Participant2.url(meetingUrl);
         const prejoinTextInput = await Participant2.$('.prejoin-input-area input');
+
         await prejoinTextInput.setValue(THIRD_PARTICIPANT);
         await Participant2.keys(ENTER_KEY);
     });
     it('Moderator should press the view button from lobby notification', async () => {
         const viewLobbyNotification = await LobbyNotification.Notification;
+
         await expect(viewLobbyNotification).toBeDisplayed();
         const viewLobbyBtn = await LobbyNotification.ViewLobby;
+
         await expect(viewLobbyBtn).toBeDisplayed();
         await viewLobbyBtn.click();
-        const participantsPane = await ParticipantsPane.ParticipantsPaneView
+        const participantsPane = await ParticipantsPane.ParticipantsPaneView;
+
         await expect(participantsPane).toBeDisplayed();
         await browser.deleteSession();
         await Participant1.deleteSession();
-Original file line number
+Diff line change
@@ @@ -14,4 +14,4 @@ class PrejoinScreen { @@
         }
     }
-    module.exports = new PrejoinScreen();
+    module.exports = new PrejoinScreen();