platform-update-home/doc/validator/validator.html
Parent Directory
| 
Revision Log
Revision 1.1 - (view) (download) (as text)
| 1 : | dbirsan | 1.1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 : | <html> | ||
| 3 : | <head> | ||
| 4 : | <title>Validation tool for eclipse features and plugins</title> | ||
| 5 : | |||
| 6 : | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | ||
| 7 : | |||
| 8 : | |||
| 9 : | <link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" | ||
| 10 : | type="text/css"> | ||
| 11 : | </head> | ||
| 12 : | <body bgcolor="#ffffff" text="#000000"> | ||
| 13 : | |||
| 14 : | <h4>Validation Tool for Eclipse Features and Plugins</h4> | ||
| 15 : | |||
| 16 : | <address>Contributed by George Voutsinas <a href="mailto:(voutsin@ca.ibm.com">(voutsin@ca.ibm.com</a>)</address> | ||
| 17 : | |||
| 18 : | |||
| 19 : | <p> <br> | ||
| 20 : | This tool is designed to validate the installed image of an Eclipse based | ||
| 21 : | product. The primary goal is to ensure that the installed product can be | ||
| 22 : | serviced via the Eclipse Update Manager successfully after deployed. No | ||
| 23 : | modifications are made to the product, and only the feature.xml, plugin.xml, and | ||
| 24 : | fragment.xml files are processed.<br> | ||
| 25 : | <br> | ||
| 26 : | Parameters:</p> | ||
| 27 : | <table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="100%" id="AutoNumber1"> | ||
| 28 : | <tr> | ||
| 29 : | <td width="20%" bgcolor="#C0C0C0">-main <drive>:\location </td> | ||
| 30 : | <td width="50%" bgcolor="#C0C0C0">Location of your features/plugins folders. | ||
| 31 : | These locations contain the features and plug-ins that need to be verified.<br> | ||
| 32 : | You can specify multiple "-main" parameters if your product is installed | ||
| 33 : | into multiple locations.</td> | ||
| 34 : | </tr> | ||
| 35 : | <tr> | ||
| 36 : | <td width="20%" bgcolor="#FFFFFF">-base <drive>:\location</td> | ||
| 37 : | <td width="50%" bgcolor="#FFFFFF">Location of a dependent product that we | ||
| 38 : | don't want to verify, but contains features our product references. This | ||
| 39 : | location is only parsed<br> | ||
| 40 : | to verify that everything our product requires, exists.</td> | ||
| 41 : | </tr> | ||
| 42 : | <tr> | ||
| 43 : | <td width="20%" bgcolor="#C0C0C0">-log <drive>:\location</td> | ||
| 44 : | <td width="50%" bgcolor="#C0C0C0">Location of log file. If this parameter is | ||
| 45 : | not specified, the log is dumped to the console.</td> | ||
| 46 : | </tr> | ||
| 47 : | </table> | ||
| 48 : | <p><br> | ||
| 49 : | An example of WSAD verify:</p> | ||
| 50 : | <p>Check that all features/plugins are installed in wstools folder and they | ||
| 51 : | require the wswb features installed in the eclipse folder: -main c:\wsad\wstools | ||
| 52 : | -base <a href="file:///c:/wsad/eclipse">c:\wsad\eclipse</a><br> | ||
| 53 : | </p> | ||
| 54 : | <p>Here are some of the checks the tool performs:</p> | ||
| 55 : | <h4>Feature testing: | ||
| 56 : | </h4> | ||
| 57 : | <ul> | ||
| 58 : | <li>verifies that all the feature.xml's are well formed. | ||
| 59 : | </li> | ||
| 60 : | <li>verifies that all the "include" features, included by each feature can be | ||
| 61 : | resolved. Optional features don't need to be there for this test to pass. </li> | ||
| 62 : | <li>verifies that all the plugin's owned by a feature exist. No exceptions. | ||
| 63 : | </li> | ||
| 64 : | <li>verifies that all features have a parent feature. Only patches and features | ||
| 65 : | that have an Update URL are exempt. I think this means everything is | ||
| 66 : | serviceable. </li> | ||
| 67 : | </ul> | ||
| 68 : | <h4>Plug-in testing: | ||
| 69 : | </h4> | ||
| 70 : | <ul> | ||
| 71 : | <li>verifies that all plugin or fragment xml's are valid or exist. Although | ||
| 72 : | folders can exist in the plugin structure with no xml, we try to avoid this. | ||
| 73 : | </li> | ||
| 74 : | <li>verifies that all plug-in's have a parent feature. This is the only way to | ||
| 75 : | make sure they can be serviced. | ||
| 76 : | Verify that all plug-in's have a SINGLE parent feature. Just to be safe. | ||
| 77 : | </li> | ||
| 78 : | </ul> | ||
| 79 : | <h4>Product testing: | ||
| 80 : | </h4> | ||
| 81 : | <ul> | ||
| 82 : | <li>verifies that all features are unique across the entire product. | ||
| 83 : | </li> | ||
| 84 : | <li>verifies that all plug-ins are unique across the entire product. | ||
| 85 : | </li> | ||
| 86 : | <li>verifies that all "require" features, required by each feature can be | ||
| 87 : | resolved. If my WDSC feature requires wswb2.1.1, then it should exist. It also require the versions to match and ignore any of the "match" | ||
| 88 : | variables. Yes, we're just being overly specific. </li> | ||
| 89 : | <li>verifies that all required plug-ins, required by each feature, can be | ||
| 90 : | resolved. Again, we're being VERY specific, so versions matter. </li> | ||
| 91 : | <li>lastly, build a feature hierarchy. This just lets you see how things | ||
| 92 : | are organized, and if there's a loop anywhere in the dependencies, it should | ||
| 93 : | be caught. </li> | ||
| 94 : | </ul> | ||
| 95 : | <p>Happy testing :-)</p> | ||
| 96 : | <p> </p> | ||
| 97 : | |||
| 98 : | |||
| 99 : | </body> | ||
| 100 : | </html> |
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |