API tooling goes amok in Jenkins, need some extra logging

[iloveeclipse]

Something similar to #771 (but not on Java 21), reported for this change (which doesn't break or add or remove any API): eclipse-platform/eclipse.platform.ui#1097.
Full maven log: https://ci.eclipse.org/platform/job/eclipse.platform.ui/job/PR-1097/4/consoleFull

Relevant part says that most of JFace API was removed. !?!?

I can only assume that something completely weird happening in the API application, like not finding any classes or comparing "empty" state with baseline etc.

Since we can't find the root cause, we should at least provide more data while reporting API errors.

This could be:

• exact Java version used,
• some baseline description (path/content or something like that)
• whatever else that could be of interest from API tooling point of view

15:12:24.531 [INFO] --- tycho-p2-extras:4.0.3:compare-version-with-baselines (compare-attached-artifacts-with-release) @ org.eclipse.jface ---
15:12:24.539 [INFO] 
15:12:24.539 [INFO] --- tycho-apitools:4.0.3:verify (verify) @ org.eclipse.jface ---
15:12:24.541 [INFO] Resolve API baseline for org.eclipse.platform:org.eclipse.jface:eclipse-plugin:3.32.0-SNAPSHOT
15:12:25.211 [INFO] Resolve API tools runtime from MavenRepositoryLocation [location=https://download.eclipse.org/eclipse/updates/4.30-I-builds/]...
383 API ERRORS
[API ERROR] File MANIFEST.MF at line 5: The major version should be incremented in version 3.32.0, since API breakage occurred since version 3.31.0 - The type org.eclipse.jface.action.IMenuListener2 in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.dialogs.MessageDialog in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.viewers.AbstractListViewer in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.action.StatusLineManager in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.viewers.TreeSelection in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.bindings.keys.SWTKeyLookup in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.dialogs.IconAndMessageDialog in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.viewers.TableViewerColumn in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.action.LegacyActionTools in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.viewers.TableViewerFocusCellManager in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.bindings.ISchemeListener in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.action.StatusLineLayoutData in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.bindings.BindingManager in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.dialogs.IPageChangedListener in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.preference.IntegerFieldEditor in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.viewers.TreeColumnViewerLabelProvider in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.util.Throttler in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.bindings.Binding in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.dialogs.IMessageProvider in org.eclipse.jface_3.32.0 is no longer an API
- The type org.eclipse.jface.wizard.Wizard in org.eclipse.jface_3.32.0 is no longer an API
362 more change(s)... (location: /home/jenkins/agent/workspace/eclipse.platform.ui_PR-1097/bundles/org.eclipse.jface/META-INF/MANIFEST.MF)

[vik-chand]

Full maven log: https://ci.eclipse.org/platform/job/eclipse.platform.ui/job/PR-1097/4/consoleFull
Unable to open it.

Irrespective of that, extra logging would be helpful especially when this is reported in the log ( instead of workspace - where user can actually see the baseline and Java version)

[laeubi]

API tooling goes amok in Jenkins

I think one way would be to run this as a local build when it happens and then one can enable debug output of maven to see more details of what Tycho has computed...

[laeubi]

Tycho SNAPSHOTS will soon contain an improved ApiToolsMojo:

• Call the API tools directly without using ApiAnalysisApplication eclipse-tycho/tycho#2899

this will allow to set a debug flag to print out more details about the used API baseline including EE and ApiTools version:

<plugin>
	<groupId>org.eclipse.tycho</groupId>
	<artifactId>tycho-apitools-plugin</artifactId>
	<configuration>
		<debug>false</debug>
	</configuration>
</plugin>

[laeubi]

@iloveeclipse I have enabled Tycho 4.0.4-SNAPSHOT now:

• Use Tycho 4.0.4-SNAPSHOT eclipse-platform/eclipse.platform.releng.aggregator#1437

I consider this issue as done with that (as it is not a pure PDE issue actually), so if you still see any issues please let me know.

[stephan-herrmann]

Would the below errors from https://ci.eclipse.org/jdt/job/eclipse.jdt.core-Github/job/PR-1447/5 fit the bill of this issue?

23:37:08  [ERROR] Failed to execute goal org.eclipse.tycho:tycho-apitools-plugin:4.0.4-SNAPSHOT:verify (verify) on project org.eclipse.jdt.core.compiler.batch: There are API errors:
23:37:08  [ERROR] src/org/eclipse/jdt/core/compiler/CategorizedProblem.java:63 The type org.eclipse.jdt.core.compiler.CategorizedProblem has been removed from org.eclipse.jdt.core.compiler.batch_3.36.0
23:37:08  [ERROR] src/org/eclipse/jdt/core/compiler/CharOperation.java:29 The type org.eclipse.jdt.core.compiler.CharOperation has been removed from org.eclipse.jdt.core.compiler.batch_3.36.0
23:37:08  [ERROR] src/org/eclipse/jdt/core/compiler/CompilationProgress.java:29 The type org.eclipse.jdt.core.compiler.CompilationProgress has been removed from org.eclipse.jdt.core.compiler.batch_3.36.0
23:37:08  [ERROR] src/org/eclipse/jdt/core/compiler/IProblem.java:256 The type org.eclipse.jdt.core.compiler.IProblem has been removed from org.eclipse.jdt.core.compiler.batch_3.36.0
23:37:08  [ERROR] src/org/eclipse/jdt/core/compiler/InvalidInputException.java:22 The type org.eclipse.jdt.core.compiler.InvalidInputException has been removed from org.eclipse.jdt.core.compiler.batch_3.36.0
23:37:08  [ERROR] src/org/eclipse/jdt/core/compiler/batch/BatchCompiler.java:29 The type org.eclipse.jdt.core.compiler.batch.BatchCompiler has been removed from org.eclipse.jdt.core.compiler.batch_3.36.0
23:37:08  [ERROR] META-INF/MANIFEST.MF:6 The major version should be incremented in version 3.36.0, since API breakage occurred since version 3.35.0

Read: Analysis points to an existing type and complains that it has been removed. Really?

[iloveeclipse]

Same here: https://ci.eclipse.org/jdt/job/eclipse.jdt.debug-github/job/PR-324/1/console
Lot of errors for removed types on a trivial, unrelated PR.

@laeubi : please fix tycho or revert the changes to use latest tycho.

[laeubi]

@stephan-herrmann I don't think that these sarcastic undertones help to resolve the issue, I just want to remind to this (still not resolve) JDT issue where jdt is unable to compile valid java code into valid byte code (really? ;-) what works fine on javac (and now with Java 21 third preview will reach even greater audience):

• Import static with protected base class yiels wrong class reference compiled in resulting classfile eclipse-jdt/eclipse.jdt.core#809

and yes there are some "insane" sideeffects possible with API tools see for example:

• API tools gets mad when changing extension point and complains with strange error but only if implemented #378

and no one really likes to support bugfixing and/or improvements (I think @vik-chand is the only one somehow dedicated to it) in that area, why I suggested to discontinue this:

• https://www.eclipse.org/lists/pde-dev/msg02945.html

but it does not get much attention back there why we have to live with that for a while.

So here are some instructions for anyone who is willing to help understand/fixing the problem:

1. go to the IDE and checkout the PR that reproduces the problem with Team > Fetch Gihub Pull Request, make sure you select the eclipse repo as a source)
2. Open a terminal and go to the folder of the failing project
3. Make sure latest Maven 3.9 is available
4. run mvn clean install -Papi-check -DskipTests -Dtycho.apitools.debug

If you can see the problem (you should already get some debug output), go back to your IDE:

1. Create a new remote debugging session for project org.eclipse.pde.api.tools
2. put a breakpoint at BaseApiAnalyzer.analyzeComponent(BuildState, IApiFilterStore, Properties, IApiBaseline, IApiComponent, IBuildContext, IProgressMonitor)
3. happy debugging!

Would the below errors from https://ci.eclipse.org/jdt/job/eclipse.jdt.core-Github/job/PR-1447/5 fit the bill of this issue

This one builds fine with the given instructions above, could you please try if you can reproduce the problem or any special jdt specific settings are required to reproduce the problem?

Same here: https://ci.eclipse.org/jdt/job/eclipse.jdt.debug-github/job/PR-324/1/console

The PR fails to compile for me locally:

[ERROR] Failed to execute goal org.eclipse.tycho:tycho-compiler-plugin:4.0.4-SNAPSHOT:compile (default-compile) on project org.eclipse.jdt.debug.tests: Compilation failure: Compilation failure: 
[ERROR] org.eclipse.jdt.debug.tests/tests/org/eclipse/jdt/debug/tests/core/ClasspathContainerTests.java:[262] 
[ERROR] 	JavaIndexer.generateIndexForJar(libraryFile.getAbsolutePath(), indexPath.toOSString());

[laeubi]

@stephan-herrmann @iloveeclipse can you please "replay" a failing build and add -Dtycho.apitools.debug to the Jenkins file?

for example (please adjust to jdt accordingly):

[iloveeclipse]

can you please "replay" a failing build and add -Dtycho.apitools.debug to the Jenkins file?

See https://ci.eclipse.org/jdt/job/eclipse.jdt.debug-github/job/PR-324/2/