Bug 307996 - Add a UI for running API migration scans
Summary: Add a UI for running API migration scans
Status: ASSIGNED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: API Tools (show other bugs)
Version: 3.6   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: PDE API Tools Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: noteworthy
Depends on:
Blocks:
 
Reported: 2010-04-02 11:10 EDT by Chris Aniszczyk CLA
Modified: 2014-01-23 10:40 EST (History)
4 users (show)

See Also:
Michael_Rennie: review-


Attachments
org.eclipse.pde.api.tools.ui.patch (63.69 KB, patch)
2010-04-05 18:04 EDT, Chris Aniszczyk CLA
no flags Details | Diff
org.eclipse.pde.api.tools.ui.patch (64.34 KB, patch)
2010-04-05 18:27 EDT, Chris Aniszczyk CLA
no flags Details | Diff
Galileo Usage Scan (864.39 KB, application/binary)
2010-04-06 14:58 EDT, Chris Aniszczyk CLA
no flags Details
org.eclipse.pde.api.tools.ui.patch (64.63 KB, patch)
2010-04-07 12:13 EDT, Chris Aniszczyk CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Aniszczyk CLA 2010-04-02 11:10:11 EDT
Similar to the UI we have now for running API usage scans, we should do something for migration scans. If running a migration scan is available via the external tools launcher, more people will be included to use migration scans.
Comment 1 Chris Aniszczyk CLA 2010-04-02 11:10:50 EDT
I'll put it in my bucket, I'm just about done with the functionality.
Comment 2 Chris Aniszczyk CLA 2010-04-05 18:04:41 EDT
Created attachment 163847 [details]
org.eclipse.pde.api.tools.ui.patch

A first cut at the functionality.

Still not working completely yet, need to dig why.
Comment 3 Chris Aniszczyk CLA 2010-04-05 18:27:21 EDT
Created attachment 163848 [details]
org.eclipse.pde.api.tools.ui.patch

An updated patch.
Comment 4 Chris Aniszczyk CLA 2010-04-05 18:29:00 EDT
Do you guys have an example of a migration scan that would show me some red flags?
Comment 5 Chris Aniszczyk CLA 2010-04-06 14:57:13 EDT
Olivier, any ideas why I'm still not getting any migration report information out of this? I'm using the attached uses scan and pointing to Eclipse 3.6M6...
Comment 6 Chris Aniszczyk CLA 2010-04-06 14:58:11 EDT
Created attachment 163949 [details]
Galileo Usage Scan
Comment 7 Olivier Thomann CLA 2010-04-06 15:00:59 EDT
The attached scan is already a migration scan. I think you want the usage scan files.
Comment 8 Chris Aniszczyk CLA 2010-04-07 12:13:05 EDT
Created attachment 164083 [details]
org.eclipse.pde.api.tools.ui.patch

An updated patch that is ready for final review.
Comment 9 Chris Aniszczyk CLA 2010-04-07 12:14:27 EDT
Mike, can you review this for the next i-build?
Comment 10 Michael Rennie CLA 2010-04-07 12:21:40 EDT
(In reply to comment #9)

yes
Comment 11 Michael Rennie CLA 2010-04-12 12:17:37 EDT
-1 from me for this patch, it needs a lot of polishing and fails out-right when I try to run a scan.

1. there is no help doc

2. the tab has the wrong name: says API Use Report, should be API Migration Report (or something similar)

3. the error reporting for the use scan field happens in the wrong field: after I entered a report location and when I was entering a regex pattern in the 'For' field I get an error message: "You must enter a use scan location". Even after filling in all the rest of the fields the error does not go away unless I change the candidate?

4. the grouping is a bit confusing, I would make the 'Analyze' group be the 'Candidate' group and move the use scan controls to their own group 'Use Scan'

5. the option for generating only the HTML for an existing migration should be included.

6. the tab opens to an error about needing a report location. I would assume it would open telling me I need to enter a use scan location first.

7. trying to run a scan fails immediately with an error dialog stating "API baseline name unspecified", when I do in fact, have a baseline selected
Comment 12 Chris Aniszczyk CLA 2010-04-13 11:24:48 EDT
If I give you an updated patch, would you consider for M7?

(In reply to comment #11)
> -1 from me for this patch, it needs a lot of polishing and fails out-right when
> I try to run a scan.
> 
> 1. there is no help doc

This isn't critical immediately.

> 2. the tab has the wrong name: says API Use Report, should be API Migration
> Report (or something similar)

Fair enough.

> 3. the error reporting for the use scan field happens in the wrong field: after
> I entered a report location and when I was entering a regex pattern in the
> 'For' field I get an error message: "You must enter a use scan location". Even
> after filling in all the rest of the fields the error does not go away unless I
> change the candidate?

Bug.

> 4. the grouping is a bit confusing, I would make the 'Analyze' group be the
> 'Candidate' group and move the use scan controls to their own group 'Use Scan'

I was struggling a bit with this and I think having two groups is fine.

> 5. the option for generating only the HTML for an existing migration should be
> included.

How does this make sense? Why would you do this?
 
> 6. the tab opens to an error about needing a report location. I would assume it
> would open telling me I need to enter a use scan location first.

Ok, we can improve that.

> 7. trying to run a scan fails immediately with an error dialog stating "API
> baseline name unspecified", when I do in fact, have a baseline selected

I didn't hit this but we can track it.
Comment 13 Michael Rennie CLA 2010-04-13 11:49:30 EDT
(In reply to comment #12)
> If I give you an updated patch, would you consider for M7?

Certainly.

> 1. there is no help doc
> 
> This isn't critical immediately.

True but I don't want to have go back and add doc later, might as well just do it now...

> 5. the option for generating only the HTML for an existing migration should be
> > included.
> 
> How does this make sense? Why would you do this?

As you have the ability to generate XML only, you might want to be able to just create the HTML, or if new HTML report features become available you might want to simply recreate the HTML without having to redo the entire scan.