| 1 | # zuul [](https://travis-ci.org/defunctzombie/zuul)
|
| 2 |
|
| 3 | Zuul is an easy way to test your javascript in browsers. Start testing your code in seconds locally and move to cloud based browsers seamlessly for better coverage.
|
| 4 |
|
| 5 | Zuul is different than other cross browser test runners in its simplicity and ability to easily run your test suite in many browsers without having them installed locally. It lets you iterate quickly during development and provide good browser coverage before release without worrying about missing a supported browser.
|
| 6 |
|
| 7 | Don't just claim your js supports "all browsers", prove it with tests!
|
| 8 |
|
| 9 | 
|
| 10 |
|
| 11 | ## Zuul workflow
|
| 12 |
|
| 13 | Zuul works out of the box with a few commonly used javascript frameworks (qunit, mocha, tape, jasmine). If you are already testing using these, zuul setup will be trivial.
|
| 14 |
|
| 15 | Zuul has 3 modes of operation: locally, cloud browsers, and continuous integration. You should make sure that zuul is working locally before you try to run the other two.
|
| 16 |
|
| 17 | Once you have [installed](https://github.com/defunctzombie/zuul/wiki/installation) zuul proceed to the [quickstart](https://github.com/defunctzombie/zuul/wiki/quickstart) to write your first test.
|
| 18 |
|
| 19 | ### Running zuul locally
|
| 20 |
|
| 21 | When iterating on your tests during development, simply use zuul `--local` mode to see your tests run in a browser.
|
| 22 |
|
| 23 | 
|
| 24 |
|
| 25 | See the [quickstart](https://github.com/defunctzombie/zuul/wiki/quickstart) page on the wiki for more details.
|
| 26 |
|
| 27 | ### Cross browser testing via Saucelabs
|
| 28 |
|
| 29 | The reason we go through all this trouble in the first place is to seamlessly run our tests against all those browsers we don't have installed. Luckily, [saucelabs](https://saucelabs.com/) runs some browsers and we can easily task zuul to test on those.
|
| 30 |
|
| 31 | 
|
| 32 |
|
| 33 | See the [cooking with sauce](https://github.com/defunctzombie/zuul/wiki/cloud-testing) wiki page to get your tests running in the cloud.
|
| 34 |
|
| 35 | ### Continuous integration
|
| 36 |
|
| 37 | No testing setup would be complete without a badge for passing or failing tests. After making sure your tests all pass in the cloud from your local machine, we will configure our tests to pass from travis-ci when we commit changes.
|
| 38 |
|
| 39 | 
|
| 40 |
|
| 41 | See the [travis-ci integration](https://github.com/defunctzombie/zuul/wiki/travis-ci) wiki page.
|
| 42 |
|
| 43 | ## Frameworks
|
| 44 |
|
| 45 | The following frameworks are supported:
|
| 46 |
|
| 47 | * mocha (tdd, qunit, and bdd flavors)
|
| 48 | * tape
|
| 49 | * qunit
|
| 50 | * jasmine
|
| 51 |
|
| 52 | ### Examples
|
| 53 |
|
| 54 | See the examples directory for some simple tests. Use the above knowledge to test the examples with your install of zuul.
|
| 55 |
|
| 56 | * [quickstart](https://github.com/defunctzombie/zuul/tree/master/examples/quickstart) - from the [quickstart](https://github.com/defunctzombie/zuul/wiki/Quickstart) wiki tutorial
|
| 57 | * [emberjs with qunit](https://github.com/defunctzombie/zuul/tree/master/examples/ember_w_qunit) - basic ember.js app with qunit tests
|
| 58 | * [jasmine](https://github.com/defunctzombie/zuul/tree/master/examples/jasmine) - basic jasmine example
|
| 59 |
|
| 60 | All of the examples can be tested locally by running the following command in each example directory.
|
| 61 |
|
| 62 | ```
|
| 63 | zuul --local 8080 -- test.js
|
| 64 | ```
|
| 65 |
|
| 66 | ## zuul.yml
|
| 67 |
|
| 68 | The zuul consumes a yaml config file. See the [zuul.yml](https://github.com/defunctzombie/zuul/wiki/zuul.yml) wiki page for all of the goodies this file provides.
|
| 69 |
|
| 70 | It includes advanced usage like how to run an additional server to support tests that make ajax requests.
|
| 71 |
|
| 72 | ## License
|
| 73 |
|
| 74 | MIT
|
| 75 |
|
| 76 | ## Credits
|
| 77 |
|
| 78 | This project is made possible by all the awesome modules it uses. See the `package.json` file for all the awesome.
|