Attachment 96616 Details for Bug 201892 – Patch.

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

[patch] Patch.

Defect_201892_patch.txt (text/plain), 80.70 KB, created by Paul Slauenwhite

on 2008-04-18 12:03:45 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Paul Slauenwhite

Created: 2008-04-18 12:03:45 EDT

Size: 80.70 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.hyades.test.doc.user
>Index: concepts/cartifacteditor.htm
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.hyades.test.doc.user/concepts/cartifacteditor.htm,v
>retrieving revision 1.5
>diff -u -r1.5 cartifacteditor.htm
>--- concepts/cartifacteditor.htm	3 May 2007 14:33:15 -0000	1.5
>+++ concepts/cartifacteditor.htm	18 Apr 2008 16:02:18 -0000
>@@ -2,7 +2,7 @@
> <html lang="en-us" xml:lang="en-us">
> 
> 
>-
> <head>
> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
> <link rel="StyleSheet" href="../css/book.css" type="text/css" />
> 
>-<title>Artifact Editor - overview</title>
>+<title>Editing an artifact</title>
> </head>
> 
> <body>
> 
>+<h1>Editing an artifact</h1>
> 
>-<h1>Artifact Editor - overview</h1>
>+Test artifacts are edited using the Artifact editor. The editor contains three tabs: 
> 
>-
>-Test artifacts associate objects such as test suites and datapools; that is,
>-artifacts make an asset available to a test suite. In the Artifact Editor,
>-there are initially two main tabs: Overview and Test Assets. 
>-A third tab, General Properties, appears after the artifact has been associated with a JUnit test.
>-
>-<img width="469" height="347"
>-	src="../images/creatingATestDeployment_image025.png" alt="" />
>-<h2>Overview Tab</h2>
>-
>-The General Information section provides the artifact's name, description, and its
>-path within the workspace.
>-
>-The Test Assets section shows the test elements associated with the artifact.
>-
>-The Property Groups section includes General Properties, and, if either 
>-of these is selected, this will instantiate an additional tab
>-named General Properties with content.
>-
>-
>-<h2>Test Assets Tab</h2>
>-In the Overview tab, clicking on the More... button, or selecting the Test Assets tab, results in the Test Assets
>-view being displayed. To add a test asset, click on the Add... button to bring up the Select Resource dialog. Navigate to a resource, select it, and click on OK.
>-The resource (in this example a TPTP JUnit test named SimpleTest.testsuite)
>-will be added to the Test Assets section. 
>-<img width="262" height="217"
>-	src="../images/creatingATestDeployment_image016.png" alt="" />You can add or remove test assets by using the Add...
>-or Remove buttons respectively. As we have seen, invoking Add...&nbsp; brings up the Select Resource dialog. To
>-remove an asset, select it by clicking on it, then press the Remove button.
>-
>-When there is more than one asset in the Test Assets section, their relative ordering can be modified by selecting an item within the list and
>-then pressing the Up or Down buttons to move the selected item up or down the list, respectively.
>-
>-If we return to the Overview tab view, we see that SimpleTest has been added
>- to the Test Assets section. Apart from the JUnit test suite, the test assets
>-should include any other resources required (for example, datapools). 
>-<h2>General Properties tab</h2>
>-The CLASSPATH is added to the General Properties section as a 
>-consequence of the artifact being associated with a JUnit test.
>-
>-In the Overview tab, either clicking on the CLASSPATH or the More... button in the General Properties section
>-of the Overview tab, selecting General Properties in the Property Groups section, or selecting the General Properties tab, all
>-result in the General Properties tab view being displayed. 
>-<img width="366" height="283" src="../images/creatingATestDeployment_image026.png" alt="" />
>-
>-Note that, while it is possible to add in further properties to the General Properties section, TPTP itself uses only the CLASSPATH
>-property. It may be that other applications can make use of additional properties, so, for completeness, we describe how to add, remove and edit such
>-properties.
>-
>-To add a new property, click on the Add... button. This launches the New Property dialog. 
>-<img width="436" height="126" src="../images/creatingATestDeployment_image027.png" alt="" />
>-
>-Enter your property name in the Property Name field, or select it from the drop-down list. 
>-<img width="436" height="140" src="../images/creatingATestDeployment_image028.png" alt="" />
>-
>-Select the Operator from =, !=, &gt;, &lt;, &gt;=, or &lt;= via the associated drop-down list
>- and insert the required value in the Property Value field.
>-
>-To edit an existing property, double-click on it to launch the Edit
>-Property dialog. 
>-<img width="436" height="126" src="../images/creatingATestDeployment_image029.png" alt="" />
>+<h2>Overview</h2>
> 
>-Then change the Property Name, Operator, or Property Value fields as required.
>+This tab provides an overview of the test artifact.
> 
>-To remove an existing property, select it then click on the Remove button.
>+This tab contains three sections:
> 
>-
>-Related concepts 
>-<a href="cdeployeditor.htm">Deployment Editor - overview</a> 
>-<a href="clocationeditor.htm">Location Editor - overview</a> 
>-
>+<ul>
>+	<li>
>+		General Information
>+		Contains the test artifact's name, description, and file path within the workspace. The test artifact's name1 and description are editable.
>+		 
>+	</li>
>+	<li>
>+		Property Groups
>+		Contains a link to the General Properties tab. Clicking the link will open the associated tab.
>+		 
>+	</li>
>+	<li>
>+		Test Assets
>+		Contains links to the test assets, such as test suites and datapools, in the Test Assets tab. Clicking a link or the More... button will
>+		open the Test Assets tab.
>+		 
>+	</li>
>+	<li>
>+		General Properties
>+		Contains links to the general properties in the General Properties tab. Clicking a link or the More... button will
>+		open the General Properties tab.
>+		 
>+		Note, the General Properties section will only appear if one or more general properties are associated with the test artifact.
>+		 
>+	</li>
>+</ul>
>+
>+[1] Test artifacts have a file name and logical name. The logical name is used in the Test Navigator, dialogs, editors, and wizards to represent the test artifact.
>+The file name represents the test artifact file (*.artifact) within the workspace. When the test artifact is created, the logical name defaults to the file name 
>+(excluding the .artifact file extension) and may be modified without modifying the file name. The logical name allows customization of the test artifact name 
>+without affecting the file name within the workspace.
>+
>+<h2>Test Assets</h2>
>+
>+This tab contains the list of test assets, such as test suites and datapools, associated with the test artifact.
>+
>+Test assets can be added to the list by clicking the Add... button and select the test assets.
>+
>+Selected test assets can be removed (Remove), moved up (Up), or moved down (Down).
>+
>+<h2>General Properties</h2>
>+
>+This tab contains the table of general properties associated with the test artifact. For example, the CLASSPATH general property contains local dependencies of the associated test suites.
>+
>+When a test suite is executed, the following dependencies are deployed to the target host: 
>+
>+<ul>
>+	<li>Dependencies on the class path of the project containing the test suite, excluding *.java, *.execution, *.testsuite, *.deploy, *.location, and *.artifact.</li>
>+	<li>Dependencies on the CLASSPATH general property.</li>
>+	<li>Test assets associated with the test artifact.</li>
>+</ul>
>+
>+Note, the General Properties tab will only appear if one or more general properties are associated with the test artifact.
>+
>+General properties can be added to the table by clicking the Add... button and entering the property name, operator (=, !=, &gt;, &lt;, &gt;=, or &lt;=), and value.
>+
>+All file paths are absolute and operating system dependent based on the local operating system.
>+
>+Selected general properties can be removed (Remove), moved up (Up), or moved down (Down). Existing general properties may be edited by double-clicking
>+the general property in the table and and modifying the property name, operator, and/or value.
> 
> 
> Related tasks 
> <a href="../tasks/tcreateartifact.htm">Creating an artifact</a> 
>-<a href="../tasks/tcreatetestdeployment.htm">Creating a deployment</a> 
>-<a href="../tasks/tcreatelocation.htm">Creating a location</a> 
>-<a href="../tasks/tassociateartifact.htm">Forming an artifact and location pairing</a> 
> 
> 
> </body>
>Index: concepts/clocationeditor.htm
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.hyades.test.doc.user/concepts/clocationeditor.htm,v
>retrieving revision 1.5
>diff -u -r1.5 clocationeditor.htm
>--- concepts/clocationeditor.htm	3 May 2007 14:33:15 -0000	1.5
>+++ concepts/clocationeditor.htm	18 Apr 2008 16:02:18 -0000
>@@ -2,7 +2,7 @@
> <html lang="en-us" xml:lang="en-us">
> 
> 
>-
> <head>
> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
> <link rel="StyleSheet" href="../css/book.css" type="text/css" />
> 
>-<title>Location Editor - overview</title>
>+<title>Editing a location</title>
> </head>
> 
> <body>
> 
>+<h1>Editing a location</h1>
> 
>-<h1>Location Editor - overview</h1>
>-
>-Test locations identify the computer where the test suite will run.
>-
>-
>-
>-<img width="473" height="392" src="../images/creatingATestDeployment_image018.png" alt="" />There are 3 tabs: Overview, General
>-Properties, and Eclipse Workbench Properties. The above screen capture shows the Overview tab information.
>-
>-<h3><a name="_Toc115944873"></a><a name="_Toc116098740"> Overview Tab</a></h3>
>-
>-The General Information section provides the location's name (testLocation here), Description ('A sample
>-location'), its path within the workspace (/java_01/testLocation.location), and the Host name (localhost).
>+Test locations are edited using the Location editor. The editor contains three tabs: 
> 
>-The default host name for the location is <kbd>localhost</kbd>. If the intention is to run on another computer, enter the name of that
>-computer in the Host name field.
>+<h2>Overview</h2>
> 
>-Property Groups references General Properties and Eclipse Workbench Properties sections, which are also separately shown on the
>-right-hand side of the Location editor overview tab view. Each&nbsp; references respectively the General Properties and Eclipse Workbench
>-Properties tabs. both reference the General Properties tab. Clicking on the More... button in either the General
>-Properties or Eclipse Workbench Properties sections switches to their respective tab views.
>+This tab provides an overview of the test location.
> 
>-<h3><a name="_Toc116098741">Eclipse Workbench Properties</a></h3>
>+This tab contains three sections:
>+
>+<ul>
>+	<li>
>+		General Information
>+		Contains the test location's name, description, file path within the workspace, and host name or IP address. The test location's name1, description, and host name or IP address are editable.
>+		 
>+		The connection to the target host may be tested by clicking the Test Connection link2.
>+		 
>+	</li>
>+	<li>
>+		Property Groups
>+		Contains a link to the General Properties and Eclipse Workbench Properties tab. Clicking a link will open the associated tab.
>+		 
>+	</li>
>+	<li>
>+		Eclipse Workbench Properties
>+		Contains links to the Eclipse Workbench properties in the Eclipse Workbench Properties tab. Clicking a link or the More... button will
>+		open the Eclipse Workbench Properties tab.
>+		 
>+		Note, the Eclipse Workbench Properties section will only appear if one or more Eclipse Workbench properties are associated with the test location.
>+		 
>+	</li>
>+	<li>
>+		General Properties
>+		Contains links to the general properties in the General Properties tab. Clicking a link or the More... button will
>+		open the General Properties tab.
>+		 
>+		Note, the General Properties section will only appear if one or more general properties are associated with the test location.
>+		 
>+	</li>
>+</ul>
>+
>+[1] Test locations have a file name and logical name. The logical name is used in the Test Navigator, dialogs, editors, and wizards to represent the test location.
>+The file name represents the test location file (*.location) within the workspace. When the test location is created, the logical name defaults to the file name 
>+(excluding the .location file extension) and may be modified without modifying the file name. The logical name allows customization of the test location name 
>+without affecting the file name within the workspace.
>+
>+[2] The <a href="../../org.eclipse.tptp.platform.agentcontroller.doc.user/concepts/ac/c_ac_ovr.html">Agent Controller</a> or 
>+<a href="../../org.eclipse.tptp.platform.agentcontroller.doc.user/concepts/ac/ciacintro.html">Integrated Agent Controller</a> 
>+(local host only) is required to be configured and running.
>+
>+<h2>General Properties</h2>
>+
>+This tab contains the table of general properties associated with the test location. For example, the CLASSPATH general property contains 
>+dependencies on the target host.
>+
>+In addition, the ROOTDIR general property contains absolute path of the directory on the target host where 
>+the dependencies configured in <a href="../concepts/cartifacteditor.htm">Artifact editor</a> are deployed when a test suite is executed. If the 
>+ROOTDIR general property is not provided or invalid for the target host, the dependencies are deployed to a temporary directory on the target host.
>+
>+Note, the General Properties tab will only appear if one or more general properties are associated with the test location.
>+
>+General properties can be added to the table by clicking the Add... button and entering the property name, operator (=, !=, &gt;, &lt;, &gt;=, or &lt;=), and value.
>+
>+All file paths are absolute and operating system dependent based on the target operating system.
>+
>+Selected general properties can be removed (Remove), moved up (Up), or moved down (Down). Existing general properties may be edited by double-clicking
>+the general property in the table and and modifying the property name, operator, and/or value.
> 
>-This is concerned with the setting of properties relating to the deployment of a TPTP JUnit Plug-in Test. It is covered in the help documentation
>-describing TPTP JUnit Plug-in Test.
>+<h2>Eclipse Workbench Properties</h2>
> 
>-<h3><a name="_Toc116098742">General Properties</a></h3>
>+This tab contains the table of Eclipse Workbench properties associated with the test location, as defined in the <a href="../../org.eclipse.pde.doc.user/guide/tools/preference_pages/target_platform.htm">Target Platform</a>. 
> 
>-
>-The functionality available here is identical to that described for the General Properties tab in the Artifact Editor.
>-
>+Note, the Eclipse Workbench Properties tab will only appear if one or more Eclipse Workbench properties are associated with the test location.
> 
>-
>-Related concepts 
>-<a href="cartifacteditor.htm">Artifact Editor - overview</a> 
>-<a href="cdeployeditor.htm">Deployment Editor - overview</a> 
>-
>+All file paths are absolute and operating system dependent based on the target operating system.
> 
> 
> Related tasks 
>-<a href="../tasks/tcreateartifact.htm">Creating an artifact</a> 
>-<a href="../tasks/tcreatetestdeployment.htm">Creating a deployment</a> 
> <a href="../tasks/tcreatelocation.htm">Creating a location</a> 
>-<a href="../tasks/tassociateartifact.htm">Forming an artifact and location pairing</a> 
> 
> 
>-
> </body>
> 
> </html>
>Index: concepts/cdeployeditor.htm
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.hyades.test.doc.user/concepts/cdeployeditor.htm,v
>retrieving revision 1.5
>diff -u -r1.5 cdeployeditor.htm
>--- concepts/cdeployeditor.htm	3 May 2007 14:33:15 -0000	1.5
>+++ concepts/cdeployeditor.htm	18 Apr 2008 16:02:18 -0000
>@@ -2,7 +2,7 @@
> <html lang="en-us" xml:lang="en-us">
> 
> 
>-
> <head>
> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
> <link rel="StyleSheet" href="../css/book.css" type="text/css" />
> 
>-<title>Deployment Editor - overview</title>
>+<title>Editing a deployment</title>
> </head>
> 
> <body>
> 
>+<h1>Editing a deployment</h1>
> 
>-<h1>Deployment Editor - overview</h1>
>-
>-The Deployment editor associates test artifacts with test locations.
>-There are 2 main tabs in the editor: Overview and Pairs. 
>-
>-
>-<h2>Overview Tab</h2>
>-
>-The General Information section provides the deployment's name, description,
>-and its path within the workspace.
>-
>-The Artifacts and Locations sections are subsequently 
>-associated with the deployment.
>-<img border="1" src="../images/deploy_editor.gif" width="492"
>-	height="423" alt=""/>
>-	
>-<h2>Pairs Tab</h2>
>+Test deployments are edited using the Deployment editor. The editor contains three tabs: 
> 
>-The Pairs tab is used to add Artifacts and Locations and to form Artifact Location pairs. 
>-<img border="0" src="../images/creatingATestDeployment_image010.gif"
>-	width="514" height="358" alt=""/>
>+<h2>Overview</h2>
> 
>-<h2>Locations</h2>
>+This tab provides an overview of the test deployment.
> 
>-The functionality available here is identical to that described for the General Properties tab in the artifact editor.
>-
>-
>-Related concepts 
>-<a href="cartifacteditor.htm">Artifact Editor - overview</a> 
>-<a href="clocationeditor.htm">Location Editor - overview</a> 
>-
>+This tab contains three sections:
>+
>+<ul>
>+	<li>
>+		General Information
>+		Contains the test deployment's name, description, and file path within the workspace. The test deployment's name1 and description are editable.
>+		 
>+	</li>
>+	<li>
>+		Test Artifacts
>+		Contains links to the test artifacts in the Pairs tab. Clicking a link or the More... button will open the Pairs tab.
>+		 
>+	</li>
>+	<li>
>+		Test Locations
>+		Contains links to the test locations in the Pairs tab. Clicking a link or the More... button will open the Pairs tab.
>+		 
>+	</li>
>+	<li>
>+		Test
>+		Contains the test suites associated with the test artifacts.
>+		 
>+	</li>
>+</ul>
>+
>+[1] Test deployments have a file name and logical name. The logical name is used in the Test Navigator, dialogs, editors, and wizards to represent the test deployment.
>+The file name represents the test deployment file (*.deploy) within the workspace. When the test deployment is created, the logical name defaults to the file name 
>+(excluding the .deploy file extension) and may be modified without modifying the file name. The logical name allows customization of the test deployment name 
>+without affecting the file name within the workspace.
>+
>+<h2>Pairs</h2>
>+
>+This tab pairs test artifacts and test locations for executing a test suite.
>+
>+This tab contains three sections:
>+
>+<ul>
>+	<li>
>+		Artifacts
>+		Contains the test artifacts associated with the test deployment.
>+		 
>+		Test artifacts can be added to the list by clicking the Add... button and selecting the test artifacts or creating a <a href="../tasks/tcreateartifact.htm">new test artifact</a>.
>+		 
>+		Selected test artifacts can be removed (Remove), moved up (Up), moved down (Down), or opened in the Artifact editor (Open...).
>+		 
>+	</li>
>+	<li>
>+		Locations
>+		Contains the test locations associated with the test deployment.
>+		 
>+		Test locations can be added to the list by clicking the Add... button and selecting the test locations or creating a <a href="../tasks/tcreatelocation.htm">new test location</a>.
>+		 
>+		Selected test locations can be removed (Remove), moved up (Up), moved down (Down), or opened in the Location editor (Open...).
>+		 
>+	</li>
>+	<li>
>+		Artifact Location Pairs
>+		 
>+		Contains the pairs test artifacts and test locations for executing a test suite.
>+		 
>+		Create pairs of test artifacts and test locations by selecting a test artifact in the Artifacts list and a test location in the Locations list and clicking the down-arrow button (<img border="0"
>+	src="../images/downArrow.gif" width="16" height="16" alt="Image of down arrow."/>).
>+		 
>+	 Selected pairs of test artifacts and test locations can be removed (Remove), moved up (Up), or moved down (Down).
>+		 
>+	</li>
>+</ul>
> 
> 
> Related tasks 
> <a href="../tasks/tcreateartifact.htm">Creating an artifact</a> 
>-<a href="../tasks/tcreatetestdeployment.htm">Creating a deployment</a> 
> <a href="../tasks/tcreatelocation.htm">Creating a location</a> 
>-<a href="../tasks/tassociateartifact.htm">Forming an artifact and location pairing</a> 
>+<a href="../tasks/tcreatetestdeployment.htm">Creating a deployment</a> 
> 
> 
> </body>
>Index: tasks/tcreatetestdeployment.htm
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.hyades.test.doc.user/tasks/tcreatetestdeployment.htm,v
>retrieving revision 1.4
>diff -u -r1.4 tcreatetestdeployment.htm
>--- tasks/tcreatetestdeployment.htm	3 May 2007 14:33:15 -0000	1.4
>+++ tasks/tcreatetestdeployment.htm	18 Apr 2008 16:02:18 -0000
>@@ -2,7 +2,7 @@
> <html lang="en-us" xml:lang="en-us">
> 
>- 
>-<head>
>-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
>-<link rel="StyleSheet" href="../css/book.css" type="text/css" />
>-
>-<title>Forming an artifact and location pairing</title>
>-</head>
>-
>-<body>
>-
>-
>-<h1>Forming an artifact and location pairing</h1>
>-
>-Create the pair of test artifact and location to be used by the test
>-deployment.
>-
>-
>-If the Deployment editor is not already open, open it by double-clicking on testDeployment.deploy. Select
>-the Pairs tab. 
>-<img width="474" height="428" src="../images/creatingATestDeployment_image019.png" alt="" />
>-
>-<h3>Adding the Artifact</h3>
>-
>-<ol>
>-	<li>
>-	Click the Add... button adjacent to the Artifacts section. The Add Artifact Association dialog launches.</li>
>-	<li>Select the Use an existing resource option. Either type in the path 
>-	reference for testArtifact in the Existing resource field, or use
>-	the Browse... button to navigate to it and select it.
>-	</li>
>-	<li>
>-	Click Finish. The artifact will be added to the list in the Artifacts section.
>-	</li>
>-</ol><h3>Adding the Location</h3>
>-
>-This follows a similar process to that for adding an artifact. 
>-<ol>
>-	<li>
>-		Click on the Add... button adjacent to the Locations section.
>-		The Add Location Association dialog launches.
>-	</li>
>-	<li>Select the Use an existing resource 
>-		option and either type in the path reference for testLocation in the 
>-		Existing resource field, or use the Browse... button to navigate to 
>-		it and select it.
>-	</li>
>-	<li>
>-		Click Finish. The location will be added to the list in the Locations section.
>-	</li>
>-</ol>
>-
>-
>-<img width="473" height="214" src="../images/creatingATestDeployment_image023.png" alt="" />
>-
>-You can add or remove items from the Artifacts or Locations lists by using their respective&nbsp; Add... or Remove
>-buttons. To remove an item, select it and then press the Remove button.
>-
>-Where there is more than one item in either list, their relative ordering can be modified by selecting an item within the list and then pressing
>-the Up or Down buttons to move the selected item up or down the list, respectively.
>-
>-Press the Open... button in either the Artifacts or Locations lists to open the Artifact or Location editor respectively for whichever
>-list item is selected.
>-
>-<h3>Forming the Artifact and Location Pairing</h3>
>-
>-Now click on the down-arrow button (<img border="0"
>-	src="../images/downArrow.gif" width="16" height="16" alt="Image of down arrow."/>) in the middle of the Pairs tab view to form the testArtifact and testLocation pairing. 
>-<img width="471" height="113" src="../images/creatingATestDeployment_image024.png" alt=""/>
>-
>-To remove a pairing, select it and then press the&nbsp; Remove button. Where there is more than one pair in&nbsp;the
>-list, their relative ordering can be modified by selecting an item within the list and then pressing the Up or Down
>-buttons to move the selected item up or down the list, respectively.
>-
>-
>-Related concepts 
>-<a href="../concepts/cartifacteditor.htm">Artifact Editor - overview</a> 
>-<a href="../concepts/cdeployeditor.htm">Deployment Editor - overview</a> 
>-<a href="../concepts/clocationeditor.htm">Location Editor - overview</a> 
>-
>-
>-
>-Related tasks 
>-<a href="tcreatetestdeployment.htm">Creating a deployment</a> 
>-<a href="tcreateartifact.htm">Creating an artifact</a> 
>-<a href="tcreatelocation.htm">Creating a location</a> 
>-
>-
>-
>-
>-</body>
>-
>-</html>
>Index: ref/rdeploymentGroundRules.htm
>===================================================================
>RCS file: ref/rdeploymentGroundRules.htm
>diff -N ref/rdeploymentGroundRules.htm
>--- ref/rdeploymentGroundRules.htm	11 Mar 2008 18:12:20 -0000	1.7
>+++ /dev/null	1 Jan 1970 00:00:00 -0000
>@@ -1,181 +0,0 @@
>-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">
>-<html lang="en-us" xml:lang="en-us">
>-
>-
>-<head>
>-<meta http-equiv=Content-Type content="text/html; charset=ISO-8859-1" />
>-<link rel=StyleSheet href="../css/book.css" type="text/css" />
>-
>-<title>Deployment ground rules</title>
>-</head>
>-
>-<body>
>-
>-<div>
>-
>-<div>
>-
>-<h1><a name="_Toc116098723">Deployment ground rules</a></h1>
>-
>-</div>
>-
>-<h3><a name="_Toc116098724">General</a></h3>
>-
>-TPTP only concerns itself with the properties CLASSPATH and ROOTDIR.
>-
>-<h3><a name="_Toc116098725">Files to be deployed</a></h3>
>-
>-The files to be deployed at execution time are:
>-
>-1.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Everything on the class path of the test project except the following file types: .java,
>-.execution, .testsuite, .deploy, .location, .artifact.
>-
>-2.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Any test assets associated with the Artifact being used for test execution
>-
>-3.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Property CLASSPATH of the General Properties of the Artifact that is used for test execution.
>-
>-&nbsp;
>-
>-<h3><a name="_Toc116098726">ROOTDIR Considerations</a></h3>
>-
>-The following procedure is used to calculate ROOTDIR:
>-
>-<table border=1 cellspacing=0 cellpadding=0>
>-	<tr>
>-		<th width=55 valign=top>Step</th>
>-		<th width=55 valign=top>Instructions</th>
>-	</tr>
>-	<tr>
>-		<td width=55 valign=top>
>-		Step 1
>-		</td>
>-		<td width=561 valign=top>
>-		TPTP first looks on the remote machine for the ROOTDIR location property (if specified); if this exists, then its value is taken as the output
>-		from this step.
>-		&nbsp;
>-		If the ROOTDIR location property has not been specified, or if it has but does not exist on the remote machine, TPTP derives one using the
>-		temporary directory found on the remote machine's environment; it looks for LOCAL_AGENT_TEMP_DIR, TEMP, and TMP, in that order, and, whichever is
>-		found first is taken as the output from this step.
>-		</td>
>-	</tr>
>-	<tr>
>-		<td width=55 valign=top>
>-		Step 2
>-		</td>
>-		<td width=561 valign=top>
>-		TPTP looks for the USR_NAME location property on the local machine. If this does not exist it pulls the user.name property from Java
>-		(System.getProperty(&quot;user.name&quot;)).
>-		</td>
>-	</tr>
>-	<tr>
>-		<td width=55 valign=top>
>-		Step 3
>-		</td>
>-		<td width=561 valign=top>
>-		TPTP concatenates the outputs from Steps 1 and 2 and takes this to be the ROOTDIR to use.
>-		</td>
>-	</tr>
>-</table>
>-
>-&nbsp;
>-
>-<h3><a name="_Toc116098727">CLASSPATH Considerations</a></h3>
>-
>-To set up JARs that will be deployed and rooted under your ROOTDIR, set up the CLASSPATH parameter for your artifact; to set up JARs that do not
>-need to be deployed (for instance, they already exist on the location/machine to be deployed to) but still need to be included in the class path,
>-then&nbsp; set up the CLASSPATH parameter in your location. So the distinction between artifact and location CLASSPATH is whether you want the JAR
>-deployed and referenced or just referenced at the deployment location.
>-
>-<h3><a name="_Toc116098728">Excluded Libraries</a></h3>
>-
>-Certain libraries are not deployed even if they are listed in the artifact's class path property. They are:
>-<ul>
>-	<li>commons-logging.jar</li>
>-	<li>common-model.jar</li>
>-	<li>common.runner.jar</li>
>-	<li>datapool_api.jar</li>
>-	<li>ecore.jar</li>
>-	<li>ecore.xmi.jar</li>
>-	<li>hcframe.jar</li>
>-	<li>hexcore.jar</li>
>-	<li>hexl.jar</li>
>-	<li>hexr.jar</li>
>-	<li>hexrecr.jar</li>
>-	<li>hgla.jar</li>
>-	<li>hglaconfig.jar</li>
>-	<li>hmodel.jar</li>
>-	<li>hparse.jar</li>
>-	<li>hl14.jar</li>
>-	<li>hlcommons.jar</li>
>-	<li>hlcore.jar</li>
>-	<li>hlevents.jar</li>
>-	<li>hlcbe101.jar</li>
>-	<li>urlRecorder.runner.jar</li>
>-	<li>http.runner.jar</li>
>-	<li>java.runner.jar</li>
>-	<li>jmxagent.jar</li>
>-	<li>junit.jar</li>
>-	<li>runtime.jar</li>
>-	<li>xercesImpl.jar</li>
>-	<li>xmlParserAPIs.jar</li>
>-</ul>
>-
>-
>-&nbsp;
>-
>-<h3><a name="_Toc115944850"></a><a name="_Toc116098729">Agent Controller Considerations</a></h3>
>-
>-Workbench clients before TPTP 3.3 cannot use agent controllers of TPTP 3.3 and beyond (they must continue to use older, pre-TPTP
>-3.3 agent controllers). Clients of TPTP 3.3 and beyond can use both old and new agent controllers.&nbsp; In summary, currently, the client/server
>-support in TPTP is the following:
>-
>-<h4>TPTP 3.3+ Clients</h4>
>-
>-Clients &gt;= TPTP 3.3 and Server &gt;= TPTP 3.3 [use new file transfer protocol if unsecured Agent Controller, old file transfer protocol if
>-secure AC]
>-
>-Clients &gt;= TPTP 3.3 and Server &lt; TPTP 3.3 [use old file transfer protocol for unsecured and secured Agent Controllers]
>-
>-<h4>TPTP Earlier Clients</h4>
>-
>-Clients &lt; TPTP 3.3 and Server &gt;= TPTP 3.3 [this combination does not function due to older clients not understanding new server file transfer
>-protocol]
>-
>-Clients &lt; TPTP 3.3 and Server &lt; TPTP 3.3 [uses old file transfer protocol for unsecured and secured Agent Controllers]
>-
>-There were file transfer service changes in TPTP 3.3 and TPTP 4.0 (to enhance the speed of deployment) that caused a new file transfer service
>-protocol to be used, any clients before TPTP 3.3 do not know about this new protocol and therefore test deployment will fail.&nbsp; Newer clients know
>-about the new and old protocols and therefore deployment will work.
>-
>-<h3><a name="_Toc115944851"></a><a name="_Toc116098730">OS Considerations</a></h3>
>-
>-<h4>File Path Naming Conventions</h4>
>-
>-Ensure that any file paths that you set in properties properly reflect the OS naming conventions for the target machine. For example, if you are
>-deploying to a Linux machine from a Windows client, and you have specified ROOTDIR, say,&nbsp; check that its value is a legal path for Linux.
>-
>-<h4>Absolute Paths</h4>
>-
>-All paths must be absolute. For example, on Windows, &quot;C:\myRootDir&quot; is appropriate and on Linux &quot;/home/user/myRootDir&quot;
>-is appropriate - all paths must be absolute and not relative.
>-
>-&nbsp;
>-
>-</div>
>-
>-</body>
>-
>-</html>
>Index: toc/deploy_toc.xml
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.hyades.test.doc.user/toc/deploy_toc.xml,v
>retrieving revision 1.1
>diff -u -r1.1 deploy_toc.xml
>--- toc/deploy_toc.xml	5 Dec 2007 20:04:00 -0000	1.1
>+++ toc/deploy_toc.xml	18 Apr 2008 16:02:18 -0000
>@@ -1,7 +1,7 @@
> <?xml version="1.0" encoding="utf-8"?>
> 
>-<head>
>-<meta http-equiv=Content-Type content="text/html; charset=ISO-8859-1"/>
>-<link rel=StyleSheet href="../css/book.css" type="text/css"/>
>-
>-<title>Create a deployment</title>
>-</head>
>-
>-<body>
>-
>-<h1>Create a deployment</h1>
>-
>-To complete the deployment process we need to
>-establish a TPTP deployment to associate the workLOC workbench location with. 
>-
>-Note that the
>-deployment editor is fully described in the referenced topics below. In this example we simply show the necessary steps
>-required to create the deployment and associate the workLOC workbench location
>-with it.
>-
>-Proceed as follows:
>-<ol>
>-	<li>Create a deployment named workDEPLOY.</li>
>-	<li>Select the Pairs tab.</li>
>-	<li>In the Locations section, click the Add... button. The Add Location Association dialog launches.</li>
>-	<li>Choose Existing Resource and type or browse to workLOC.</li>
>-	<li>Click Finish. workLOC will be added to the Locations list.</li>
>-</ol>
>-
>-Note that there is no need to provide an
>-Artifact in this case.
>-
>-
>-Related concepts 
>-<a href="../../org.eclipse.hyades.test.doc.user/concepts/cartifacteditor.htm">Artifact Editor - overview</a> 
>-<a href="../../org.eclipse.hyades.test.doc.user/concepts/cdeployeditor.htm">Deployment Editor - overview</a> 
>-<a href="../../org.eclipse.hyades.test.doc.user/concepts/clocationeditor.htm">Location Editor - overview</a> 
>-
>-
>-
>-Related tasks 
>-<a href="../../org.eclipse.hyades.test.doc.user/tasks/tcreateartifact.htm">Creating an artifact</a> 
>-<a href="../../org.eclipse.hyades.test.doc.user/tasks/tcreatetestdeployment.htm">Creating a deployment</a> 
>-<a href="../../org.eclipse.hyades.test.doc.user/tasks/tcreatelocation.htm">Creating a location</a> 
>-<a href="../../org.eclipse.hyades.test.doc.user/tasks/tassociateartifact.htm">Forming an artifact and location pairing</a> 
>-
>-
>-</body>
>-
>-</html>
>Index: tasks/tdeploy.htm
>===================================================================
>RCS file: tasks/tdeploy.htm
>diff -N tasks/tdeploy.htm
>--- tasks/tdeploy.htm	9 Apr 2008 19:57:53 -0000	1.2
>+++ /dev/null	1 Jan 1970 00:00:00 -0000
>@@ -1,50 +0,0 @@
>-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">
>-<html lang="en-us" xml:lang="en-us">
>-
>-<head>
>-<meta http-equiv=Content-Type content="text/html; charset=ISO-8859-1"/>
>-<link rel=StyleSheet href="../css/book.css" type="text/css"/>
>-<title>Deploying a JUnit plug-in test</title>
>-</head>
>-
>-<body>
>-
>-<h1>Deploying a JUnit plug-in test</h1>
>-
>-Deploying a JUnit plug-in test normally
>-requires the creation and configuration of a workbench location. If the
>-deployment is local, there is a default deployment, Deployment on the
>-local workbench, that is automatically selected within the Run dialog if a TPTP JUnit
>-plug-in test is selected. 
>-
>-<img width=783 height=488
>-src="../images/deploy_image002.jpg" alt=""/>
>-
>-Note: The
>-default deployment Deployment on the local
>-workbench does not provide, for example, instance reuse, a headless workbench, nor does it run tests
>-in the UI thread. To obtain these features and other features, you must set up
>-a specific workbench location.
>-
>-
>-Related tasks 
>-<a href="../../org.eclipse.hyades.test.doc.user/tasks/tdeploymentintro.htm">Creating a deployment</a> 
>-<a href="tcreateWorkbenchLocation.htm">Creating a workbench location</a> 
>-
>-
>-</body>
>-
>-</html>
>Index: tasks/tcreateWorkbenchLocation.htm
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.tools.junit.plugin.doc.user/tasks/tcreateWorkbenchLocation.htm,v
>retrieving revision 1.2
>diff -u -r1.2 tcreateWorkbenchLocation.htm
>--- tasks/tcreateWorkbenchLocation.htm	9 Apr 2008 19:57:53 -0000	1.2
>+++ tasks/tcreateWorkbenchLocation.htm	18 Apr 2008 16:02:21 -0000
>@@ -24,48 +24,37 @@
> 
> <h1>Creating a workbench location</h1>
> 
>-
>-A workbench location is used to specify where a TPTP JUnit Plug-in test will run.
>-
>+Test workbench locations associate a target host with a test deployment. The test suite will be executed 
>+on the target host specified in the test workbench location.
>+
>+Create a test workbench location:
> 
> <ol>
>-	<li>
>-	Select File &gt; New &gt; Other &gt; Workbench Location 
>-	&gt; Test &gt; Test Assets. Click Next.
>-	</li>
>-	<li>
>-	In the &quot;Enter or select the parent folder&quot; field, type pluginProject/src. 
>-	In the Name field type workLOC. 
>-	</li>
>-	<li>
>-	Click Next to launch the Workbench Details dialog. 
>-		<ul>
>-			<li>
>-			Select 'On the local workbench' if local deployment is required; 
>-			otherwise select 'On another workbench' and provide the Host name, 
>-			address, and the relevant Eclipse installation directory.
>-			</li>
>-			<li>
>-			If you want the same Eclipse instance to be reused (i.e. 
>-			it will not shutdown and restart between test runs),
>-			then check the 'Allow the same instance to be reused' check box.
>-			Similarly, if you require a headless workbench or to 
>-			run tests in the UI thread, check the appropriate check 
>-			boxes in the dialog.
>-			</li>
>-		</ul>
>-	</li>
>-	<li>
>-	Click Next and provide a description of your workbench location 
>-	if required.
>-	</li>
>-	<li>
>-	Click Finish. The workbench location editor will open with the 
>-	Overview tab open. (If not, double-click on the workLOC 
>-	location file.)
>-	</li>
>+	<li>Right-click in the Test Navigator and select New &gt; Test Element....</li>
>+	<li>Select Test Assets &gt; Workbench Location and click Next.</li>
>+ <li>Provide the parent folder and the name for the test workbench location and click Next.</li>
>+ <li>Optionally, provide a description for the test workbench location and click Next.</li>
>+ <li>Select the target workbench as either the local workbench, as defined in the <a href="../../org.eclipse.pde.doc.user/guide/tools/preference_pages/target_platform.htm">Target Platform</a>, 
>+ or another workbench. If another workbench is selected, enter the host name or IP address of the target host, Eclipse location (&lt;Eclipse installation directory absolute path&gt;/eclipse), 
>+ workspace location (&lt;Eclipse workspace directory absolute path&gt;/eclipse), operating system, windowing system, architecture, and locale for the host where the other workbench is installed.
>+ Test the connection to the target host by clicking the Test Connection link1. Select the main options for the target workbench</li>
>+ <li>Click Finish to create the test workbench location.</li>
> </ol>
> 
>+[1] The <a href="../../org.eclipse.tptp.platform.agentcontroller.doc.user/concepts/ac/c_ac_ovr.html">Agent Controller</a> or 
>+<a href="../../org.eclipse.tptp.platform.agentcontroller.doc.user/concepts/ac/ciacintro.html">Integrated Agent Controller</a> 
>+(local host only) is required to be configured and running.
>+	 
>+
>+Related concepts 
>+<a href="../concepts/cworkbenchLocationEditor.htm">Editing a workbench location</a> 
>+
>+
>+
>+Related tasks 
>+<a href="../../org.eclipse.hyades.test.doc.user/tasks/tcreatetestdeployment.htm">Creating a deployment</a> 
>+
>+
> </body>
> 
> </html>
>Index: concepts/cworkbenchLocationEditor.htm
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.tools.junit.plugin.doc.user/concepts/cworkbenchLocationEditor.htm,v
>retrieving revision 1.2
>diff -u -r1.2 cworkbenchLocationEditor.htm
>--- concepts/cworkbenchLocationEditor.htm	9 Apr 2008 19:57:54 -0000	1.2
>+++ concepts/cworkbenchLocationEditor.htm	18 Apr 2008 16:02:21 -0000
>@@ -26,76 +26,77 @@
> <body>
> 
> <h1>Workbench location editor</h1>
>-
>-Use the Workbench location editor if necessary to adjust the workbench 
>-location where the JUnit plug-in test will run.
>-The editor has three tabs: Overview, Eclipse Workbench Properties, and General Properties.
>-
>-<img border="0" src="../images/workbenchLocationEditor_image002.gif"
>-	width="523" height="468" alt="" />
>-
>-&nbsp;
>-
>-&nbsp;
> 
>-<h3>Overview Tab</h3>
>+Test workbench locations are edited using the Location editor. The editor contains three tabs: 
> 
>-The General Information section provides the Workbench
>-Location name (workLOC in this example), description, the path to the workLOC file
>-(/pluginProject/src/workLOC.location), and the host name (localhost). 
>+<h2>Overview</h2>
> 
>-The Property Groups
>-section provides links to&nbsp; Eclipse Workbench Properties and General Properties. These also have their
>-own sections in this page and tabs in the editor. Selecting&nbsp; Eclipse Workbench
>-Properties or General Properties
>-anywhere within the Overview tab
>-page has the same effect as selecting their respective editor tabs.
>-
>-
>-The links
>-provided in the Eclipse Workbench Properties
>-section all result, if selected, in the editor switching to
>-the Eclipse Workbench Properties
>-tab page where the actual relevant property setting facilities are found.
>-
>+This tab provides an overview of the test workbench location.
> 
>-<h3>Eclipse Workbench Properties Tab</h3>
>+This tab contains three sections:
> 
>-<img width=517 height=424
>-src="../images/workbenchLocationEditor_image003.png" alt=""/>
>+<ul>
>+	<li>
>+		General Information
>+		Contains the test workbench location's name, description, file path within the workspace, and host name or IP address. The test workbench location's name1, description, and host name or IP address are editable.
>+		 
>+		The connection to the target host may be tested by clicking the Test Connection link2.
>+		 
>+	</li>
>+	<li>
>+		Property Groups
>+		Contains a link to the General Properties and Eclipse Workbench Properties tab. Clicking a link will open the associated tab.
>+		 
>+	</li>
>+	<li>
>+		Eclipse Workbench Properties
>+		Contains links to the Eclipse Workbench properties in the Eclipse Workbench Properties tab. Clicking a link or the More... button will
>+		open the Eclipse Workbench Properties tab.
>+		 
>+	</li>
>+	<li>
>+		General Properties
>+		Contains links to the general properties in the General Properties tab. Clicking a link or the More... button will
>+		open the General Properties tab.
>+		 
>+		Note, the General Properties section will only appear if one or more general properties are associated with the test workbench location.
>+		 
>+	</li>
>+</ul>
>+
>+[1] Test workbench locations have a file name and logical name. The logical name is used in the Test Navigator, dialogs, editors, and wizards to represent the test workbench location.
>+The file name represents the test workbench location file (*.location) within the workspace. When the test workbench location is created, the logical name defaults to the file name 
>+(excluding the .location file extension) and may be modified without modifying the file name. The logical name allows customization of the test workbench location name 
>+without affecting the file name within the workspace.
>+
>+[2] The <a href="../../org.eclipse.tptp.platform.agentcontroller.doc.user/concepts/ac/c_ac_ovr.html">Agent Controller</a> or 
>+<a href="../../org.eclipse.tptp.platform.agentcontroller.doc.user/concepts/ac/ciacintro.html">Integrated Agent Controller</a> 
>+(local host only) is required to be configured and running.
>+
>+<h2>General Properties</h2>
>+
>+This tab contains the table of general properties associated with the test workbench location. 
>+
>+Note, the General Properties tab will only appear if one or more general properties are associated with the test workbench location.
>+
>+General properties can be added to the table by clicking the Add... button and entering the property name, operator (=, !=, &gt;, &lt;, &gt;=, or &lt;=), and value.
>+
>+All file paths are absolute and operating system dependent based on the target operating system.
> 
>-&nbsp;
>+Selected general properties can be removed (Remove), moved up (Up), or moved down (Down). Existing general properties may be edited by double-clicking
>+the general property in the table and and modifying the property name, operator, and/or value.
> 
>-This page offers facilities to set particular Eclipse
>-Workbench properties. 
>+<h2>Eclipse Workbench Properties</h2>
> 
>-Of particular interest to TPTP JUnit Plug-in Test users are the properties eclipseLocation, allowReuse, headless, and uiThread,
>-for which options were provided when creating the Workbench Location.
>+This tab contains the table of Eclipse Workbench properties associated with the test workbench location, as defined in the <a href="../../org.eclipse.pde.doc.user/guide/tools/preference_pages/target_platform.htm">Target Platform</a>. 
> 
>-The other properties should already be familiar to
>-Eclipse plug-in developers.
>-
>-<h3>General Properties Tab</h3>
>-
>-<img width=301 height=211
>-src="../images/workbenchLocationEditor_image005.png" alt=""/>
>-
>-&nbsp;
>-
>-The General
>-Properties page provides facilities to add additional properties
>-over and above those specifiable in the Eclipse
>-Workbench Properties page. A detailed explanation of how to
>-configure General Properties is
>-written in the topic Creating a Test
>-Deployment.
>-
>-&nbsp;
>+All file paths are absolute and operating system dependent based on the target operating system.
> 
> 
>-Related tasks 
>-<a href="../../org.eclipse.hyades.test.doc.user/tasks/tdeploymentintro.htm">Creating a Test Deployment</a> 
>+Related tasks 
>+<a href="../tasks/tcreateWorkbenchLocation.htm">Creating a workbench location</a> 
> 
>+
> </body>
> 
> </html>
>Index: toc/junitplugin_toc.xml
>===================================================================
>RCS file: /cvsroot/tptp/test/org.eclipse.tptp.test.tools.junit.plugin.doc.user/toc/junitplugin_toc.xml,v
>retrieving revision 1.3
>diff -u -r1.3 junitplugin_toc.xml
>--- toc/junitplugin_toc.xml	16 Apr 2008 19:32:51 -0000	1.3
>+++ toc/junitplugin_toc.xml	18 Apr 2008 16:02:21 -0000
>@@ -28,10 +28,9 @@
> </topic>
> 		 <topic label="Tutorial: Accessing a datapool from a JUnit Plug-in test" href="../org.eclipse.hyades.test.doc.user/samples/saccessdp.htm"/>
> </topic> 
>- <topic label="Creating a workbench location" href="tasks/tcreateWorkbenchLocation.htm"/>
>- <topic label="Workbench location editor" href="concepts/cworkbenchLocationEditor.htm"/>
>- <topic label="Create a deployment" href="tasks/tdeploy2.htm"/>
>- <topic label="Deploying a JUnit plug-in test" href="tasks/tdeploy.htm"/>
>+	 <topic label="Creating a workbench location" href="tasks/tcreateWorkbenchLocation.htm">
>+	 <topic label="Editing a workbench location" href="concepts/cworkbenchLocationEditor.htm"/>
>+	 </topic>
> <topic label="Running a test" href="../org.eclipse.hyades.test.doc.user/tasks/trun.htm"/>
> 
> 	 <link toc="../org.eclipse.hyades.test.doc.user/toc/logviewer_toc.xml"/>

Actions: View | Diff

Attachments on bug 201892: 96616