diff options
author | Sven Gothel <[email protected]> | 2014-05-13 09:16:32 +0200 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2014-05-13 09:16:32 +0200 |
commit | c06288d2a12586ab8df3715cf130549fdd7499fb (patch) | |
tree | 933aa7179c39202f2262d88bd5452184a76fefbd | |
parent | f39100b35d0833764f2220e487ea7ea05ed87352 (diff) |
Unit Test: Added Semantic Version Test (Current version agains v2.1.5)
TestVersionSemantics adds testing of semantic versioning
of 2.1.5 gluegen-rt.jar against the current version within a unit test.
Currently we expect BACKWARD_COMPATIBLE_USER
and need to toggle this to NON_BACKWARD_COMPATIBLE,
if actually perfoming non compatible major or minor version changes.
The latter is allowed right now, since we increment from 2.1 -> 2.2!
- Added https://github.com/jeluard/semantic-versioning semver.jar (Apache License Version 2.0)
-rw-r--r-- | .classpath | 1 | ||||
-rw-r--r-- | make/build-test.xml | 6 | ||||
-rwxr-xr-x | make/gluegen-properties.xml | 1 | ||||
-rw-r--r-- | make/lib/semantic-versioning/LICENSE | 202 | ||||
-rw-r--r-- | make/lib/semantic-versioning/README.md | 319 | ||||
-rw-r--r-- | make/lib/semantic-versioning/VERSION | 10 | ||||
-rw-r--r-- | make/lib/semantic-versioning/semver-src.zip | bin | 0 -> 40354 bytes | |||
-rw-r--r-- | make/lib/semantic-versioning/semver.jar | bin | 0 -> 294397 bytes | |||
-rw-r--r-- | make/lib/v2.1.5/gluegen-rt.jar | bin | 0 -> 289171 bytes | |||
-rwxr-xr-x | make/scripts/runtest.sh | 8 | ||||
-rw-r--r-- | src/junit/com/jogamp/common/util/TestVersionSemantics.java | 149 |
11 files changed, 690 insertions, 6 deletions
@@ -26,5 +26,6 @@ <classpathentry kind="lib" path="make/lib/antlr.jar"/> <classpathentry kind="lib" path="make/lib/android-sdk/15/android.jar" sourcepath="make/lib/android-sdk/15/android-java-src.zip"/> <classpathentry kind="lib" path="make/lib/junit.jar" sourcepath="make/lib/junit-sources.jar"/> + <classpathentry kind="lib" path="make/lib/semantic-versioning/semver.jar" sourcepath="make/lib/semantic-versioning/semver-src.zip"/> <classpathentry kind="output" path="build/eclipse-classes"/> </classpath> diff --git a/make/build-test.xml b/make/build-test.xml index 2bf2e37..a4ebdb3 100644 --- a/make/build-test.xml +++ b/make/build-test.xml @@ -75,18 +75,20 @@ <path id="junit.compile.classpath"> <pathelement location="${junit.jar}" /> + <pathelement location="${semver.jar}" /> <pathelement location="${gluegen.jar}" /> </path> <path id="junit.run.classpath"> <pathelement location="${junit.jar}" /> + <pathelement location="${semver.jar}" /> <pathelement location="${TestJarsInJar.jar}" /> <pathelement location="${gluegen-rt.jar}" /> <pathelement location="${gluegen.jar}" /> <pathelement location="${gluegen-test.jar}" /> </path> - <property name="junit.run.jars" value="${junit.jar}${path.separator}${ant.jar}${path.separator}${TestJarsInJar.jar}${path.separator}${gluegen.root}/${rootrel.build}/gluegen-rt.jar${path.separator}${gluegen.root}/${rootrel.build}/gluegen.jar${path.separator}${build_t}/gluegen-test.jar"/> - <property name="junit.run.remote.jars" value="${junit.jar}${path.separator}${env.TARGET_ANT_HOME}/lib/ant.jar${path.separator}${env.TARGET_ANT_HOME}/lib/ant-junit.jar${path.separator}${env.TARGET_ANT_HOME}/lib/ant-junit4.jar${path.separator}${gluegen.root}/make/lib/TestJarsInJar.jar${path.separator}${gluegen.root}/${rootrel.build}/gluegen-rt.jar${path.separator}${gluegen.root}/${rootrel.build}/gluegen.jar${path.separator}${build_t}/gluegen-test.jar"/> + <property name="junit.run.jars" value="${junit.jar}${path.separator}${ant.jar}${path.separator}${semver.jar}${path.separator}${TestJarsInJar.jar}${path.separator}${gluegen.root}/${rootrel.build}/gluegen-rt.jar${path.separator}${gluegen.root}/${rootrel.build}/gluegen.jar${path.separator}${build_t}/gluegen-test.jar"/> + <property name="junit.run.remote.jars" value="${junit.jar}${path.separator}${env.TARGET_ANT_HOME}/lib/ant.jar${path.separator}${env.TARGET_ANT_HOME}/lib/ant-junit.jar${path.separator}${env.TARGET_ANT_HOME}/lib/ant-junit4.jar${path.separator}${env.TARGET_ANT_HOME}/lib/semantic-versioning/semver.jar${path.separator}${gluegen.root}/make/lib/TestJarsInJar.jar${path.separator}${gluegen.root}/${rootrel.build}/gluegen-rt.jar${path.separator}${gluegen.root}/${rootrel.build}/gluegen.jar${path.separator}${build_t}/gluegen-test.jar"/> <property name="junit.run.remote.apks" value="${gluegen.root}/${rootrel.build}/jogamp-android-launcher.apk${path.separator}${ant-junit-all.apk}${path.separator}${gluegen.root}/${rootrel.build}/gluegen-rt-android-${android.abi}.apk${path.separator}${build_t}/gluegen-test.apk${path.separator}${gluegen.root}/make/lib/TestJarsInJar.apk"/> <property name="stub.includes.dir" value="stub_includes" /> <!-- NOTE: this MUST be relative for FileSet --> diff --git a/make/gluegen-properties.xml b/make/gluegen-properties.xml index b9411cc..7e51e0a 100755 --- a/make/gluegen-properties.xml +++ b/make/gluegen-properties.xml @@ -54,6 +54,7 @@ <property name="ant.jar" value="${ant.home}/lib/ant.jar" /> <property name="ant-junit.jar" value="${ant.home}/lib/ant-junit.jar" /> <property name="ant-junit4.jar" value="${ant.home}/lib/ant-junit4.jar" /> + <property name="semver.jar" value="${gluegen.root}/make/lib/semantic-versioning/semver.jar" /> <property name="android.version" value="9" /> <!-- default - if not set by jogamp-env.xml:jogamp.env.init --> <property name="android-min.jar" value="${gluegen.root}/make/lib/android-sdk/${android.version}/android.jar" /> diff --git a/make/lib/semantic-versioning/LICENSE b/make/lib/semantic-versioning/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/make/lib/semantic-versioning/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/make/lib/semantic-versioning/README.md b/make/lib/semantic-versioning/README.md new file mode 100644 index 0000000..c786653 --- /dev/null +++ b/make/lib/semantic-versioning/README.md @@ -0,0 +1,319 @@ +![CI status](https://secure.travis-ci.org/jeluard/semantic-versioning.png) + +Version number changes implications are not always clearly identified. Can I be sure this new minor version didn't break the public API? +As a library writer, how to continuously validate I don't break binary compatibility? + +`semantic-versioning` is a Java library allowing to validate (using bytecode inspection) if library version numbers follows Semantic Versioning principles as defined by [Semantic Versioning](http://semver.org). +It can check JAR files or classes to identify changes between versions and validate if the new version number is correct according to semver. + +`semantic-versioning` is available as an [API](#api), a [command line tool](#cli) and a [maven enforcer](http://maven.apache.org/enforcer/maven-enforcer-plugin/) [rule](#rule). + +<a name="api"></a> +## API overview + +Semantic Versioning also provides an API for programmatically validating your project's version number. + +```java +final File previousJar = ...; +final File currentJar = ...; + +final Comparer comparer = new Comparer(previousJar, currentJar, ..., ...); +final Delta delta = comparer.diff(); + +final String compatibilityType = ...; + +//Validates that computed and provided compatibility type are compatible. +final Delta.CompatibilityType expectedCompatibilityType = Delta.CompatibilityType.valueOf(compatibilityType); +final Delta.CompatibilityType detectedCompatibilityType = delta.computeCompatibilityType(); +if (detectedCompatibilityType.compareTo(expectedCompatibilityType) > 0) { + //Not compatible. +} + +//Provide version number for previous and current Jar files. +final Version previous = Version.parse(...); +final Version current = Version.parse(...); + +//Validates that current version number is valid based on semantic versioning principles. +final boolean compatible = delta.validate(previous, current); +``` + +<a name="cli"></a> +## CLI + +This simple command line tool looks at Java JAR files and determine API changes. + +### Built-in help + +``` +% java -jar semver.jar --help +Semantic Version validator. + +Usage: semver [options] + +Options: + --base-jar JAR The base jar. + --base-version VERSION Version of the base jar (given with --base-jar). + --check,-c Check the compatibility of two jars. + --diff,-d Show the differences between two jars. + --excludes EXCLUDE;... Semicolon separated list of full qualified class names + or partly qualified class names with wild cards + to be excluded. + --help,-h Show this help and exit. + --includes INCLUDE;... Semicolon separated list of full qualified class names + or partly qualified class names with wild cards + to be included. + --infer,-i Infer the version of the new jar based on the previous + jar. + --new-jar JAR The new jar. + --new-version VERSION Version of the new jar (given with --new-jar). + --validate,-v Validate that the versions of two jars fulfil the + semver specification. +``` + +### Diff + +Dump all changes between two JARs on standard output. + +``` +% java -jar semver.jar --diff --base-jar previousJar --new-jar current.jar +Class org.project.MyClass + Added Class +Class org.project.MyClass2 + Added Method method1 + Removed Field field1 + Changed Field field2 removed: final +``` + +### Excludes / Includes + +In- or exclude classes for the validation by specifying a fully qualified +class name or using wild cards. There are two wild cards: `*` and `**`. +`*` is a wild card for an arbitrary number of characters but at most one +folder hierarchy. +`**` is a wild card for an arbitrary number of characters and an arbitrary +number of folder hierarchies. + +``` +% java -jar semver.jar --excludes **/MyClass; org/**/MyClass; org/**/*Class; +``` + +### Check + +Check compatibility type between two JARs. + +``` +% java -jar semver.jar --check --base-jar previousJar --new-jar current.jar +BACKWARD_COMPATIBLE_IMPLEMENTER +``` + +### Infer + +Infer JAR version based on a previously versioned JAR. + +``` +% java -jar semver.jar --infer --base-version 1.0.0 --base-jar previous.jar --new-jar current.jar +1.0.1 +``` + +### Validate + +Validate JAR version based on a previously versioned JAR. + +``` +% java -jar semver.jar --validate --base-version 1.0.0 --base-jar previous.jar --new-version 1.0.1 --new-jar current.jar +true +``` + +<a name="rule"></a> +## Maven Enforcer Rule + +The enforcer rule offers a rule for checking project's version against a previously released artifact. + +### Checking a project's compatibility + +In order to check your project's compatibility, you must add the enforcer rule as a dependency to +the maven-enforcer-plugin and then configure the maven-enforcer-plugin to run the rule: + +```xml +<project> + ... + <build> + ... + <plugins> + ... + <plugin> + <artifactId>maven-enforcer-plugin</artifactId> + <version>1.0.1</version> + ... + <dependencies> + ... + <dependency> + <groupId>org.semver</groupId> + <artifactId>enforcer-rule</artifactId> + <version>0.9.23</version> + </dependency> + ... + </dependencies> + ... + <executions> + .... + <execution> + <id>check</id> + <phase>verify</phase> + <goals> + <goal>enforce</goal> + </goals> + <configuration> + <rules> + <requireBackwardCompatibility implementation="org.semver.enforcer.RequireBackwardCompatibility"> + <compatibilityType>BACKWARD_COMPATIBLE_IMPLEMENTER</compatibilityType> + </requireBackwardCompatibility> + </rules> + </configuration> + </execution> + ... + </executions> + ... + </plugin> + ... + </plugins> + ... + </build> + ... +</project> +``` + +Once you have configured your project, maven-enforcer will be able to throw a build error if current version is not backward compatible with last released one. + +You can force strict checking (i.e. compatibility type must exactly match specified one): + +```xml +<configuration> + <rules> + <requireBackwardCompatibility implementation="org.semver.enforcer.RequireBackwardCompatibility"> + ... + <strictChecking>true</strictChecking> + ... + </requireBackwardCompatibility> + </rules> +</configuration> +``` + +### Checking a project's version + +In order to check your project's version, you must add the enforcer rule as a dependency to +the maven-enforcer-plugin and then configure the maven-enforcer-plugin to run the rule: + +```xml +<project> + ... + <build> + ... + <plugins> + ... + <plugin> + <artifactId>maven-enforcer-plugin</artifactId> + <version>1.0.1</version> + ... + <dependencies> + ... + <dependency> + <groupId>org.semver</groupId> + <artifactId>enforcer-rule</artifactId> + <version>0.9.23</version> + </dependency> + ... + </dependencies> + ... + <executions> + .... + <execution> + <id>check</id> + <phase>verify</phase> + <goals> + <goal>enforce</goal> + </goals> + <configuration> + <rules> + <requireSemanticVersioningConformance implementation="org.semver.enforcer.RequireSemanticVersioningConformance" /> + </rules> + </configuration> + </execution> + ... + </executions> + ... + </plugin> + ... + </plugins> + ... + </build> + ... +</project> +``` + +Once you have configured your project, maven-enforcer will be able to throw a build error if current version follows semantic versioning principles. + +## Dumping details + +Dump details of detected changes: + +```xml +<configuration> + <rules> + <require...> + ... + <dumpDetails>true</dumpDetails> + ... + </require...> + </rules> +</configuration> +``` + +### Checking against a well known version + +You can force check with a well known version: + +```xml +<configuration> + <rules> + <require...> + ... + <previousVersion>1.0.0</previousVersion> + ... + </require...> + </rules> +</configuration> +``` + +### Filtering + +Both rules allow to filter classes/packages: + +```xml +<require...> + ... + <includes> + <include>org.project.MyClass</include> + <include>org.project.internal</include> + </includes> + <excludes> + <exclude>org.project.MyClass</exclude> + <exclude>org.project.internal</exclude> + </excludes> + ... +</require...> +``` + +## Maven dependency + +```xml +<dependency> + <groupId>org.semver</groupId> + <artifactId>enforcer-rule</artifactId> + <version>0.9.23</version> +</dependency> +``` + +## License + +Released under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0.html). diff --git a/make/lib/semantic-versioning/VERSION b/make/lib/semantic-versioning/VERSION new file mode 100644 index 0000000..09a5894 --- /dev/null +++ b/make/lib/semantic-versioning/VERSION @@ -0,0 +1,10 @@ +https://github.com/jeluard/semantic-versioning + +0.9.24-SNAPSHOT + +commit dd1e89102b15eb10d8c94e9efe3a4203e5484121 +Author: Julien Eluard <[email protected]> +Date: Fri Apr 18 08:44:34 2014 -0300 + +branch master + diff --git a/make/lib/semantic-versioning/semver-src.zip b/make/lib/semantic-versioning/semver-src.zip Binary files differnew file mode 100644 index 0000000..df78442 --- /dev/null +++ b/make/lib/semantic-versioning/semver-src.zip diff --git a/make/lib/semantic-versioning/semver.jar b/make/lib/semantic-versioning/semver.jar Binary files differnew file mode 100644 index 0000000..3c9303f --- /dev/null +++ b/make/lib/semantic-versioning/semver.jar diff --git a/make/lib/v2.1.5/gluegen-rt.jar b/make/lib/v2.1.5/gluegen-rt.jar Binary files differnew file mode 100644 index 0000000..c20455e --- /dev/null +++ b/make/lib/v2.1.5/gluegen-rt.jar diff --git a/make/scripts/runtest.sh b/make/scripts/runtest.sh index f518668..c6bc1b7 100755 --- a/make/scripts/runtest.sh +++ b/make/scripts/runtest.sh @@ -57,8 +57,8 @@ rm -f $LOG #D_ARGS="-Djogamp.debug=all" function onetest() { - USE_CLASSPATH=lib/junit.jar:$ANT_JARS:"$builddir"/../make/lib/TestJarsInJar.jar:"$builddir"/gluegen-rt.jar:"$builddir"/gluegen.jar:"$builddir"/test/build/gluegen-test.jar - #USE_CLASSPATH=lib/junit.jar:$ANT_JARS:"$builddir"/../make/lib/TestJarsInJar.jar:"$builddir"/gluegen-rt-alt.jar:"$builddir"/gluegen.jar:"$builddir"/test/build/gluegen-test.jar + USE_CLASSPATH=lib/junit.jar:$ANT_JARS:lib/semantic-versioning/semver.jar:"$builddir"/../make/lib/TestJarsInJar.jar:"$builddir"/gluegen-rt.jar:"$builddir"/gluegen.jar:"$builddir"/test/build/gluegen-test.jar + #USE_CLASSPATH=lib/junit.jar:$ANT_JARS:lib/semantic-versioning/semver.jar:"$builddir"/../make/lib/TestJarsInJar.jar:"$builddir"/gluegen-rt-alt.jar:"$builddir"/gluegen.jar:"$builddir"/test/build/gluegen-test.jar libspath="$builddir"/test/build/natives #USE_CLASSPATH=lib/junit.jar:$ANT_JARS:"$builddir"/../make/lib/TestJarsInJar.jar:"$builddir"/classes:"$builddir"/test/build/classes #libspath="$builddir"/obj:"$builddir"/test/build/natives: @@ -80,6 +80,7 @@ function onetest() { #onetest com.jogamp.common.util.TestSystemPropsAndEnvs 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestVersionInfo 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestVersionNumber 2>&1 | tee -a $LOG +onetest com.jogamp.common.util.TestVersionSemantics 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestIteratorIndexCORE 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.locks.TestRecursiveLock01 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.locks.TestRecursiveThreadGroupLock01 2>&1 | tee -a $LOG @@ -96,7 +97,6 @@ function onetest() { #onetest com.jogamp.common.util.TestRunnableTask01 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestIOUtil01 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestIOUtilURICompose 2>&1 | tee -a $LOG -#onetest com.jogamp.common.GlueGenVersion 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestIOUtilURIHandling 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestTempJarCache 2>&1 | tee -a $LOG #onetest com.jogamp.common.util.TestJarUtil 2>&1 | tee -a $LOG @@ -122,5 +122,5 @@ function onetest() { #onetest com.jogamp.gluegen.test.junit.generation.Test1p2ProcAddressEmitter 2>&1 | tee -a $LOG #onetest com.jogamp.gluegen.test.junit.generation.Test1p2LoadJNIAndImplLib 2>&1 | tee -a $LOG #onetest com.jogamp.gluegen.test.junit.structgen.TestStructGen01 2>&1 | tee -a $LOG -onetest com.jogamp.gluegen.test.junit.structgen.TestStructGen02 2>&1 | tee -a $LOG +#onetest com.jogamp.gluegen.test.junit.structgen.TestStructGen02 2>&1 | tee -a $LOG diff --git a/src/junit/com/jogamp/common/util/TestVersionSemantics.java b/src/junit/com/jogamp/common/util/TestVersionSemantics.java new file mode 100644 index 0000000..a4f33b2 --- /dev/null +++ b/src/junit/com/jogamp/common/util/TestVersionSemantics.java @@ -0,0 +1,149 @@ +/** + * Copyright 2014 JogAmp Community. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, are + * permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this list of + * conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, this list + * of conditions and the following disclaimer in the documentation and/or other materials + * provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * The views and conclusions contained in the software and documentation are those of the + * authors and should not be interpreted as representing official policies, either expressed + * or implied, of JogAmp Community. + */ +package com.jogamp.common.util; + +import java.io.File; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.HashSet; +import java.util.Iterator; +import java.util.Set; + +import org.junit.Assert; +import org.junit.FixMethodOrder; +import org.junit.Test; +import org.junit.runners.MethodSorters; +import org.osjava.jardiff.DiffCriteria; +import org.osjava.jardiff.SimpleDiffCriteria; +import org.semver.Comparer; +import org.semver.Delta; +import org.semver.Dumper; +import org.semver.Delta.Difference; + +import com.jogamp.common.GlueGenVersion; +import com.jogamp.common.util.IOUtil; +import com.jogamp.common.util.JarUtil; +import com.jogamp.common.util.VersionNumberString; + +/** + * Compares a defined previous version with the current version. + * <p> + * {@link SimpleDiffCriteria} is chosen as it's {@link DiffCriteria}, + * i.e. considering: + * <ul> + * <li>not synthetic classes, methods and fields which are either + * <ul> + * <li>public</li> + * <li>protected</li> + * </ul></li> + * </ul> + * </p> + * + * @throws IllegalArgumentException + * @throws IOException + * @throws URISyntaxException + */ +@FixMethodOrder(MethodSorters.NAME_ASCENDING) +public class TestVersionSemantics { + public static final String jarFile = "gluegen-rt.jar"; + public static final VersionNumberString preVersion = new VersionNumberString("2.1.5"); + public static final Delta.CompatibilityType expectedCompatibilityType = Delta.CompatibilityType.BACKWARD_COMPATIBLE_USER; + + @Test + public void testVersion01() throws IllegalArgumentException, IOException, URISyntaxException { + + final GlueGenVersion glueGenVersion = GlueGenVersion.getInstance(); + final VersionNumberString curVersion = new VersionNumberString(glueGenVersion.getImplementationVersion()); + + final File previousJar = new File("lib/v"+preVersion.getVersionString()+"/"+jarFile); + + final ClassLoader rootCL = TestVersionSemantics.class.getClassLoader(); + + // Get containing JAR file "TestJarsInJar.jar" and add it to the TempJarCache + final URI currentJarURI = JarUtil.getJarSubURI(GlueGenVersion.class.getName(), rootCL); + final String currentJarLocS = IOUtil.decodeURIIfFilePath(currentJarURI); + final File currentJar = new File(currentJarLocS); + + final DiffCriteria diffCriteria = new SimpleDiffCriteria(); + + final Set<String> includes = new HashSet<String>(); + + final Set<String> excludes = new HashSet<String>(); + excludes.add("jogamp/**"); + + final Comparer comparer = new Comparer(diffCriteria, previousJar, currentJar, includes, excludes); + final Delta delta = comparer.diff(); + + //Validates that computed and provided compatibility type are compatible. + final Delta.CompatibilityType detectedCompatibilityType = delta.computeCompatibilityType(); + final int comp = detectedCompatibilityType.compareTo(expectedCompatibilityType); + final boolean compOK = 0 >= comp; + final String compS; + if( 0 > comp ) { + compS = "< "; + } else if ( 0 == comp ) { + compS = "=="; + } else { + compS = "> "; + } + + System.err.println("GlueGen Semantic Versioning Test"); + System.err.println("Previous version: "+preVersion+" - "+previousJar.toString()); + System.err.println("Current version: "+curVersion+" - "+currentJar.toString()); + System.err.println("Compat. expected: "+expectedCompatibilityType); + System.err.println("Compat. pre -> cur: "+detectedCompatibilityType); + System.err.println("Compat. result: detected "+compS+" expected -> "+(compOK ? "OK" : "ERROR")); + + final Set<Difference> diffs = delta.getDifferences(); + System.err.println(diffs.size()+" differences!"); + int diffI = 0; + for(final Iterator<Difference> iter = diffs.iterator(); iter.hasNext(); diffI++) { + final Difference diff = iter.next(); + System.err.printf("Diff %4d: %-11s in class %s%n", diffI, diff.getClass().getSimpleName(), diff.getClassName()); + } + Dumper.dump(delta); + + Assert.assertTrue("Current version "+curVersion+" is "+compS+" of previous version "+preVersion, compOK); + + /*** + //Provide version number for previous and current Jar files. + final Version previous = Version.parse(...); + final Version current = Version.parse(...); + + //Validates that current version number is valid based on semantic versioning principles. + final boolean compatible = delta.validate(previous, current); + */ + } + + public static void main(String args[]) throws IOException { + String tstname = TestVersionSemantics.class.getName(); + org.junit.runner.JUnitCore.main(tstname); + } + +} |