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

<!-- 

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

Name        : publish.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 publishing -->

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

    <description>

    Zipping, delta zipping and copying targets

    </description>

    <!-- Tools configuration for basic Helium tools. -->

    <hlm:envdata id="helium.tools.envdata">

        <hlm:executable name="7za" versionArgs="" versionRegex="7-Zip (\S+)"/>

        <hlm:executable name="ant" versionArgs="-version" versionRegex="Apache Ant version (\S+)"/>

        <hlm:executable name="armcc" versionArgs="" versionRegex="RVCT(.+)" output="stderr"/>

        <hlm:executable name="ccm" versionArgs="version -c" versionRegex="(\S+)"/>

        <hlm:executable name="codescanner" versionArgs="" versionRegex="version (\S+)"/>

        <hlm:executable name="ctc" versionArgs="" versionRegex="This is CTC\+\+ \(v(\S+)\)"/>

        <hlm:executable name="java" versionArgs="-version" versionRegex="java version &quot;(\S+)\&quot;"/>

        <hlm:executable name="perl" versionArgs="-v" versionRegex="This is perl, v(\S+)"/>

        <hlm:executable name="python" versionArgs="--version" versionRegex="Python (\S+)"/>

        <hlm:executable name="sbs" versionArgs="-version" versionRegex="sbs version (.+)$"/>

        <hlm:executable name="unzip" versionArgs="-v" versionRegex="UnZip (\S+)"/>

        <hlm:executable name="emake" versionArgs="--version" versionRegex="Electric Make version (\S+)"/>

        <hlm:executable name="ectool" versionArgs="--version" versionRegex="ElectricCommander Tool version (\S+)"/>

    </hlm:envdata>

    <!--* @property zip.config.file

    The ZIP configuration XML file.

    @type string

    @editable required

    @scope public

    -->

    <!--* @property zips.ee.spec.name

    The name of the configuration section for EE zipping.

    @type string

    @editable optional

    @scope public

    -->

    <!--* @property zips.localised.spec.name

    The name of the configuration section for localisation zipping.

    @type string

    @editable optional

    @scope public

    -->

    <!--* @property zips.localised.spec.name

    The name of the configuration section for subcon zipping.

    @type string

    @editable optional

    @scope public

    -->

    <!--* @property delta.zip.file.size

    Define the file size of the zipped up released file, this is then used by delta zipping code to determine if a delta zip is required or a full zip should be created. The delta zip will only be published if it is less than 1/2 the size of this property

    @type string

    @editable required

    @scope public

    -->

    <!--* @property file-comparison.left_side

    The fileset id used on the left side of comparison.

    @type string

    @editable required

    @scope public

    -->

    <!--* @property file-comparison.right_side

    The fileset id used on the right side of comparison.

    @type string

    @editable required

    @scope public

    -->

    <!--* Set to true to generate zip file containing binaries generated by build.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

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

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

    Set to run archiving targets if archiving.enabled set to true.

    @type boolean

    @scope private

    -->

    <!--* @property skip-zips

    Set to true to generate zip file containing binaries generated by build. - deprecated: Start using archiving.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!--* @property publish.enabled

    Set to true to publish build artificats.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

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

    Set to run publishing targets if publish.enabled set to true.

    @type boolean

    @scope private

    -->

    <!--* @property publish

    Set to true to publish build artificats.. - deprecated: Start using publish.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!--* @property archive.wa.enabled

    Set to true to archive or zip the synergy workarea.

    @type boolean

    @editable required

    @scope public

    @since 11.0

    -->

    <!--* @property internal.archive.wa.enabled

    Set to run synergy wa archiving targets if archive.wa.enabled set to true.

    @type boolean

    @scope private

    -->

    <!--* @property zip.wa

    Set to true to arhive or zip the synergy workarea. - deprecated: Start using archive.wa.enabled property.

    @type boolean

    @editable required

    @scope public

    @deprecated since 11.0

    -->

    <!-- Check, is zipping binaries enabled -->

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

        <and>

            <not>

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

            </not>

            <not>

                <isset property="skip-zips"/>

            </not>

        </and>

    </condition>

    <!-- Check, is publish enabled -->

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

        <or>

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

            <isset property="publish"/>

        </or>

    </condition>

    <!-- Check, is publish enabled -->

    <condition property="internal.archive.wa.enabled">

        <or>

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

            <isset property="zip.wa"/>

        </or>

    </condition>

    <import file="internal-api/internal-api.ant.xml" />

    <import file="nwiki.ant.xml" />

    <import file="synergy.ant.xml" />

    <import file="test/test2_publishing_to_diamonds.ant.xml" />

    <!-- Set the maximum number of threads running for archiving (for a parallel job).

    @type integer

    -->

    <property name="archive.max.number.of.threads" value="8" />

    <fileset id="publish.files" dir="${build.output.dir}">

        <include name="logs/**/*" />

        <exclude name="logs/**/*_ant_build.log" />

        <include name="development_flash_images/**/*" />

        <include name="release_flash_images/**/*" />

        <include name="sisfiles/**/*" />

        <include name="build_area/**/*" />

        <include name="relnotes/**/*" />

        <include name="test_results/**/*" />

        <include name="utilities/**/*" />

        <include name="images/**/*" />

        <include name="variant_images/**/*" />

        <include name="BaseForNightlyBuild.txt" />

    </fileset>

    <!-- above fileset divided into following 4 filesets-->

    <fileset id="publish.files1" dir="${build.output.dir}">

        <include name="logs/**/*" />

        <exclude name="logs/**/*_ant_build.log" />

    </fileset>

    <fileset id="publish.files2" dir="${build.output.dir}">

        <include name="development_flash_images/**/*" />

    </fileset>

    <fileset id="publish.files3" dir="${build.output.dir}">

        <include name="sisfiles/**/*" />

        <include name="build_area/**/*" />

        <include name="relnotes/**/*" />

        <include name="test_results/**/*" />

        <include name="utilities/**/*" />

        <include name="variant_images/**/*" />

        <include name="images/**/*" />

        <include name="BaseForNightlyBuild.txt" />

    </fileset>

    <fileset id="publish.files4" dir="${build.output.dir}">

        <include name="release_flash_images/**/*" />

    </fileset>

    <!-- list of filesets -->

    <!-- The fileset id which will be upload

    @type string

    -->

    <property name="publish.fileset.ids" value="publish.files1,publish.files2,publish.files3,publish.files4" />

    <fileset id="helium.files" dir="${helium.dir}">

        <include name="*.bat" />

        <include name="**/*.ant.xml" />

        <include name="tools/common/**/*" />

        <include name="tools/release/**/*" />

    </fileset>

    <!-- 

        If publish property is set, copy the publish.files fileset to the publish.dir directory using 

        number.of.threads parallel threads

    -->

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

        <sequential>

            <if>

                <isset property="internal.publish.enabled" />

                <then>

                    <for list="${publish.fileset.ids}" param="fileset.id" parallel="true" threadCount='${number.of.threads}'>

                        <sequential>

                            <copy todir="${publish.dir}" preservelastmodified="true" failonerror="false">

                                <fileset refid="@{fileset.id}" />

                            </copy>

                            <pathconvert pathsep=" " property="@{fileset.id}.diamonds.files">

                                <map from="${build.output.dir}" to="${publish.dir}"/>

                                <fileset refid="@{fileset.id}"/>

                            </pathconvert>

                            <property name="diamonds.files" value="" />

                            <var name="diamonds.files" value="${@{fileset.id}.diamonds.files} ${diamonds.files}"/>

                        </sequential>

                    </for>

                </then>

            </if>

        </sequential>

    </macrodef>

    <!-- Creates the publish directory. Directory location is defined by property: ${publish.dir} -->

    <target name="prep-publish" if="internal.publish.enabled">

        <mkdir dir="${publish.dir}" />

    </target>

    <!-- Parses the zip configuration file. Expands all the ant properties. -->

    <target name="preprocess-zip-config">

        <!-- Path to the parsed file of zip specification file

        @type string

        @scope private

        -->

        <property name="zip.config.file.parsed" location="${temp.build.dir}/zip.cfg.xml.parsed" />

        <copy file="${zip.config.file}" tofile="${zip.config.file.parsed}" overwrite="true">

            <filterchain>

                <expandproperties />

            </filterchain>

        </copy>

    </target>

    <!-- This macro merges all the generated metadata files together.

    It uses the archiving configuration to find the output archive directory.

    The it merges all the <config.name>.metadata.xml files together.

    e.g:

    <pre>

    <hlm:mergeMetadataMacro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}"/>

    </pre>

    -->

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

        <attribute name="file" />

        <attribute name="config" />

        <sequential>

            <hlm:python>

                <![CDATA[

import configuration

import symrec

import os

import sys

import logging

import ant

LOGGER = logging.getLogger("metadatamerger")

LOGGER.setLevel(level=logging.INFO)

logging.basicConfig(level=logging.INFO)

def merge_filelist(merger, filelist):

    for filename in filelist:

        try:

            LOGGER.info("Merging %s" % filename)

            merger.merge(filename)

            os.unlink(filename)

        except Exception, exc:

            LOGGER.warning("Warning: %s" % exc)

try:

    builder = configuration.NestedConfigurationBuilder(open(ant.get_property(r'@{file}')), 'r')

    configSet = builder.getConfiguration()

    configs = configSet.getConfigurations(ant.get_property(r'@{config}'))

    if len(configs) > 0:

        filelist = []

        for config in configs:

            if config.get_boolean("grace.metadata", False):

                metadata = os.path.join(config['archives.dir'], config['name']+ ".metadata.xml")

                if os.path.exists(metadata):

                    LOGGER.info("Found %s" % metadata)

                    filelist.append(metadata)

        merger = None

        metadata_main = os.path.join(configs[0]['archives.dir'], "release_metadata.xml")

        if os.path.exists(metadata_main):

            merger = symrec.MetadataMerger(metadata_main)

            merge_filelist(merger, filelist)

            LOGGER.info(str("Writing %s" % metadata_main))

            merger.save()

        elif len(filelist) > 0:

            input = filelist.pop(0)

            merger = symrec.MetadataMerger(input)

            merge_filelist(merger, filelist)

            LOGGER.info(str("Writing %s" % metadata_main))

            merger.save(metadata_main)

            os.unlink(input)

except Exception, e:

    LOGGER.error('ERROR: %s' % e)

    sys.exit(-1)

]]> 

            </hlm:python>

        </sequential>

    </macrodef>

    <!-- This macro allows you to add or update one archive definition inside the release metadata files.

    e.g.:

    <pre>

        <hlm:updateMetadataMacro file="<path>/release_metadata.xml" archive="<path>/archive.zip" />

    </pre>

     -->

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

        <attribute name="file" />

        <attribute name="archive" />

        <attribute name="filters" default=""/>

        <sequential>

            <hlm:python>

        <![CDATA[

import symrec

import os

import traceback

import fileutils

import ant

import sys

import logging

LOGGER = logging.getLogger("metadataupdater")

LOGGER.setLevel(level=logging.INFO)

logging.basicConfig(level=logging.INFO)

if ant.get_property(r'@{file}') is None:

    raise Exception('file attribute is not defined.')

if ant.get_property(r'@{archive}') is None:

    raise Exception('archive attribute is not defined.')

filters = None

if ant.get_property(r'@{filters}') is not None:

    filters = ant.get_property(r'@{filters}').split(r',')

try:

    filename = ant.get_property(r'@{file}')

    archive = ant.get_property(r'@{archive}')

    if not os.path.exists(filename):

        raise Exception("Could not find file: %s" % filename)

    if not os.path.exists(archive):

        raise Exception("Could not find file: %s" % archive)

    LOGGER.info(str("Opening %s" % filename))

    md = symrec.ReleaseMetadata(filename)

    if os.path.basename(archive) not in md.keys():

        LOGGER.info(str("Adding %s to metadata" % os.path.basename(archive)))

        md.add_package(os.path.basename(archive), md5checksum=fileutils.getmd5(archive), size=os.path.getsize(archive), filters=filters)

    else:

        LOGGER.info(str("Updating %s to metadata" % os.path.basename(archive)))

        result = md[os.path.basename(archive)]

        result['md5checksum'] = unicode(fileutils.getmd5(archive))

        result['size'] = unicode(os.path.getsize(archive))

        if filters is not None:

            result['filters'] = filters

        md[os.path.basename(archive)] = result

    md.save()

except Exception, e:

    LOGGER.error('ERROR: %s' % e)

    sys.exit(-1)

]]> 

            </hlm:python>

        </sequential>

    </macrodef>

    <!-- This macro update the metadata file generated by the config provided by file.

    e.g:

    <pre>

    <hlm:updateMD5Macro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}"/>

    </pre>

    -->

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

        <attribute name="file" />

        <attribute name="config" />

        <sequential>

            <hlm:python>

        <![CDATA[

import configuration

import archive

import os

import symrec

import ant

import logging

import sys

LOGGER = logging.getLogger("metadataMD5updater")

LOGGER.setLevel(level=logging.INFO)

logging.basicConfig(level=logging.INFO)

# Reading the config from Ant

try:

    config_filename = ant.get_property(r'@{file}')

    spec_name = ant.get_property(r'@{config}')

    # Loading the config file.                        

    builder = configuration.NestedConfigurationBuilder(open(config_filename, 'r'))

    configSet = builder.getConfiguration()

    configs = configSet.getConfigurations(spec_name)

    if len(configs) > 0:

        if os.path.exists(os.path.join(configs[0]['archives.dir'], "release_metadata.xml")):

            md5update = symrec.MD5Updater(os.path.join(configs[0]['archives.dir'], "release_metadata.xml"))

            md5update.update()

            md5update.save()

        else:

            LOGGER.warning(str('WARNING: Could not find %s.' % os.path.join(configs[0]['archives.dir'], "release_metadata.xml")))

    else:

        LOGGER.warning('WARNING: No config.')

except Exception, e:

    LOGGER.error('ERROR: %s' % e)

    sys.exit(-1)

]]> 

        </hlm:python>

        </sequential>

    </macrodef>

    <condition property="archive.using.ec">

        <or>

            <equals arg1="${build.system}" arg2="ec-helium" />

            <equals arg1="${build.system}" arg2="sbs-ec" />

        </or>

    </condition>

    <!-- Zips files using a type and zip config file as args -->

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

        <attribute name="type" />

        <attribute name="file" />

        <attribute name="ec" default="${archive.using.ec}"/>

        <attribute name="failonemptyconfig" default="true"/>