Skip to content

Commit

Permalink
Updated documentation to new parameter name
Browse files Browse the repository at this point in the history
  • Loading branch information
fiunchinho committed Aug 22, 2014
1 parent 5ec05b1 commit c9eb13c
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ phpunit-randomizer
A PHPUnit extension that allows you to execute your test cases in a random order. This way you can identify tests that depend on other tests because they share some state, like object state, or even database state.
PHPUnit has an option to execute test cases in process isolation, but that takes a lot of time when you have many tests.

With this library, you don't have to modify any PHPUnit code. Just install it, and use the executable to run your tests, instead of using the default phpunit command.
With this library, you don't have to modify any PHPUnit code. Just install it, and use the binary from the vendor folder (vendor/fiunchinho/phpunit-randomizer/bin/phpunit-randomizer) to run your tests, instead of using the default phpunit command.


Installing Dependencies
Expand All @@ -17,21 +17,27 @@ $> php composer.phar install

Usage
-------
The executable binary is under the bin folder and it works exactly the same as the default phpunit file, accepting the same arguments, except for one: The `seed` argument.
The executable binary is under the bin folder and it works exactly the same as the default phpunit file, accepting the same arguments, except for one: The `order` argument.

```bash
$> bin/phpunit-randomizer -h
```

When you execute your tests using this library, if you look to the output, you'll see that it says that the tests have been randomized using a random seed. If you don't specify any seed, the seed will be calculated randomly, every time you execute your tests. But if you want to repeat an specific order that is interesting to you (because it failed, for example), you can re-run that order specifing the seed argument.
When you execute your tests using this library, you will get the same results as using a regular PHPUnit installation unless you use the `--order rand` parameter. Try executing the following:

For example, let's try to execute the example tests twice, and see how the order differ.
```bash
$> bin/phpunit-randomizer --order rand
```

If you look to the output, you'll see that it says that the tests have been randomized using a random seed. If you don't specify any seed (like the example above), the seed will be calculated randomly every time you execute your tests. But if you want to repeat an specific order that is interesting to you (because it failed, for example), you can re-run that order specifing the seed in your `order` argument.

For example, let's try to execute the example tests (that print the name of the test case so we can see the order in which they are executed) twice, and see how the order differ.

![Executing randomly your tests](http://i.imgur.com/zXVc11R.png)
![Executing randomly your tests](http://i.imgur.com/CM3RoQz.png)

Here you can see how the order of the test cases is different in the two executions. Also, you can see the seed used in both cases (604 in the first one, 295 in the second). Now, if we want to repeat the order of the second execution, we can select the same seed.
Here you can see how the order of the test cases is different in the two executions. Also, you can see the seed used in both cases (8639 in the first one, 4674 in the second). Now, if we want to repeat the order of the second execution, we can select the same seed.

![Executing randomly your tests](http://i.imgur.com/bGk33g1.png)
![Executing randomly your tests](http://i.imgur.com/uTWtspK.png)

As you can see, the order is exactly the same.

Expand Down

0 comments on commit c9eb13c

Please sign in to comment.