QA/Automation/Projects/WebRTC: Difference between revisions

Latest revision as of 05:44, 7 May 2014

Overview

"WebRTC is a free, open project that enables web browsers with Real-Time Communications (RTC) capabilities via simple Javascript APIs. The WebRTC components have been optimized to best serve this purpose."

To ensure that the code quality of WebRTC in Firefox is in an overall good shape, automated tests have to be written. Those tests will be executed by the Mochitest framework on a per check-in basis.


Name:	WebRTC tests
Leads:	Nils Ohlmeier
Contributors:	n/a
Repository:	http://hg.mozilla.org/mozilla-central/file/default/dom/media/tests
Tracking Bug:	bug 749522
Etherpad:	http://etherpad.mozilla.com:9000/automation-webrtc

Details

The code of WebRTC is still in an early state as the standards around WebRTC are not finalized yet. The WebRTC code and its tests are part of the official Firefox build since version 22. So all the relevant code can be found in mozilla-central. If you want to develop test cases for WebRTC please follow these steps:

Build Firefox and WebRTC Tests

1. To build your own version of Firefox, setup the build system by following the steps outlined on the MDN page 'Simple Firefox build'.

2. Execute the WebRTC mochitests (after buiding locally):

   $ ./mach mochitest-plain dom/media/test/mochitest/

Test Network Setups

To verify that our WebRTC can handle all possible network setups we should have at least all the different network setups described on the [WebRTC Test Networks]

Bug Report Recording Tools

If you experience quality issues with the audio playback or video rendering in Firefox please create a ticket in Bugzilla for it. To avoid lengthy verbals description of the symptoms you experienced it would be really helpful if you could record the problem with one of the tools below and add a link to your Bugzilla ticket for the developer to download and listen or watch your recording.

Linux

We recommend recordMyDesktop which is an free, open source tool to record your desktop content and also allows to make audio recordings. It is available for all major Linux distributions or can be compiled from source code.

Mac OS X

You can simply record your desktop with the QuickTime Player, which should be pre-installed on any recent Mac OS X.

Start the QuickTime Player
Open "File" menu
Click "New Screen Recording"
Press the red button in the new window

For audio recordings we recommend to install Soundflower that is an open source tool which presents itself as an audio device and allows to redirect the audio to another application. In combination with the above mentioned QuickTime Player it allows to create audio recordings.

Windows

Microsoft offers a ScreenRecorder for Windows 7 on TechNet with instructions how to use it: http://technet.microsoft.com/en-us/magazine/2009.03.utilityspotlight2.aspx

@@ Line 1: / Line 1: @@
-__NOTOC__
+==Overview==
+&quot;WebRTC is a free, open project that enables web browsers with Real-Time Communications (RTC) capabilities via simple Javascript APIs. The WebRTC components have been optimized to best serve this purpose.&quot;
-==Overview==
+To ensure that the code quality of WebRTC in Firefox is in an overall good shape, automated tests have to be written. Those tests will be executed by the [https://developer.mozilla.org/Mochitest Mochitest] framework on a per check-in basis.
-TODO
 {| style="width: 90%; margin: 0 0 1em 1em" |
@@ Line 12: / Line 12: @@
   |- valign="top"
   | '''Leads:'''
-  | [mailto:hskupin@mozilla.com Henrik Skupin], [mailto:dhunt@mozilla.com Dave Hunt], [mailto:rwood@mozilla.com Rob Wood]
+  | [mailto:nils@mozilla.com Nils Ohlmeier]
   |- valign="top"
   | '''Contributors:'''
@@ Line 18: / Line 18: @@
   |- valign="top"
   | '''Repository:'''
-  | http://hg.mozilla.org/projects/alder/file/default/dom/media/tests/
+  | http://hg.mozilla.org/mozilla-central/file/default/dom/media/tests
+ |- valign="top"
+ | '''Tracking Bug:'''
+ | {{bug|749522}}
   |- valign="top"
   | '''Etherpad:'''
@@ Line 24: / Line 27: @@
 |}
-==Sub Projects==
+==Details==
-{| class="fullwidth-table" |
+The code of WebRTC is still in an early state as the standards around WebRTC are not finalized yet. The WebRTC code and its tests are part of the official Firefox build since version 22. So all the relevant code can be found in mozilla-central. If you want to develop test cases for WebRTC please follow these steps:
- | style="background:#EFEFEF; width: 25%" | Sub Project
- | style="background:#EFEFEF; width: 15%" | Status
+===Build Firefox and WebRTC Tests===
- | style="background:#EFEFEF; width: 40%" | Description
+. To build your own version of Firefox, setup the build system by following the steps outlined on the MDN page '[https://developer.mozilla.org/en-US/docs/Simple_Firefox_build Simple Firefox build]'.
- |- valign="top"
- | [[Auto-tools/Automation_Development/Projects/WebRTC/Smoketests|Smoketests]]
+. Execute the WebRTC mochitests (after buiding locally):
- | Active
+    $ ./mach mochitest-plain dom/media/test/mochitest/
- | Suite of Smoketests for initial launch of WebRTC
-|}
+==Test Network Setups==
+To verify that our WebRTC can handle all possible network setups we should have at least all the different network setups described on the [[https://wiki.mozilla.org/WebRTC/Test_Networks WebRTC Test Networks]]
+==Bug Report Recording Tools==
+If you experience quality issues with the audio playback or video rendering in Firefox please create a ticket in [https://bugzilla.mozilla.org/ Bugzilla] for it. To avoid lengthy verbals description of the symptoms you experienced it would be really helpful if you could record the problem with one of the tools below and add a link to your Bugzilla ticket for the developer to download and listen or watch your recording.
+===Linux===
+We recommend [http://recordmydesktop.sourceforge.net/ recordMyDesktop] which is an free, open source tool to record your desktop content and also allows to make audio recordings. It is available for all major Linux distributions or can be compiled from source code.
+===Mac OS X===
+You can simply record your desktop with the QuickTime Player, which should be pre-installed on any recent Mac OS X.
+* Start the QuickTime Player
+* Open "File" menu
+* Click "New Screen Recording"
+* Press the red button in the new window
+For audio recordings we recommend to install [https://code.google.com/p/soundflower/ Soundflower] that is an open source tool which presents itself as an audio device and allows to redirect the audio to another application. In combination with the above mentioned QuickTime Player it allows to create audio recordings.
+===Windows===
+Microsoft offers a ScreenRecorder for Windows 7 on TechNet with instructions how to use it: http://technet.microsoft.com/en-us/magazine/2009.03.utilityspotlight2.aspx