Skip to content

Commit 1265897

Browse files
author
Benjamin Gehrels
committed
Merge remote-tracking branch 'tests/master' into upstream
2 parents 74e4932 + f07ddd9 commit 1265897

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+11062
-1
lines changed

‎.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,12 @@
55
.idea
66
*.iml
77
/target/
8+
9+
/bin/
10+
build
11+
.settings/
12+
/.gradle/
13+
/gradle/
14+
/gradlew
15+
/gradlew.bat
16+
.gitmodules

‎LICENSE

Lines changed: 180 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
============================================================================
1+
===== License for the code in /src/main:
22

33
Copyright (c) 2002 JSON.org
44

@@ -21,3 +21,182 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2121
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2222
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2323
SOFTWARE.
24+
25+
===== License for the code in /src/test:
26+
27+
Apache License
28+
Version 2.0, January 2004
29+
http://www.apache.org/licenses/
30+
31+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
32+
33+
1. Definitions.
34+
35+
"License" shall mean the terms and conditions for use, reproduction,
36+
and distribution as defined by Sections 1 through 9 of this document.
37+
38+
"Licensor" shall mean the copyright owner or entity authorized by
39+
the copyright owner that is granting the License.
40+
41+
"Legal Entity" shall mean the union of the acting entity and all
42+
other entities that control, are controlled by, or are under common
43+
control with that entity. For the purposes of this definition,
44+
"control" means (i) the power, direct or indirect, to cause the
45+
direction or management of such entity, whether by contract or
46+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
47+
outstanding shares, or (iii) beneficial ownership of such entity.
48+
49+
"You" (or "Your") shall mean an individual or Legal Entity
50+
exercising permissions granted by this License.
51+
52+
"Source" form shall mean the preferred form for making modifications,
53+
including but not limited to software source code, documentation
54+
source, and configuration files.
55+
56+
"Object" form shall mean any form resulting from mechanical
57+
transformation or translation of a Source form, including but
58+
not limited to compiled object code, generated documentation,
59+
and conversions to other media types.
60+
61+
"Work" shall mean the work of authorship, whether in Source or
62+
Object form, made available under the License, as indicated by a
63+
copyright notice that is included in or attached to the work
64+
(an example is provided in the Appendix below).
65+
66+
"Derivative Works" shall mean any work, whether in Source or Object
67+
form, that is based on (or derived from) the Work and for which the
68+
editorial revisions, annotations, elaborations, or other modifications
69+
represent, as a whole, an original work of authorship. For the purposes
70+
of this License, Derivative Works shall not include works that remain
71+
separable from, or merely link (or bind by name) to the interfaces of,
72+
the Work and Derivative Works thereof.
73+
74+
"Contribution" shall mean any work of authorship, including
75+
the original version of the Work and any modifications or additions
76+
to that Work or Derivative Works thereof, that is intentionally
77+
submitted to Licensor for inclusion in the Work by the copyright owner
78+
or by an individual or Legal Entity authorized to submit on behalf of
79+
the copyright owner. For the purposes of this definition, "submitted"
80+
means any form of electronic, verbal, or written communication sent
81+
to the Licensor or its representatives, including but not limited to
82+
communication on electronic mailing lists, source code control systems,
83+
and issue tracking systems that are managed by, or on behalf of, the
84+
Licensor for the purpose of discussing and improving the Work, but
85+
excluding communication that is conspicuously marked or otherwise
86+
designated in writing by the copyright owner as "Not a Contribution."
87+
88+
"Contributor" shall mean Licensor and any individual or Legal Entity
89+
on behalf of whom a Contribution has been received by Licensor and
90+
subsequently incorporated within the Work.
91+
92+
2. Grant of Copyright License. Subject to the terms and conditions of
93+
this License, each Contributor hereby grants to You a perpetual,
94+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
95+
copyright license to reproduce, prepare Derivative Works of,
96+
publicly display, publicly perform, sublicense, and distribute the
97+
Work and such Derivative Works in Source or Object form.
98+
99+
3. Grant of Patent License. Subject to the terms and conditions of
100+
this License, each Contributor hereby grants to You a perpetual,
101+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
102+
(except as stated in this section) patent license to make, have made,
103+
use, offer to sell, sell, import, and otherwise transfer the Work,
104+
where such license applies only to those patent claims licensable
105+
by such Contributor that are necessarily infringed by their
106+
Contribution(s) alone or by combination of their Contribution(s)
107+
with the Work to which such Contribution(s) was submitted. If You
108+
institute patent litigation against any entity (including a
109+
cross-claim or counterclaim in a lawsuit) alleging that the Work
110+
or a Contribution incorporated within the Work constitutes direct
111+
or contributory patent infringement, then any patent licenses
112+
granted to You under this License for that Work shall terminate
113+
as of the date such litigation is filed.
114+
115+
4. Redistribution. You may reproduce and distribute copies of the
116+
Work or Derivative Works thereof in any medium, with or without
117+
modifications, and in Source or Object form, provided that You
118+
meet the following conditions:
119+
120+
(a) You must give any other recipients of the Work or
121+
Derivative Works a copy of this License; and
122+
123+
(b) You must cause any modified files to carry prominent notices
124+
stating that You changed the files; and
125+
126+
(c) You must retain, in the Source form of any Derivative Works
127+
that You distribute, all copyright, patent, trademark, and
128+
attribution notices from the Source form of the Work,
129+
excluding those notices that do not pertain to any part of
130+
the Derivative Works; and
131+
132+
(d) If the Work includes a "NOTICE" text file as part of its
133+
distribution, then any Derivative Works that You distribute must
134+
include a readable copy of the attribution notices contained
135+
within such NOTICE file, excluding those notices that do not
136+
pertain to any part of the Derivative Works, in at least one
137+
of the following places: within a NOTICE text file distributed
138+
as part of the Derivative Works; within the Source form or
139+
documentation, if provided along with the Derivative Works; or,
140+
within a display generated by the Derivative Works, if and
141+
wherever such third-party notices normally appear. The contents
142+
of the NOTICE file are for informational purposes only and
143+
do not modify the License. You may add Your own attribution
144+
notices within Derivative Works that You distribute, alongside
145+
or as an addendum to the NOTICE text from the Work, provided
146+
that such additional attribution notices cannot be construed
147+
as modifying the License.
148+
149+
You may add Your own copyright statement to Your modifications and
150+
may provide additional or different license terms and conditions
151+
for use, reproduction, or distribution of Your modifications, or
152+
for any such Derivative Works as a whole, provided Your use,
153+
reproduction, and distribution of the Work otherwise complies with
154+
the conditions stated in this License.
155+
156+
5. Submission of Contributions. Unless You explicitly state otherwise,
157+
any Contribution intentionally submitted for inclusion in the Work
158+
by You to the Licensor shall be under the terms and conditions of
159+
this License, without any additional terms or conditions.
160+
Notwithstanding the above, nothing herein shall supersede or modify
161+
the terms of any separate license agreement you may have executed
162+
with Licensor regarding such Contributions.
163+
164+
6. Trademarks. This License does not grant permission to use the trade
165+
names, trademarks, service marks, or product names of the Licensor,
166+
except as required for reasonable and customary use in describing the
167+
origin of the Work and reproducing the content of the NOTICE file.
168+
169+
7. Disclaimer of Warranty. Unless required by applicable law or
170+
agreed to in writing, Licensor provides the Work (and each
171+
Contributor provides its Contributions) on an "AS IS" BASIS,
172+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
173+
implied, including, without limitation, any warranties or conditions
174+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
175+
PARTICULAR PURPOSE. You are solely responsible for determining the
176+
appropriateness of using or redistributing the Work and assume any
177+
risks associated with Your exercise of permissions under this License.
178+
179+
8. Limitation of Liability. In no event and under no legal theory,
180+
whether in tort (including negligence), contract, or otherwise,
181+
unless required by applicable law (such as deliberate and grossly
182+
negligent acts) or agreed to in writing, shall any Contributor be
183+
liable to You for damages, including any direct, indirect, special,
184+
incidental, or consequential damages of any character arising as a
185+
result of this License or out of the use or inability to use the
186+
Work (including but not limited to damages for loss of goodwill,
187+
work stoppage, computer failure or malfunction, or any and all
188+
other commercial damages or losses), even if such Contributor
189+
has been advised of the possibility of such damages.
190+
191+
9. Accepting Warranty or Additional Liability. While redistributing
192+
the Work or Derivative Works thereof, You may choose to offer,
193+
and charge a fee for, acceptance of support, warranty, indemnity,
194+
or other liability obligations and/or rights consistent with this
195+
License. However, in accepting such obligations, You may act only
196+
on Your own behalf and on Your sole responsibility, not on behalf
197+
of any other Contributor, and only if You agree to indemnify,
198+
defend, and hold each Contributor harmless for any liability
199+
incurred by, or claims asserted against, such Contributor by reason
200+
of your accepting any such warranty or additional liability.
201+
202+
END OF TERMS AND CONDITIONS

‎README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,55 @@ as of 29 July, 2015.
146146
JSON-java releases can be found by searching the Maven repository for groupId "org.json"
147147
and artifactId "json". For example:
148148
https://search.maven.org/search?q=g:org.json%20AND%20a:json&core=gav
149+
150+
# Unit tests
151+
The test suite can be run by calling
152+
```
153+
mvn test
154+
```
155+
156+
157+
158+
## Conventions
159+
Test filenames should consist of the name of the module being tested, with the suffix "Test".
160+
For example, <b>Cookie.java</b> is tested by <b>CookieTest.java</b>.
161+
162+
<b>The fundamental issues with JSON-Java testing are:</b><br>
163+
* <b>JSONObjects</b> are unordered, making simple string comparison ineffective.
164+
* Comparisons via **equals()** is not currently supported. Neither <b>JSONArray</b> nor <b>JSONObject</b> override <b>hashCode()</b> or <b>equals()</b>, so comparison defaults to the <b>Object</b> equals(), which is not useful.
165+
* Access to the <b>JSONArray</b> and <b>JSONObject</b> internal containers for comparison is not currently available.
166+
167+
<b>General issues with unit testing are:</b><br>
168+
* Just writing tests to make coverage goals tends to result in poor tests.
169+
* 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.
170+
* 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.
171+
* Without unit tests it is hard to feel confident about the quality of the code, especially when fixing bugs or refactoring. Good tests prevents regressions and keeps the intent of the code correct.
172+
* If you have unit test results along with pull requests, the reviewer has an easier time understanding your code and determining if the it works as intended.
173+
174+
When you start working on a test, add the empty file to the repository and update the readme, so that others will know that test is taken.
175+
176+
**Caveats:**
177+
JSON-Java is Java 1.6-compatible, but JSON-Java-unit-tests requires Java 1.8. If you see this error when building JSON-Java-unit-test, make sure you have 1.8 installed, on your path, and set in JAVA_HOME:
178+
```
179+
Execution failed for task ':compileJava'.
180+
> invalid flag: -parameters
181+
```
182+
183+
184+
| Resource files used in test |
185+
| ------------- |
186+
| EnumTest.java |
187+
| MyBean.java |
188+
| MyBigNumberBean.java |
189+
| MyEnum.java |
190+
| MyEnumClass.java |
191+
| MyEnumField.java |
192+
| MyJsonString.java |
193+
| MyPublicClass.java |
194+
| PropertyTest.java |
195+
| JunitTestSuite.java |
196+
| StringsResourceBundle.java |
197+
| TestRunner.java |
198+
| Util.java |
199+
200+

0 commit comments

Comments
 (0)