Testing Contributions

Contents

• Get Set Up
• Verify the Problem
• Create a Testcase
• Prepare the Change
• Submit It

Web Developers are encouraged to download aWebKit Build Archiveto try out new features. If you come across a bug, make sure toreport it to the bug tracker.

Get Set Up

• Make a Bugzilla account atbugs.webkit.org.
• AddTools/Scriptsto your shell path soscriptsare easy to run.

Verify the Problem

• Update your build by runningupdate-webkitfollowed bybuild-webkit.
• Make sure the problem you’re fixing still exists by runningrun-safari.

Create a Testcase

For step by step instructions seeCreating Layout Tests.

• See the documentation onrunning tests,writing new tests,andWriting Layout Tests for DumpRenderTree
• Runrun-webkit-teststo see if your bug fix fixes an existing broken testcase. (If it breaks a test that passed before, besureyour fix is correct before submitting it.)
• Otherwise, create a new testcase.
  • Many tests are HTML files containing JavaScript that exercises a single feature or sub-feature and produces a reliable, easily recognizable result. For example, seefast/events/event-creation.htmlorfast/dom/HTMLSelectElement/listbox-select-reset.html.
  • It’s also possible to create a testcase that produces a PNG file and checksum to be compared with an expected result, if you’re testing things like colors. For example, seefast/dom/css-rule-functions.html.For that, be surenotto usetestRunner.dumpAsText().
• Create the expected result file(s).
  • If your fix fixes an existing test (or breaks one, but you’re certain it’s correct), delete the existing expected result(s) for that test so a new expected result can be generated.
  • Run your new test(s). To run only a subset of the full test suite, runrun-webkit-testswith the paths of the test directories or files relative to yourLayoutTestsdirectory. For example,run-webkit-tests fast/dom/HTMLSelectElement/will run all the tests in that directory. If you want to generate PNGs and checksum files too, add the-poption torun-webkit-tests.
  • After the tests are done, the test system will launch your newly built Safari and offer to show the actual results of any tests that have no expected results, as well as diffs of the expected and actual results when applicable. It will automatically create the expected result files for any new tests, so look at their results and make sure they’re correct.
  • If you need to make further changes, you can remove an expected result file and re-run its test to generate a new one. Or, you can run the test with the old expected results in place, and copy the new actual result from /tmp to the correct expected result file. (Don’t just copy and paste from the window, because it’s hard to make sure that all the whitespace is exactly right.)
• When you’re happy with the expected result, run the test again to be sure it now passes.

Prepare the Change

• Ensure your environment is prepared withgit-webkit setup.
• Find, or file, an appropriate bug for your patch inBugzilla,following thebug-reporting guidelines.
• Seethe WebKit guide to contributing code.
• git addany files you’re modifying or adding.

Submit It

• Usegit-webkit prto create a pull request for your changes.
• Edit the commit message template to add the bug reference(s) and brief descriptions for each change, following the examples in the template.
• You will receive a URL for your pull request in the output.