| 1 |
Development rules |
| 2 |
================= |
| 3 |
|
| 4 |
Here are some rules that we follow when developing jMock: |
| 5 |
|
| 6 |
* Never check in a class without associated unit tests. |
| 7 |
|
| 8 |
* Never check a failing unit test into the repository. |
| 9 |
|
| 10 |
* Acceptance tests may fail. A failing acceptance test indicates |
| 11 |
something that needs to be done: a todo item, feature request or |
| 12 |
bug report, for example. It's ok to check a failing acceptance test |
| 13 |
into the repository. |
| 14 |
|
| 15 |
* Separate acceptance and unit tests. Make it easy to run only the |
| 16 |
unit tests so that we can check that they pass before committing, |
| 17 |
even when acceptance tests are failing. |
| 18 |
|
| 19 |
* Resolve and remove all TODO comments before checking in. |
| 20 |
|
| 21 |
* Avoid the following words in class names and other identifiers: |
| 22 |
Helper, Impl (or a derivative), Manager. |
| 23 |
|
| 24 |
* And the reverse: don't start interfaces with an I. |
| 25 |
|
| 26 |
* Use the TestDox naming conventions for unit tests. |
| 27 |
|
| 28 |
|
| 29 |
Architectural Constraints |
| 30 |
========================= |
| 31 |
|
| 32 |
* No dependency on any specific test framework. |
| 33 |
|
| 34 |
That means, don't use JUnit Assert.assertBlahBlah to check expectations. |
| 35 |
Throw ExpectationError to report a violated expectation. |
| 36 |
Throw some kind of RuntimeException to report programming errors in the |
| 37 |
use of the framework. E.g. trying to set up an expectation to return a |
| 38 |
result of the wrong type. |
| 39 |
|
| 40 |
Release |
| 41 |
======= |
| 42 |
mvn versions:set -DoldVersion=* -DnewVersion=2.10.0 -DgroupId=org.jmock -DgenerateBackupPoms=false |
| 43 |
|
| 44 |
eval $(gpg-agent --daemon --no-grab --write-env-file $HOME/.gpg-agent-info) |
| 45 |
export GPG_AGENT_INFO |
| 46 |
export GPG_TTY=$(tty) |
| 47 |
export SONATYPE_USERNAME=UUU |
| 48 |
export SONATYPE_PASSWORD=PPPP |
| 49 |
mvn clean deploy -P release --settings settings.xml -Dgpg.keyname=XXXXXXXX |
| 50 |
|
| 51 |
mvn versions:set -DoldVersion=* -DnewVersion=2.11.0-SNAPSHOT -DgroupId=org.jmock -DgenerateBackupPoms=false |
| 52 |
|