Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 165113

Summary: Mispackaging of codegeneration plugin
Product: z_Archived Reporter: Andrew Eberbach <aeberbac>
Component: TPTP.monitoringAssignee: Andrew Eberbach <aeberbac>
Status: RESOLVED DUPLICATE QA Contact:
Severity: critical    
Priority: P3 CC: bsubram, smith
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Attachments:
Description Flags
Fix propsed in bug description none

Description Andrew Eberbach CLA 2006-11-19 23:10:11 EST 
The org.eclipse.tptp.wsdm.tooling.codegeneration plugin has code that references files which will be added via an update site from Apache Muse. However, the org.eclipse.tptp.wsdm.tooling.codegeneration plugin is not part of the feature which the Muse update site will update. 

What happens is that there is a directory in the plugin that must be copied verbatim to a newly generated project and that code currently looks in the org.eclipse.tptp.wsdm.tooling.codegeneration plugin to find the directory it needs. The fix to the problem involves

1. Removing the skeleton directory structure (which contains only the files which passed legal approval) and putting them into the update site which will place them into the org.apache.muse.tools plugin.

2. Update one line of code in the codegeneration plugin. The reason it is only one line (which is an import) is because I am using the Activator class from the plugin as a reference point from which to load the files via the classloader file loading mechanism. The proposed fix changes the Activator to be that of org.apache.muse.tools instead of org.eclipse.tptp.wsdm.tooling.codegeneration. 

This fix is important to make sure that the tooling can be installed without any  manual copying of files into the plugins directory which has already been raised as an issue by an adopter of the tooling.
Comment 1 Andrew Eberbach CLA 2006-11-19 23:11:05 EST 
Created attachment 54144 [details]
Fix propsed in bug description

This is the fixed I proposed in the bug description.
Comment 2 Dave Smith CLA 2006-11-20 13:10:57 EST 
Targetting to i3 as this is critical to the usability of the installation process for the WSDM Tooling tech preview.
Comment 3 Dave Smith CLA 2006-11-20 13:14:05 EST 
Reassigning to Andrew who created the patch.
Comment 4 Dave Smith CLA 2006-11-21 10:58:38 EST 
Standard stop-ship template questions:

1) Explain why you believe this is a stop-ship defect.  How does the defect
manifest itself, and how will users of TPTP / consuming products be
affected if the defect is not fixed?

This defect affects the user installation experience of the WSDM Tooling tech preview.
In the 4.2 Managed Agent Explorer tech preview users were required to download and copy jars and resources manually from Apache Muse web site into the TPTP plugins.  Users have found this process confusing and error prone.  As a result, an Apache Muse update site was developed so TPTP users can retrieve the required Muse files into the corresponding empty TPTP Muse plugins.  During the testing of the installation process, it was found that one TPTP code plugin still required Muse files to be included. For the update site to work properly, these Muse files should be installed in one of the TPTP Muse empty plugins. A code change is required in the TPTP code plugin so it can find the moved files. If this is not fixed, the user will have to manually download the affected files and insert them into the TPTP code plugin in the correct location, complicating the installation process, considering the remainder of the Muse depencencies will be installed via the update site.


2) Is there a work-around?  If so, why do you believe the work-around is
insufficient?
The workaround is to document the manual process of downloading and copying the required files into the correct TPTP plugin.  This adds unnecessary complexity to the installation process, considering the remainder of the Muse dependencies will be installed via the update site.


3) Is this a regression or API breakage?  Explain.

This particular TPTP tech preview plugin is new in 4.3 so is not a regression and not an API breakage issue.

4) Does this require new API?

No.

5) Who performed the code review?

Andrew Eberbach prepared the fix and it was reviewed by Balan Subramanian and Dave Smith.

6) Is there a test case attached to the bugzilla record?

There is an installation testcase that covers this case.

7) What is the risk associated with this fix?

The fix is to one WSDM Tooling tech preview plugin (org.eclipse.tptp.wsdm.tooling.codegeneration) and does not affect any TPTP GA functionality.  Some files will be removed from TPTP CVS and moved to Apache Muse plugin to make the Muse update complete.  The code fix to one class is to replace the import statement for the Activator class of the current TPTP plugin with an import statement for the Activator class of the TPTP Muse plugin where the required files will be located once the plugin has been updated from the Apache Muse update site.  The Activator class is only used to get the location of the required files so the risk is very low.  The fix has been fully tested with the update site installation.


8) Is this fix related to any standards that TPTP adheres to?  If so, who
has validated that the fix continues to adhere to the standard?

No.
Comment 5 Dave Smith CLA 2006-11-23 01:52:06 EST 
Deferring to 4.4 as it was not approved by PMC for inclusion in 4.3.
Comment 6 Dave Smith CLA 2007-01-12 02:44:44 EST 
Does this defect still apply to 4.4?  If so and it is critical, it should have P1 priority.
Comment 7 Balan Subramanian CLA 2007-01-15 23:51:01 EST 

*** This bug has been marked as a duplicate of bug 170582 ***
Comment 8 Dave Smith CLA 2007-01-16 01:44:34 EST 
This was resolved in iteration 1.