JSON-Java-unit-test

This project is no longer accepting pull requests. It is not the source of truth for JSON-Java unit tests. The unit tests have been ported to https://github.com/stleary/JSON-java so that code and tests reside together. Please submit all pull requests to the new location.

Unit tests to validate the JSON-Java GitHub project code

https://github.com/stleary/JSON-java

Gradle and Eclipse is the recommended build tool and IDE.
Run individual tests or JunitTestSuite using EclEmma Coverage, or execute the TestRunner application directly.

The following libraries are required:

• asm-1.0.2.jar
  
• commons-io-2.1.jar
  
• commons-lang-2.6.jar
  
• hamcrest-core-1.3.jar
  
• json-path-2.1.0.jar
  
• json-smart-2.1.1.jar
  
• junit-4.12.jar
  
• mockito-all-1.9.5.jar
  
• slf4j-api-1.7.12.jar
  
• slf-simple-1.7.12.jar
  
• JSON-java.jar
  

To build from the command line using gradle:
Until the unit tests are merged into the JSON-Java project, the code has to be wired by hand.
# In an empty directory of your choice, clone JSON-Java-unit-test:

git clone https://github.com/stleary/JSON-Java-unit-test.git .

# Create a directory structure for the JSON-Java code

# Windows 10 version
mkdir src\main\java\org\json
# *nix version
mkdir -p src/main/java/org/json

# clone JSON-Java

#Windows version
git clone https://github.com/stleary/JSON-Java.git src\main\java\org\json

#*Nix version
git clone https://github.com/stleary/JSON-Java.git src/main/java/org/json

# Build, then execute the unit tests and code coverage

gradle clean build test jacocoTestReport

# Eclipse setup requires the Gradle IDE plug-in
# I use Gradle IDE 3.6.4.201503050952-RELEASE org.springsource.ide.eclipse.gradle.feature.feature.group Pivotal Software, Inc.
# From the Eclipse IDE:

File > Import > Gradle project > (navigate to your directory) > Build Model > (Select your directory) > Finish
(It is not necessary to run "gradle eclipse" on the project, from the command line)

Unit test results will be in build\reports\tests\index.html
Code coverage will be in build\reports\jacoco\html\index.html

To create an Eclipse project, you will need the Eclipse Gradle plug-in, available from the Eclipse Marketplace. I am currently using Gradle IDE 3.6.4.201503050952-RELEASE
Select File > Import > Gradle > Gradle project
Browse to the directory where you cloned JSON-Java-unit-test
Select Build model
Select built project

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:

• JSONObjects are unordered, making simple string comparison ineffective.
• Comparisons via equals() is not currently supported. Neither JSONArray nor JSONObject override 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:

• 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.
• 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.
• 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.

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.

Caveats: 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:

Execution failed for task ':compileJava'.
> invalid flag: -parameters

Resource files used in test
EnumTest.java
MyBean.java
MyBigNumberBean.java
MyEnum.java
MyEnumClass.java
MyEnumField.java
MyJsonString.java
MyPublicClass.java
PropertyTest.java
JunitTestSuite.java
StringsResourceBundle.java
TestRunner.java
Util.java