Merge branch 'master' into master

Author: symptog

_posts/2017-07-20-html5-tests.md

@@ -5,97 +5,73 @@ category: labs
 date: 2017-07-20 23:37:51
 ---
 
-# Acceptance Testing in HTML Client. Getting Started
+## BigBlueButton Puppeteer Tests
 
-The test suite for HTML5 client is currently under active development. The following instructions will help you install all the necessary tools and libraries to run the exiting specs and start writing your own tests.
+Tests for BigBlueButton using Puppeteer, Chromium and Jest.
 
-## Run Selenium Server
+## Get BBB URL and Secret and configure .env file
 
-Assuming that you installed HTML5 client already, you should have all `npm` packages including `webdriver-manager` installed at this stage. We use `webdriver-manager` tool to keep track of the latest Selenium Server and Chrome / Firefox WebDrivers.
+To run these tests with an existing BigBlueButton server, make sure you have a server set up, and that you have the server's URL and secret. These will be the same URL and secret you would use to make API calls to the server. If you do not have these, you can find them by running `bbb-conf --secret` from the terminal in the server.
 
-From the `bigbluebutton/bigbluebutton-html5` run:
+Copy the `.env-template` file to a new file, and name it `.env`. In the `.env` file, add your BigBlueButton server URL and secret, so the tests will know which server to connect to.
 
-```bash
-$ ./node_modules/.bin/webdriver-manager update
-```
-
-This command will download the latest versions of the WebDrivers and Selenium.
+## Setup
 
-Along with the Selenium and WebDrivers, you need to install the browsers itself.
+To run these tests, you will need the following:
+* Ubuntu 16.04 or later
+* Node.js 8.11.4 or later
+* Docker
 
-### How to install Chrome:
+These instructions assume you have the BigBlueButton repository cloned into a directory named `bigbluebutton`.
 
-```bash
-$ wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
-$ sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
-$ sudo apt-get update
-$ sudo apt-get install google-chrome-stable
-```
+First, you need to have the dependencies installed with `meteor npm install`, from the `bigbluebutton-html5` directory. When Puppeteer installs, it will automatically install the Chromium browser in which the tests will run.
 
-### How to install Firefox:
+To run individual tests, you can also optionally install Jest globally with `sudo npm install jest -g`.
 
 ```bash
-$ sudo apt-get install firefox
+$ cd tests/puppeteer
+$ npm install
 ```
 
-There are 3 browsers currently used in the test specs (multiremote mode): Chrome Stable/Mobile, Firefox Stable.
+## Running the tests with an existing BigBlueButton server (All in one)
 
-In order to run headless browser, we will use Xvfb display server:
+To run all the tests at once, run `npm test`.
 
-```bash
-$ sudo apt-get install xvfb
-```
+## Running a single test with an existing BigBlueButton server (Specific test)
 
-At this point, you can run the Selenium server (from under `bigbluebutton/bigbluebutton-html5`):
+To run a specific test from `bash`:
 
 ```bash
-$ xvfb-run ./node_modules/.bin/webdriver-manager start
+$ ./tests/puppeteer/run.sh -t testcase
 ```
 
-If you get an error `Xvfb failed to start`, run it with an `-a` option (Xvfb will use another display if the current one is already in use):
+Test cases list: `webcamlayout/whiteboard/webcam/virtualizedlist/user/sharednotes/screenshare/presentation/notifications/customparameters/chat/breakout/audio`.
 
-```bash
-$ xvfb-run -a ./node_modules/.bin/webdriver-manager start
-```
+If you have Jest installed globally, you can run individual tests with `jest TEST [TEST...]`. The tests are found in the `.test.js` files, but you may choose to omit file extensions when running the tests.
 
-Congratulations! You have Selenium server up and running. It is ready to handle your test cases. Now, keep the `xvfb-run` process running and continue in a new terminal session.
+## Debugging, Metrics and Evidences
 
-## Run the test specs
+### Debugging
 
-We use WebdriverIO interface to write the acceptance test cases. In order to execute the existing tests, you need to use `wdio` test runner. By default, it will look into any `*.spec.js` file inside the `/home/firstuser/dev/bigbluebutton/bigbluebutton-html5/tests/webdriverio/specs` directory. You can change the location of the test specs by modifying the `wdio` config file: `wdio.conf.js` (inside the `webdriverio` directory).
+To debug the tests, you will need to set `DEBUG=true`; if `DEBUG` receives `true`, the logs will show in the console from which we start the tests.
 
-Before proceeding any further, make sure HTML5 client is up and running.
-Node.js installation is also required:
+Debugging output will look like below:
 
-```bash
-$ sudo apt-get install nodejs-legacy
 ```
-
-You can run all of the existing test specs with a single npm command:
-
-```bash
-$ cd /home/firstuser/dev/bigbluebutton/bigbluebutton-html5
-$ npm test
+  console.log
+    19-Jan-2021 13:03:30  Meeting ID:  random-6850458
 ```
 
-### Test suites
+### Getting Metrics
 
-To make it easier to run a single specific set of tests, we group the specs into test suits. All the suits are defined in `wdio.conf.js`.
+To run the tests and get their metrics, you will need to set `BBB_COLLECT_METRICS=true`; if `BBB_COLLECT_METRICS` receives `true`, the metrics will be generated at the end of the test inside `/data/test-date-testName/metrics` folder; for example: 
+`data/test-19-01-2021-pollResultsChatMessage/metrics`.
 
-To run a single test suite, you need to pass its name to the npm script:
+### Getting Evidences
 
-```bash
-$ npm test -- --suite login
-```
-
-If you want to run a single spec (test file), `--spec` option can be used:
-
-```bash
-$ npm test -- --spec ./tests/webdriverio/specs/login.spec.js
-```
+Generating evidences is about to take screenshots of the client during testing. And to realize this, assigning `GENERATE_EVIDENCES` in `.env` to `true`. This will take screenshots and save them in `data/test-date-testName/screenshots`; for example: `data/test-19-01-2021-pollResultsChatMessage/screenshots`.
 
 ## Visual Regression
 
-Our test suite includes visual regression specs that can be execute separately with `npm run test-visual-regression` (desktop + mobile) or `npm run test-visual-regression-desktop` (desktop only). It will take screenshots of various views and components of the client, save them inside the `/screenshots` folder and put the failed cases into `/screenshots/diff`. The pictures will be put into subfolders sorted by browser name and screen resolution. By default, we use desktop Firefox, desktop Chrome and mobile Chrome (via mobile emulation). The screenshots are taken in 960x1200 and 1920x1200 resolutions.
+Our test suite includes visual regression specs that can be execute separately with `npm run test-visual-regression` (desktop only). It will take screenshots of various views and components of the client, save them inside the `tests/puppeteer/__image_snapshots__` folder and put the failed cases into `tests/puppeteer/__image_snapshots__/__diff_output__`.
 
-The pictures inside `/screenshots/reference` are reference images the test runner uses to detect potential visual regressions. If there's a big UI change in the client, the images can be regenerated any time using `npm run generate-refs-visual-regression` or `npm run generate-refs-visual-regression-desktop`.

_posts/2018-06-03-install.md

@@ -1440,6 +1440,7 @@ To create the dialplan, use the XML below and save it to `/opt/freeswitch/conf/d
 ```xml
 <extension name="from_my_provider">
  <condition field="destination_number" expression="^EXTERNALDID">
+   <action application="start_dtmf" /> 
    <action application="answer"/>
    <action application="sleep" data="500"/>
    <action application="play_and_get_digits" data="5 5 3 7000 # conference/conf-pin.wav ivr/ivr-that_was_an_invalid_entry.wav pin \d+"/>

_posts/2019-02-14-customize.md

@@ -595,6 +595,7 @@ To create the dialplan, use the XML below and save it to `/opt/freeswitch/conf/d
 ```xml
 <extension name="from_my_provider">
  <condition field="destination_number" expression="^EXTERNALDID">
+   <action application="start_dtmf" />
    <action application="answer"/>
    <action application="sleep" data="1000"/>
    <action application="play_and_get_digits" data="5 5 3 7000 # conference/conf-pin.wav ivr/ivr-that_was_an_invalid_entry.wav pin \d+"/>
@@ -949,7 +950,7 @@ Kurento uses the range 24577 - 32768, which is defined in `/etc/kurento/modules/
 
 ### Apply custom settings for TURN server
 
-If always want a specific TURN server configuration, the following to `apply-config.sh` and modify `aaa.bbb.ccc.ddd` and `secret` with your values.
+If always want a specific TURN server configuration, the following to [apply-config.sh](#apply-confsh) and modify `aaa.bbb.ccc.ddd` and `secret` with your values.
 
 ```bash
 echo "  - Update TURN server configuration turn-stun-servers.xml"
@@ -1131,7 +1132,8 @@ Useful tools for development:
 | `userdata-bbb_client_title=`               | Specifies a string to set as the HTML5 client title                                                                                 | BigBlueButton |
 | `userdata-bbb_force_listen_only=`          | If set to `true`, the user will be not be able to join with a microphone as an option                                               | `false`       |
 | `userdata-bbb_listen_only_mode=`           | If set to `false`, the user will not be able to join the audio part of the meeting without a microphone (disables listen-only mode) | `true`        |
-| `userdata-bbb_skip_check_audio=`           | If set to `true`, the user will not see the "echo test" prompt on login                                                             | `false`       |
+| `userdata-bbb_skip_check_audio=`           | If set to `true`, the user will not see the "echo test" prompt when sharing audio                                                             | `false`       |
+| `userdata-bbb_skip_check_audio_on_first_join=`      | (Introduced in BigBlueButton 2.3) If set to `true`, the user will not see the "echo test" when sharing audio for the first time in the session. If the user stops sharing, next time they try to share audio the echo test window will be displayed, allowing for configuration changes to be made prior to sharing audio again                                                             | `false`       |
 | `userdata-bbb_override_default_locale=`    | (Introduced in BigBlueButton 2.3) If set to `de`, the user's browser preference will be ignored - the client will be shown in 'de' (i.e. German) regardless of the otherwise preferred locale 'en' (or other)                                                             | `null`       |
 
 ### Branding parameters
@@ -1155,7 +1157,8 @@ Useful tools for development:
 | `userdata-bbb_enable_screen_sharing=`    | If set to `false`, the client will display the screen sharing button if they are the current presenter                              | `true`        |
 | `userdata-bbb_enable_video=`             | If set to `false`, the client will display the webcam sharing button (in effect disabling/enabling webcams)                         | `true`        |
 | `userdata-bbb_record_video=`             | If set to `false`, the user won't have her/his video stream recorded                                                                | `true`        |
-| `userdata-bbb_skip_video_preview=`       | If set to `true`, the client will not see a preview of their webcam before sharing it                                               | `false`       |
+| `userdata-bbb_skip_video_preview=`       | If set to `true`, the user will not see a preview of their webcam before sharing it                                               | `false`       |
+| `userdata-bbb_skip_video_preview_on_first_join=`       | (Introduced in BigBlueButton 2.3) If set to `true`, the user will not see a preview of their webcam before sharing it when sharing for the first time in the session. If the user stops sharing, next time they try to share webcam the video preview will be displayed, allowing for configuration changes to be made prior to sharing                                              | `false`       |
 | `userdata-bbb_mirror_own_webcam=`         | If set to `true`, the client will see a mirrored version of their webcam. Doesn't affect the incoming video stream for other users. | `false`       |
 
 ### Presentation parameters

_posts/2019-02-14-dev.md

@@ -255,7 +255,7 @@ Install Meteor.js.
 $ curl https://install.meteor.com/ | sh
 ```
 
-The HTML5 client in BigBlueButton 2.2 depends on Meteor version 1.8.x. Navigate to `bigbluebutton-html5/` and set the appropriate version of Meteor
+The HTML5 client in BigBlueButton 2.2 depends on Meteor version 1.8.x. Navigate to `bigbluebutton-html5/` and set the appropriate version of Meteor. Note that 2.3-dev needs version 1.10.2.
 
 ```
 meteor update --allow-superuser --release 1.8
@@ -365,7 +365,7 @@ vi ~/.sbt/1.0/global.sbt
 Add the following into it
 
 ```scala
-resolvers += "Artima Maven Repository" at "http://repo.artima.com/releases"
+resolvers += "Artima Maven Repository" at "https://repo.artima.com/releases"
 updateOptions := updateOptions.value.withCachedResolution(true)
 ```