587
|
1 |
<#--
|
|
2 |
============================================================================
|
|
3 |
Name : stage_ats.rst.inc.ftl
|
|
4 |
Part of : Helium
|
|
5 |
|
|
6 |
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
7 |
All rights reserved.
|
|
8 |
This component and the accompanying materials are made available
|
|
9 |
under the terms of the License "Eclipse Public License v1.0"
|
|
10 |
which accompanies this distribution, and is available
|
|
11 |
at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
12 |
|
|
13 |
Initial Contributors:
|
|
14 |
Nokia Corporation - initial contribution.
|
|
15 |
|
|
16 |
Contributors:
|
|
17 |
|
|
18 |
Description:
|
|
19 |
|
|
20 |
============================================================================
|
|
21 |
-->
|
|
22 |
|
|
23 |
.. index::
|
|
24 |
single: ATS - STIF, TEF, RTEST, MTF and EUnit
|
|
25 |
|
|
26 |
.. _`Stage-ATS-label`:
|
|
27 |
|
|
28 |
Stage: ATS - STIF, TEF, RTEST, MTF and EUnit (also Qt)
|
|
29 |
=======================================================
|
|
30 |
|
|
31 |
ATS testing is the automatic testing of the phone code once it has been compiled and linked to create a ROM image.
|
|
32 |
|
|
33 |
Explanation of the process for getting ATS (`STIF`_ and `EUnit`_) tests compiled and executed by Helium, through the use of the ``ats-test`` target.
|
|
34 |
|
|
35 |
http://developer.symbian.org/wiki/index.php/Symbian_Test_Tools
|
|
36 |
|
|
37 |
<#if !(ant?keys?seq_contains("sf"))>
|
|
38 |
.. _`STIF`: http://s60wiki.nokia.com/S60Wiki/STIF
|
|
39 |
.. _`EUnit`: http://s60wiki.nokia.com/S60Wiki/EUnit
|
|
40 |
</#if>
|
|
41 |
|
|
42 |
.. image:: ats.dot.png
|
|
43 |
|
|
44 |
Prerequisites
|
|
45 |
----------------
|
|
46 |
|
|
47 |
* `Harmonized Test Interface (HTI)`_ needs to be compiled and into the image.
|
|
48 |
* The reader is expected to already have a working ATS setup in which test cases can be executed. ATS server names,
|
|
49 |
access rights and authentication etc. is supposed to be already taken care of.
|
|
50 |
|
|
51 |
<#if !(ant?keys?seq_contains("sf"))>
|
|
52 |
.. _`Harmonized Test Interface (HTI)`: http://s60wiki.nokia.com/S60Wiki/HTI
|
|
53 |
<#else>
|
|
54 |
.. _`Harmonized Test Interface (HTI)`: http://developer.symbian.org/wiki/index.php/HTI_Tool
|
|
55 |
</#if>
|
|
56 |
|
|
57 |
Test source components
|
|
58 |
-------------------------
|
|
59 |
|
|
60 |
Test source usually lives in a component's ``tsrc`` directory. Test source components are created like any other Symbian SW component;
|
|
61 |
there is a ``group`` directory with a ``bld.inf`` file for building, ``.mmp`` files for defining the targets, and so on.
|
|
62 |
|
|
63 |
The test generation code expects ``.pkg`` file in the ``group`` directory of test component to be compiled, to get the paths of the files
|
|
64 |
(can be data, configuration, initialization, etc files) to be installed and where to install on the phone.
|
|
65 |
|
|
66 |
Three STEPS to setup ATS with Helium
|
|
67 |
--------------------------------------
|
|
68 |
|
|
69 |
**Step 1: Configure System Definition Files**
|
|
70 |
If the tsrc directory structure meets the criteria defined in the `new API test automation guidelines`_, then test components
|
|
71 |
should be included in the System Definition files; **layers** in ``layers.sysdef.xml`` file and **configuration** in ``build.sysdef.xml``
|
|
72 |
file (`Structure of System Definition files`_).
|
|
73 |
|
|
74 |
<#if !(ant?keys?seq_contains("sf"))>
|
|
75 |
.. _`new API test automation guidelines`: http://s60wiki.nokia.com/S60Wiki/Test_Asset_Guidelines
|
|
76 |
.. _`Structure of System Definition files`: http://delivery.nmp.nokia.com/trac/helium/wiki/SystemDefinitionFiles
|
|
77 |
</#if>
|
|
78 |
|
|
79 |
A template of layer in layers.sysdef.xml
|
|
80 |
|
|
81 |
.. code-block:: xml
|
|
82 |
|
|
83 |
<layer name="name_test_layer">
|
|
84 |
<module name="module_name_one">
|
|
85 |
<unit unitID="unit_id1" name="unit_name1" bldFile="path_of_tsrc_folder_to_be_built" mrp="" />
|
|
86 |
</module>
|
|
87 |
|
|
88 |
<module name="module_name_two">
|
|
89 |
<unit unitID="unit_id2" name="unit_name2" bldFile="path_of_tsrc_folder_to_be_built" mrp="" />
|
|
90 |
</module>
|
|
91 |
</layer>
|
|
92 |
|
|
93 |
* Layer name should end with **_test_layer**
|
|
94 |
* Two standard names for ATS test layers are being used; ``unit_test_layer`` and ``api_test_layer``. Test components (the``unit`` tags)
|
|
95 |
should be specified under these layers and grouped by ``module`` tag(s).
|
|
96 |
* In the above, two modules means two drop files will be created; ``module`` may have one or more ``unit``
|
|
97 |
* By using property ``exclude.test.layers``, complete layers can be excluded and the components inside that layer will not be included in the AtsDrop. This property is a comma (,) separated list
|
|
98 |
|
|
99 |
|
|
100 |
**Step 2: Configure ATS properties in build.xml**
|
|
101 |
|
|
102 |
**(A)** Username and Password for the ATS should be set in the `.netrc file`_::
|
|
103 |
|
|
104 |
machine ats login ats_user_name password ats_password
|
|
105 |
|
|
106 |
Add the above line in the ``.netrc`` file and replace ``ats_user_name`` with your real ATS username and ``ats_password`` with ATS password.
|
|
107 |
|
|
108 |
**(B)** The following properties are ATS dependent with their edit status
|
|
109 |
|
|
110 |
* [must] - must be set by user
|
|
111 |
* [recommended] - should be set by user but not mandatory
|
|
112 |
* [allowed] - should **not** be set by user however, it is possible.
|
|
113 |
|
|
114 |
.. csv-table:: ATS Ant properties
|
|
115 |
:header: "Property name", "Edit status", "Description"
|
|
116 |
|
|
117 |
":hlm-p:`ats.server`", "[must]", "For example: ``4fix012345`` or ``catstresrv001.cats.noklab.net:80``. Default server port is ``8080``, but it is not allowed between intra and Noklab. Because of this we need to define server port as 80. The host can be different depending on site and/or product."
|
|
118 |
":hlm-p:`ats.drop.location`", "[must]", "Server location (UNC path) to save the ATSDrop file, before sending to the ATS Server. For example: ``\\\\trwsem00\\some_folder\\``. In case, :hlm-p:`ats.script.type` is set to ``import``, ATS doesn't need to have access to :hlm-p:`ats.drop.location`, its value can be any local folder on build machine, for example ``c:/temp`` (no network share needed)."
|
|
119 |
":hlm-p:`ats.product.name`", "[must]", "Name of the product to be tested."
|
|
120 |
":hlm-p:`eunit.test.package`", "[recommended]", "The EUnit package name to be unzipped on the environment, for executing EUnit tests."
|
|
121 |
":hlm-p:`eunitexerunner.flags`", "[recommended]", "Flags for EUnit exerunner can be set by setting the value of this variable. The default flags are set to ``/E S60AppEnv /R Off``."
|
|
122 |
":hlm-p:`ats.email.list`", "[recommended]", "The property is needed if you want to get an email from ATS server after the tests are executed. There can be one to many semicolon-separated email addresses."
|
|
123 |
":hlm-p:`ats.flashfiles.minlimit`", "[recommended]", "Limit of minimum number of flash files to execute :hlm-t:`ats-test` target, otherwise ``ATSDrop.zip`` will not be generated. Default value is 2 files."
|
|
124 |
":hlm-p:`ats.plan.name`", "[recommended]", "Modify the plan name if you have understanding of ``test.xml`` file or leave it as it is. Default value is ``plan``."
|
|
125 |
":hlm-p:`ats.product.hwid`", "[recommended]", "Product HardWare ID (HWID) attached to ATS. By default the value of HWID is not set."
|
|
126 |
":hlm-p:`ats.script.type`", "[recommended]", "There are two types of ats script files to send drop to ATS server, ``runx`` and ``import``; only difference is that with ``import`` ATS doesn't have to have access rights to ``testdrop.zip`` file, as it is sent to the system over http and import doesn't need network shares. If that is not needed ``import`` should not be used. Default value is ``runx`` as ``import`` involves heavy processing on ATS server."
|
|
127 |
":hlm-p:`ats.target.platform`", "[recommended]", "Sets target platform for compiling test components. Default value is ``armv5 urel``."
|
|
128 |
":hlm-p:`ats.test.timeout`", "[recommended]", "To set test commands execution time limit on ATS server, in seconds. Default value is ``60``."
|
|
129 |
":hlm-p:`ats.testrun.name`", "[recommended]", "Modify the test-run name if you have understanding of ``test.xml`` file or leave it as it is. Default value is a string consist of build id, product name, major and minor versions."
|
|
130 |
":hlm-p:`ats.trace.enabled`", "[recommended]", "Should be ``True`` if tracing is needed during the tests running on ATS. Default value is ``False``, the values are case-sensitive. See http://s60wiki.nokia.com/S60Wiki/CATS/TraceTools."
|
|
131 |
":hlm-p:`ats.ctc.enabled`", "[recommended]", "Should be ``True`` if coverage measurement and dynamic analysis (CTC) tool support is to be used by ATS. Default value is ``False``. The values are case-sensitive."
|
|
132 |
":hlm-p:`ats.ctc.host`", "[recommended]", "CTC host, provided by CATS used to create coverage measurement reports. MON.sym files are copied to this location, for example ``10.0.0.1``. If not given, code coverage reports are not created"
|
|
133 |
":hlm-p:`ats.obey.pkgfiles.rule`", "[recommended]", "If the property is set to ``True``, then the only test components which will have PKG files, will be included into the ``test.xml`` as a test-set. Which means, even if there's a test component (executable) but there's no PKG file, it should not be considered as a test component and hence not included into the test.xml as a separate test. By default the property value is ``False``."
|
|
134 |
"``reference.ats.flash.images``", "[recommended]", "Fileset for list of flash images (can be .fpsx, .C00, .V01 etc) It is recommended to set the fileset, default filset is given below which can be overwritten. set *dir=""* attribute of the filset to ``${r'$'}{build.output.dir}/variant_images`` if hlm-t:`variant-image-creation` target is being used."
|
|
135 |
":hlm-p:`tsrc.data.dir`", "[allowed]", "The default value is ``data`` and refers to the 'data' directory under 'tsrc' directory."
|
|
136 |
":hlm-p:`tsrc.path.list`", "[allowed]", "Contains list of the tsrc directories. Gets the list from system definition layer files. Assuming that the test components are defined already in te ``layers.sysdef.xml`` files to get compiled. Not recommended, but the property value can be set if there are no System Definition file(s), and tsrc directories paths to set manually."
|
|
137 |
":hlm-p:`ats.report.location`", "[allowed]", "Sets ATS reports store location. Default location is ``${r'$'}{publish.dir}/${r'$'}{publish.subdir}``."
|
|
138 |
":hlm-p:`ats.multiset.enabled`", "[allowed]", "Should be ``True`` so a set is used for each pkg file in a component, this allows tests to run in parallel on several devices."
|
|
139 |
":hlm-p:`ats.diamonds.signal`", "[allowed]", "Should be ``true`` so at end of the build diamonds is checked for test results and Helium fails if tests failed."
|
|
140 |
":hlm-p:`ats.delta.enabled`", "[allowed]", "Should be ``true`` so only ADOs changed during :hlm-t:`do-prep-work-area` are tested by ATS."
|
|
141 |
":hlm-p:`ats4.enabled`", "[allowed]", "Should be ``true`` if ATS4 is to be used."
|
|
142 |
":hlm-p:`ats.emulator.enable`", "[allowed]", "Should be ``true`` if ``WINSCW`` emulator is to be used."
|
|
143 |
":hlm-p:`ats.specific.pkg`", "[allowed]", "Text in name of PKG files to use eg. 'sanity' would only use xxxsanity.pkg files from components."
|
|
144 |
|
|
145 |
An example of setting up properties:
|
|
146 |
|
|
147 |
.. code-block:: xml
|
|
148 |
|
|
149 |
<property name="ats.server" value="4fio00105" />
|
|
150 |
<property name="ats.drop.location" location="\\trwsimXX\ATS_TEST_SHARE\" />
|
|
151 |
<property name="ats.email.list" value="temp.user@company.com; another.email@company.com" />
|
|
152 |
<property name="ats.flashfiles.minlimit" value="2" />
|
|
153 |
<property name="ats.product.name" value="PRODUCT" />
|
|
154 |
<property name="ats.plan.name" value="plan" />
|
|
155 |
<property name="ats.product.hwid" value="" />
|
|
156 |
<property name="ats.script.type" value="runx" />
|
|
157 |
<property name="ats.target.platform" value="armv5 urel" />
|
|
158 |
<property name="ats.test.timeout" value="60" />
|
|
159 |
<property name="ats.testrun.name" value="${r'$'}{build.id}_${r'$'}{ats.product.name}_${r'$'}{major.version}.${r'$'}{minor.version}" />
|
|
160 |
<property name="ats.trace.enabled" value="False" />
|
|
161 |
<property name="ats.ctc.enabled" value="False" />
|
|
162 |
<property name="ats.obey.pkgfiles.rule" value="False" />
|
|
163 |
<property name="ats.report.location" value="${r'$'}{publish.dir}/${r'$'}{publish.subdir}" />
|
|
164 |
<property name="eunit.test.package" value="" />
|
|
165 |
<property name="eunitexerunner.flags" value="/E S60AppEnv /R Off" />
|
|
166 |
|
|
167 |
...
|
|
168 |
<import file="${r'$'}{helium.dir}/helium.ant.xml" />
|
|
169 |
...
|
|
170 |
|
|
171 |
<fileset id="reference.ats.flash.images" dir="${r'$'}{release.images.dir}">
|
|
172 |
<include name="**/${r'$'}{build.id}*.core.fpsx"/>
|
|
173 |
<include name="**/${r'$'}{build.id}*.rofs2.fpsx"/>
|
|
174 |
<include name="**/${r'$'}{build.id}*.rofs3.fpsx"/>
|
|
175 |
</fileset>
|
|
176 |
|
|
177 |
|
|
178 |
.. Note::
|
|
179 |
|
|
180 |
Always declare *Properties* before and *filesets* after importing helium.ant.xml.
|
|
181 |
|
|
182 |
**STEP 3: Call target ats-test**
|
|
183 |
|
|
184 |
To execute the target, a property should be set(``<property name="enabled.ats" value="true" />``).
|
|
185 |
|
|
186 |
Then call ``ats-test``, which will create the ATSDrop.zip (test package).
|
|
187 |
|
|
188 |
If property *ats.email.list* is set, an email (test report) will be sent when the tests are ready on ATS.
|
|
189 |
|
|
190 |
CTC:
|
|
191 |
----
|
|
192 |
|
|
193 |
CTC code coverage measurements reports can be created as part of Test Automation process.
|
|
194 |
|
|
195 |
1. Build the src using ``build_ctc`` configuration, which is in ``build.sysdef.xml`` file, to create ``MON.sym`` files. It means that a property ``sysdef.configurations.list`` should be modified either add or replace current build configuration with ``build_ctc``
|
|
196 |
|
|
197 |
2. Set the property, ``ats.ctc.host``, as described above, for sending the ``MON.sym`` files to the network drive. *(Please contact ATS server administrator and ask for the value to set this property)*
|
|
198 |
|
|
199 |
3. Enable CTC process by setting up property ``ats.ctc.enabled`` to "true"
|
|
200 |
|
|
201 |
4. Test drops are sent to the ATS server, where, after executing tests ``ctcdata.txt`` files are created. ``ctcdata.txt`` and ``MON.sym`` files are then further processed to create code coverage reports.
|
|
202 |
|
|
203 |
5. View or download the Code coverage reports by following the link provided in the ATS report email (sent after the tests are executed on ATS)
|
|
204 |
|
|
205 |
*NOTE: After receiving the email notification, it may take a few minutes before the code coverage reports are available.*
|
|
206 |
|
|
207 |
|
|
208 |
Qt Tests:
|
|
209 |
---------
|
|
210 |
|
|
211 |
QtTest.lib is supported and the default harness is set to EUnit. If ``QtTest.lib`` is there in ``.mmp`` file, Helium sets the Harness to Eunit and ATS supported Qt steps are added to test.xml file
|
|
212 |
|
|
213 |
In ``layers.sysdef.xml`` file, the layer name should end with "_test_layer" e.g. "qt_unit_test_layer".
|
|
214 |
|
|
215 |
There are several ``.PKG`` files created after executing ``qmake``, but only one is selected based on which target platform is set. Please read the property (``ats.target.platform``) description above.
|
|
216 |
|
|
217 |
.. _`Skip-Sending-AtsDrop-label`:
|
|
218 |
|
|
219 |
Skip Sending AtsDrop to ATS
|
|
220 |
----------------------------
|
|
221 |
|
|
222 |
By setting property of ``skip.ats.sending``, ``ats-test`` target only creates a drop file, and does not send the drop (or package) to ATS server.
|
|
223 |
|
|
224 |
Customizing the test.xml in ATS
|
|
225 |
--------------------------------
|
|
226 |
|
|
227 |
The user can customize the generated test.xml with files:
|
|
228 |
|
|
229 |
* **preset_custom.xml** goes before first set
|
|
230 |
* **postset_custom.xml** goes after last set
|
|
231 |
* **precase_custom.xml** goes before first case
|
|
232 |
* **postcase_custom.xml** goes after last case
|
|
233 |
* **prestep_custom.xml** goes before first step
|
|
234 |
* **poststep_custom.xml** goes after last step
|
|
235 |
* **prerun_custom.xml** goes before first run or execute step
|
|
236 |
* **postrun_custom.xml** goes after last run or execute step
|
|
237 |
* **prepostaction.xml** goes before first postaction
|
|
238 |
* **postpostaction.xml** goes after last postaction
|
|
239 |
|
|
240 |
The files must be in the directory custom under the tsrc folder processed.
|
|
241 |
|
|
242 |
The files need to be proper XML snippets that fit to their place. In case of an error an error is logged and a comment inserted to the generated XML file.
|
|
243 |
|
|
244 |
A postaction section customization file ( prepostaction.xml or postpostaction.xml) could look like this
|
|
245 |
|
|
246 |
.. code-block:: xml
|
|
247 |
|
|
248 |
<postAction>
|
|
249 |
<type>Pre PostAction from custom file</type>
|
|
250 |
<params>
|
|
251 |
<param name="foo2" value="bar2" />
|
|
252 |
</params>
|
|
253 |
</postAction>
|
|
254 |
|
|
255 |
|
|
256 |
|
|
257 |
The ``prestep_custom.xml`` can be used to flash and unstall something custom.
|
|
258 |
|
|
259 |
.. code-block:: xml
|
|
260 |
|
|
261 |
<step name="Install measurement tools" harness="STIF" significant="false">
|
|
262 |
<!-- Copy SIS-packages to DUT -->
|
|
263 |
<command>install</command>
|
|
264 |
<params>
|
|
265 |
<param src="Nokia_Energy_Profiler_1_1.sisx"/>
|
|
266 |
<param dst="c:\data\Nokia_Energy_Profiler_1_1.sisx"/>
|
|
267 |
</params>
|
|
268 |
...
|
|
269 |
</step>
|
|
270 |
|
|
271 |
|
|
272 |
And then the ``prerun_custom.xml`` can be used to start measuring.
|
|
273 |
|
|
274 |
.. code-block:: xml
|
|
275 |
|
|
276 |
<step name="Start measurement" harness="STIF" significant="false">
|
|
277 |
<!-- Start measurement -->
|
|
278 |
<command>execute</command>
|
|
279 |
<params>
|
|
280 |
<param file="neplauncher.exe"/>
|
|
281 |
<param parameters="start c:\data\nep.csv"/>
|
|
282 |
<param timeout="30"/>
|
|
283 |
</params>
|
|
284 |
</step>
|
|
285 |
|
|
286 |
|
|
287 |
|
|
288 |
**Note:** The users is expected to check the generated test.xml manually, as there is no validation. Invalid XML input files will be disregarded and a comment will be inserted to the generated XML file.
|
|
289 |
|
|
290 |
Overriding Test xml values
|
|
291 |
--------------------------
|
|
292 |
|
|
293 |
Set the property ``ats.config.file`` to the location of the config file.
|
|
294 |
|
|
295 |
Example configuration:
|
|
296 |
|
|
297 |
.. code-block:: xml
|
|
298 |
|
|
299 |
<ATSConfigData>
|
|
300 |
<config name="common" abstract="true">
|
|
301 |
|
|
302 |
<!-- Properties to add/ modify -->
|
|
303 |
<config type="properties">
|
|
304 |
<set name="HARNESS" value="STIF" />
|
|
305 |
<set name="2" value="3" />
|
|
306 |
</config>
|
|
307 |
|
|
308 |
<!-- Settings to add/ modify -->
|
|
309 |
<config type="settings">
|
|
310 |
<set name="HARNESS" value="STIF" />
|
|
311 |
<set name="2" value="3" />
|
|
312 |
</config>
|
|
313 |
|
|
314 |
<!-- Attributes to modify -->
|
|
315 |
<config type="attributes">
|
|
316 |
<set name="xyz" value="2" />
|
|
317 |
<set name="significant" value="true" />
|
|
318 |
</config>
|
|
319 |
</config>
|
|
320 |
</ATSConfigData>
|
|
321 |
|
|
322 |
|
|
323 |
.. index::
|
|
324 |
single: ATS - ASTE
|
|
325 |
|
|
326 |
Stage: ATS - ASTE
|
|
327 |
===================
|
|
328 |
|
|
329 |
Explanation of the process for getting ATS `ASTE`_ tests compiled and executed by Helium, through the use of the ``ats-aste`` target.
|
|
330 |
|
|
331 |
<#if !(ant?keys?seq_contains("sf"))>
|
|
332 |
.. _`ASTE`: http://s60wiki.nokia.com/S60Wiki/ASTE
|
|
333 |
</#if>
|
|
334 |
|
|
335 |
Prerequisites
|
|
336 |
--------------
|
|
337 |
|
|
338 |
* `Harmonized Test Interface (HTI)`_ needs to be compiled and into the image.
|
|
339 |
* The reader is expected to already have a working ATS setup in which test cases can be executed. ATS server names, access rights and authentication etc. is supposed to be already taken care of.
|
|
340 |
* `SW Test Asset`_ location and type of test should be known.
|
|
341 |
|
|
342 |
<#if !(ant?keys?seq_contains("sf"))>
|
|
343 |
.. _`Harmonized Test Interface (HTI)`: http://s60wiki.nokia.com/S60Wiki/HTI
|
|
344 |
.. _`SW Test Asset`: http://s60wiki.nokia.com/S60Wiki/MC_SW_Test_Asset_documentation
|
|
345 |
</#if>
|
|
346 |
|
|
347 |
Test source components
|
|
348 |
--------------------------
|
|
349 |
|
|
350 |
Unlike STIF, EUnit etc tests, test source components (or ``tsrc`` structure) is not needed for `ASTE`_ tests.
|
|
351 |
|
|
352 |
Two STEPS to setup ASTE with Helium
|
|
353 |
------------------------------------
|
|
354 |
|
|
355 |
**STEP 1: Configure ASTE properties in build.xml**
|
|
356 |
|
|
357 |
**(A)** Username and Password for the ATS should be set in the `.netrc file`_
|
|
358 |
|
|
359 |
.. code-block:: text
|
|
360 |
|
|
361 |
machine ats login ats_user_name password ats_password
|
|
362 |
|
|
363 |
Add the above line in the .netrc file and replace *ats_user_name* with your real ats username and "ats_password" with ats password.
|
|
364 |
|
|
365 |
.. _`.netrc file`: configuring.html?highlight=netrc#passwords
|
|
366 |
|
|
367 |
|
|
368 |
**(B)** The following properties are ASTE dependent with their edit status
|
|
369 |
|
|
370 |
* [must] - must be set by user
|
|
371 |
* [recommended] - should be set by user but not mandatory
|
|
372 |
* [allowed] - should **not** be set by user however, it is possible.
|
|
373 |
|
|
374 |
.. csv-table:: ATS Ant properties
|
|
375 |
:header: "Property name", "Edit status", "Description"
|
|
376 |
|
|
377 |
":hlm-p:`ats.server`", "[must]", "For example: ``4fio00105`` or ``catstresrv001.cats.noklab.net:80``. Default server port is ``8080``, but it is not allowed between intra and Noklab. Because of this we need to define server port as ``80``. The host can be different depending on site and/or product."
|
|
378 |
":hlm-p:`ats.drop.location`", "[must]", "Server location (UNC path) to save the ATSDrop file, before sending to the ATS. For example: ``\\\\trwsem00\\some_folder\\``. In case, ``ats.script.type`` is set to ``import``, ATS doesn't need to have access to :hlm-p:`ats.drop.location`, its value can be any local folder on build machine, for example ``c:/temp`` (no network share needed)."
|
|
379 |
":hlm-p:`ats.product.name`", "[must]", "Name of the product to be tested."
|
|
380 |
":hlm-p:`ats.aste.testasset.location`", "[must]", "Location of SW Test Assets, if the TestAsset is not packaged then it is first compressed to a ``.zip`` file. It should be a UNC path."
|
|
381 |
":hlm-p:`ats.aste.software.release`", "[must]", "Flash images releases, for example 'SPP 51.32'."
|
|
382 |
":hlm-p:`ats.aste.software.version`", "[must]", "Version of the software to be tested. For example: 'W810'"
|
|
383 |
":hlm-p:`ats.aste.email.list`", "[recommended]", "The property is needed if you want to get an email from ATS server after the tests are executed. There can be one to many semicolon(s) ";" separated email addresses."
|
|
384 |
":hlm-p:`ats.flashfiles.minlimit`", "[recommended]", "Limit of minimum number of flash files to execute ats-test target, otherwise ATSDrop.zip will not be generated. Default value is "2" files."
|
|
385 |
":hlm-p:`ats.aste.plan.name`", "[recommended]", "Modify the plan name if you have understanding of test.xml file or leave it as it is. Default value is "plan"."
|
|
386 |
":hlm-p:`ats.product.hwid`", "[recommended]", "Product HardWare ID (HWID) attached to ATS. By default the value of HWID is not set."
|
|
387 |
":hlm-p:`ats.test.timeout`", "[recommended]", "To set test commands execution time limit on ATS server, in seconds. Default value is '60'."
|
|
388 |
":hlm-p:`ats.aste.testrun.name`", "[recommended]", "Modify the test-run name if you have understanding of ``test.xml`` file or leave it as it is. Default value is a string consists of build id, product name, major and minor versions."
|
|
389 |
":hlm-p:`ats.aste.test.type`", "[recommended]", "Type of test to run. Default is 'smoke'."
|
|
390 |
":hlm-p:`ats.aste.testasset.caseids`", "[recommended]", "These are the cases that which tests should be run from the TestAsset. For example, value can be set as ``100,101,102,103,105,106,``. A comma is needed to separate case IDs"
|
|
391 |
":hlm-p:`ats.aste.language`", "[recommended]", "Variant Language to be tested. Default is 'English'"
|
|
392 |
"``reference.ats.flash.images``", "[recommended]", "Fileset for list of flash images (can be .fpsx, .C00, .V01 etc) It is recommended to set the fileset, default filset is given below which can be overwritten. set *dir=\"\"* attribute of the filset to ``${r'$'}{build.output.dir}/variant_images`` if :hlm-t:`variant-image-creation` target is being used."
|
|
393 |
|
|
394 |
|
|
395 |
An example of setting up properties:
|
|
396 |
|
|
397 |
.. code-block:: xml
|
|
398 |
|
|
399 |
<property name="ats.server" value="4fio00105" />
|
|
400 |
<property name="ats.drop.location" value="\\trwsimXX\ATS_TEST_SHARE\" />
|
|
401 |
<property name="ats.aste.email.list" value="temp.user@company.com; another.email@company.com" />
|
|
402 |
<property name="ats.flashfiles.minlimit" value="2" />
|
|
403 |
<property name="ats.product.name" value="PRODUCT" />
|
|
404 |
<property name="ats.aste.plan.name" value="plan" />
|
|
405 |
<property name="ats.product.hwid" value="" />
|
|
406 |
<property name="ats.test.timeout" value="60" />
|
|
407 |
<property name="ats.aste.testrun.name" value="${r'$'}{build.id}_${r'$'}{ats.product.name}_${r'$'}{major.version}.${r'$'}{minor.version}" />
|
|
408 |
<property name="ats.aste.testasset.location" value="" />
|
|
409 |
<property name="ats.aste.software.release" value="SPP 51.32" />
|
|
410 |
<property name="ats.aste.test.type" value="smoke" />
|
|
411 |
<property name="ats.aste.testasset.caseids" value="100,101,102,104,106," />
|
|
412 |
<property name="ats.aste.software.version" value="W810" />
|
|
413 |
<property name="ats.aste.language" value="English" />
|
|
414 |
|
|
415 |
...
|
|
416 |
<import file="${r'$'}{helium.dir}/helium.ant.xml" />
|
|
417 |
...
|
|
418 |
|
|
419 |
<fileset id="reference.ats.flash.images" dir="${r'$'}{release.images.dir}">
|
|
420 |
<include name="**/${r'$'}{build.id}*.core.fpsx"/>
|
|
421 |
<include name="**/${r'$'}{build.id}*.rofs2.fpsx"/>
|
|
422 |
<include name="**/${r'$'}{build.id}*.rofs3.fpsx"/>
|
|
423 |
</fileset>
|
|
424 |
|
|
425 |
|
|
426 |
*PLEASE NOTE:* Always declare *Properties* before and *filesets* after importing helium.ant.xml.
|
|
427 |
|
|
428 |
**STEP 2: Call target ats-aste**
|
|
429 |
|
|
430 |
To execute the target, a property should be set(``<property name="enabled.aste" value="true" />``).
|
|
431 |
|
|
432 |
Then call ``ats-aste``, which will create the ATSDrop.zip (test package).
|
|
433 |
|
|
434 |
If property ``ats.aste.email.list`` is set, an email (test report) will be sent when the tests are ready on ATS/ASTE.
|
|
435 |
|
|
436 |
|
|
437 |
Skip Sending AtsDrop to ATS
|
|
438 |
------------------------------
|
|
439 |
|
|
440 |
click :ref:`Skip-Sending-AtsDrop-label`:
|
|
441 |
|