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

Parent Directory | Revision Log | Patch

-revision 1.11, Tue Jun 11 22:57:35 2002 UTC
+revision 1.12, Fri Feb 21 18:31:59 2003 UTC
 Line 2
  <html>
  <head>
     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-    <meta name="GENERATOR" content="Mozilla/4.72 [en] (Windows NT 5.0; U) [Netscape]">
+    <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
  </head>
  <body>
  <h1>
  Scenario: Updating Eclipse Install Using The Update Manager</h1>
- Last Updated: June 11, 2002 6:05PM
+ Last Updated:
- <h3>
+ <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%A, %B %d, %Y" startspan -->Friday, February 21, 2003<!--webbot bot="Timestamp" endspan i-checksum="55249" --><h3>
  Objectives:</h3>
  The objective of these scenarios is to illustrate the Eclipse update manager
  function through simple end-to-end use cases. The scenarios are divided
- into two parts.
+ into two parts.<ul>
- <ul>
  <li>
- Part-1 excercises updating of Eclipse itself from a test site containing
+ Part-1 exercises updating of Eclipse itself from a test site containing
  Eclipse builds repackaged as downloadable features. The Eclipse feature
  structure is a reasonable representation of a non-trivial product. It contains
  a primary feature (the platform) and a number of other features ( jdt,
-Line 25
+Line 24
  <li>
  Part-2 uses an example "product" to go through the various steps of updating
  and extending it using both the update manager, as well as native installation
- (using .zip file containing features and plugins that can be extracted
+ (using .zip file containing features and plug-ins that can be extracted
  directly into the file system)</li>
+ <li>
+ Part-3 uses an even simpler feature hierarchy to go through more advanced
+ capabilities that include optional features and emergency fixes.</li>
  </ul>
  <h2>
-Line 37
+Line 40
  Available sites:
  <ul>
  <li>
- <a href="http://download.eclipse.org/updates/">http://download.eclipse.org/updates/</a></li>
+ <a href="http://download.eclipse.org/updates/">http://update.eclipse.org/testUpdates/</a></li>
  </ul>
  <table BORDER COLS=1 WIDTH="100%" >
-Line 55
+Line 58
  numbers modified as part of the build process. They are generally of the
  form 2.0.0.QUALIFIER, where the qualifier differs build to build. Note,
  however, that when you install base Eclipse (.zip downloaded from eclipse.org),
- all of its features and plugins only use 3 part version identifiers (generally
+ all of its features and plug-ins only use 3 part version identifiers (generally
-.0.0). So all the 2.0.0.Q updates in fact appear more recent that the
+.1.0). So all the 2.1.0.Q updates in fact appear more recent that the
  build you are running, even though they may in fact be an older build.
  Note, that when you update the Eclipse components from the update site
  and restart you may in fact now be running </font><font color="#FF0000">DIFFERENT
  CODE THAN WHAT YOU STARTED WITH</font><font color="#000000">. So it is
  really important that you start each of the test scenario steps with a
- clean install of eclipse. </font><font color="#FF0000">It is suggested
+ <b>clean install of eclipse</b>. </font><font color="#FF0000">It is suggested
  that you always use a second install of Eclipse running with a different
  workspace (than what you use to do development) to actually run through
- these scenarios.</font>
+ these scenarios.</font><p><font color="#000000">When opening Bugzilla defects, use the
- <p><font color="#000000">When openning Bugzilla defects, use the platform/update
+ Platform/Update
  component. Please ALWAYS specify the failing scenario step, and include
  a .zip of the &lt;workspace>/.metadata/ directory</font></td>
  </tr>
-Line 96
+Line 99
  restart when new features are detected on startup.</li>
  <li>
- A.2 go to Help> About and click [Feature Details] and [Plugin Details]
+ A.2 go to Help> About and click [Feature Details] and [Plug-in Details]
  to see more details of what is actually running. Note the baseline version
- of the various items (most will be 2.0.0)</li>
+ of the various items (most will be 2.1.0)</li>
  <li>
  A.3. go to Help> Software Updates> Update Manager and verify that the features
-Line 129
+Line 132
  B.6. popup, Properties, change name to "Baseline"</li>
  <li>
- B.7 close update manager</li>
+ B.7 close Update Manager</li>
  </ul>
  <h4>
-Line 138
+Line 141
  <ul>
  <li>
  C.0. NOTE: you must be connected to the network with access to www.eclipse.org
- to perform this step. You will be downloading a full eclipse sdk drop as
+ to perform this step. You will be downloading a full Eclipse SDK drop as
  part of this step. So you should have a reasonably fast network connection
  for this step.</li>
-Line 160
+Line 163
  verification dialog, click [Install].</li>
  <li>
- C.5. when you complete the installation, you'll be prompter to restart.
+ C.5. when you complete the installation, you'll be prompted to restart.
  Select [Yes] to restart the platform</li>
  <li>
- C.6. workbench should restart automatically</li>
+ C.6. workbench should restart automatically</li><ul>
- <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). Depending on what the update site contained at that
+ the platform plug-ins). Depending on what the update site contained at that
  point (changes build to build) the platform may not even restart, and you
  may need to reinstall eclipse to continue. Report defects for this (to
  make sure there is not actually a legitimate problem) but please be clear
-Line 181
+Line 182
  <li>
  C.7. go to Help> About> [Plug-In Details] and [Feature Details] to verify
  you are running new version of the platform (the versions for the items
- will be 2.0.0.&lt;qualifier>)</li>
+ will be 2.1.0.&lt;qualifier>)</li>
  <li>
  C.8. Go to Help> Software Updates> Update Manager and expand "Current Configuration"
-Line 205
+Line 206
  D.4. Restart the workbench when prompted</li>
  <li>
- D.5. workbench should restart automatically, and open into Update manager</li>
+ D.5. workbench should restart automatically, and open into Update Manager</li>
  <li>
  D.6. expand "Current Configuration" and verify all configured features
- are the baseline feature versions (generally 2.0.0)</li>
+ are the baseline feature versions (generally 2.1.0)</li>
  <li>
  D.6.1. click "Show Disabled Features" button in the toolbar of the Configurations
- view. Observe the updated version as unconfigured.</li>
+ view. Observe the updated version as disabled.</li>
  <li>
- D.7. click the "Show disabled features" button in the Configuration view
+ D.7. click the "Show Disabled Features" button in the Configuration view
  tool bar</li>
  <li>
-Line 225
+Line 226
  <li>
  D.9. go to Help> About dialog, [Plug-In Details] and verify you are in
- fact running the baseline plugins (all 2.0.0, except for the "special cases"
+ fact running the baseline plug-ins (all 2.0.0, except for the "special cases"
- like xerces, ant, lucene, tomcat, etc)</li>
+ like Xerces, Ant, Lucene, Tomcat, etc)</li>
  <li>
  D.10. shut down the workbench</li>
-Line 242
+Line 243
  <li>
  <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/index.html">http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/</a></li>
  </ul>
- The above site contains prebuilt features used as part of the following
+ The above site contains pre-built features used as part of the following
  scenario steps. It also includes several .zip files (containing features
- and plugins) that are used to simulate native installer steps.
+ and plug-ins) that are used to simulate native installer steps.<br>&nbsp;
- <br>&nbsp;
  <table BORDER COLS=1 WIDTH="100%" >
  <tr>
  <td>
 Line 255
  </tr>
  <tr>
- <td><font color="#000000">When openning Bugzilla defects, use the platform/update
+ <td><font color="#000000">When opening Bugzilla defects, use the Platform/Update
  component. Please ALWAYS specify the failing scenario step, and include
  a .zip of the &lt;workspace>/.metadata/ directory</font></td>
  </tr>
 Line 267
  plus several extensions. The application installs a tool button, and a
  menu ("Alphabet Soup") that can be used to query the content of the "soup
  bowl" and interact with the individual installed "letters" (each letter
- in the bowl corresponds to a separate plugin)
+ in the bowl corresponds to a separate plug-in)
  <ul>
  <li>
  base product is a nested feature, my.alphabet, containing two sub-features
  with base sets of "letters"</li>
  <li>
-extension features containing additional "letters" (plugins). The features
+extension features containing additional "letters" (plug-ins). The features
  have a dependency relationship as follows:</li>
  <ul>
 Line 290
  "straight letters" extension pack to be installed</li>
  </ul>
  </ul>
- Just follow the steps and you'll get the idea.
+ Just follow the steps and you'll get the idea.<h3>
- <h3>
  Steps:</h3>
  <ul>
-Line 309
+Line 308
  <ul>
  <li>
- O.1. after you have installed baseline eclipse, unzip the Aplhabet Soup
+ O.1. after you have installed baseline eclipse, unzip the Alphabet Soup
  product features from <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/native/my.alphabet_1.0.0.zip">my.alphabet_1.0.0.zip</a>&nbsp;
  into the eclipse/ installation directory. The unzip should overwrite the
  install.ini file that is packaged with Eclipse (sets the Alphabet Soup
-Line 333
+Line 332
  <li>
  O.6. Expand "Current Configuration". Verify "Alphabet Soup 1.0.0" is configured,
- and it contains 2 subfeatures (Round and Straight letters)</li>
+ and it contains 2 sub-features (Round and Straight letters)</li>
  <li>
- O.7. click on each of the features and view more details about each freature</li>
+ O.7. click on each of the features and view more details about each feature</li>
  <li>
  O.8. select "Alphabet Soup 1.0.0" and press [Disable]. You should be notified
-Line 370
+Line 369
  <li>
  P.6. Click the "Show disabled features" filter button .... should see both
- versions (one configured, the other unconfugured (icon with grey "stop"
+ versions (one enabled, the other disabled (icon with red "stop"
  overlay))</li>
  <li>
-Line 390
+Line 389
  <ul>
  <li>
- Q.1. unzip the Aplhabet Soup product features from <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/native/my.alphabet_1.1.0.zip">my.alphabet_1.1.0.zip</a>&nbsp;
+ Q.1. unzip the Alphabet Soup product features from <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/native/my.alphabet_1.1.0.zip">my.alphabet_1.1.0.zip</a>&nbsp;
  into the eclipse/ installation directory (look into the features/ or plugins/
- subdirectory to veify you see new 1.1.0 versions)</li>
+ subdirectory to verify you see new 1.1.0 versions)</li>
  <li>
- Q.2. start Eclipse (a.k.a. Alphabet Soup). You'll see the splash comming
+ Q.2. start Eclipse (a.k.a. Alphabet Soup). You'll see the splash coming
- up twice as the platfrom is updating the configuration. Workbench will
+ up twice as the platform is updating the configuration. Workbench will
  come up, with a dialog informing you have changes. Click [OK] to open the
  update manager change dialog.</li>
-Line 413
+Line 412
  <li>
  Q.6. Open update manager and expand "Current Configuration". Should see
- Alphabet Soup 1.1.0 configured, and the other 2 unconfigured (click the
+ Alphabet Soup 1.1.0 enabled, and the other 2 disabled (click the
  "Show disabled features").</li>
  </ul>
-Line 431
+Line 430
  Restart workbench when prompted.</font></li>
  <li>
- <font color="#000000">R.3. click of the "Alphaber Soup" tool button and
+ <font color="#000000">R.3. click of the "Alphabet Soup" tool button and
  interact with "Alphabet Soup" menu to see new round letters (D and G).
  <b>Note:</b>
- may need to go to Window> Costomize Perspective...> Other and select the
+ may need to go to Window> Customize Perspective...> Other and select the
  action sets for the new letters</font></li>
  <li>
- <font color="#000000">R.4. expand Current Configuration ans verify the
+ <font color="#000000">R.4. expand Current Configuration and verify the
  new feature is showing as configured.</font></li>
  <li>
- <font color="#000000">R.4. close the update manager and shut down the workbench</font></li>
+ <font color="#000000">R.5. close the update manager and shut down the workbench</font></li>
+ <li>
+ R.6. As an alternative, try to install several extension features at once using
+ group install. For each feature you want to add, check the checkbox at the
+ bottom of the Preview for that feature. When done, go to 'Selected Updates' view
+ and process all the pending jobs. A multi-install wizard should guide you
+ through the installation.</li>
  </ul>
  <h4>
-Line 458
+Line 464
  <li>
  <font color="#000000">S.1. Set up a new install directory somewhere in
  your file system. Create eclipse/ subdirectory under it. U</font>nzip the
- Aplhabet Soup Straight Letters extension&nbsp; from <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/native/my.alphabet.more.straight.letters_1.0.0.zip">my.alphabet.more.straight.letters_1.0.0.zip</a>&nbsp;
+ Alphabet Soup Straight Letters extension&nbsp; from <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/native/my.alphabet.more.straight.letters_1.0.0.zip">my.alphabet.more.straight.letters_1.0.0.zip</a>&nbsp;
  into the eclipse/ subdirectory. You should end up with</li>
  <ul>
-Line 487
+Line 493
  <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  plugins/</ul>
- <li>
+ <li>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;
+ and add a single line into it</li> <br>
- and add a single line into it</li>
+ <br>
+ <font face="Courier New">&nbsp;&nbsp;&nbsp; <font size="2">path=&lt;some new
- <br>&nbsp;
+ install directory&gt; </font></font>
- <p>&nbsp;
- <br>&nbsp;
- <br>&nbsp;
- <br>&nbsp;
- <br>&nbsp;
- <p>path=&lt;some new install directory>
  <p><b>Note</b>: the path should be an absolute path using local file system
  syntax. The .link file is loaded as a Java properties file, so on Windows
- you need to double up the back-slashes (eg. path=c:\\temp\\install)
+ you need to double up the back-slashes (e.g. path=c:\\temp\\install) </li>
  <li>
- S.4. start eclipse (Alphabet Soup). You'll see the splash comming up twice
+ S.4. start eclipse (Alphabet Soup). You'll see the splash coming up twice
- as the platfrom is updating the configuration. Workbench will come up,
+ as the platform is updating the configuration. Workbench will come up,
  with a dialog informing you have changes. Click [OK] to open the update
  manager change dialog.</li>
 Line 526
  S.8. Open update manager and expand "Current Configuration". Should see
  a new site representing the extension install, and it should contain the
  extension feature you've installed.</li>
+ <li>
+ S.9. Click on the new extension, and disable it in the Preview view. After
+ restart, verify that all the features and plug-ins from the extension are
+ missing. Enable it and verify that they are back after the restart.</li>
  </ul>
  <h4>
-Line 558
+Line 562
  <li>
  <font color="#000000">T.5. click of the "Alphabet Soup" tool button and
  interact with "Alphabet Soup" menu to see new numbers (3 and 5). <b>Note:</b>
- may need to go to Window> Costomize Perspective...> Other and select the
+ may need to go to Window> Customize Perspective...> Other and select the
  action sets for the new numbers</font></li>
  <li>
- <font color="#000000">T.6. expand Current Configuration ans verify the
+ <font color="#000000">T.6. expand Current Configuration and verify the
  new feature is showing as configured in the original install site</font></li>
  <li>
-Line 584
+Line 588
  directory</font></li>
  </ul>
+ <h2>
+ Part 3: Optional features and e-fixes</h2>
+ <h3>
+ Setup:</h3>
+ <p>Available sites:</p>
+ <ul>
+ <li>
+ <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/index.html">http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/optionalSite/</a></li>
+ </ul>
+ <p>The above site contains pre-built features used as part of the following
+ scenario steps.<br>&nbsp; </p>
+ <table BORDER COLS=1 WIDTH="100%" >
+ <tr>
+ <td>
+ <center>
+ <p><b><font color="#FF0000">*** PLEASE READ *** PLEASE READ *** PLEASE
+ READ *** PLEASE READ ***</font></b></p>
+ </center>
+ </td>
+ </tr>
+ <tr>
+ <td><font color="#000000">When opening Bugzilla defects, use the Platform/Update
+ component. Please ALWAYS specify the failing scenario step, and include
+ a .zip of the &lt;workspace>/.metadata/ directory. Note that we ran out of
+ letters, so we are starting from A again. You need to include the part number
+ when specifying steps (e.g. 3.A7)</font></td>
+ </tr>
+ </table>
+ <h3>
+ Description:</h3>
+ <p>The Optional Site is a simple site that contains several versions of the
+ 'Root' feature. The feature includes another feature (XYZBogus) that in turn
+ includes features XYZ and Bogus. The last two features are included as optional,
+ which means that users can elect not to install them. Several interesting
+ consequences result from this capability, and this part deals with them.</p>
+ <p>The site also contains several e-fixes. E-fix is a feature that is designed
+ to patch another feature with an exact ID and version. It is used to deliver
+ temporary fixes between full root updates.</p>
+ <h2>A. Installing feature Root 1.0.0</h2>
+ <p>A1. Open Update Manager. Create a bookmark with the URL listed above.<br>
+ A2. Expand the new node and select feature Root 1.0.0. Press 'Install' button in
+ the Preview view.<br>
+ A3. Accept the license in the License page.<br>
+ A4. Uncheck 'XYZ 1.0.0' optional feature in the Optional Features page. Leave
+ 'Bogus 1.0.0' feature selected.<br>
+ A5. Install (accept unsigned feature). Restart.<br>
+ A6. Verify that 'Root 1.0.0' feature has been installed and that 'XYZ 1.0.0' is
+ missing. <br>
+ A7. Toggle the view button so that disabled features are visible. Verify that
+ 'XYZ 1.0.0' is shown and marked as '(not installed')<br>
+ A8. If you want to stop being warned about unsigned features, toggle the option
+ off in the Install/Update preferences. Verify that you are warned about the
+ consequences (rogue features deleting your entire hard drive and such).</p>
+ <h2>B. Updating Root 1.0.0 to Root 1.0.1</h2>
+ <p>B1. Open Update Manager. Expand 'Optional site' bookmark created in scenario
+ A and select 'Root 1.0.1'. Verify that Preview view shows 'Update' button. Press
+ it.<br>
+ B2. After accepting the license, verify that features 'XYZBogus' and 'Bogus' are
+ checked&nbsp; and grayed out in 'Optional Features' page, while 'XYZ' plug-ins is
+ unchecked (leave it unchecked). Install and restart.<br>
+ B3. Verify that we now have Root 1.0.1 installed that is still without XYZ
+ feature (XYZ 1.0.1 shows as 'not installed' when disabled features are shown in
+ the view).</p>
+ <h2>C. Preserving the state of the optional feature</h2>
+ <p>C1. Close Eclipse. Manually delete all 'com.example.*' features from the
+ features/ directory and all 'com.example.*' plug-ins from the plugins/
+ directory. Delete the '.config' directory in the .metadata directory of the
+ workspace (you want to preserve the bookmark).<br>
+ C2. Repeat scenario A but this time leave all the optional features selected.<br>
+ C3. Restart and open current configuration. Verify that all the features are
+ showing as enabled.<br>
+ C4. Select 'XYZ 1.0.0' feature and select 'Disable' button in the preview.
+ Restart.<br>
+ C5. Verify that 'XYZ 1.0.0' feature is now disabled in the 'Root 1.0.0'
+ hierarchy (you will need to make disabled features visible in the view to do
+ that).<br>
+ C6. Move to the Updates view and find Root 1.0.1 feature in 'Optional Site'
+ bookmark. Click on 'Update' button.<br>
+ C7. After accepting the license, leave all settings default and install the new
+ version. Restart.<br>
+ C8. Verify that 'Root 1.0.1' is now installed, and that 'XYZBogus 1.0.1' and
+ 'Bogus 1.0.1' are showing in the hierarchy. Also verify that 'XYZ 1.0.1' is <b>
+ installed but disabled </b>(we are testing whether the original state of XYZ
+.0.0 was preserved during the update). The expected outcome is that the new
+ version of XYZ is installed but it remains disabled as before.</p>
+ <h2>D1. Installing the missing optional feature (from the originating site)</h2>
+ <p>D1.1. Repeat cleanup as in C1.<br>
+ D1.2. Repeat the scenario A.<br>
+ D1.3. After the restart, go back to the Updates view and select Root 1.0.0
+ again. Verify that the action button is visible and that the label is &quot;Change&quot;.
+ Press it.<br>
+ D1.4. When in 'Optional Features' wizard page, ensure that 'Bogus 1.0.0'
+ optional feature is checked and grayed out. Select 'XYZ 1.0.0' feature. Finish
+ the install. Restart.<br>
+ D1.5. Verify that we now have all the features in 'Root 1.0.0' hierarchy in the
+ current configuration.</p>
+ <h2>D2. Installing the missing optional feature (using the saved originating
+ site URL)</h2>
+ <p>D2.1. After finishing D1., delete XYZ 1.0.0 feature and XYZ 1.0.0 plug-in
+ manually from <b>features</b> and <b>plugins</b> directories, respectively.<br>
+ D2.2. After restart, open Update Manager and toggle 'Show Disabled Features'
+ button on the 'Configuration' view. Select 'XYZ 1.0.0' feature object (should be
+ shown as 'not installed').<br>
+ D2.3. Verify that the 'Install' button is shown in the Details view. Press it.<br>
+ D2.4. When the install wizard shows up, follow it until XYZ 1.0.0 plug-in is
+ installed. <font color="#0000FF">Cool: missing optional feature reference has a
+ preserved URL of the originating site that it can use to reconnect and install
+ it later.</font></p>
+ <h2>E. Discovering missing optional feature</h2>
+ <p>E1. Manually copy 'com.example.xyz_1.0.0' from 'features' directory and
+ 'com.example.xyz_1.0.0' from 'plugins' directory into a temp. place. After that,
+ repeat cleanup as in C1.<br>
+ E2. Repeat the scenario A and verify that XYZ 1.0.0 is missing from the
+ configuration (shown as 'not installed').<br>
+ E3. Close Eclipse. Manually copy 'com.example.xyz_1.0.0' feature from the temp.
+ space into the 'features' directory and 'com.example.xyz_1.0.0' plug-in from the
+ temp. space into the 'plugins' directory. Start Eclipse.<br>
+ E4. Verify that no dialog was shown and that feature XYZ 1.0.0 was detected and
+ configured into the hierarchy of 'Root 1.0.0'.</p>
+ <h2>F. Installing missing optional features natively after updates</h2>
+ <p>F1. Repeat preservation + cleanup as in E1.<br>
+ F2. Repeat the scenario A.<br>
+ F3. Run the 'one-click' update (Help-&gt;Software Updates-&gt;New Updates). The wizard
+ should discover feature 'Root 1.0.1'. Accept the license and finish install.
+ Restart.<br>
+ F4. At this point, we should have installed Root 1.0.1 with XYZBogus 1.0.1 and
+ Bogus 1.0.1, but not XYZ 1.0.1 (not installed because we didn't have XYZ 1.0.0
+ and one-click update should only update installed software).<br>
+ F5. Manually copy feature XYZ 1.0.0 from the temp space and plug-in XYZ 1.0.0
+ from the temp space as in E3. <br>
+ F6. At this point, verify that XYZ 1.0.0 is present in the hierarchy of XYZ
+.0.0 but disabled because Root 1.0.0 is disabled.<br>
+ F7. Run the 'one-click' update again as in F3. It should discover XYZ 1.0.1
+ again because we now have previous version of XYZ and it can now bring it up to
+.0.1<br>
+ F8. Verify in the configuration that XYZ 1.0.1 is now installed and enabled.</p>
+ <p><font color="#0000FF">Note: as you go through the the scenarios G, H and I
+ that deal with e-fixes, it is recommended to increase the coverage by switching
+ between multiple workspaces (install couple of e-fixes, then start with a new
+ workspace, install some more, create a new workspace, install some more, than
+ switch back to the first one). Since state is stored in each workspace, that
+ will give Update an additional workout to reconcile its state with changes in
+ the file system (both partial and full reconcilers will kick in).</font></p>
+ <h2>G1. Cumulative patches</h2>
+ <p>G1.1 Repeat steps C1, C2 and C3 to install Root 1.0.0 feature hierarchy.
+ Verify that all Root features (including optional ones) are installed.<br>
+ G1.2 Expand optional site bookmark in Updates and locate folder &quot;Emergency
+ Fixes&quot;. Locate feature EFIX e334 1.0.0. Select it and install it.<br>
+ G1.3 After restart, verify that EFIX e334 has been installed and that it
+ includes XYZ 1.0.0.e334. The same XYZ feature should be included by Root
+.0.0-&gt;XYZ Bogus 1.0.0 (should show up arrow indicating branch update). There
+ should be no errors or warnings.<br>
+ G1.4 Expand optional site bookmark in Updates and locate folder &quot;Emergency
+ Fixes&quot;. Locate feature EFIX e335 1.0.0. Select it and install it. <i>Note: e335
+ is a cumulative fix because it fixes a problem in XYZ 1.0.0 and also includes a
+ fix in e334.<br>
+ </i>G1.5 After restart, verify that e335 has been installed and that it includes
+ XYZ 1.0.0.e335. The same XYZ feature should be included by Root 1.0.0-&gt;XYZ Bogus
+.0.0 (should show up arrow indicating branch update).&nbsp;<br>
+ G1.6 <b>The same XYZ 1.0.0.e335 should also show up as a child of EFIX e334</b>.
+ The interpretation is that XYZ 1.0.0.e335 also includes a fix for e334, so the
+ fact that the previous version has been disabled does not invalidate EFIX e334.</p>
+ <h2>G2. Patches that include other patches</h2>
+ <p>G2.1. Repeat steps C1, C2 and C3 to install Root 1.0.0 feature hierarchy.
+ Verify that all Root features (including optional ones) are installed.<br>
+ G2.2. Expand optional site bookmark in Updates and locate folder 'Emergency
+ Fixes'. Locate feature EFIX e452 1.0.0. Select it and install it.<br>
+ G2.3. After restart, verify that: EFIX e452 is installed; its child feature e388
+ should include Bogus Feature 1.0.0.e388. The same Bogus Feature should be
+ included by Root 1.0.0 hierarchy. There should be no errors or warnings.<br>
+ G2.4. Expand 'Saved Configurations' folder. Verify that a backup configuration
+ for e452 has been created (backup configurations have label in format &quot;@&lt;id_version&gt;&nbsp;
+ backup&quot;.</p>
+ <h2>H. Updating feature branches with partial patch cleanup</h2>
+ <p>H1. After installing patch e452 in scenario G2, search for new updates by
+ selecting 'Window-&gt;Updates-&gt;New Updates'. <br>
+ H2. When the update wizard comes up with the results, uncheck the checkbox
+ 'Filter features included ...'. Uncheck &quot;Root 1.0.1&quot; and check &quot;XYZBogus 1.0.1&quot;
+ from the list of search results. <font color="#0000FF">Cool: this demonstrates
+ how branches in the feature hierarchy can be individually updated.</font><br>
+ H3. Accept the license agreement and install the feature.<br>
+ H4. After restart, verify that Root 1.0.0 now includes XYZBogus 1.0.1 (<font color="#0000FF">Cool:
+ XYZBogus 1.0.1 image should have an upward pointing arrow overlay indicating
+ that the feature has been updated from the original version specified in the
+ Root 1.0.0 manifest</font>). Also verify that e388 does not show up anywhere,
+ but EFIX e452 should still be present in the configuration.</p>
+ <p><font color="#0000FF">Note: Technically, since EFIX e452 includes EFIX e388
+ and since e388 is now disabled because XYZBogus 1.0.1 is updated, EFIX e452
+ should show error status (missing included feature). Update performs additional
+ computation in this case to find if e452 is really broken. The fact is that even
+ though the referenced feature e388 is disabled, it is a patch for XYZBogus 1.0.0
+ which has since been upgraded. Updates makes a (daring) assumption that a formal
+ update for a feature includes all the patches published for a previous version
+ of that feature. In this particular case, Update assumes that XYZBogus 1.0.1,
+ being an update to XYZBogus 1.0.0, contains all the fixes registered for
+ XYZBogus 1.0.0, including e388. It concludes that EFIX e452 will indirectly
+ satisfy its need for e388 through XYZBogus 1.0.1 code.</font></p>
+ <h2>I. Updating feature root with patch cleanup</h2>
+ <p>I1. After updating XYZBogus in scenario H, search for updates again. This
+ time, accept the default (Root 1.0.1) and install it.<br>
+ I2. After restart, verify that Root 1.0.1 is installed and that all the included
+ features are version 1.0.1. Also verify that there are no e-fixes left enabled
+ in the configuration.<br>
+ I3. Open file &quot;.install-log&quot; in &lt;workspace&gt;/.metadata/.config/ and verify that
+ it contains logs of all the activities performed in scenarios G, H and I.</p>
+ <h2>J. Handling cross-site version conflicts</h2>
+ <p>The role of this scenario is to show how cross-site conflicts are handled.
+ Cross-site conflicts are caused by root features in separate install sites that
+ include features of the same ID but different versions. Since both features will
+ be configured and their plug-ins contributed to the Eclipse runtime, runtime
+ will resolve the duplication by selecting plug-ins with the higher version.
+ Update warns about this 'silent' upgrade when an attempt is made to install or
+ update a feature that can cause such a conflict to appear.</p>
+ <ul>
+   <li>Available sites:
+ <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/index.html">http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/extensionSite/</a></li>
+ </ul>
+ <p>J1. Repeat cleanup as in C1.<br>
+ J2. Select &quot;Optional Site&quot; bookmark as in A1 and install Root 1.0.0 with all the
+ optional features. Restart.<br>
+ J3. Add another bookmark called &quot;Extension Site&quot; with the URL as shown above.<br>
+ J4. Expand the bookmark object and select feature &quot;Root Extension 1.0.0&quot;. Press
+ &quot;Install&quot; button.<br>
+ J5. Accept the license and select both the optional features for install.<br>
+ J6. Do not accept the default target install site. Instead, create a new one by
+ pressing &quot;Add&quot; button. Choose a location outside the Eclipse product tree
+ (anywhere else on the disk). Press &quot;Finish&quot;. Restart.<br>
+ J7. Verify that the current configuration has two install sites. The first one
+ should contain Eclipse features and Root 1.0.0. The second one (the one you
+ picked in J6) should contain Root Product Extension 1.0.0. There should be no
+ conflicts.<br>
+ J8. Search for new updates by selecting &quot;Window-&gt;Updates-&gt;New Updates&quot;. You
+ should get two results: Root 1.0.1 and Root Extension 1.0.1. Uncheck Root 1.0.1.
+ Press &quot;Next&quot; and accept all other default settings until &quot;Finish&quot; is enabled.
+ Press Finish&quot;.<br>
+ J9. Verify that a warning dialog is opened explaining the conflict. The conflict
+ should be caused by XYZ and Bogus features that will be 1.0.0 in one site and
+.0.1 in another if the update proceeds. Answer &quot;No&quot;.<br>
+ J10. Return back to the first page of the wizard and select both results (Root
+.0.1 and Root Extension 1.0.1). Advance to the last page and press &quot;Finish&quot;
+ again. This time, there should be no conflicts because both XYZ and Bogus
+ features will be simultaneously updated to version 1.0.1.<br>
+ J11. After restart, verify that the current configuration shows no warning
+ overlays.</p>
+ <h2>I. Web-triggered updates</h2>
+ <p>Update Manager has a neat feature whereby it can run a Web application and
+ accept calls from a browser with the right URL. Tasks like presentation, search,
+ classification, user verification etc. can all be handled by the provider's web
+ site (presumably running a Web application itself). Features and plug-ins are
+ still in the standard update sites, but these sites are used as feature servers.
+ When users click on 'Download' or similar buttons or links, a URL query is
+ composed and sent to Eclipse with the Update Web application running. Update
+ servlet receives the query and initiates the install process. At this point, we
+ are in the familiar install wizard.</p>
+ <ul>
+   <li>Available sites:
+ <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/site/index.html">http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-update-home/optionalSite/index.html</a></li>
+ </ul>
+ <p>I1. Repeat the cleanup as in C1.<br>
+ I2. Open &quot;Preferences&quot; dialog and select &quot;Install/Update-&gt;Web-triggered updates&quot;
+ page. Turn the web application on. When pressing &quot;OK&quot; there will be a couple of
+ seconds delay (starting the Tomcat server).<br>
+ I3. Open Update Manager and create a new site bookmark using the URL listed
+ above. When in the wizard, choose the non-default 'Web site' bookmark type.
+ Finish.<br>
+ I4. Double-click on the bookmark to cause the External Preview view to open
+ (note: this is only on Windows; on other platform, the page will open in a
+ standalone Web browser).<br>
+ I5. You should see a page with two Download buttons. Press on the Download
+ button for Root 1.0.0. Verify that a progress monitor dialog opens while
+ connecting to the feature server. Eventually, Install Wizard should show up.
+ Follow it to install Root 1.0.0.<br>
+ I6. After restart, double-click on the Web link again and click on the
+ 'Download' button for Root 1.0.0. This time, a problem response page should show
+ up indicating that the requested feature is already installed.<br>
+ I7. Click on the 'Download' button for the feature Root 1.0.1. This one should
+ be treated as an update. Follow it to the end and restart.<br>
+ I8. Verify that the configuration shows the correct features.</p>
  </body>
  </html>

 Legend:



Removed from v.1.11
 


changed lines


 
Added in v.1.12
 Legend:



Removed from v.1.11
 


changed lines


 
Added in v.1.12
-Removed from v.1.11
+Added in v.1.12

help@eclipse.org	ViewVC Help
Powered by ViewVC 1.0.3