Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
View | Details | Raw Unified | Return to bug 211752
Collapse All | Expand All

(-)org/eclipse/tptp/platform/releng/tools/testautomation/readme.html (-26 / +18 lines)
Lines 1-7 Link Here
1
<html>
1
<html>
2
<!--
2
<!--
3
3
4
  Copyright (c) 2008 IBM Corporation and others. 
4
  Copyright (c) 2008, 2010 IBM Corporation and others. 
5
  All rights reserved.   This program and the accompanying materials 
5
  All rights reserved.   This program and the accompanying materials 
6
  are made available under the terms of the Eclipse Public License v1.0 
6
  are made available under the terms of the Eclipse Public License v1.0 
7
  which accompanies this distribution, and is available at 
7
  which accompanies this distribution, and is available at 
Lines 57-68 Link Here
57
		<li>Create a directory to store the test automation in, such as test-automation in the following sample structure:<br/>
57
		<li>Create a directory to store the test automation in, such as test-automation in the following sample structure:<br/>
58
		test-automation<br/>
58
		test-automation<br/>
59
		|-scripts<br/>
59
		|-scripts<br/>
60
		| |-bin<br/>
61
		|-dependencies<br/>
60
		|-dependencies<br/>
62
		|-ant<br/>
61
		|-ant<br/>
63
		|-workbench</li>
62
		|-workbench</li>
64
		<li>Extract the automation scripts to the scripts directory from CVS and set the sh scripts to execute</li>
63
		<li>Extract the automation scripts to the scripts directory from CVS and set the sh scripts to execute</li>
65
		<li>Ensure the jar files for configuring the remote machine are in a bin/ directory where the ant scripts are located (test-automation/scripts/bin/)</li>
66
		<li>Navigate to <a href="http://ant.apache.org">http://ant.apache.org</a></li>
64
		<li>Navigate to <a href="http://ant.apache.org">http://ant.apache.org</a></li>
67
		<li>Click on Binary Distributions under the Download section in the left navigation bar</li>
65
		<li>Click on Binary Distributions under the Download section in the left navigation bar</li>
68
		<li>Download Ant, for example to dependencies</li>
66
		<li>Download Ant, for example to dependencies</li>
Lines 77-88 Link Here
77
	<b>Reporting automation setup</b><br/>
75
	<b>Reporting automation setup</b><br/>
78
	<ol>
76
	<ol>
79
		<li>Download <a href="http://download.eclipse.org/eclipse/downloads/">Eclipse</a>, <a href="http://www.eclipse.org/tptp/home/downloads/">TPTP</a>,
77
		<li>Download <a href="http://download.eclipse.org/eclipse/downloads/">Eclipse</a>, <a href="http://www.eclipse.org/tptp/home/downloads/">TPTP</a>,
80
		<a href="http://download.eclipse.org/birt/downloads/">BIRT</a>, <a href="http://www.eclipse.org/datatools/downloads.php">DTP</a>, and 
78
		<a href="http://download.eclipse.org/birt/downloads/">BIRT</a>, <a href="http://www.eclipse.org/datatools/downloads.php">DTP</a>, 
81
		<a href="http://www.eclipse.org/gef/downloads/">GEF</a>. For TPTP 4.5.x you will also need the As-Is components Manual Test Tools, 
79
		<a href="http://www.eclipse.org/gef/downloads/">GEF</a>, <a href="http://eclipse.org/modeling/emf/downloads/">EMF</a>, <a href="http://eclipse.org/modeling/emf/downloads/">XSD</a>, As-Is components Manual Test Tools, Automated GUI Recorder, 
82
		Business Intelligence and Reporting Tools (BIRT) Test Reports, Business Intelligence and Reporting Tools (BIRT) Log Reports, 
80
		Business Intelligence and Reporting Tools (BIRT) Test Reports, Business Intelligence and Reporting Tools (BIRT) Trace Reports.</li>
83
		Business Intelligence and Reporting Tools (BIRT) Trace Reports, and Business Intelligence and Reporting Tools (BIRT) Statistical Reports.</li>
84
		<li>Extract the downloads to a workbench folder</li>
81
		<li>Extract the downloads to a workbench folder</li>
85
		<li>Copy workbench\eclipse\plugins\com.jcraft.jsch_0.1.31.jar and eclipse\plugins\org.eclipse.hyades.execution_&lt;build-id&gt;\ant-tptp.jar to
82
		<li>Copy workbench\eclipse\plugins\com.jcraft.jsch_0.1.41.v200903070017.jar and workbench\eclipse\dropins\eclipse\plugins\org.eclipse.hyades.execution_&lt;build-id&gt;\ant-tptp.jar to
86
		the ant\lib directory</li>
83
		the ant\lib directory</li>
87
	</ol>
84
	</ol>
88
	<b>Test automation setup</b><br/>
85
	<b>Test automation setup</b><br/>
Lines 110-132 Link Here
110
<p>
107
<p>
111
	After completing <a href="#Setup">setup</a>, you can run reports on test suites to automatically generate reports.<br/>
108
	After completing <a href="#Setup">setup</a>, you can run reports on test suites to automatically generate reports.<br/>
112
	Syntax for nightly.sh for reporting:<br/>
109
	Syntax for nightly.sh for reporting:<br/>
113
	nightly.sh report &lt;release&gt; &lt;property file&gt; "&lt;report start time&gt;"<br/>
110
	nightly.sh --runType=report --tptpRelease=&lt;release&gt; --propertyFile=&lt;property file&gt; --reportStartTime=&quot;&lt;reportStartTime&gt&quot;<br/>
114
	Note: no end time is passed since it is automatically determined, i.e. reports will be from start time until the script begins<br/>
111
	Note: no end time is passed since it is automatically determined, i.e. reports will be from start time until the script begins<br/>
115
	Syntax for setup.sh for reporting:<br/>
112
	Syntax for setup.sh for reporting with only a report start time:<br/>
116
	With only a report start time: setup.sh report &lt;release&gt; &lt;property file&gt; &quot;&lt;report start time&gt;&quot;<br/>
113
	setup.sh --runType=report --tptpRelease=&lt;release&gt; --propertyFile=&lt;property file&gt; --reportStartTime=&quot;&lt;reportStartTime&gt&quot;<br/>
117
	With both a report start and end time: setup.sh report &lt;release&gt; &lt;property file&gt; &quot;&lt;report start time&gt;&quot; &quot;&lt;report end time&gt;&quot;<br/>
114
	Syntax for setup.sh for reporting with both a report start and end time:<br/>
118
	Setup a cronjob for nightly reporting, e.g. export CVS_RSH=ssh; cd test-automation/scripts; ./nightly.sh report 4.5.0 test-automation/scripts/test450.properties &quot;02/04/2008 12:00 AM&quot;&gt;test-automation/scripts/report.log 2&gt;&amp;1
115
	setup.sh --runType=report --tptpRelease=&lt;release&gt; --propertyFile=&lt;property file&gt; --reportStartTime=&quot;&lt;reportStartTime&gt&quot; --reportEndTime=&quot;&lt;reportEndTime&gt&quot;<br/>
116
	Setup a cronjob for nightly reporting:<br/> e.g. export CVS_RSH=ssh; cd test-automation/scripts; ./nightly.sh --runType=report --tptpRelease=4.7.0 --propertyFile=test-automation/scripts/test.properties  --reportStartTime=&quot;05/24/2010 12:00 PM&quot; &gt test-automation/scripts/report.log 2&gt;&amp;1
119
</p>
117
</p>
120
118
121
<h2><a name="Testing"></a>Running Testing Automation</h2>
119
<h2><a name="Testing"></a>Running Testing Automation</h2>
122
<p>
120
<p>
123
	After completing <a href="#Setup">setup</a>, you can run test automation on test suites.<br/>
121
	After completing <a href="#Setup">setup</a>, you can run test automation on test suites. Make sure no other bvt is currently running on the machine.<br/>
124
	Syntax for nightly.sh for testing:<br/>
122
	Syntax for nightly.sh for testing:<br/>
125
	nightly.sh bvt &lt;release&gt; &lt;property file&gt;<br/>
123
	nightly.sh --runType=bvt --tptpRelease=&lt;release&gt; --propertyFile=&lt;property file&gt; --jreList=&lt;jre list&gt;<br/>
126
	Note: no start time is passed since it is automatically determined, i.e. bvt will be for that day's build<br/>
124
	Note: no start time is passed since it is automatically determined, i.e. bvt will be for that day's build<br/>
127
	Syntax for setup.sh for testing:<br/>
125
	Syntax for setup.sh for testing:<br/>
128
	setup.sh bvt &lt;release&gt; &lt;property file&gt; &lt;driver&gt;<br/>
126
	setup.sh --runType=bvt --tptpRelease=&lt;release&gt; --propertyFile=&lt;property file&gt; --tptpDriver=&lt;driver&gt; --jreList=&lt;jre list&gt;<br/>
129
	Setup a cronjob for nightly testing, e.g. export CVS_RSH=ssh; cd test-automation/scripts; ./nightly.sh bvt 4.5.0 test-automation/scripts/test.properties&gt;test-automation/scripts/bvt.log 2&gt;&amp;1
127
	Setup a cronjob for nightly testing:<br/> e.g. export CVS_RSH=ssh; cd test-automation/scripts; ./nightly.sh --runType=bvt --tptpRelease=4.7.0 --propertyFile=test-automation/scripts/test.properties --jreList= &lt;jre list&gt &gt test-automation/scripts/bvt.log 2&gt;&amp;1
130
</p>
128
</p>
131
129
132
<h2><a name="Properties"></a>Property File Configuration</h2>
130
<h2><a name="Properties"></a>Property File Configuration</h2>
Lines 137-155 Link Here
137
	<b>user</b><sup>1</sup> - The user to login with on the remote machine.<br/>
135
	<b>user</b><sup>1</sup> - The user to login with on the remote machine.<br/>
138
	<b>keyfile</b><sup>1</sup> - The path (including file name) for the keyfile to login to the remote machine.<br/>
136
	<b>keyfile</b><sup>1</sup> - The path (including file name) for the keyfile to login to the remote machine.<br/>
139
	<b>dir</b><sup>1</sup> - The root directory for test automation on the remote machine.<br/> 
137
	<b>dir</b><sup>1</sup> - The root directory for test automation on the remote machine.<br/> 
138
	<b>cygwinPath</b><sup>1</sup> - The path to the AC home directory on the remote machine.<br/>
140
	<br/>
139
	<br/>
141
140
142
	<b>acUser</b><sup>1</sup> - The user for configuring the Agent Controller on the remote machine.<br/>
143
	<b>acPassword</b><sup>1</sup> - The password for the user used to configure the Agent Controller on the remote machine.<br/>
144
	<b>cygwinACPath</b><sup>1</sup> - The path to the AC home directory on the remote machine.<br/>
145
	<b>javaLocation</b><sup>1</sup> - The path to the JRE on the remote machine.<br/>
146
	<br/>
147
	
148
	<b>reportLocation</b><sup>1,2</sup> - The location to store the reports when running the automation on the local machine.<br/>
141
	<b>reportLocation</b><sup>1,2</sup> - The location to store the reports when running the automation on the local machine.<br/>
149
	<b>reportDirectory=TP1</b><sup>2</sup> - The containing directory within the project where the test suites are located.<br/> 
142
	<b>reportDirectory=TP1</b><sup>2</sup> - The containing directory within the project where the test suites are located.<br/> 
150
	<b>reportCheckinDirectory</b><sup>2</sup> - The containing directory to store the reports for check-in.<br/>
143
	<b>reportCheckinDirectory</b><sup>2</sup> - The containing directory to store the reports for check-in.<br/>
151
	<b>reportHostname</b><sup>1</sup> - The hostname of the machine to copy the test automation reports to.<br/>
144
	<b>reportHost</b><sup>1</sup> - The hostname of the machine to copy the test automation reports to.<br/>
152
	<b>reportUser</b><sup>1</sup> - The user to use when logging into the host for test automation report copying.<br/>
153
	<br/>
145
	<br/>
154
	
146
	
155
	<b>tptp.test.workspace</b><sup>1,2</sup> - The location to create the workspace on the local machine.<br/>
147
	<b>tptp.test.workspace</b><sup>1,2</sup> - The location to create the workspace on the local machine.<br/>
Lines 160-166 Link Here
160
	<b>cvsBranch</b><sup>1,2</sup> - The branch to check the projects out from CVS.<br/>
152
	<b>cvsBranch</b><sup>1,2</sup> - The branch to check the projects out from CVS.<br/>
161
	<br/>
153
	<br/>
162
	
154
	
163
	<b>tptpDriver</b><sup>1</sup> - The type of remote machine for test automation (tptpWinDriver or tptpLinuxDriver).<br/>
155
	<b>acDriver</b><sup>1</sup> - The Agent Controller driver for test automation (tptpWinDriver or tptpLinuxDriver).<br/>
164
	<b>testSuite</b><sup>1,2</sup> - The test suite to include in test automation or reporting. Note: This must be set to a non-existent test suite name if only test suite exclusion is required.<br/> 
156
	<b>testSuite</b><sup>1,2</sup> - The test suite to include in test automation or reporting. Note: This must be set to a non-existent test suite name if only test suite exclusion is required.<br/> 
165
	<b>excludeTestSuite</b><sup>1,2</sup> - The test suite to exclude in test automation or reporting. Note: This must be set to a non-existent test suite name if all test suites are required.<br/>
157
	<b>excludeTestSuite</b><sup>1,2</sup> - The test suite to exclude in test automation or reporting. Note: This must be set to a non-existent test suite name if all test suites are required.<br/>
166
	<b>testProject</b><sup>1,2</sup> - The project to obtain the test suites from.<br/>
158
	<b>testProject</b><sup>1,2</sup> - The project to obtain the test suites from.<br/>

Return to bug 211752