Bug 332763 - Producer oriented API Use Scan Migration task
Summary: Producer oriented API Use Scan Migration task
Status: RESOLVED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: API Tools (show other bugs)
Version: 3.7   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.7 M6   Edit
Assignee: Ankur Sharma CLA
QA Contact:
URL:
Whiteboard:
Keywords: noteworthy
Depends on:
Blocks:
 
Reported: 2010-12-16 11:34 EST by Peter Parapounsky CLA
Modified: 2011-03-08 16:10 EST (History)
3 users (show)

See Also:
Michael_Rennie: review+


Attachments
first cut (35.76 KB, patch)
2011-02-07 15:46 EST, Ankur Sharma CLA
no flags Details | Diff
v01 (95.81 KB, patch)
2011-03-03 09:59 EST, Ankur Sharma CLA
no flags Details | Diff
v02 - Patch with doc (110.52 KB, patch)
2011-03-04 10:30 EST, Ankur Sharma CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Parapounsky CLA 2010-12-16 11:34:54 EST
Build Identifier: 

There is a new API Tooling feature in Eclipse 3.7 M4, which allows API use scans to be compared to a workspace. We would like to be able to do this in a headless build via an ANT task. The task would take as inputs scan report URLs(local or remote) and also an Eclipse site(baseline) against which to do the scanning. This will automate our process in terms of discovering when a build producing API could break it's API build consumers.

Reproducible: Always
Comment 1 Curtis Windatt CLA 2010-12-20 14:45:29 EST
Investigating for M5.

In 3.7 we added support to integrate Use Scans into the API Tools builder/analyzer.  It compares the workspace contents to one or more use scans to check that all references are still available.

The API Use Migration Task reports very similar errors, but is targeted at the reference consumers.  You provide it with a use scan and a product release.

This request is for a new migration task that will target the reference producers.  It will take one or more use scans and a baseline and report any references from the use scans that are not provided by the baseline.  The task will have similarities to both the current API Use Migration task and the API Analysis task.

We are hoping that as the workspace use scan integration uses the api analyzer, implementing this task should be easier, taking advantage of the framework used in the API Analysis task.  The output of the task will be very similar to the analysis task.
Comment 2 Ankur Sharma CLA 2011-01-20 09:48:14 EST
Need to figure out a way for reporting line numbers too.
Comment 3 Ankur Sharma CLA 2011-02-07 15:46:59 EST
Created attachment 188475 [details]
first cut

This is first cut to show the progress. Do not review the code yet. Hope its good enough to test the Ant. Haven't tested the it heavily yet.

TODO
html conversion task
comment and code cleaning
correction to Ant setter types
Comment 4 Ankur Sharma CLA 2011-03-03 09:59:08 EST
Created attachment 190273 [details]
v01

Mike, please review. I will continue to polish it in meantime.
Comment 5 Curtis Windatt CLA 2011-03-03 17:09:45 EST
Mike and I looked at the patch for a bit.  Mike will try run it against some scans tomorrow.

Reminder that we need the task to be doc'd in the doc plug-in.

Why did you create your own parser?  Why did you change the xslt (I didn't think the xslt in the project was used anymore)?
Comment 6 Ankur Sharma CLA 2011-03-04 03:12:21 EST
(In reply to comment #5)

> Reminder that we need the task to be doc'd in the doc plug-in.

I will attach another for it today
 
> Why did you create your own parser?  Why did you change the xslt (I didn't
> think the xslt in the project was used anymore)?
Had to create parser as my XMLs and requirements were different and it was ensured, we doesn't have to test the other tasks
I could see only the notsearched.xslt being used by other ant tasks. I am reusing it instead of redoing it. The modification is a IF to suppress the link to Missing bundles as its not needed (currently).
Comment 7 Ankur Sharma CLA 2011-03-04 10:30:37 EST
Created attachment 190395 [details]
v02 - Patch with doc
Comment 8 Michael Rennie CLA 2011-03-04 17:08:45 EST
The patch works fine. I made a few tweaks, including:

1. properly write out the not searched components
2. sorting for the HTML reports
3. removed spurious table column headers
4. fixed the missing version info in the XML and HTML
5. fixed cleaning the output directory each run
6. proper grouping of reported problems under the type they belong to
7. corrected some of the doc
8. updated the ant-tasks.properties file
9. updated the api-tasks.xml file

Applied to HEAD