<?xml version="1.0" encoding="UTF-8"?>

<!-- 

============================================================================ 

Name        : ats.ant.xml 

Part of     : Helium 

Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

All rights reserved.

This component and the accompanying materials are made available

under the terms of the License "Eclipse Public License v1.0"

which accompanies this distribution, and is available

at the URL "http://www.eclipse.org/legal/epl-v10.html".

Initial Contributors:

Nokia Corporation - initial contribution.

Contributors:

Description:

============================================================================

-->

<!--* @package testing -->

<project name="_testing.ats" xmlns:hlm="http://www.nokia.com/helium">

    <description>

    ATS testing targets.

    </description>

    <!--* @property enabled.ats

    Value must be set to execute ats-test target.

    @type boolean

    @editable required

    @scope public

    -->

    <!--* @property enabled.aste

    Value must be set to execute ats-aste target.

    @type boolean

    @editable required

    @scope public

    -->

    <!--* @property ats.product.name

    Name of the product to be tested. For example: "PRODUCT"

    @type string

    @editable required

    @scope public

    -->

    <!--* @property ats.drop.location

    Server location (UNC path) to save the ATS3Drop 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 ats.drop.location, its value can be any local folder on build machine, for example c:\temp (no network share needed).

    @type string

    @editable required

    @scope public

    -->

    <!--* @property ats.server

    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.

    @type string

    @editable required

    @scope public

    -->

    <!--* @property ats.password

    Password for ATS. This password might be different from NOE or HTTP/UNIX password.

    @type string

    @editable required

    @scope public

    -->

    <!--* @property ats.username

    Username for ATS server. This is NOT the NOE or HTTP/UNIX username.

    @type string

    @editable required

    @scope public

    -->

    <!-- -->

    <fileset id="reference.ats.flash.images" dir="${release.images.dir}">

        <include name="**/*.fpsx" />

        <include name="**/*rnd.C00" />

        <include name="**/*rnd.V01" />

    </fileset>

    @type string

    @scope public

    -->

    <fileset id="reference.ats.sis.images" dir="${ats.sis.images.dir}">

        <include name="**/*.sis" />

    </fileset>

    <!-- Limit of minimum number of sis files to execute matti-test target, otherwise MATTI-drop.zip will not be generated. Default value is "1" files.

    @type string

    @scope public

    -->

    <property name="ats.sisfiles.minlimit" value="1" />

    <var name="drop.file.counter" value="0" />

    The layer definition, in system definition file, for tsrc directory should look like:

    <pre>

    <layer name="name_test_layer">

        <module name="module_name">

            <unit id="unit_id" name="unti_name" bldFile="path_of_tsrc_folder_to_be_built" filter=""/>

        </module>

    </layer>

    </pre>

    -->

        <mkdir dir="${test.log.dir}"/>

        <hlm:filterRecordStartMacro pattern="${ats.password}" category="ats"/>

        <trycatch property="exception" reference="exception">

            <try>

                <runtarget target="ats-delta"/>

                <antcall target="create-canonical-sysdef-file" inheritRefs="true">

                    <reference refid="ats.system.definition.files" torefid="system.definition.files" />

                </antcall>

                <runtarget target="copy-mon-sym" />

                <runtarget target="ats-create-drop" />

            </try>

            <catch>

                <if>

                    <istrue value="${ats.delta.enabled}" />

                    <then>

                        <echo message="${exception}"/>

                    </then>

                    <else>

                        <throw refid="exception"/>

                    </else>

                </if>

            </catch>

        </trycatch>

        <hlm:filterRecordStopMacro log="${test.log.dir}/${build.id}_ats.log" append="false"/>

        <hlm:metadatarecord database="${metadata.dbfile}">

            <hlm:textmetadatainput>

                <fileset casesensitive="false" file="${test.log.dir}/${build.id}_ats.log" />

                <metadatafilterset refid="filterset.ats" />

            </hlm:textmetadatainput>

        </hlm:metadatarecord>

        <hlm:generateBuildStatus file="${build.id}_ats.log" />

    </target>

    <!-- The target creates the ATSdrop.zip file including test.xml for ATS ASTE tests. This target is executable.-->

    <target name="ats-aste" if="enabled.aste">

        <mkdir dir="${test.log.dir}"/>

        <hlm:filterRecordStartMacro pattern="${ats.password}" category="ats"/>

        <runtarget target="do-ats-aste" />

        <hlm:filterRecordStopMacro log="${test.log.dir}/${build.id}_aste.log" append="false"/>

        <hlm:metadatarecord database="${metadata.dbfile}">

            <hlm:textmetadatainput>

                <fileset casesensitive="false" file="${test.log.dir}/${build.id}_aste.log" />

                <metadatafilterset refid="filterset.aste" />

            </hlm:textmetadatainput>

        </hlm:metadatarecord>

        <hlm:generateBuildStatus file="${build.id}_aste.log" />

    </target>

    <!-- The target creates the MATTI_drop.zip file including test.xml for MATTI tests. This target is executable.-->

    <target name="matti-test" if="enabled.matti">

        <mkdir dir="${test.log.dir}"/>

        <hlm:filterRecordStartMacro pattern="${ats.password}" category="ats"/>

        <runtarget target="do-ats-matti" />

        <hlm:filterRecordStopMacro log="${test.log.dir}/${build.id}_matti.log" append="false"/>

        <hlm:metadatarecord database="${metadata.dbfile}">

            <hlm:textmetadatainput>

                <fileset casesensitive="false" file="${test.log.dir}/${build.id}_matti.log" />

                <metadatafilterset refid="filterset.matti" />

            </hlm:textmetadatainput>

        </hlm:metadatarecord>

        <hlm:generateBuildStatus file="${build.id}_matti.log" />

    </target>

    <!-- Sends drop file to ATS/ASTE. Please see `ats-test` for description. -->

    <target name="do-ats-test" depends="ats-username, ats-password" unless="skip.ats.sending">

        <property name="ats.sending" value="true" />

        <!-- Make the drop file visible to ATS. -->

        <var name="ats.drop.location.file" unset="true"/>

        <if>

            <isset property="ats.drop.location" />

            <then>

                <mkdir dir="${ats.drop.location}" />

                <property name="ats.drop.location.file" location="${ats.drop.location}/${ats.drop.file}" />

                <copy file="${build.output.dir}/ats/${ats.drop.file}" tofile="${ats.drop.location.file}" />

            </then>

            <else>

                <property name="ats.drop.location.file" location="${build.output.dir}/ats/${ats.drop.file}" />

            </else>

        </if>

        <!-- Notify ATS about the drop. -->

        <if>

            <istrue value="${ats4.enabled}" />

            <then>

                <hlm:python failonerror="true">

version = r'${java.version}'

if '1.6.0' in version:

    assert int(version.split('_')[1]) > 6, 'Java 6 u7 required'

                </hlm:python>

                <condition property="ats.import.arg" value="-import" else="">

                    <equals arg1="${ats.script.type}" arg2="import" />

                </condition>

                <condition property="ats4.libs" value="${helium.dir}/extensions/nokia/external/ats4" else="${helium.dir}/external/antlibs">

                    <available type="dir" file="${helium.dir}/extensions/nokia/external/ats4"/>

                </condition>

                    <classpath>

                        <pathelement path="${java.class.path}"/>

                        <fileset dir="${ats4.libs}" includes="*.jar"/>

                    </classpath>

                    <arg line="-url http://${ats.server}/ServerService -path ${ats.drop.location.file} ${ats.import.arg}"/>

                </java>

            </then>

            <else>

            </else>

        </if>

    </target>

    <!-- The target is dependent on "ats-test", should not be called independently. The target fetches flash files location -->

        <pathconvert pathsep="," property="ats.flash.images">

            <fileset refid="reference.ats.flash.images"/>

        </pathconvert>

        <hlm:python failonerror="true">

<![CDATA[

flashfilescount = len(r'${ats.flash.images}'.split(','))

mincount = int(r'${ats.flashfiles.minlimit}')

if flashfilescount < mincount:

    raise Exception('Not enough flash files, check reference.ats.flash.images and build.id, found: ' + r'${ats.flash.images}' + ', looking in: ' + r'${release.images.dir}')

]]>

        </hlm:python>

    </target>

    <!-- The target is dependent on "ats-test", should not be called independently. The target fetches flash files location -->

    <target name="ats-set-sis-flash-image-path">

        <pathconvert pathsep="," property="ats.sis.images">

            <fileset refid="reference.ats.sis.images"/>

        </pathconvert>

    </target>

    <!-- Sets values common for ATS, this is a dependent target and shouldn't be used as an individual target -->

    <target name="ats-common">

        <property name="ats.config.file" value="" />

        <property name="ats.specific.pkg" value="" />

        <property name="ats4.enabled" value="False" />

        <!-- Product HardWare ID (HWID) attached to ATS. By default the value of HWID is not set.

        @type string

        @scope public

        -->

        <property name="ats.product.hwid" value="" />

        <!-- To set test commands execution time limit on ATS3 server, in seconds. Default value is "60".

        @type string

        @scope public

        -->

        <property name="ats.test.timeout" value="60" />

        <!-- Sets ATS reports store location. Default location is "${publish.dir}/${publish.subdir}"

        @type string

        @scope public

        -->

        <property name="ats.report.location" value="${publish.dir}/${publish.subdir}" />

        <condition property="internal.ats.diamonds.arg" value="--diamonds-build-url=http://${diamonds.host}${diamonds.build.id}" else="">

            <isset property="diamonds.build.url" />

        </condition>

    </target>

    <!-- Sets default values for the ATS (STIF and EUnit), this is a dependent target and shouldn't be used as an individual target -->

    <target name="ats-set-defaults-stifeunit" depends="ats-common,lookup-email">

        <!-- Default values for the properties -->

        <!-- 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.

        @type string

        @scope public

        -->

        <property name="ats.email.list" value="${email.from}" />

        <!-- The default value is "data" and refers to the 'data' directory under 'tsrc' directory.

        @type string

        @scope public

        -->

        <property name="tsrc.data.dir" value="data" />

        <!-- Modify the plan name if you have understanding of test.xml file or leave it as it is. Default value is "plan"

        @type string

        @scope public

        -->

        <property name="ats.plan.name" value="plan" />

        <!-- 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

        @type string

        @scope public

        -->

        <property name="ats.testrun.name" value="${build.id}_${ats.product.name}" />

        <!-- 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

        @type string

        @scope public

        -->

        <property name="ats.ctc.host" value="" />

        <condition property="ats.version" value="4" else="3">

            <istrue value="${ats4.enabled}" />

        </condition>

        <var name="ats.drop.file" value="ATS${ats.version}Drop${drop.file.counter}.zip" />

        @type string

        @scope public

        -->

        <!-- Should be "True" if tracing is needed during the tests running on ATS3. Default value is "False", the values are case-sensitive.

        @type string

        @scope public

        -->

        <property name="ats.trace.enabled" value="False" />

        <!-- 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.

        @type string

        @scope public

        -->

        <property name="ats.ctc.enabled" value="False" />

        <property name="ats.multiset.enabled" value="False" />

        <!-- Flags for EUnit exerunner can be set by setting the value of this variable. The default flags are set to "/E S60AppEnv /R Off".

        @type string

        @scope public

        -->

        <property name="eunitexerunner.flags" value="/E S60AppEnv /R Off" />

        <!-- 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.

        @type string

        @scope public

        -->

        <property name="ats.obey.pkgfiles.rule" value="False" />

    </target>

    <!-- Sets default values for the ASTE, this is a dependent target and shouldn't be used as an individual target -->

    <target name="ats-set-defaults-aste" depends="ats-common">

        <var name="ats.drop.file" value="ATSAsteDrop.zip" />

        <property name="ats.aste.test.type" value="smoke" />

        <property name="ats.aste.testasset.caseids" value="100,101,102,103,105,106,107,108,109,110,111,112,113,114,115" />

        <property name="ats.aste.software.version" value="${build.id}" />

        <property name="ats.aste.language" value="English" />

        <property name="ats.aste.software.release" value="${build.name}" />

        <!-- Modify the plan name if you have understanding of test.xml file or leave it as it is. Default value is "plan"

        @type string

        @scope public

        -->

        <property name="ats.aste.plan.name" value="plan" />

        <!-- 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

        @type string

        @scope public

        -->

        <property name="ats.aste.testrun.name" value="${build.id}_${ats.product.name}_${major.version}.${minor.version}" />

        <!-- 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.

        @type string

        @scope public

        -->

        <property name="ats.aste.email.list" value="" />

    </target>

    <!-- This macro fetches the tsrc paths from system definition file (layers.sysdef.xml), layer defintion should look like

    <pre>

    <layer name="name_test_layer">

        <module name="module_name">

            <unit id="unit_id" name="unti_name" bldFile="path_of_tsrc_folder_to_be_built" filter="" />

        </module>

    </layer>

    </pre>

    -->

    <scriptdef name="getModuleTsrcMacro" language="jython" uri="http://www.nokia.com/helium">

        <attribute name="property" />

        <attribute name="prefix"/>        

import traceback

import os

import atsant

from com.nokia.ant.util import Helper

canonicalsysdeffile = Helper.getProperty(project, 'canonical.sysdef.file')

modules = atsant.files_to_test(canonicalsysdeffile, project.getProperty('exclude.test.layers'), project.getProperty('ido.build.filter'), project.getProperty('build.drive'))

for name in modules.keys():    

    if modules[name] == []:

        del modules[name]

    else:

        project.setProperty("%s.%s" % (attributes.get('prefix'), name), " ".join(modules[name]))

project.setProperty(attributes.get('property'), ",".join(modules.keys()))

project.setProperty('ats.drops.count', str(len(modules)))

    </scriptdef>

    <!-- The target is dependent on "ats-test", should not be called individually. The target creates the ATSdrop.zip file including test:xml file -->

        <mkdir dir="${build.output.dir}/ats" />

        <hlm:getModuleTsrcMacro property="module.list" prefix="module.tsrc" />

        <if>

            <scriptcondition language="beanshell">

                <![CDATA[

                    String value = project.getProperty("module.list");

                    if (value != null) {

                        String[] out = value.split(",");

                        if ((out == null) || (out.length == 0) || ((out.length == 1) && (out[0].length()==0))) {

                                    self.setValue(true);

                            } else {

                                    self.setValue(false);

                            }

                        } else {

                            self.log("Error: module.list not defined.");

                            self.setValue(true);

                        }

                            ]]>

            </scriptcondition>

            <then>

                <echo message="Error: No test modules found!" />

            </then>

            <else>

                <for list="${module.list}" delimiter="," param="module">

                    <sequential>

                        <runtarget target="ats-set-defaults-stifeunit" />

                        <echo>${ats.drop.file}</echo>

                        <exec executable="python">

                            <arg line="-m ats3.__init__" />

                            <arg value="--device-type=${ats.product.name}" />

                            <arg value="--device-hwid=${ats.product.hwid}" />

                            <arg value="${internal.ats.diamonds.arg}" />

                            <arg value="--drop-file=${build.output.dir}/ats/${ats.drop.file}" />

                            <arg value="--report-email=${ats.email.list}" />

                            <arg value="--plan-name=${ats.plan.name}" />

                            <arg value="--testrun-name=${ats.testrun.name}_@{module}" />

                            <arg value="--flash-images=${ats.flash.images}" />

                            <arg value="--minimum-flash-images=${ats.flashfiles.minlimit}" />

                            <arg value="--target-platform=${ats.target.platform}" />

                            <arg value="--data-dir=${tsrc.data.dir}" />

                            <arg value="--test-timeout=${ats.test.timeout}" />

                            <arg value="--build-drive=${build.drive}" />

                            <arg value="--trace-enabled=${ats.trace.enabled}" />

                            <arg value="--ctc-enabled=${ats.ctc.enabled}" />

                            <arg value="--multiset-enabled=${ats.multiset.enabled}" />

                            <arg value="--file-store=${ats.report.location}" />

                            <arg value="--eunitexerunner-flags=${eunitexerunner.flags}" />

                            <arg value="--ctc-run-process-params=${ats.ctc.host}#${ats.drop.file}#${ats.drops.count}" /> <!-- Three differnt value are combined with '#' character which is later parsed inside the script -->

                            <arg value="--monsym-files=${ats.ctc.monsyms}" />

                            <arg value="--config=${ats.config.file}" />

                            <arg value="--obey-pkgfiles=${ats.obey.pkgfiles.rule}" />

                            <arg value="--ats4-enabled=${ats4.enabled}" />

                            <arg value="--specific-pkg=${ats.specific.pkg}" />

                            <arg value="--verbose" />

                            <arg line="${module.tsrc.@{module}}" />

                        </exec>

                        <runtarget target="do-ats-test" />

                        <math result="drop.file.counter" operand1="1" operation="+" operand2="${drop.file.counter}" datatype="int" />

                    </sequential>

                </for>