isabella232 / japicmp

Comparison of two versions of a jar archive

The website is located at https://siom79.github.io/japicmp.

#japicmp#

japicmp is a tool to compare two versions of a jar archive:

java -jar japicmp-0.9.3-jar-with-dependencies.jar -n new-version.jar -o old-version.jar

It can also be used as a library:

JarArchiveComparatorOptions comparatorOptions = new JarArchiveComparatorOptions();
JarArchiveComparator jarArchiveComparator = new JarArchiveComparator(comparatorOptions);
List<JApiClass> jApiClasses = jarArchiveComparator.compare(oldArchives, newArchives);

japicmp is available in the Maven Central Repository:

<dependency>
	<groupId>com.github.siom79.japicmp</groupId>
	<artifactId>japicmp</artifactId>
	<version>0.9.3</version>
</dependency>

A maven plugin allows you to integrate the checks into your build:

<plugin>
	<groupId>com.github.siom79.japicmp</groupId>
	<artifactId>japicmp-maven-plugin</artifactId>
	<version>0.9.3</version>
	<configuration>
		<oldVersion>
			<dependency>
				<groupId>japicmp</groupId>
				<artifactId>japicmp-test-v1</artifactId>
				<version>${oldversion}</version>
				<type>jar</type>
			</dependency>
		</oldVersion>
		<newVersion>
			<file>
				<path>${project.build.directory}/${project.artifactId}-${project.version}.${project.packaging}</path>
			</file>
		</newVersion>
		<parameter>
			<!-- see documentation -->
		</parameter>
	</configuration>
	<executions>
		<execution>
			<phase>verify</phase>
			<goals>
				<goal>cmp</goal>
			</goals>
		</execution>
	</executions>
</plugin>

##Motivation##

Every time you release a new version of a library or a product, you have to tell your clients or customers what has changed in comparison to the last release. Without the appropriate tooling, this task is tedious and error-prone. This tool/library helps you to determine the differences between the java class files that are contained in two given jar archives.

This library does not use the Java Reflection API to compute the differences, as the usage of the Reflection API makes it necessary to include all classes the jar archive under investigation depends on are available on the classpath. To prevent the inclusion of all dependencies, which can be a lot of work for bigger applications, this library makes use of the javassist library to inspect the class files. This way you only have to provide the two jar archives on the command line (and eventually libraries that contain classes/interfaces you have extended/implemented).

This approach also detects changes in instrumented and generated classes. You can even evaluate changes in class file attributes (like synthetic) or annotations. The comparison of annotations makes this approach suitable for annotation-based APIs like JAXB, JPA, JAX-RS, etc.

The goal of this project is to provide a fast and easy to use API comparison for Java. Therefore it does not aim to integrate change tracking of other types of artifacts (configuration files, etc.) as a generic implementation means to make compromises in terms of performance and ease of usage. japicmp for example compares two archives with about 1700 classes each in less than one second and therewith can be easily integrated in each build.

##Features##

• Comparison of two jar archives without the need to add all of their dependencies to the classpath.
• Differences are printed on the command line in a simple diff format.
• Differences can optionally be printed as XML or HTML file.
• Per default private and package protected classes and class members are not compared. If necessary, the access modifier of the classes and class members to be compared can be set to public, protected, package or private.
• Per default all classes are tracked. If necessary, certain packages, classes, methods or fields can be excluded or explicitly included. Inclusion and exclusion is also possible based on annotations.
• All changes between all classes/methods/fields are compared. japicmp differentiates between source and binary compatible changes (as described in the Java Language Specification and this Oracle blog).
• All changes between annotations are compared, hence japicmp can be used to track annotation-based APIs like JAXB, JPA, JAX-RS, etc.
• A maven plugin is available that allows you to compare the current artifact version with some older version from the repository.
• The option --semantic-versioning tells you which part of the version you have to increment in order to follow semantic versioning.
• If a class is serializable, changes are evaluated regarding the Java Object Serialization Specification.
• Per default synthetic classes and class members (e.g. bridge methods) are hidden. They can be listed by using the option --include-synthetic.
• The maven plugin allows project-specific filtering and reports using a custom Groovy script.

melix has developed a gradle plugin for japicmp.

##Downloads##

You can download the latest version from the release page or directly from the maven central repository.

#Development#

• 

##Reports##

Use the maven site plugin (mvn site) to generate the following reports:

• findbugs
• checkstyle
• japicmp
• cobertura test coverage

##Release##

This is the release procedure:

• Update ReleaseNotes.md.
• Increment version in README.md.
• Run release build (substitute passphrase with your GPG password):

mvn release:clean release:prepare -DautoVersionSubmodules=true -Dgpg.passphrase=passphrase
mvn release:perform -Dgpg.passphrase=passphrase

• Login to Sonatype's Nexus repository
  • Download released artifact from staging repository.
  • Close and release staging repository if sanity checks are successful.
• Update maven site report.

The second and third step can also be automated using the python script release.py in the root directory:

python3 release.py --gpg-passphrase <gpgpassphrase> --dry-run --new-version <new-version> --release-version <release-version> --release-tag <release-tag> --old-version <old-version>

##Contributions##

Pull requests are welcome, but please follow these rules:

• The basic editor settings (indentation, newline, etc.) are described in the .editorconfig file (see EditorConfig).
• Provide a unit test for every change.
• Name classes/methods/fields expressively.
• Fork the repo and create a pull request (see GitHub Flow).

##Website##

The website can be generated by using the maven-site-plugin:

mvn site:site
mvn site:stage
cp -r target/staging $SIOM79_GITHUB_IO_REPO