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

<!-- 

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

Name        : ido-prep.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 preparation -->

<project name="ido-prep" xmlns:hlm="http://www.nokia.com/helium">

    <description>

        IDO related targets.

         * Build area preparation

         * Codescanner integration

         * Cenrep generation (old way)

         * IBY export (old way)

    </description>

    <!-- Path to the cenrep root. Default value is "${build.drive}/epoc32/tools/cenrep/ido/src"

    @type string

    @scope private

    -->

    <property name="ido.cenrep.root" location="${build.drive}/epoc32/tools/cenrep/ido/src"  />

    <!-- Path to the cenrep target directory. Default value is "${build.drive}/epoc32/data/z/private/10202be9"

    @type string

    @scope private

    -->

    <property name="ido.cenrep.target" value="${build.drive}/epoc32/data/z/private/10202be9"  />

    <!-- Defines the location of Codescanner output.

    @type string

    -->

    <property name="ido.codescanner.output.dir" location="${build.output.dir}/${build.id}_codescanner"/>

    <!-- Defines the location of CMT++ output and the input for the diamonds creation target.

    @type string

    -->

    <property name="ido.cmt.html.output.dir" location="${build.log.dir}/${build.id}_cmt"/>

    <!--* @property package.cone.validation.enabled

    Enables to run confml file validation.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

    <!--* @property internal.package.cone.validation.enabled

    Enables the targets to run confml file validation if package.cone.validation.enabled set to true.

    @type boolean

    @scope private

    -->

    <!-- Path to a INI file that contains the mapping between the ADO from Synergy WA and it's location on the BA for quality targets.

    @type string

    @scope private

    @deprecated since 12.0 Not used, ido-create-ado-mapping is not used, it is replaced with macro createAdoMappingMacro.

    -->

    <property name="ado.mapping.file" location="${build.output.dir}/build/ado_mapping.ini"/>

    <!-- Path to a INI file that contains the quality mapping between the ADO from Synergy WA and it's location on the BA for quality targets.

    @type string

    @scope private

    @deprecated since 12.0 Not used, ido-create-ado-mapping is not used, it is replaced with macro createAdoMappingMacro.

    -->

    <property name="ado.quality.mapping.file" location="${build.output.dir}/build/ado_quality_mapping.ini"/>

    <!-- Path to the build romtree; the location contains iby files. Default value is "${build.drive}${env.EPOCROOT}/epoc32/rom/include"

    deprecated: Not used, ido-create-ado-mapping is not used, it is replaced with macro createAdoMappingMacro.

    @type string

    @scope private

    @deprecated 12.0 since Not used, ido-create-ado-mapping is not used, it is replaced with macro createAdoMappingMacro.

    -->

    <!--* @property cmt.enabled

    Enables to run cmt, testing code coverage tool.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

    <!--* @property internal.cmt.enabled

    Enables to run cmt tools targets if cmt.enabled is set to true, testing code coverage tool.

    @type boolean

    @scope private

    -->

    <!--* @property enable.cmt

    Enables to run cmt, testing code coverage tool. - deprecated: Start using cmt.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!--* Enables codescanner tool to run.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

    <property name="codescanner.enabled" value="true"/>

    <!--* @property codescanner.lxr.source.url

    Enables source files referring to lxr url path in codescanner output html files. Should not include source path on platform.

    @type string

    @scope public

    @since 12.0

    -->

    <!--* @property internal.codescanner.enabled

    Enables codescanner targets to run if codescanner.enabled is set to true.

    @type boolean

    @scope private

    -->

    <!--* @property skip.codescanner

    Enables codescanner tool to run. - deprecated: Start using codescanner.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!-- Set to true to keep old sources of build area.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

    <property name="keep.old.source.enabled" value="false"/>

    <!--* @property ido.keep.old

    Set to true to keep old sources of build area. - deprecated: Start using keep.old.source.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!-- Set to true to copy internal folders while coping source from wa to build area.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

    <property name="keep.internal.folders.enabled" value="false"/>

    <!--* @property keep.internals

    Set to true to keep old internal folder while coping source from wa to build area. - deprecated: Start using keep.internal.folders.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!-- Internal target that generates the '''ado.mapping.file'''.

     It is a INI file that contains ADO location as a key and target location as value.

    -->

    <!-- To enable to confml file validation -->

    <condition property="internal.package.cone.validation.enabled">

        <istrue value="${package.cone.validation.enabled}" />

    </condition>

    <!-- check, is cmt enabled -->

    <condition property="internal.cmt.enabled">

        <or>

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

            <isset property="enable.cmt"/>

        </or>

    </condition>

    <!-- check is codescanner enabled-->

    <condition property="internal.codescanner.enabled">

        <and>

            <not>

                <isfalse value="${codescanner.enabled}" />

            </not>

            <not>

                <isset property="skip.codescanner"/>

            </not>

        </and>

    </condition>

    <!--

    @deprecated: since 12.0: Use createAdoMappingMacro  

     -->

    <target name="ido-create-ado-mapping">

        <hlm:createAdoMappingMacro adoMapFile="${ado.mapping.file}" />

        <hlm:createAdoMappingMacro adoMapFile="${ado.quality.mapping.file}" mapForQuality="true"/>

    </target>

    <!-- Internal target to generate ado mapping for old sysdef format, this would be deprecated once

         the sysdef3 is deployed. 

    -->

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

        <attribute name="adomapfile" />

        <attribute name="mapforquality" />

import os

import idoprep

idoprep.create_ado_mapping(project.getProperty(r"prep.dynamic.sysdef.config"), attributes.get(r"adomapfile"), attributes.get(r"mapforquality"), project.getProperty(r"build.drive"), project.getProperty(r"ado.quality.dirs.path"))

    </scriptdef>

    <!-- Generates ado mapping file which could be used to identify the new sources. 

        e.g: 

        <pre>

            <property name="prep.copy.mapping.file" location="${build.output.dir}/build/ado_mapping_copy.ini" />

            <hlm:createAdoMappingMacro adoMapFile="${prep.copy.mapping.file}" />

        </pre>

    Usage example:

    <pre>

        <target name="ido-map-file">

            <property name="prep.copy.mapping.file" location="${build.output.dir}/build/ado_mapping_copy.ini" />

            <hlm:createAdoMappingMacro adoMapFile="${prep.copy.mapping.file}" />

        </target>

    </pre>

    -->

    <macrodef name="createAdoMappingMacro" uri="http://www.nokia.com/helium">

        <attribute name="adoMapFile"/>

        <attribute name="mapForQuality" default="false"/>

        <sequential>

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

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

            <if>

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

                <then>

                    <if>

                        <and>

                            <isreference refid="ado.quality.dirs" />

                            <equals arg1="@{mapForQuality}" arg2="true" />

                        </and>

                        <then>

                            <hlm:createPackageMapping epocroot="${build.drive}" destFile="@{adoMapFile}"

                                filterDirSet="ado.quality.dirs" >

                                <path refid="system.definition.files" />

                            </hlm:createPackageMapping>

                        </then>

                        <else>

                            <hlm:createPackageMapping epocroot="${build.drive}" destFile="@{adoMapFile}">

                                <path refid="system.definition.files" />

                            </hlm:createPackageMapping>

                        </else>

                    </if>

                </then>

                <else>

                    <tempfile property="prep.dynamic.sysdef.config" suffix=".txt" deleteonexit="false" destdir="${temp.build.dir}"/>

                    <trycatch property="error.message">

                        <try>

                            <hlm:referenceToFileMacro refid="system.definition.files" output="${prep.dynamic.sysdef.config}"/>

                        </try>

                        <catch>       

                            <propertyregex property="message" input="${error.message}"

                              regexp=":(.*)$"

                              select="\1" casesensitive="false" />

                            <fail message="Error: ${message}" />     

                        </catch>               

                    </trycatch>

                    <trycatch>

                        <try>

                            <pathconvert pathsep="," property="ado.quality.dirs.path">

                                <dirset refid="ado.quality.dirs"/>

                            </pathconvert>                              

                        </try>

                    </trycatch>

                    <hlm:adoMappingOldSysdefMacro adomapfile="@{adoMapFile}"  mapforquality="@{mapForQuality}" />

                </else>

            </if>

        </sequential>

    </macrodef>

    <!-- Target to generate cenreps using cone tool -->

    <target name="ido-gen-cenrep">

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

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

        <tempfile property="cenrep.dynamic.config" suffix=".xml" deleteonexit="false" destdir="${temp.build.dir}"/>

        <fmpp sourceFile="${helium.dir}/tools/preparation/templates/ido-cenrep-gen.xml.ftl"

              outputfile="${cenrep.dynamic.config}">

            <data expandProperties="yes">

                dbPath: ${metadata.dbfile}

                ant: antProperties()

                os: eval('System.getProperty("os.name")')

            </data>

        </fmpp>

        <ant antfile="${cenrep.dynamic.config}"/>

        <copy file="${post.log.dir}/${build.id}_cenrep.cone.log" tofile="${temp.build.dir}/${build.id}_cenrep_includefile.txt" overwrite="true" failonerror="false">

            <filterchain>

                <linecontainsregexp>

                    <regexp pattern="^\s*Generating file"/>

                </linecontainsregexp>

            </filterchain>

        </copy>

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

            <hlm:textmetadatainput>

                <fileset casesensitive="false" file="${post.log.dir}/${build.id}_cenrep.cone.log" />

                <metadatafilterset>

                    <metadatafilter priority="error" regex="^ERROR\s+:.*" description="cone error" />

                    <metadatafilter priority="warning" regex="^WARNING\s+:.*" description="cone warnings" />

                    <metadatafilter priority="info" regex="^INFO\s+:.*" description="cone info" />

                </metadatafilterset>

            </hlm:textmetadatainput>

        </hlm:metadatarecord>

        <hlm:metadataCountSeverity severity="ERROR" log="${post.log.dir}/${build.id}_cenrep.cone.log" database="${metadata.dbfile}" property="cone.error.total"/>

        <echo>ConE error: ${cone.error.total}</echo>

        <hlm:generateBuildStatus file="${post.log.dir}/${build.id}_cenrep.cone.log" />

    </target>

    <!-- To validate confml files of packages.-->

    <target name="ido-validate-confml" if="internal.package.cone.validation.enabled">

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

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

        <tempfile property="confml.dynamic.config" suffix=".xml" deleteonexit="false" destdir="${temp.build.dir}"/>

        <fmpp sourceFile="${helium.dir}/tools/preparation/templates/ido-confml-validate.ant.xml.ftl"

              outputfile="${confml.dynamic.config}">

            <data expandProperties="yes">

                dbPath: ${metadata.dbfile}

                ant: antProperties()

                os: eval('System.getProperty("os.name")')

            </data>

        </fmpp>

        <trycatch property="confml.validate.thrown">

            <try>

                <ant antfile="${confml.dynamic.config}"/>

            </try>

            <catch>

                <fail message="${confml.validate.thrown}"/>

            </catch>

            <finally>

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

                    <hlm:textmetadatainput>

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

                        <metadatafilterset>

                            <metadatafilter priority="error" regex="^ERROR\s+:.*" description="cone error" />

                            <metadatafilter priority="warning" regex="^WARNING\s+:.*" description="cone warnings" />

                            <metadatafilter priority="info" regex="^INFO\s+:.*" description="cone info" />

                            <metadatafilter priority="error" regex="\s*[1-9]\d*\s*problem\(s\).*?" description="cone validation error" />

                        </metadatafilterset>

                    </hlm:textmetadatainput>

                </hlm:metadatarecord>

                <hlm:metadataCountSeverity severity="ERROR" log="${post.log.dir}/${build.id}_validate_confml.log" database="${metadata.dbfile}" property="confml.validate.error.total"/>

                <echo>ConE error: ${confml.validate.error.total}</echo>

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

                <hlm:signalMacro logfile="${post.log.dir}/${build.id}_validate_confml.log" phase="post" signal.input="ConEValidateSignalInput" />

            </finally>

        </trycatch>

    </target>

    <!--* Defines which template to use in order to achive the package copying.

    @type string

    @scope public

    -->

    <property name="ido.prep.copy.template" location="${helium.dir}/tools/preparation/templates/ido-ant-copy.xml.ftl" />

    <!-- Target that uses the information from the system.definition.files to prepare the IDO build area.

        It relies on the fact that layer_real_source_path entity is declared in each ADO configuration.

        By default it deletes the previous content. If you want to backup what was previoulsy used please

        defined '''keep.old.source.enabled''' property.         

        -->

    <target name="ido-prep-copy">

        <property name="prep.copy.mapping.file" location="${build.output.dir}/build/ado_mapping_copy.ini" />

        <hlm:createAdoMappingMacro adoMapFile="${prep.copy.mapping.file}" />

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

        <tempfile property="prep.dynamic.config" suffix=".xml" deleteonexit="false" destdir="${temp.build.dir}"/>

        <fmpp sourceFile="${ido.prep.copy.template}"

            outputFile="${prep.dynamic.config}">

            <data expandProperties="yes">

                inputfile: antProperty(prep.copy.mapping.file)

                ant: antProperties()

                    data: eval('

                            java.io.FileInputStream pin = new java.io.FileInputStream(filename);

                            java.util.Properties props = new java.util.Properties();

                            props.load(pin);

                            return props;

                            ', {filename:get(inputfile)})

            </data>

        </fmpp>

        <ant antfile="${prep.dynamic.config}"/>

    </target>

    <!--

    Run cleanup system definition configuration. The configuration name are

    generated from the ``sysdef.configurations.list`` property, appending '_clean'

    at the end of each configuration also reversing their build order.

    if ``sysdef.clean.configurations.list`` is defined it overrides

    the previous beharvious and is used to cleanup the environment.

    -->

    <target name ="ido-prep-clean">

        <if>

            <not>

                <isset property="sysdef.clean.configurations.list"/>

            </not>

            <then>

                <if>

                    <isset property="sysdef.configurations.list"/>

                    <then>

                        <script language="jython" setbeans="false">

rev_names = ""

for sysdef in project.getProperty("sysdef.configurations.list").split(","):    

    rev_names = sysdef + "_clean," + rev_names

project.setProperty("sysdef.clean.configurations.list", rev_names)

                        </script>

                    </then>

                    <else>

                        <fail message="You should either define sysdef.clean.configurations.list or sysdef.configurations.list."/>

                    </else>

                </if>

            </then>

        </if>

        <antcall target="compile-main" inheritRefs="true">

            <param name="sysdef.configurations.list" value="${sysdef.clean.configurations.list}"/>

            <param name="compile.signal.input" value="compileCleanSignalInput"/>

            <param name="internal.compile.discard.result.enabled" value="true"/>

            <param name="internal.compile.cmd.clean.enabled" value="true"/>

        </antcall>

    </target>

    <!--

        This targets run the codescanner application on each discovered ADO.

        The location of the output is defined byt ``ido.codescanner.output.dir`` property.

        And the type is defined by ``ido.codescanner.output.type`` (default is HTML). 

        To update the HTML files with lxr source URL you need to set the property ``codescanner.lxr.source.url`` 

        URL should not include source path on platform.

    -->

    <target name="ido-codescanner" if="internal.codescanner.enabled">

        <property name="codescanner.mapping.file" location="${build.output.dir}/build/ado_mapping_codescanner.ini" />

        <hlm:createAdoMappingMacro adoMapFile="${codescanner.mapping.file}" mapForQuality="true"/>

        <!--hlm:iniKeys2Path ini="${codescanner.mapping.file}" pathid="ado.src.path"/-->

        <!-- Defines the format of Codescanner output (html|xml|std).

        @type string

        -->

        <hlm:resourceaccess lockName="subst-drive">

            <property name="ido.codescanner.output.type" value="html"/>

            <!-- Defines the fmpp template for Codescanner.

            @type string

            @scope private

            -->

            <property name="ido.codescanner.template" value="${helium.dir}/tools/preparation/templates/ido-codescanner.ant.xml.ftl"/>

            <script language="jython" setbeans="false">

#internal.codescanner.drive

import os

import fileutils

import configuration

import pathaddition.relative

config = configuration.PropertiesConfiguration(stream=open(str(project.getProperty("codescanner.mapping.file")), 'r'))

prefix = pathaddition.relative.commonprefix(config.keys())

if not os.path.exists(prefix):

    raise Exception("Could not find common prefix for the following paths:\n" + "\n".join(config.keys()))

if os.sep == '\\':

    self.log(str('Substing %s' % prefix))

    drive = fileutils.get_next_free_drive()

    fileutils.subst(drive, prefix)

else:

    drive = prefix

project.setProperty('internal.codescanner.drive', drive)

# creating the structure form subst drive.

path = project.createDataType("path")

for location in config.keys():

    self.log(str("From %s" % location))

    location = drive + os.sep + pathaddition.relative.abs2rel(location, prefix)

    self.log(str("To %s" % location))

    pe = path.createPathElement()

    pe.setPath(location)

project.addReference('substed.ado.src.path', path)

            </script>

        </hlm:resourceaccess>

        <trycatch property="codescanner.thrown">

            <try>

                <if>

                    <isset property="codescanner.lxr.source.url"/>

                    <then>

                        <tempfile property="codescanner.dynamic.config" suffix=".xml" deleteonexit="false" destdir="${temp.build.dir}"/>

                        <fmpp sourceFile="${ido.codescanner.template}"

                            outputFile="${codescanner.dynamic.config}">

                            <data expandProperties="yes">

                                inputfile: antProperty(codescanner.mapping.file)