Difference between revisions of "User talk:Charley.wang.gmail.com"

Revision as of 13:42, 19 July 2010

How do I make Mylyn work with custom status transitions?

Pending bugs 259291 and 311966, Mylyn will have the ability to work with Bugzilla custom status transitions.

There are two ways to use this feature. Please note that for both options, tasks may have to be refreshed for the change to take effect.

Use XMLRPC API (requires Bugzilla 3.6 or greater)

Using the XMLRPC API, Mylyn can automatically fetch information about valid transitions from the host Bugzilla. To enable this option, just check the Autodetect Workflow box in the Repository's preference page:

Tasks should now reflect the new status workflow. The limitation of this approach is that there is currently no way to identify the Duplicate Status or valid Start Statuses from XMLRPC alone.

Use workflow descriptor file

Using a workflow descriptor file, it is possible to get full control over the workflow, duplicate status and start statuses. For descriptor file formatting, please see Mylyn/Bugzilla_Connector#Custom_Transitions

To enable this option, select a file from your filesystem in a repository's Additional Settings. Currently the workflow descriptor file will supercede any information received from Bugzilla XMLRPC, though there are plans to enable the use of the descriptor file for special workflow settings and maximize use of the XMLRPC.

EGIt/JGit ignore testing

Successfully ignored

Successfully not ignored (File added to parent's .gitignore)

Mylyn Custom Transitions

Principle: As per contributor guidelines, avoid changing Mylyn code whereever possible. In case of failure, fall back on Mylyn's original behaviour (even if that behaviour will not work)

Customization cases:

1. User changes workflow only (via editworkflow.cgi)

    - Can use original BugzillaOperation enum

    - Certain transitions are version-specific (e.g. reassignbycomponent) -- will have to add verifiers

2. User changes name of statuses in bug_status table

3. Other special user-settings -- e.g. the DUPLICATE action can have different end bug_statuses, unconfirmed status may or may not exist

'Proposed 'Workflow:

Front-end: User has selection box in Repository Preferences to choose a Transition Descriptor File (TDF), and a checkbox to specify that custom workflows are in use. By default, none of these are checked.

Back-end: If custom workflows are in use, Mylyn checks if TDF exists & is valid. If not, Mylyn then checks if XMLRPC is available & is valid. If either the TDF or XMLRPC are valid, parse their output and figure out the transition table. Render everything according to the transition table. If no custom transition table is available, use Mylyn's original default behaviour.

Plan:

Add IBugzillaOperation with two implementations -- the default BugzillaOperation enum that is already in use, and a new CustomBugzillaOperation. In addition to the current fields in BugzillaOperation, CustomBugzillaOperation needs to contain: Server String (i.e. operation that must be sent to the server when the user hits Submit), Version Verifier.

Use a TransitionManager that checks if a transition descriptor file or xmlrpc Bug.fields is available and uses available information to create a list of valid transitions. If the file or xmlrpc Bug.fields are not available, fall back on Mylyn default behaviour.

Approaching completion:

Patch for customization case #1

Next step:

JUnit testing of current patch. Fix existing issues. Add Transition Descriptor File selection box to Repository Preferences. Add XMLRPC communication.

Future:

I have a plan and a half-implemented patch for case #2, after which I will work on case #3.