1
0
Fork 0
mirror of https://github.com/ethauvin/JSON-java.git synced 2025-06-17 07:50:52 -07:00

Update README.md

This commit is contained in:
stleary 2015-03-21 13:18:56 -05:00
parent b0ce7f3bd9
commit 09b5562ad9

View file

@ -8,24 +8,24 @@ Eclipse is the recommended development environment.
Run individual tests or <b>JunitTestSuite</b> using *EclEmma Coverage*, or execute the <b>TestRunner<b> application directly.<br> Run individual tests or <b>JunitTestSuite</b> using *EclEmma Coverage*, or execute the <b>TestRunner<b> application directly.<br>
Test filenames should consist of the name of the module being tested, with the suffix "Test". 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*. For example, <b>Cookie.java</b> is tested by <b>CookieTest.java</b>.
When adding a new unit test, don't forget to update *JunitTestSuite.java*. When adding a new unit test, don't forget to update <b>JunitTestSuite.java</b>.
The fundamental issues with JSON-Java testing are: The fundamental issues with JSON-Java testing are:
* *JSONObjects* are unordered, making simple string comparison ineffective. * <b>JSONObjects</b> 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. * Comparisons via equals() is not currently supported. Neither <b>JSONArray</b> nor <b>JSONObject</b> overrride <b>hashCode()</b> or <b>equals()</b>, so comparison defaults to the <b>Object</b> equals(), which is not useful.
* Access to the JSONArray and JSONObject internal containers for comparison is not currently available. * Access to the <b>JSONArray</b> and <b>JSONObject</b> internal containers for comparison is not currently available.
* JSONObject sometimes wraps entries in quotes, other times does not, complicating comparisons. * <b>JSONObject</b> sometimes wraps entries in quotes, other times does not, complicating comparisons.
When you start working on a test, add the empty file to the repository, so that others will know that test is taken. When you start working on a test, add the empty file to the repository, so that others will know that test is taken.
A unit test is considered complete when the coverage is >= 90% as measured by EclEmma. A unit test is considered complete when the coverage is >= 90% as measured by EclEmma.
| Test file name | Coverage | Comments | | Test file name | Coverage | Comments
| ------------- | ------------- | | ------------- | ------------- |
| CookieTest.java | 97.5% | Completed | | CookieTest.java | 97.5% | Completed
| PropertyTest.java | 94.8% | Completed | | PropertyTest.java | 94.8% | Completed
| CDLTest.java | 94.8% | Relies too much on string tests, needs to be reworked | | CDLTest.java | 94.8% | Relies too much on string tests, needs to be reworked
<b>Completed tests:</b><br> <b>Completed tests:</b><br>
CDLTest.java<br> CDLTest.java<br>