chore(maven): Change pom.xml to add revapi #1115

surli · 2017-01-13T08:40:20Z

Use revapi to compare Spoon API against the last published snapshot. Fix #1023.
Thanks a lot @metlos for the support and quick changes on revapi.
Launched today and obtain the following result:

[INFO] Comparing [fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170112.234557-2] against [fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT] (including their transitive dependencies).
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 18.682 s
[INFO] Finished at: 2017-01-13T09:22:53+01:00
[INFO] Final Memory: 117M/857M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.revapi:revapi-maven-plugin:0.8.1:check (revapi-check) on project spoon-core: The following API problems caused the build to fail:
[ERROR] java.method.addedToInterface: method spoon.reflect.factory.QueryFactory spoon.reflect.factory.Factory::Query(): Method was added to an interface. (breaks semantic versioning)
[ERROR] java.method.addedToInterface: method spoon.reflect.visitor.chain.CtQuery spoon.reflect.factory.Factory::createQuery(): Method was added to an interface. (breaks semantic versioning)
[ERROR] java.method.addedToInterface: method spoon.reflect.visitor.chain.CtQuery spoon.reflect.factory.Factory::createQuery(java.lang.Object): Method was added to an interface. (breaks semantic versioning)
[ERROR] java.field.serialVersionUIDUnchanged: field spoon.reflect.factory.FactoryImpl.serialVersionUID: The class changed in an incompatible way with regards to serialization but the serialVersionUID field stayed unchanged. This might be ok and/or desired but is suspicious. (breaks semantic versioning)
[ERROR] java.method.added: method spoon.reflect.factory.QueryFactory spoon.reflect.factory.FactoryImpl::Query(): Method was added. (breaks semantic versioning)
[ERROR] java.method.added: method spoon.reflect.visitor.chain.CtQuery spoon.reflect.factory.FactoryImpl::createQuery(): Method was added. (breaks semantic versioning)
[ERROR] java.method.added: method spoon.reflect.visitor.chain.CtQuery spoon.reflect.factory.FactoryImpl::createQuery(java.lang.Object): Method was added. (breaks semantic versioning)
[ERROR] java.class.added: class spoon.reflect.factory.QueryFactory: Class was added. (breaks semantic versioning)
[ERROR] java.class.nonPublicPartOfAPI: class spoon.support.compiler.jdt.JDTTreeBuilderHelper: Class 'spoon.support.compiler.jdt.JDTTreeBuilderHelper' is indirectly included in the API (by the means of method return type for example) but the class is not accessible (neither public nor protected).
[ERROR] Use chain of the type in the old API: spoon.support.compiler.jdt.JDTTreeBuilderHelper is returned from method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() (method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() is part of the API)
[ERROR] Use chain of the type in the new API: spoon.support.compiler.jdt.JDTTreeBuilderHelper is returned from method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() (method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() is part of the API)

It currently breaks a mvn install and so, it should break a Travis build if a change in the API is not documented.
We can still ignore some changes in the API editing revapi.json file. Maybe it should be good to document our process concerning changes in the API and the usage of revapi (add justification to breaks inside the revapi.json).

…xml to support comparison with last snapshot.

surli · 2017-01-13T08:52:37Z

Note that it's also possible to automatically change the version number of the future release to respect the semantic versioning:

[ERROR] If you're using the semver-ignore extension, update your module's version to one compatible with the current changes (e.g. mvn package revapi:update-versions).

monperrus · 2017-01-13T09:06:43Z

Cool. I propose to extensively comment revapi.json, so that we easily understand what it means.

…ment.

…script

monperrus · 2017-01-21T06:51:30Z

@surli,
added in pull_request-INRIA-spoon-master-revapi

if [[ -f chore/revapy.py ]];
then python chore/revapy.py $GH_USER $GH_TOKEN $1
fi

in order not to have PR failures while this one is not merged.

…stead of a JSON string.

surli · 2017-01-25T16:18:14Z

Analysis results

Old API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170124.234602-14

New API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT

old:

new: interface spoon.compiler.SpoonCompiler

java.class.added: Class was added. (breaks semantic versioning)

SOURCE: NON_BREAKING, OTHER: BREAKING, BINARY: NON_BREAKING

old: class spoon.support.compiler.jdt.JDTTreeBuilderHelper

new: class spoon.support.compiler.jdt.JDTTreeBuilderHelper

java.class.nonPublicPartOfAPI: Class 'spoon.support.compiler.jdt.JDTTreeBuilderHelper' is indirectly included in the API (by the means of method return type for example) but the class is not accessible (neither public nor protected).

Use chain of the type in the old API: spoon.support.compiler.jdt.JDTTreeBuilderHelper is returned from method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() (method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() is part of the API)

Use chain of the type in the new API: spoon.support.compiler.jdt.JDTTreeBuilderHelper is returned from method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() (method spoon.support.compiler.jdt.JDTTreeBuilderHelper spoon.support.compiler.jdt.JDTTreeBuilder::getHelper() is part of the API) (breaks semantic versioning)

SOURCE: NON_BREAKING, OTHER: BREAKING, SEMANTIC: BREAKING, BINARY: NON_BREAKING

old: field spoon.support.DefaultCoreFactory.serialVersionUID

new: field spoon.support.DefaultCoreFactory.serialVersionUID

java.field.serialVersionUIDUnchanged: The class changed in an incompatible way with regards to serialization but the serialVersionUID field stayed unchanged. This might be ok and/or desired but is suspicious. (breaks semantic versioning)

SOURCE: EQUIVALENT, OTHER: BREAKING, SEMANTIC: POTENTIALLY_BREAKING, BINARY: EQUIVALENT

old:

new: method boolean spoon.support.compiler.jdt.JDTBasedSpoonCompiler::compileInputSources()

java.method.added: Method was added. (breaks semantic versioning)

SOURCE: NON_BREAKING, OTHER: BREAKING, BINARY: NON_BREAKING

old:

new: method spoon.reflect.cu.SourcePosition spoon.reflect.factory.CoreFactory::createSourcePosition(spoon.reflect.cu.CompilationUnit, int, int, int, int[])

java.method.addedToInterface: Method was added to an interface. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, SEMANTIC: POTENTIALLY_BREAKING, BINARY: NON_BREAKING

old: method R spoon.reflect.visitor.chain.CtQuery::first()

new:

java.method.removed: Method was removed. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, BINARY: BREAKING

old: method R spoon.reflect.visitor.chain.CtQuery::first(java.lang.Class)

new:

java.method.removed: Method was removed. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, BINARY: BREAKING

old:

new: method java.lang.ClassLoader spoon.compiler.Environment::getClassLoader()

java.method.addedToInterface: Method was added to an interface. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, SEMANTIC: POTENTIALLY_BREAKING, BINARY: NON_BREAKING

old:

new: method java.util.List spoon.reflect.declaration.CtElement::getReferences(spoon.reflect.visitor.Filter)

java.method.addedToInterface: Method was added to an interface. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, SEMANTIC: POTENTIALLY_BREAKING, BINARY: NON_BREAKING

old:

new: method boolean spoon.reflect.declaration.CtTypeInformation::isAssignableFrom(spoon.reflect.reference.CtTypeReference<?>)

java.method.addedToInterface: Method was added to an interface. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, SEMANTIC: POTENTIALLY_BREAKING, BINARY: NON_BREAKING

old: method boolean spoon.reflect.visitor.EarlyTerminatingScanner::isTerminated()

new:

java.method.removed: Method was removed. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, BINARY: BREAKING

old: method spoon.reflect.visitor.chain.CtQuery spoon.reflect.visitor.chain.CtQuery::select(spoon.reflect.visitor.Filter)

new:

java.method.removed: Method was removed. (breaks semantic versioning)

SOURCE: BREAKING, OTHER: BREAKING, BINARY: BREAKING

surli · 2017-01-25T16:46:19Z

@monperrus for now the Gakoci hook only use the branch of the PR creator which is quite inconveniant as old API can be considered. Just have a look at the beginning of the last comment and you'll see...
In order to change that I proposed a PR in gakoci: monperrus/gakoci#1 to be able to generate the report considering the merged commit of the PR easily (just using the PR number actually).

spoon-bot · 2017-01-31T15:15:13Z

Revapi Analysis results

Old API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170130.234600-20

New API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT

Detected changes: 15.

Change 1

Name	Element
Old	class spoon.reflect.visitor.filter.CatchVariableReferenceFunction
New	none
Code	java.class.removed
Description	Class was removed.
Breaking	binary: breaking, source: breaking

Change 2

Name	Element
Old	class spoon.reflect.visitor.filter.CatchVariableScopeFunction
New	none
Code	java.class.removed
Description	Class was removed.
Breaking	binary: breaking, source: breaking

Change 3

Name	Element
Old	class spoon.reflect.visitor.filter.LocalVariableReferenceFunction
New	none
Code	java.class.removed
Description	Class was removed.
Breaking	binary: breaking, source: breaking

Change 4

Name	Element
Old	class spoon.reflect.visitor.filter.LocalVariableScopeFunction
New	none
Code	java.class.removed
Description	Class was removed.
Breaking	binary: breaking, source: breaking

Change 5

Name	Element
Old	class spoon.reflect.visitor.filter.ParameterReferenceFunction
New	none
Code	java.class.removed
Description	Class was removed.
Breaking	binary: breaking, source: breaking

Change 6

Name	Element
Old	class spoon.reflect.visitor.filter.ParameterScopeFunction
New	none
Code	java.class.removed
Description	Class was removed.
Breaking	binary: breaking, source: breaking

Change 7

Name	Element
Old	class spoon.support.compiler.jdt.JDTTreeBuilderHelper
New	class spoon.support.compiler.jdt.JDTTreeBuilderHelper
Code	java.class.nonPublicPartOfAPI
Description	Class 'spoon.support.compiler.jdt.JDTTreeBuilderHelper' is indirectly included in the API (by the means of method return type for example) but the class is not accessible (neither public nor protected).
Breaking	binary: non_breaking, source: non_breaking, semantic: breaking

Change 8

Name	Element
Old	none
New	method spoon.reflect.cu.SourcePosition spoon.reflect.factory.CoreFactory::createSourcePosition(spoon.reflect.cu.CompilationUnit, int, int, int, int[])
Code	java.method.addedToInterface
Description	Method was added to an interface.
Breaking	binary: non_breaking, source: breaking, semantic: potentially_breaking

Change 9

Name	Element
Old	method R spoon.reflect.visitor.chain.CtQuery::first()
New	none
Code	java.method.removed
Description	Method was removed.
Breaking	binary: breaking, source: breaking

Change 10

Name	Element
Old	method R spoon.reflect.visitor.chain.CtQuery::first(java.lang.Class)
New	none
Code	java.method.removed
Description	Method was removed.
Breaking	binary: breaking, source: breaking

Change 11

Name	Element
Old	none
New	method java.lang.ClassLoader spoon.compiler.Environment::getClassLoader()
Code	java.method.addedToInterface
Description	Method was added to an interface.
Breaking	binary: non_breaking, source: breaking, semantic: potentially_breaking

Change 12

Name	Element
Old	none
New	method java.util.List spoon.reflect.declaration.CtElement::getReferences(spoon.reflect.visitor.Filter)
Code	java.method.addedToInterface
Description	Method was added to an interface.
Breaking	binary: non_breaking, source: breaking, semantic: potentially_breaking

Change 13

Name	Element
Old	none
New	method boolean spoon.reflect.declaration.CtTypeInformation::isAssignableFrom(spoon.reflect.reference.CtTypeReference<?>)
Code	java.method.addedToInterface
Description	Method was added to an interface.
Breaking	binary: non_breaking, source: breaking, semantic: potentially_breaking

Change 14

Name	Element
Old	method boolean spoon.reflect.visitor.EarlyTerminatingScanner::isTerminated()
New	none
Code	java.method.removed
Description	Method was removed.
Breaking	binary: breaking, source: breaking

Change 15

Name	Element
Old	method spoon.reflect.visitor.chain.CtQuery spoon.reflect.visitor.chain.CtQuery::select(spoon.reflect.visitor.Filter)
New	none
Code	java.method.removed
Description	Method was removed.
Breaking	binary: breaking, source: breaking

spoon-bot · 2017-01-31T15:42:51Z

Revapi Analysis results

Old API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170130.234600-20

New API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT

Detected changes: 1.

Change 1

Name	Element
Old	class spoon.support.compiler.jdt.JDTTreeBuilderHelper
New	class spoon.support.compiler.jdt.JDTTreeBuilderHelper
Code	java.class.nonPublicPartOfAPI
Description	Class 'spoon.support.compiler.jdt.JDTTreeBuilderHelper' is indirectly included in the API (by the means of method return type for example) but the class is not accessible (neither public nor protected).
Breaking	source: non_breaking, binary: non_breaking, semantic: breaking

…hould fix INRIA#1156

spoon-bot · 2017-01-31T16:20:32Z

Revapi Analysis results

Old API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170130.234600-20

New API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT

Detected changes: 0.

spoon-bot · 2017-01-31T16:39:01Z

Revapi Analysis results

Old API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170130.234600-20

New API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT

Detected changes: 0.

spoon-bot · 2017-01-31T16:54:14Z

Revapi Analysis results

Old API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-20170130.234600-20

New API: fr.inria.gforge.spoon:spoon-core:jar:5.6.0-SNAPSHOT

Detected changes: 0.

surli added 4 commits January 12, 2017 15:54

Change pom.xml to use RevApi to detect API changes during build.

4bb33bd

Externalize configuration for RevAPI. Add snapshot repository in pom.…

0dbfe79

…xml to support comparison with last snapshot.

Change version of revapi in pom.xml

1305017

Merge remote-tracking branch 'inria/master' into addRevAPI

f43bf70

Add documentation to revapi.json

ec01460

surli changed the title ~~chore(maven): Change pom.xml to add revapi~~ WiP: chore(maven): Change pom.xml to add revapi Jan 18, 2017

surli added 7 commits January 18, 2017 15:52

Change revapi configuration to only create a report file.

211baf3

Add a small python script to publish revapi report directly in PR com…

0a67c14

…ment.

Fix syntax error in python script

dc0cad1

Fix broken travis.yml and add test for travis PR env value in python …

b082152

…script

Try to fix travis.yml file

ebd9115

Still trying to debug travis.yml...

aac01fd

Now use webhook with gakoci. Revert some changes and modify script.

9e04f22

Edit again revapy python script to consider payload as a file path in…

d6d687a

…stead of a JSON string.

surli force-pushed the addRevAPI branch from c1a71d7 to d6d687a Compare January 25, 2017 15:46

surli added 8 commits January 30, 2017 17:01

Change revapi configuration

44a7cc2

Test revapi

1c8dbed

Another test

69a62f3

Change revapi configuration in order to display correctly changes

8b5baae

Change template for revapi report, to use Github Markdown.

cb7f19b

Change again template to be readable on github.

ddd9cb6

Change template and remove new line in Python script.

7af3cc2

Fix error in template with lower case.

99f720c

Test merge PR in hook

aa66dcd

monperrus mentioned this pull request Jan 31, 2017

fix bad smell detected by revapi #1156

Closed

Change visibility of JDTTreeBuilderHelper to be explicitly visible. S…

54b2aab

…hould fix INRIA#1156

monperrus merged commit 8195e3c into INRIA:master Jan 31, 2017

monperrus changed the title ~~WiP: chore(maven): Change pom.xml to add revapi~~ chore(maven): Change pom.xml to add revapi Jan 31, 2017

tdurieux mentioned this pull request Mar 15, 2017

New release coming: Spoon-5.6.0 #1223

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(maven): Change pom.xml to add revapi #1115

chore(maven): Change pom.xml to add revapi #1115

surli commented Jan 13, 2017 •

edited

surli commented Jan 13, 2017

monperrus commented Jan 13, 2017

monperrus commented Jan 21, 2017

surli commented Jan 25, 2017

surli commented Jan 25, 2017

spoon-bot commented Jan 31, 2017

spoon-bot commented Jan 31, 2017

spoon-bot commented Jan 31, 2017

spoon-bot commented Jan 31, 2017

spoon-bot commented Jan 31, 2017

chore(maven): Change pom.xml to add revapi #1115

chore(maven): Change pom.xml to add revapi #1115

Conversation

surli commented Jan 13, 2017 • edited

surli commented Jan 13, 2017

monperrus commented Jan 13, 2017

monperrus commented Jan 21, 2017

surli commented Jan 25, 2017

surli commented Jan 25, 2017

spoon-bot commented Jan 31, 2017

Revapi Analysis results

Change 1

Change 2

Change 3

Change 4

Change 5

Change 6

Change 7

Change 8

Change 9

Change 10

Change 11

Change 12

Change 13

Change 14

Change 15

spoon-bot commented Jan 31, 2017

Revapi Analysis results

Change 1

spoon-bot commented Jan 31, 2017

Revapi Analysis results

spoon-bot commented Jan 31, 2017

Revapi Analysis results

spoon-bot commented Jan 31, 2017

Revapi Analysis results

surli commented Jan 13, 2017 •

edited