diff --git a/README.md b/README.md index b7be9be..9c27a4f 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,17 @@ Mockery: https://github.com/mockito/mockito
Coverage: http://www.eclemma.org/ (just install the latest in Eclipse)
JSON-Java.jar (make this jar of the files to be tested yourself)
-*Conventions*
+Conventions
Test filenames should consist of the name of the module being tested, with the suffix "Test". For example, Cookie.java is tested by CookieTest.java. When adding a new unit test, don't forget to update JunitTestSuite.java. -*The fundamental issues with JSON-Java testing are:* +The fundamental issues with JSON-Java testing are:
* JSONObjects are unordered, making simple string comparison ineffective. * Comparisons via **equals()** is not currently supported. Neither JSONArray nor JSONObject overrride hashCode() or equals(), so comparison defaults to the Object equals(), which is not useful. * Access to the JSONArray and JSONObject internal containers for comparison is not currently available. -General issues with unit testing are: +General issues with unit testing are:
* Just writing tests to make coverage goals tends to result in poor tests. * Unit tests are a form of documentation - how a given method actually works is demonstrated by the test. So for a code reviewer or future developer looking at code a good test helps explain how a function is supposed to work according to the original author. This can be difficult if you are not the original developer. * It is difficult to evaluate unit tests in a vacuum. You also need to see the code being tested to understand if a test is good.