Difference between revisions of "Webapps/Submitting tests"

From W3C Wiki
Jump to: navigation, search
m (How to Submit New Tests - The Long Version)
m (How to Submit New Tests - The Long Version)
Line 63: Line 63:
 
GitHub itself has a nice long help document explaining [https://help.github.com/articles/fork-a-repo how to contribute to projects].
 
GitHub itself has a nice long help document explaining [https://help.github.com/articles/fork-a-repo how to contribute to projects].
  
'''Also see the [http://testthewebforward.org/github_test_submission.html Test Submission Guide] that Rebecca Hauck created (as part of [http://testthewebforward.org/ Test the Web Forward].
+
Also see the '''[http://testthewebforward.org/github_test_submission.html Test Submission Guide]''' that Rebecca Hauck created (in the context of [http://testthewebforward.org/ Test the Web Forward]).
'''
+
 
 
If you are brand new to Git and GitHub, you should probably read the [https://help.github.com/articles/set-up-git getting started guide] from the start. It's nice and friendly. The [https://help.github.com/ GitHub help pages] has lots of other great information and guides. And for everything else you are welcome to send an email to the WG's <code>[mailto:public-webapps-testsuite@w3.org public-webapps-testsuite]</code> e-mail list ([http://lists.w3.org/Archives/Public/public-webapps-testsuite/ archive]).
 
If you are brand new to Git and GitHub, you should probably read the [https://help.github.com/articles/set-up-git getting started guide] from the start. It's nice and friendly. The [https://help.github.com/ GitHub help pages] has lots of other great information and guides. And for everything else you are welcome to send an email to the WG's <code>[mailto:public-webapps-testsuite@w3.org public-webapps-testsuite]</code> e-mail list ([http://lists.w3.org/Archives/Public/public-webapps-testsuite/ archive]).
  

Revision as of 11:57, 21 May 2013

Webapps' tests are primarily written as testharness.js tests. You can find the repository on GitHub, and our public mirror on w3c-test.org.

Test Licensing

All of the tests in WebApps' test suites are intended to be released under both the W3C Test Suite license and the 3-clause BSD license.

If a Contributor is a member of WebApps, there is no need to complete any license forms. However, if a Contributor is not a member of WebApps, the Contributor must grant permission to distribute their contribution under these two licenses, and this requires completing the W3C's license grant form.

Test Repository Structure

The WG uses the W3C's web-platform-tests repository on GitHub for its tests.

The structure of the repository, is:

  • .../[specification]/
    • .../eventsource/
    • .../webstorage/
  • .../[specification]/[section]/test.htm

Where:

  • specification is the short-name of a specification as used when the spec is published as a Technical Report e.g. XMLHttpRequest, workers, webstorage
  • section is up to three level deep sections of the spec where the test belongs. NOTE: some tests do not use the section subdirectories.

If the test folder for the specification you're writing a test for uses the sections, you should too.

All tests that exist in the test repository are considered approved and reviewed. You can find current submissions by looking at the open pull requests of the repository.

Test Case Requirements

The group has agreed that all tests need to be written in the following manner:

  1. Tests should use the JavaScript harness described in testharness.js
  2. If a test is a visual test (not API specific) a Reference Test (aka RefTest) must be created. Note that -ref must be added to the testcase name to identify the reference page. For some information on RefTests, see:
    1. RefTests by the CSS WG
    2. Creating reftest-based unit tests by Mozilla
  3. The final option is a self-describing test and should be used only when a JavaScript or a RefTest is not appropriate.

The tests should preferably include the metadata:

<link rel="author" title="Name of Author" href="mailto: or http://"/>
<link rel="help" href="http://example.com/relevant-spec#section"/>
<meta name="assert" content="The lines of what the test asserts"/>

How to Submit a New Test - The Short Version

The way to contribute is just the usual GitHub way:

  1. Fork the GitHub repository (and make sure you're still relatively in sync with it if you forked a while ago)
  2. Create a branch for your changes, git checkout -b submission/your-name
  3. Make your changes
  4. Push that to your GitHub repository
  5. Send in a pull request based on the above

You might get asked about completing W3C's license grant form if your employer is not already a member and you have not done so before. Someone will review your test and you might have to do some changes based on that review.

You are also welcome to ping the public-webapps-testsuite mailing list for any reason. Such as explicitly asking for review, discuss or announce your submission.

How to Submit New Tests - The Long Version

GitHub itself has a nice long help document explaining how to contribute to projects.

Also see the Test Submission Guide that Rebecca Hauck created (in the context of Test the Web Forward).

If you are brand new to Git and GitHub, you should probably read the getting started guide from the start. It's nice and friendly. The GitHub help pages has lots of other great information and guides. And for everything else you are welcome to send an email to the WG's public-webapps-testsuite e-mail list (archive).

Test Review and Approval Workflow

The general workflow for test reviews and approval follows the GitHub contribution model and is summarized here:

  • Pre condition: we assume everyone that is interested in reviewing and/or approving WebApps' tests will set a "Watch" at GitHub so they will be notified when a Pull Request (PR) is made.
  • To initiate a review, make a Pull Request to the main web-platform-tests/master on GitHub (this will notify all subscribers of the PR). The review initiator can also notify the group of the PR via the public-webapps-testsuite mail list.
  • Reviewers should review the test code and reply accordingly. If no issues are found, the reviewer should state that so there is a trail a review was done.
  • After all of the review issues are addressed, the PR will be merged into the repository. The merge may be done by the spec's Test Facilitator or someone that is overseeing the test repository. ^1
  • The merged tests are considered Approved.

^1 If you are a member of WebApps, and would like to be able to merge Pull Requests after a successful review, ask one of the W3C Staff members to add your GitHub account into the Team group. Good candidates are Robin (darobin), Tobie (tobie) and Mike (MikeSmith).

Testing Roles

Information in this document refers to the following roles:

  • Contributor / Submitter - someone that contributes one or more test cases
  • Test Facilitator - the person(s) responsible for maintaining a specification's test suite, including updating test cases, making sure Pull Requests are reviewed, etc. Normally, this role is assumed to the specification's Editor(s). A Test Facilitator will be designated as the Default Assignee for the test suite's bug component in WebApp's Bugzilla database. Test Facilitators are expected to work with Contributors e.g. to resolve quality issues, to eliminate redundant/overlapping asserts, etc.
  • Testing Coordinator - the person responsible for coordinating all of WebApps' testing efforts. By default, this role is taken by a WG Chair, a WebApps Team Contact or a member of the WG. (In practice, this role may be shared by more than one person.)

Test Suite Status

The easiest way to determine the status of a spec's test suite is to simply ask on the public-webapps-testsuite@w3.org mai list. Additionally, some test suite status information including the spec's Test Facilitator is available in WebApps Publication Status document.

How to Report a Test Case Bug

A bug report for a test case can be reported via any of the following:

  • An e-mail to the public-webapps-testsuite@w3.org mai list
  • Make a Pull Request with a patch to fix the bug
  • File a Bugzilla bug against the appropriate test suite component in WebApps' Bugzilla database. Please identify the test case(s) that has a bug and clearly describe the bug. (If you do not have write access to the bug database, send an e-mail to the list above).