Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Call the API tools directly without using ApiAnalysisApplication #2899

Merged
merged 1 commit into from
Oct 8, 2023

Conversation

laeubi
Copy link
Member

@laeubi laeubi commented Oct 7, 2023

This replaces ApiAnalysisApplication usage by a more direct approach that do not require us to pass file lists around and directly class the ApiTools.
This is also much more flexible in regard to debugging and additional printouts but still retains that we can consume dynamic implementation from P2 repositories.

Currently this is work-in-progress:

  1. For full features we need a solution for the problem described here: [apitools] BaseApiAnalyzer should have a way to discover the source without a java project eclipse-pde/eclipse.pde#785
  2. Currently API problems are just printed for demo purpose and feature validation
  3. The ApiTools currently determine the profile internally, we should supply the profile generated by Tycho

@github-actions
Copy link

github-actions bot commented Oct 7, 2023

Test Results

   561 files  ±0     561 suites  ±0   4h 52m 50s ⏱️ + 30m 49s
   364 tests ±0     358 ✔️ +1    6 💤 ±0  0 ±0 
1 092 runs  ±0  1 073 ✔️ +1  19 💤 ±0  0 ±0 

Results for commit 408b95a. ± Comparison against base commit a1c9e4b.

♻️ This comment has been updated with latest results.

@laeubi laeubi force-pushed the call_api_tools_directly branch from d51aedc to 4828b0e Compare October 7, 2023 15:50
@laeubi laeubi marked this pull request as ready for review October 7, 2023 15:50
@laeubi
Copy link
Member Author

laeubi commented Oct 7, 2023

This is ready now and gives much better user feedback. Instead of "ApiApplication failed" and require the user to scan the logs one now will be presented in the error message with the details about the failure:
grafik

beside that the API analysis is now faster because we don't need to build / compile the project to perform the API analysis (in this case before 25 seconds now 15 seconds).

This also adds a new parameter "debug" that prints additional information about the used API baseline:

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

@laeubi laeubi added the backport-to-tycho-4.0.x Can be added to a PR to trigger an automatic backport of the change label Oct 7, 2023
@laeubi laeubi force-pushed the call_api_tools_directly branch 3 times, most recently from c3c8a8c to d29b889 Compare October 8, 2023 06:15
This replaces ApiAnalysisApplication usage by a more direct approach
that do not require us to pass file lists around and directly class the
ApiTools. This is also much more flexible in regard to debugging and
additional printouts but still retains that we can consume dynamic
implementation from P2 repositories.

Beside that we can now give much better failure report to the user.
@laeubi laeubi force-pushed the call_api_tools_directly branch from d29b889 to 408b95a Compare October 8, 2023 06:28
@laeubi laeubi merged commit 8526ce0 into eclipse-tycho:master Oct 8, 2023
8 checks passed
@github-actions
Copy link

github-actions bot commented Oct 8, 2023

💚 All backports created successfully

Status Branch Result
tycho-4.0.x

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-to-tycho-4.0.x Can be added to a PR to trigger an automatic backport of the change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant