1005296 - Add documentation for WebAPI tests

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Certification Suite, defect)

Description

[William Lachance (:wlach)]

We should have documentation for the individual webapi tests, with links to the webapi documentation on MDN and their source code. This should help with tracking down problems when they occur.

Comment 1

[William Lachance (:wlach)]

Attachment: WIP (needs more work)

Comment 2

[William Lachance (:wlach)]

Comment on attachment 8416697 [details] [diff] [review]
WIP (needs more work)

Review of attachment 8416697 [details] [diff] [review]:
-----------------------------------------------------------------

Does this look ok to you? We should unbitrot this if so.

Comment 3

[Robert Wood [:rwood]]

Comment on attachment 8416697 [details] [diff] [review]
WIP (needs more work)

Review of attachment 8416697 [details] [diff] [review]:
-----------------------------------------------------------------

Great thanks Will, I just used review to provide feedback... comments inline thanks

::: webapi_tests/fm_radio/__init__.py
@@ +2,4 @@
>  # License, v. 2.0. If a copy of the MPL was not distributed with this file,
>  # You can obtain one at http://mozilla.org/MPL/2.0/.
>  
> +from test_fm_radio_basic import TestFMRadioBasic

I don't really understand this change; in order for the tests to find the common code / methods in FMRadioTestCommon I need the "from fm_radio_test import FMRadioTestCommon" import...

::: webapi_tests/fm_radio/test_fm_radio_basic.py
@@ +4,5 @@
>  
>  import time
>  
> +from webapi_tests.semiauto import TestCase
> +from fm_radio_test import FMRadioTestCommon

I don't understand why these changes...

@@ +11,5 @@
>  class TestFMRadioBasic(TestCase, FMRadioTestCommon):
> +    """
> +    This tests basic functionality of the `WebFM API`_
> +
> +    .. _`WebFM API`: https://developer.mozilla.org/en-US/docs/WebAPI/WebFM_API

It would be great if in the docs for each test, along with the web api under test, it also shows the methods and properties being tested in each test. Maybe keywords like this?

.. _'Methods': mozFMRadio.enable, mozFMRadio.disable
.. _'Properties': mozFMRadio.antennaAvailable, mozFMRadio.enabled

(Not sure if I have the format correct)

::: webapi_tests/semiauto/testcase.py
@@ +9,4 @@
>  
>  from marionette import Marionette, MarionetteException
>  
> +import environment

Again not sure why this is being changed, it works as/is...

Comment 4

[William Lachance (:wlach)]

Attachment: Updated patch

Good news! With some of the recent work that went in, apparently we don't need to futz with imports and __init__'s to make this work. Note however that this functionality *does* depend on a virtualenv with all the certsuite's dependencies installed, which means we need bug 1025292 to land before this.

Comment 5

[William Lachance (:wlach)]

Attachment: Take 3

Forgot to add a file last time

Comment 6

[Robert Wood [:rwood]]

Comment on attachment 8440919 [details] [diff] [review]
Take 3

Generating the html docs worked great once I installed the sphinx module in my virtualenv. Thanks Will.

Comment 7

[William Lachance (:wlach)]

Committed an updated version of the package with sphinx included in the deps list: https://github.com/mozilla-b2g/fxos-certsuite/commit/d4b75da327cdfa75f8f0a88a53d0b8e6591d0557

Will update readthedocs now.