platform-update-home/doc/Test Scenarios/eclipse update.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.7, Sat Jun 1 18:51:04 2002 UTC revision 1.8, Mon Jun 3 01:23:04 2002 UTC
# Line 8  Line 8 
8    
9  <h1>  <h1>
10  Scenario: Updating Eclipse Install Using The Update Manager</h1>  Scenario: Updating Eclipse Install Using The Update Manager</h1>
11  &nbsp;  Last Updated: June 2, 2002 9:45PM
 <table BORDER COLS=1 WIDTH="100%" >  
 <tr>  
 <td><font color="#FF0000">NOTE: The test scenarios are being updated to  
 match the F2 build structure. At present, only scenario Part 2 (Alphabet  
 Soup) can be tried</font></td>  
 </tr>  
 </table>  
   
 <p>Last Updated: June 1, 2002 2:45PM&nbsp; .... being updated  
12  <h3>  <h3>
13  Objectives:</h3>  Objectives:</h3>
14  The objective of these scenarios is to illustrate the Eclipse update manager  The objective of these scenarios is to illustrate the Eclipse update manager
# Line 39  Line 30 
30  </ul>  </ul>
31    
32  <h2>  <h2>
33  Part 1: Updating Eclipse</h2>  Part 1: Updating Eclipse - "One Click" Update</h2>
34    
35  <h3>  <h3>
36  Setup:</h3>  Setup:</h3>
# Line 106  Line 97 
97  restart when new features are detected on startup.</li>  restart when new features are detected on startup.</li>
98    
99  <li>  <li>
100  A.2. go to update manager and verify that the features corresponding to  A.2 go to Help> About and click [About Features] and [About Plugins] to
101  the baseline install appear in the "Current Configuration"</li>  see more details of what is actually running. Note the baseline version
102    of the various items (most will be 2.0.0)</li>
103    
104    <li>
105    A.3. go to Help> Software Updates> Update Manager and verify that the features
106    corresponding to the baseline install appear in the "Current Configuration"</li>
107  </ul>  </ul>
108    
109  <h4>  <h4>
# Line 132  Line 128 
128    
129  <li>  <li>
130  B.6. popup, Properties, change name to "Baseline"</li>  B.6. popup, Properties, change name to "Baseline"</li>
 </ul>  
   
 <h4>  
 C. View the test site</h4>  
   
 <ul>  
 <li>  
 C.1. create new site bookmark (popup in Updates view, New> Site Bookmark...)</li>  
   
 <li>  
 C.2. type in a name (eg. Eclipse Updates) and copy the test site URL as  
 specified in the scenario "Setup"</li>  
   
 <li>  
 C.3. New site bookmark appears ... expand it. You should see categories  
 representing various available updates.</li>  
   
 <ul>  
 <li>  
 Note: the content of the site will be changing (ie. will be growing) as  
 new builds become available</li>  
 </ul>  
131    
132  <li>  <li>
133  C.4. select the category representing the latest build and expand the list  B.7 close update manager</li>
 of individual features</li>  
   
 <li>  
 C.5. you should see features corresponding to the updates</li>  
   
 <li>  
 C.6. uncheck the "Show matching features only" .... you should not see  
 other platform-specific features that do not match you environment</li>  
   
 <li>  
 C.7. check the "Show matching features only" again (to reduce the clutter)</li>  
134  </ul>  </ul>
135    
 <table BORDER COLS=1 WIDTH="100%" >  
 <tr>  
 <td>Note: at various points in the scenarios you are asked to verify the  
 configuration state of features. To see disabled (unconfigured) features  
 you need to press the "Show disabled features" button in the Configuration  
 view tool bar</td>  
 </tr>  
 </table>  
   
136  <h4>  <h4>
137  D. Update&nbsp; JDT and its source</h4>  C. "One Click" update</h4>
 Note: JDT is "middle of the stack" feature  
 <ul>  
 <li>  
 D.1. select "Eclipse Java Development Tools"</li>  
138    
139    <ul>
140  <li>  <li>
141  D.2. Click [Update] in the Preview and follow the Install Wizard (taking  C.0. NOTE: you must be connected to the network with access to www.eclipse.org
142  defaults) to install the feature.</li>  to perform this step. You will be downloading a full eclipse sdk drop as
143    part of this step. So you should have a reasonably fast network connection
144    for this step.</li>
145    
146  <li>  <li>
147  D.3. <font color="#000000"><b>DO NOT</b> restart </font>the workbench when  C.1. select Help> Software Updates> New Updates</li>
 prompted (on completion of the installation)</li>  
148    
149  <li>  <li>
150  D.4. select "Eclipse Java Development Tools SDK"</li>  C.2. wait while eclipse is searching for new updates</li>
151    
152  <li>  <li>
153  D.5. Click [Update] in the Preview and follow the Install Wizard (taking  C.3. the search results page should display a new version of eclipse SDK
154  defaults) to install the feature.</li>  preselected</li>
155    
156  <li>  <li>
157  D.6. <b>Restart</b> the workbench when prompted (on completion of the installation)</li>  C.4. click [Finish] and proceed to install the update. When you see feature
158    verification dialog, click [Install Feature].</li>
159    
160  <li>  <li>
161  D.7. workbench should restart automatically, and open into Update manager</li>  C.5. when you complete the installation, you'll be prompter to restart.
162    Select [OK] to restart the platform</li>
163    
164  <li>  <li>
165  D.8. expand "Current Configuration" and verify you now recognize the new  C.6. workbench should restart automatically</li>
 versions of the 2 features that were updated. Click on the "Show Disabled  
 Features" button to see the prior versions of the features (different icon).  
 The unconfigured feature should show a warning overlay (but may not, depending  
 on the combination of the base build and the update). If they do, select  
 the feature, right click, Show Status ... The error dialog shows details  
 (in this case reporting the fact that if this feature were to be configured  
 it would result in multiple versions of the same plugin being configured)</li>  
166    
167  <ul>  <ul>
168  <li>  <li>
169  confusing message text, <font color="#FF0000">defect 16712</font></li>  <b>PLEASE NOTE</b>: at this point you are no longer executing the update
170  </ul>  manager code you started with, but rather are running a version of the
171    update manager that was contained in the update (along with the rest of
172  <li>  the platform plugins). Depending on what the update site contained at that
173  D.9. go to Help> About dialog, [About Plug-Ins] and verify you are in fact  point (changes build to build) the platform may not even restart, and you
174  running updated versions of the JDT plugins.</li>  may need to reinstall eclipse to continue. Report defects for this (to
175    make sure there is not actually a legitimate problem) but please be clear
176    that you failed in step C.6.</li>
177  </ul>  </ul>
178    
 <h4>  
 E. Update PDE</h4>  
 Note: PDE is a "top of the stack" feature  
 <ul>  
 <li>  
 E.0. expand the update site bookmark (in Updates view) to show the available  
 individual features for the latest build</li>  
   
 <li>  
 E.1. select "Eclipse Plug-In Development Environment"</li>  
   
 <li>  
 E.2. Click [Update] in the Preview and follow the Install Wizard (taking  
 defaults) to install the feature.</li>  
   
 <li>  
 E.3. Restart the workbench when prompted (on completion of the installation)</li>  
   
179  <li>  <li>
180  E.4. workbench should restart automatically, and open into Update manager</li>  C.7. go to Help> About> [About Plug-Ins] and [About Features] to verify
181    you are running new version of the platform (the versions for the items
182    will be 2.0.0.&lt;qualifier>)</li>
183    
184  <li>  <li>
185  E.5. expand "Current Configuration" and verify you now recognize the new  C.8. Go to Help> Software Updates> Update Manager and expand "Current Configuration"
186  version of the feature that was updated</li>  and verify you now recognize the new version of the platform that was updated</li>
   
 <li>  
 E.6. go to Help> About dialog, [About Plug-Ins] and verify you are in fact  
 running updated versions of the PDE plugins.</li>  
187  </ul>  </ul>
188    
189  <h4>  <h4>
190  F. Restoring Original Configuration</h4>  D. Restoring Original Configuration</h4>
191    
192  <ul>  <ul>
193  <li>  <li>
194  F.1. expand "Saved Configurations"</li>  D.1. in Update Manager, expand "Saved Configurations"</li>
195    
196  <li>  <li>
197  F.2. select "Baseline" created in step B</li>  D.2. select "Baseline" created in step B</li>
198    
199  <li>  <li>
200  F.3. press restore</li>  D.3. press restore</li>
201    
202  <li>  <li>
203  F.4. Restart the workbench when prompted</li>  D.4. Restart the workbench when prompted</li>
204    
205  <li>  <li>
206  F.5. workbench should restart automatically, and open into Update manager</li>  D.5. workbench should restart automatically, and open into Update manager</li>
207    
208  <li>  <li>
209  F.6. expand "Current Configuration" and verify all configured features  D.6. expand "Current Configuration" and verify all configured features
210  are the baseline feature versions (generally 2.0.0)</li>  are the baseline feature versions (generally 2.0.0)</li>
211    
212  <li>  <li>
213  F.7. click the "Show disabled features" button in the Configuration view  D.7. click the "Show disabled features" button in the Configuration view
214  tool bar</li>  tool bar</li>
215    
216  <li>  <li>
217  F.8. verify "Current Configuration" shows the features updated in steps  D.8. verify "Current Configuration" shows the features updated in steps
218  D and E as disabled (different icon)</li>  D and E as disabled (different icon)</li>
219    
220  <li>  <li>
221  F.9. go to Help> About dialog, [About Plug-Ins] and verify you are in fact  D.9. go to Help> About dialog, [About Plug-Ins] and verify you are in fact
222  running the baseline plugins (all 2.0.0, except for the "special cases"  running the baseline plugins (all 2.0.0, except for the "special cases"
223  like xerces, ant, luce, tomcat, etc)</li>  like xerces, ant, luce, tomcat, etc)</li>
 </ul>  
   
 <h4>  
 <b>G. [removed]</b></h4>  
   
 <h4>  
 H. [removed]</h4>  
   
 <h4>  
 I. Update the platform</h4>  
 Note: platform is a "bottom of the stack" feature, and is the primary feature  
 <ul>  
 <li>  
 I.0. expand the configuration view. Select the "Eclipse Platform" feature.  
 In preview, click [Disable] ... should be notified you cannot disable the  
 platform or a primary feature (our selection is both)</li>  
   
 <li>  
 I.1. expand the update site bookmark (in Updates view) to show the available  
 individual features for the latest build</li>  
   
 <li>  
 I.1. select "Eclipse Platform"</li>  
   
 <li>  
 I.2. Click [Update] in the Preview and follow the Install Wizard (taking  
 defaults) to install the feature.</li>  
   
 <li>  
 I.3. Restart the workbench when prompted (on completion of the installation)</li>  
   
 <li>  
 I.4. workbench should restart automatically, and open into Update manager</li>  
   
 <ul>  
 <li>  
 <b>PLEASE NOTE</b>: at this point you are no longer executing the update  
 manager code you started with, but rather are running a version of the  
 update manager that was contained in the update (along with the rest of  
 the platform plugins). If you did not select the latest build from the  
 update site (and instead selected some old build) the platform may not  
 even restart, and you may need to reinstall eclipse to continue. Do not  
 report defects in this step unless you did get the latest available update.</li>  
 </ul>  
   
 <li>  
 I.5. expand "Current Configuration" and verify you now recognize the new  
 version of the platform that was updated</li>  
   
 <li>  
 I.5.1. go to Help> About> [About Plug-Ins] to verify you are running new  
 version of the platform.</li>  
   
 <li>  
 I.6. repeat step F to <b><font color="#FF0000">restore the original configuration</font></b>  
 (ie. the code you are testing)</li>  
 </ul>  
   
 <h4>  
 J. [removed]</h4>  
   
 <h4>  
 K. "Natively" installed extension</h4>  
   
 <li>  
 Note: if you performed Step I, make sure you repeat step F (revert to original  
 configuration) and then shot down.</li>  
   
 <ul>  
 <li>  
 K.0. in the first 2 steps you will be performing manually a linking task  
 typically done by the extension native installer (end users will never  
 need to do this)</li>  
   
 <li>  
 K.1. unzip the <a href="reddot_extension.zip">"RedDot" extension</a> somewhere  
 into the file system (the .zip contains a root directory RedDotInstall)</li>  
   
 <li>  
 K.2. manually create a link file in the Eclipse install you are using</li>  
   
 <ul>  
 <li>  
 in the eclipse/ directory, create links/ subdirectory</li>  
   
 <li>  
 in the links/ subdirectory create a file called "reddot.link"</li>  
   
 <li>  
 edit the file and type in a line</li>  
   
 <br>path=&lt;red dot install path>  
 <li>  
 Note: the path value is a file path to the target install directory using  
 native OS format. On Win, double up backslashes, eg. path=c:\\temp\\RedDotInstall</li>  
 </ul>  
224    
225  <li>  <li>
226  K.3. start Eclipse. Should observe Eclipse restarting (doing the "2 splash  D.10. shut down the workbench</li>
 dance")</li>  
   
 <li>  
 K.4. workbench opends with a dialog saying we have detected changes.</li>  
   
 <li>  
 K.5. click [OK] to open Update Manager</li>  
   
 <li>  
 K.6. Configuration Changes wizard shows. Check the changes you want to  
 apply (check the box beside the change, should only see one change)</li>  
   
 <li>  
 K.7. Click [Finish] and restart the workbench when prompted</li>  
   
 <li>  
 K.8. workbench should restart automatically. Open the update manager (if  
 not opened already ... depends if it was opened when the change was detected)</li>  
   
 <li>  
 K.9. expand "Current Configuration" and verify you now recognize the new  
 extension site and it contains configured RedDot feature</li>  
   
 <li>  
 K.10. Window> Customize Perspective...> Other> check Red Dot Set, [OK]</li>  
   
 <li>  
 K.11. verify new tool button appears, and a dialog shows when the button  
 is clicked.</li>  
227  </ul>  </ul>
228    
229  <h2>  <h2>
# Line 542  Line 346 
346  P.1. expand "Sites to Visit", and "Alphabet Soup Update Site" and "Alphabet  P.1. expand "Sites to Visit", and "Alphabet Soup Update Site" and "Alphabet
347  Soup Category"</li>  Soup Category"</li>
348    
 <ul>  
 <li>  
 wait for it to expand, even after the "hourglass" disappears - <font color="#FF0000">defect  
 16487</font></li>  
 </ul>  
   
349  <li>  <li>
350  P.2. Select "Alphabet Soup 1.0.0" ... preview should not show [Update]  P.2. Select "Alphabet Soup 1.0.0" ... preview should not show [Update]
351  button</li>  button</li>
# Line 599  Line 397 
397  <li>  <li>
398  Q.3. check the change (so it is applied) and press [Finish]</li>  Q.3. check the change (so it is applied) and press [Finish]</li>
399    
 <ul>  
 <li>  
 nested structure not shown - <font color="#FF0000">defect 16496</font></li>  
 </ul>  
   
400  <li>  <li>
401  Q.4. restart the workbench when prompted</li>  Q.4. restart the workbench when prompted</li>
402    
# Line 616  Line 409 
409  Q.6. Open update manager and expand "Current Configuration". Should see  Q.6. Open update manager and expand "Current Configuration". Should see
410  Alphabet Soup 1.1.0 configured, and the other 2 unconfigured (click the  Alphabet Soup 1.1.0 configured, and the other 2 unconfigured (click the
411  "Show disabled features").</li>  "Show disabled features").</li>
   
 <ul>  
 <li>  
 showing 2 features as configured - <font color="#FF0000">defect 16502</font></li>  
 </ul>  
412  </ul>  </ul>
413    
414  <h4>  <h4>
# Line 631  Line 419 
419  <font color="#000000">R.1. expand "Sites to Visit", "Alphabet Soup Update  <font color="#000000">R.1. expand "Sites to Visit", "Alphabet Soup Update
420  Site", "Alphabet Soup Fun Pack - Round Letters"</font></li>  Site", "Alphabet Soup Fun Pack - Round Letters"</font></li>
421    
 <ul>  
 <li>  
 <font color="#000000">wait for expansion (</font><font color="#FF0000">defect  
 16487 </font><font color="#000000">as in P.1.), ignore duplicate sites  
 (</font><font color="#FF0000">defect 16502 </font><font color="#000000">as  
 in Q.6.)</font></li>  
 </ul>  
   
422  <li>  <li>
423  <font color="#000000">R.2. select "Alphabet Soup Round Letters Extension  <font color="#000000">R.2. select "Alphabet Soup Round Letters Extension
424  Pack 1.0.0" and click [Install]. Accept defaults in wizard and [Finish].  Pack 1.0.0" and click [Install]. Accept defaults in wizard and [Finish].
# Line 705  Line 485 
485  S.3. within the links/ subdirectory, create a file called my.alphabet.link&nbsp;  S.3. within the links/ subdirectory, create a file called my.alphabet.link&nbsp;
486  and add a single line into it</li>  and add a single line into it</li>
487    
488  <br>&nbsp;  <p><br>path=&lt;some new install directory>
 <p>&nbsp;  
 <br>&nbsp;  
 <br>&nbsp;  
 <p>path=&lt;some new install directory>  
489  <p><b>Note</b>: the path should be an absolute path using local file system  <p><b>Note</b>: the path should be an absolute path using local file system
490  syntax. The .link file is loaded as a Java properties file, so on Windows  syntax. The .link file is loaded as a Java properties file, so on Windows
491  you need to double up the back-slashes (eg. path=c:\\temp\\install)  you need to double up the back-slashes (eg. path=c:\\temp\\install)
# Line 738  Line 514 
514  S.8. Open update manager and expand "Current Configuration". Should see  S.8. Open update manager and expand "Current Configuration". Should see
515  a new site representing the extension install, and it should contain the  a new site representing the extension install, and it should contain the
516  extension feature you've installed.</li>  extension feature you've installed.</li>
   
 <ul>  
 <li>  
 side note: the symptoms of <font color="#FF0000">defect 16502 </font><font color="#000000">(Q.6.)  
 disappear</font></li>  
 </ul>  
517  </ul>  </ul>
518    
519  <h4>  <h4>
# Line 755  Line 525 
525  <font color="#000000">T.1. expand "Sites to Visit", "Alphabet Soup Update  <font color="#000000">T.1. expand "Sites to Visit", "Alphabet Soup Update
526  Site", "Alphabet Soup Fun Pack - Numbers"</font></li>  Site", "Alphabet Soup Fun Pack - Numbers"</font></li>
527    
 <ul>  
 <li>  
 <font color="#000000">wait for expansion (</font><font color="#FF0000">defect  
 16487 </font><font color="#000000">as in P.1.)</font></li>  
 </ul>  
   
528  <li>  <li>
529  <font color="#000000">T.2. The Numbers extension specifies an OS in its  <font color="#000000">T.2. The Numbers extension specifies an OS in its
530  feature definition. The update site contains features for Win and Linux.  feature definition. The update site contains features for Win and Linux.
# Line 808  Line 572 
572  directory</font></li>  directory</font></li>
573  </ul>  </ul>
574    
 <h2>  
 <font color="#000000">Part-3: Adopting Eclipse</font></h2>  
   
 <h3>  
 Setup:</h3>  
 Available sites:  
 <ul>  
 <li>  
 <a href="http://klicnik.torolab.ibm.com/shrek/">http://klicnik.torolab.ibm.com/shrek/</a></li>  
 </ul>  
 <b>Note</b>: this site is not available on the public internet. It is a  
 test site containing an example of Eclipse packaged as a nested feature.  
 <b>The  
 data on the site contains only Eclipse support for Windows.</b>  
 <h3>  
 Description:</h3>  
 This scenario starts with base eclipse install. It is then updated with  
 new feature definitions that "adopt" the features in the base build into  
 a nested structure. The base nested feature containing Eclipse runtime  
 support is then updated to a new version.  
 <h3>  
 Steps:</h3>  
   
 <ul>  
 <li>  
 Install second copy of Eclipse to run these scenarios ... do not use your  
 development copy of Eclipse for this.</li>  
   
 <li>  
 either use the default workspace created by the second Eclipse copy, or  
 specify (-data) a new workspace for these scenarios</li>  
 </ul>  
   
 <h4>  
 V. Adopting "Flat" Eclipse</h4>  
   
 <ul>  
 <li>  
 V.1. startup Eclipse. On the initial startup with new workspace you should  
 see the splash come up, be taken down down, and come up again before it  
 is finally taken down before the Workbench appears. This is due to Eclipse  
 restart when new features are detected on startup.</li>  
   
 <li>  
 V.2. go to update manager and verify that the features corresponding to  
 the baseline install appear in the "Current Configuration"</li>  
   
 <li>  
 V.3. create new site bookmark (popup in Updates view, New> Site Bookmark...)</li>  
   
 <li>  
 V.4. type in a name (eg. Nested Updates) and copy the test site URL as  
 specified in the scenario "Setup"</li>  
   
 <li>  
 V.5. New site bookmark appears ... expand it. You should see a category  
 "Adopt Flat Eclipse". Expand it, and select "Eclipse Runtime for Windows".  
 Note this is a nested feature. Click on the [+] to see its content. Note  
 that is you select any of the child features you cannot perform update  
 functions on these (no action buttons in preview). If you select the parent  
 you should see [Install]</li>  
   
 <li>  
 V.6. Click [Install] when the parent feature is selected and and follow  
 the Install Wizard (taking defaults) to install the feature. The install  
 should be very fast, since all the plugins referenced by the nested structure  
 are already installed (they are the base 2.0.0 versions)</li>  
   
 <li>  
 V.7. <b>Restart</b> the workbench when prompted (on completion of the installation)</li>  
   
 <li>  
 V.8. workbench should restart automatically, and open into Update manager</li>  
   
 <li>  
 V.9. expand "Current Configuration" and verify the baseline features have  
 been "adopted" into the nested structure. The baseline SDK features remain  
 non-nested (top level features)</li>  
   
 <li>  
 V.10. go to Help> About> [About Plug-Ins] and verify you are still running  
 the baseline versions of all plugins (ie. the update only affected the  
 feature structure)</li>  
   
 <li>  
 V.11. Expand "Current Configuration". Select the nested feature and press  
 [Disable] in the preview. You should be notified that you cannot disable  
 the feature (contains the platform).</li>  
 </ul>  
   
 <h4>  
 W. Updating the nested Eclipse</h4>  
   
 <ul>  
 <li>  
 W.1. Expand the update site bookmarked in the previous step. This time  
 expand the NESTED category corresponding to the latest build. Select "Eclipse  
 Runtime for Windows".</li>  
   
 <li>  
 W.2. Click [Update] when the parent feature is selected and and follow  
 the Install Wizard (taking defaults) to install the feature. The install  
 should be slow, since we are downloading all new features and plugins (they  
 are the&nbsp; 2.0.0.QUALIFIER versions). Do not do this step unless you  
 have a reasonably fast connection.</li>  
   
 <li>  
 W.3. <b>Restart</b> the workbench when prompted (on completion of the installation)</li>  
   
 <li>  
 W.4. workbench should restart automatically, and open into Update manager</li>  
   
 <li>  
 W.5. expand "Current Configuration" and verify you now have an updated  
 version of the nested feature (new parent version as well as new children)</li>  
   
 <li>  
 W.5. go to Help> About> [About Plug-Ins] and verify that all runtime plugins  
 have in fact been updated to the new version (the SDK plugins have not)</li>  
 </ul>  
   
575  </body>  </body>
576  </html>  </html>
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.8