FCL/sftools/dev/build: comparison buildframework/helium/tools/publish/publish.ant.xml

equal deleted inserted replaced

-:c7c26511138f
+:7c4a911dc066
 <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
 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" />
 <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="publish" />
+<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="publish">
+<target name="prep-publish" if="internal.publish.enabled">
 <mkdir dir="${publish.dir}" />
 </target>
 <!-- Parses the zip configuration file. Expands all the ant properties. -->
 ]]>
 </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" />
 ]]>
 </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}"/>
 ]]>
 </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" />
 </if>
 <mkdir dir="${@{phase}.log.dir}"/>
 <mkdir dir="${post.log.dir}"/>
 <property name="zip.@{type}.nopolicy.log.file" location="${@{phase}.log.dir}/${build.id}_@{type}_archive.nopolicy.log" />
 <property name="zip.@{type}.policy.log.file" location="${@{phase}.log.dir}/${build.id}_@{type}_archive.policy.log" />
-<trycatch property="exception" reference="exception">
+<hlm:taskRecorder output="${zip.@{type}.log.file}">
-<try>
+<!-- Path to the parsed file of zip specification file
-<!-- Don't print 'compressing' on console -->
+@type string
-<hlm:logtoconsole action="stop" />
+@scope private
-<!-- Stops writing on ...ant_build.log file-->
+-->
-<hlm:startSpecificLogMacro name="${zip.@{type}.log.file}" phase="@{phase}"/>
+<property name="zip.config.file.parsed" location="${temp.build.dir}/zip.cfg.xml.parsed" />
+<copy file="@{file}" tofile="${zip.config.file.parsed}" overwrite="true">
-<!-- Path to the parsed file of zip specification file
+<filterchain>
-@type string
+<expandproperties />
-@scope private
+</filterchain>
--->
+</copy>
-<property name="zip.config.file.parsed" location="${temp.build.dir}/zip.cfg.xml.parsed" />
+<hlm:updateArchiveConfig configtype="${zips.@{type}.spec.name}" configfileparsed="${zip.config.file.parsed}" usingec="@{ec}" failonemptyconfig="@{failonemptyconfig}"/>
-<copy file="@{file}" tofile="${zip.config.file.parsed}" overwrite="true">
+<if>
-<filterchain>
+<istrue value="@{ec}" />
-<expandproperties />
+<then>
-</filterchain>
+<echo>emake.root.to.append=${emake.root.to.append}</echo>
-</copy>
+<hlm:emakeMacro name="archive-full-@{type}" makefile="${build.drive}/ZIP_${zips.@{type}.spec.name}.make" target="all" dir="${build.drive}/" annodetail="basic,history,file,waiting" root="${emake.root.to.append}" failonerror="false" phase="archive"/>
-<hlm:updateArchiveConfig configtype="${zips.@{type}.spec.name}" configfileparsed="${zip.config.file.parsed}" usingec="@{ec}" failonemptyconfig="@{failonemptyconfig}"/>
+</then>
-<if>
+<else>
-<istrue value="@{ec}" />
+<if>
-<then>
+<isgreaterthan arg1="${number.of.threads}" arg2="${archive.max.number.of.threads}"/>
-<echo>emake.root.to.append=${emake.root.to.append}</echo>
+<then>
-<hlm:emakeMacro name="archive-full-@{type}" makefile="${build.drive}/ZIP_${zips.@{type}.spec.name}.make" target="all" dir="${build.drive}/" annodetail="basic,history,file,waiting" root="${emake.root.to.append}" failonerror="false" phase="archive"/>
+<ant antfile="${build.drive}/ZIP_${zips.@{type}.spec.name}.xml">
-</then>
+<!-- how many parallel threads can run
-<else>
+@type string
-<if>
+-->
-<isgreaterthan arg1="${number.of.threads}" arg2="${archive.max.number.of.threads}"/>
+<property name="number.of.threads" value="${archive.max.number.of.threads}"/>
-<then>
+</ant>
-<ant antfile="${build.drive}/ZIP_${zips.@{type}.spec.name}.xml">
+</then>
-<!-- how many parallel threads can run
+<else>
-@type string
+<ant antfile="${build.drive}/ZIP_${zips.@{type}.spec.name}.xml" />
--->
+</else>
-<property name="number.of.threads" value="${archive.max.number.of.threads}"/>
+</if>
-</ant>
+</else>
-</then>
+</if>
-<else>
+<hlm:python>
-<ant antfile="${build.drive}/ZIP_${zips.@{type}.spec.name}.xml" />
-</else>
-</if>
-</else>
-</if>
-<hlm:python>
 import archive
 import configuration
 builder = configuration.NestedConfigurationBuilder(open(r'${zip.config.file.parsed}', 'r'))
 configSet = builder.getConfiguration()
 configs = configSet.getConfigurations(r'${zips.@{type}.spec.name}')
 prebuilder = archive.ArchivePreBuilder(configuration.ConfigurationSet(configs), r'${zips.@{type}.spec.name}')
 prebuilder.cleanupSubstDrives()
 </hlm:python>
 <hlm:mergeMetadataMacro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}" />
 <hlm:updateMD5Macro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}" />
-</try>
+</hlm:taskRecorder>
-<catch>
-<!-- Printing and propagating the error -->
-<echo>ERROR: ${exception}</echo>
-<throw refid="exception"/>
-</catch>
-<finally>
-<!-- Todo: metadata: Convert to metadata structure -->
-<!-- Stops log back to main log. -->
-<hlm:stopSpecificLogMacro name="${zip.@{type}.log.file}" phase="@{phase}"/>
-<hlm:logtoconsole action="resume" />
-</finally>
-</trycatch>
 <hlm:assertFileExists file="${zip.@{type}.log.file}" />
 <copy file="${zip.@{type}.log.file}" tofile="${zip.@{type}.nopolicy.log.file}" verbose="true">
 <filterchain>
 <linecontainsregexp negate="true">
 <regexp pattern="POLICY_(ERROR|WARNING|INFO)" />
 <hlm:signalMacro logfile="${zip.@{type}.policy.log.file}"
 signal.input="archivePolicyErrorSignalInput" />
 </sequential>
 </macrodef>
 <!--
 1. To update the archive configuration file with substituted drives information for UNC paths (if any).
 2. To create the .make file to zip the sources using EC.
 -->
 <scriptdef name="updateArchiveConfig" language="jython" uri="http://www.nokia.com/helium">
 ]]>
 </scriptdef>
 <!-- Zips the Engineering English content. -->
-<target name="zip-ee" unless="skip-zips">
+<target name="zip-ee" if="internal.archiving.enabled">
 <hlm:zipContentMacro type="ee" file="${zip.config.file}" />
 </target>
 <!-- Zips the subcon content. -->
-<target name="zip-subcon" unless="skip-zips">
+<target name="zip-subcon" if="internal.archiving.enabled">
 <hlm:zipContentMacro type="subcon" file="${zip.config.file}" />
 </target>
 <!-- Zips the subcon rom content. -->
-<target name="zip-subcon-roms" unless="skip-zips">
+<target name="zip-subcon-roms" if="internal.archiving.enabled">
 <hlm:zipContentMacro type="subcon_roms" file="${zip.config.file}" />
 </target>
 <!-- Zips the localised content. -->
-<target name="zip-localised" unless="skip-zips">
+<target name="zip-localised" if="internal.archiving.enabled">
 <hlm:zipContentMacro type="localised" file="${zip.config.file}" />
 </target>
 <!-- Zips the trace rom content -->
-<target name="zip-trace-roms" unless="skip-zips">
+<target name="zip-trace-roms" if="internal.archiving.enabled">
 <hlm:zipContentMacro type="trace_roms" file="${zip.config.file}" />
 </target>
 <!-- Publishes the content defined by the filesets at the top of this project.
 The files are split into 4 filesets to parallelize the publish operation:
 * publish.files1
 * publish.files3
 * publish.files4
 All content is copied to the location defined by publish.dir. Also verify the source and target content after publish.
 -->
-<target name="publish" depends="prep-publish" if="publish">
+<target name="publish" depends="prep-publish" if="internal.publish.enabled">
 <hlm:publishMacro />
-<resourcecount property="total.changes.in.fileset">
+<!--<resourcecount property="total.changes.in.fileset">
 <fileset id="publish.files.location" dir="${build.output.dir}">
 <exclude name="logs/**/*_ant_build.log" />
 <exclude name="*" />
 <exclude name="build/**/*" />
 <exclude name="ec/**/*" />
 </not>
 <then>
 <echo message="ERROR: There are ${total.changes.in.fileset} changes in the publish directory. Uploading the changes again..." />
 <hlm:publishMacro />
 </then>
-</if>
+</if>-->
 </target>
 <!-- Basic publish target that publishes all important content. -->
-<target name="publish-generic" depends="prep-publish,publish-tools" if="publish">
+<target name="publish-generic" depends="prep-publish,publish-tools" if="internal.publish.enabled">
 <hlm:publishMacro />
 </target>
 <!-- Publishes tools needed to run commands from a published build area. -->
-<target name="publish-tools" depends="prep-publish" if="publish">
+<target name="publish-tools" depends="prep-publish" if="internal.publish.enabled">
 <echoproperties destfile="${publish.dir}/build_properties.txt">
 <propertyset>
 <propertyref name="publish.dir" />
 <propertyref name="publish.release.dir" />
 </propertyset>
 </copy>
 </target>
 <!-- The same as a basic publish. -->
-<target name="publish-variants" depends="prep-publish" if="publish">
+<target name="publish-variants" depends="prep-publish" if="internal.publish.enabled">
 <hlm:publishMacro />
 </target>
 <!-- Notifies the lxr indexing engine that the build area is ready to be indexed. -->
 <target name="lxr">
 <copy todir="${lxr.publish.dir}" preservelastmodified="true" failonerror="false" flatten="true">
 <fileset refid="publish.files" />
 </copy>
 <echo file="${lxr.publish.dir}\${build.id}_ready.txt" />
-</target>
-<!-- Mails the Diamonds XML data to the Diamonds server account. -->
-<target name="mail-log-to-diamonds">
-<runtarget target="lookup-email" />
-<echo message="Sending XML log through email." />
-<!--Ant mail task can not include xml as msg body. so do it in python-->
-<!-- TODO - would this work by using a <message> subelement? -->
-<hlm:python>
-import sys, smtplib, string
-fromaddr = r'${email.from}'
-toaddrs  = r'${diamonds.mail}'
-smtpserver  = r'${email.smtp.server}'
-subject  = "[DIAMONDS_DATA] ${build.id}>>>${diamonds.host}>>>${diamonds.path}"
-file = open(r'${diamonds.log.file}', 'r')
-msg = file.read()
-body = string.join(("From: %s" %fromaddr, "To: %s" %toaddrs, "Subject: %s" %subject, "", msg), "\r\n")
-try:
-server = smtplib.SMTP(smtpserver)
-server.sendmail(fromaddr, toaddrs, body)
-server.quit()
-print "Mail sent to " , toaddrs
-except Exception:
-print "SMTP server " + smtpserver + " unavailable!! Unable to send log to " , toaddrs
-</hlm:python>
 </target>
 <!-- Reports on the status of the build, through other targets. -->
 <target name="report" depends="binary-sizes-log"/>
 </hlm:python>
 <antcall target="post-build-md5" />
 </target>
 <!-- Generate a list of checksums for all files in the build area using EC system. @scope private-->
 <target name="build-md5-ec" depends="pre-build-md5">
 <mkdir dir="${delta.zip.location}" />
 <echo>delta.zip.temp.location: ${delta.zip.temp.location}</echo>
 <hlm:python failonerror="true">
 <arg value="${release.grace.service}/${release.grace.product}/${old.release.label}" />
 </exec>
 <move file="${delta.zip.temp.location}/specialInstructions.xml" tofile="${delta.zip.delete.file}" />
 <move file="${delta.zip.temp.location}/${build.id}.md5" tofile="${md5.signature.file}" />
 </target>
 <!-- Set prop old.md5.file to md5 file from last build in publish dir -->
 <target name="delta-use-last-build">
 <antcall target="grace-upload">
 <reference refid="grace.delta.zips.id" torefid="release.zips" />
 </antcall>
 </target>
 <!-- Publishes the Ant build log.
 First the logging should be stopped, before the file is copied. Hence this target should be called
 by the "final" target last.
 -->
-<target name="publish-build-log" depends="prep-publish" if="publish">
+<target name="publish-build-log" depends="prep-publish" if="internal.publish.enabled">
 <copy todir="${publish.dir}/logs" preservelastmodified="true" failonerror="false">
 <fileset dir="${build.log.dir}" includes="**/*.log" />
 </copy>
 </target>
 <!-- Copy the debug log to the build area if available-->
 <target name="copy-debug-logs">
 <echo message="log4j.dir:${log4j.cache.dir}" />
 <if>
 <available file="${log4j.cache.dir}" />
 </copy>
 </then>
 </if>
 </target>
 <!-- Target to simulate that the build is failed because of processing
 ant output
 -->
 <target name="raise-error">
 <echo message="ERROR: Build failed due to exceptions" />
 </target>
 <!-- Update the build status by processing the ant build output log -->
 <target name="build-status">
 <hlm:metadatarecord database="${metadata.dbfile}">
 <hlm:antmetadatainput>
 </hlm:metadatarecord>
 <hlm:signalMacro logfile="${build.log}"
 signal.input="exceptionSignalInput" />
 </target>
+<property name="ExecListener.file" value="${build.cache.log.dir}/${build.id}_executables.csv"/>
+<!-- Logs details about the tools used in the environment.
+This includes name, path, version. -->
+<target name="log-environment">
+<hlm:environment output="${build.log.dir}/${build.id}_environment.xml">
+<hlm:envdata refid="helium.tools.envdata"/>
+</hlm:environment>
+</target>
 <!-- Exception handler to process the ant output log -->
 <target name="hlm-exception-handler">
 <if>
 <available file="${build.log}"/>
 <runtarget target="do-exception-handler" />
 </then>
 </if>
 </target>
 <target name="do-exception-handler" depends="raise-error, build-status, build-log-summary, copy-debug-logs, publish-build-log" />
 <!-- Does any wrap-up at the end of the build. This should be the last target for every top-level target. -->
-<target name="final" depends="build-status, build-log-summary, copy-debug-logs, publish-build-log" />
+<target name="final" depends="build-status, build-log-summary, copy-debug-logs, publish-build-log, log-environment" />
 <!-- This target will zip the WA depending on the ado mapping file -->
-<target name="zip-wa" depends="ido-create-ado-mapping" if="zip.wa">
+<target name="zip-wa" depends="ido-create-ado-mapping" if="internal.archive.wa.enabled">
 <tempfile property="zipwa.dynamic.config" suffix=".xml" deleteonexit="false" destdir="${temp.build.dir}"/>
 <fmpp sourceFile="${helium.dir}/tools/common/templates/ido/zip-ant-wa-copy.xml.ftl" outputFile="${zipwa.dynamic.config}">
 <data expandProperties="yes">
 inputfile: antProperty(ado.mapping.file)
 ant: antProperties()

changeset 628	7c4a911dc066
parent 588	c7c26511138f
child 645	b8d81fa19e7d