Merge "Improve branch cutting scripts"
[releng/builder.git] / jjb / releng-macros.yaml
index 02f5642dd7b13d3b8496196dca97c6c038d001e4..82e772c74fac727c3ca240c9db0f2e676bf9701d 100644 (file)
@@ -6,8 +6,11 @@
       - build-discarder:
           days-to-keep: '{build-days-to-keep}'
           num-to-keep: 40
-          artifact-days-to-keep: -1
-          artifact-num-to-keep: 5
+          # Need to keep artifacts for at least 1 day as some projects need to
+          # be able to validate their artifacts and only allowing limited
+          # number of artifacts could make fast moving jobs lost their
+          # artifacts before the developers can test it.
+          artifact-days-to-keep: 1
 
 - parameter:
     name: opendaylight-infra-parameters
           description: 'Parameter to identify an ODL Gerrit project'
       - string:
           name: ARCHIVE_ARTIFACTS
-          default: '{artifacts} **/target/surefire-reports/*-output.txt **/hs_err_*.log **/target/feature/feature.xml'
+          default: >
+              {artifacts}
+              # Before adding more here, beware of https://jira.linuxfoundation.org/browse/RELENG-280
+              **/target/surefire-reports/*-output.txt
+              **/target/failsafe-reports/failsafe-summary.xml
+              **/hs_err_*.log
+              **/target/feature/feature.xml
+              **/*.hprof
           description: 'Space separated glob patterns for artifacts to archive into logs.opendaylight.org'
       - string:
           name: GERRIT_PROJECT
       - string:
           name: GERRIT_REFSPEC
           default: '{refspec}'
-          description: "GERRIT_REFSPEC parameter if not given by trigger"
+          description: |
+              Gerrit reference to checkout (ex: refs/heads/master,
+              refs/changes/48/61548/1 where 61548 is Gerrit change ID, 1 is
+              patch number and 48 is last two digits of change ID)
       - string:
           name: STACK_NAME
-          default: '$JOB_NAME-$BUILD_NUMBER'
+          default: '$SILO-$JOB_NAME-$BUILD_NUMBER'
           description: "Used by Heat to generate a unique stack & vm name"
+      - string:
+          name: OS_CLOUD
+          default: '{os-cloud}'
+          description: |
+              The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
+              variable name that is significant to openstack client as a
+              environment variable. Please refer to the documentation for
+              further details.
+              https://docs.openstack.org/developer/python-openstackclient/
 
 - parameter:
     name: build-tag
       - string:
           name: PATCHES_TO_BUILD
           default: ''
-          description: 'csv list of patches in project:changeset format to build distribution with'
+          description: |
+            Patches to add to distro in CSV project:changeset format (genius:32/53632/9,netvirt:59/50259/47)
+
+- parameter:
+    name: run-test-parameter
+    parameters:
+      - string:
+          name: RUNTEST
+          default: '{run-test}'
+          description: 'Set true to run test after build'
 
 - parameter:
     name: distribution-branch-to-build-parameter
           server-name: '{server}'
           trigger-on:
             - patchset-created-event:
-                exclude-drafts: 'true'
-                exclude-trivial-rebase: 'false'
-                exclude-no-code-change: 'true'
+                exclude-drafts: true
+                exclude-trivial-rebase: false
+                exclude-no-code-change: false
             - draft-published-event
             - comment-added-contains-event:
-                comment-contains-value: 'recheck'
+                comment-contains-value: recheck
           projects:
-            - project-compare-type: 'ANT'
+            - project-compare-type: ANT
               project-pattern: '{project}'
               branches:
-                - branch-compare-type: 'ANT'
+                - branch-compare-type: ANT
                   branch-pattern: '**/{branch}'
               file-paths:
-                - compare-type: 'ANT'
+                - compare-type: ANT
                   pattern: '{files}'
 
 # TODO: Unify argument names across gerrit-trigger-* macros.
             unstable: true
             notbuilt: true
 
-- publisher:
-    name: archive-artifacts
-    publishers:
-      - archive:
-          artifacts: '{artifacts}'
-          allow-empty: true
-          fingerprint: true
-          latest-only: true
-
 - publisher:
     name: email-notification
     publishers:
                 healthy: 50
                 unhealthy: 40
 
-- publisher:
-    name: opendaylight-infra-shiplogs
-    # To archive things the job will need to create a "archives" directory in
-    # the workspace and this macro will handle copying the contents of the
-    # archives directory.
-    #
-    # Uses the build parameter ARCHIVE_ARTIFACTS if not empty to find files
-    # to archive. You can pass globstar patterns for example "**/*.xml **/*.log"
-    # as the archive pattern. This is a space separated list of files to archive.
-    #
-    # Also ensure that the workspace is cleaned up at the end of the build.
-    publishers:
-      - postbuildscript:
-          builders:
-            - shell: !include-raw: include-raw-stack-delete.sh
-            - shell: !include-raw-escape: include-raw-deploy-archives.sh
-            - maven-target:
-                maven-version: '{maven-version}'
-                pom: '.archives/deploy-archives.xml'
-                goals: 'clean deploy -V -B -q -Dmaven.repo.local=/tmp/r'
-                settings: 'jenkins-log-archives-settings'
-                settings-type: cfp
-                global-settings: 'odl-global-settings'
-                global-settings-type: cfp
-            - description-setter:
-                regexp: '^Build logs: .*'
-            # Cleanup after ourselves
-            - wipe-org-opendaylight-repo
-          script-only-if-succeeded: false
-          script-only-if-failed: false
-          mark-unstable-if-failed: true
-      - workspace-cleanup:
-          exclude:
-            # Do not clean up *.jenkins-trigger files for jobs that use a
-            # properties file as input for triggering another build.
-            - '**/*.jenkins-trigger'
-          fail-build: false
+- builder:
+    # Deploys a maven site to Nexus using lftools nexus-zip command
+    name: opendaylight-infra-deploy-maven-site
+    builders:
+      - lf-provide-maven-settings:
+          global-settings-file: global-settings
+          settings-file: '{settings-file}'
+      - lf-infra-create-netrc:
+          server-id: opendaylight-site
+      - shell: !include-raw-escape:
+          - global-jjb/shell/lftools-install.sh
+          - opendaylight-infra-deploy-maven-site.sh
+      - lf-provide-maven-settings-cleanup
 
 - builder:
     name: opendaylight-infra-stack
     name: distribute-build-url
     # Place URL of the current run of a build job to a file at given path.
     builders:
-      - shell: 'echo "$BUILD_URL" > {path}/build.url'
+      - shell: |
+          #!/bin/bash
+          set +e  # DO NOT fail script if command returns non-zero.
+
+          echo "$BUILD_URL" > {path}/build.url
+
+          # DO NOT fail the build if the echo failed.
+          exit 0
 
 - builder:
     name: wipe-org-opendaylight-repo
       - mask-passwords
       - config-file-provider:
           files:
+            - file-id: npmrc
+              target: '$HOME/.npmrc'
             - file-id: rackspace-heat
               target: '$HOME/.config/openstack/clouds.yaml'
       - timeout:
           single-use: true
 
 - builder:
-    name: packer-validate
+    # TODO: Verify signature after downloading users public key from a locally created
+    # repository instead of the public keymesh. This requires a process in place to get ODL
+    # developers public keys into a local repository without increasing the job thoughput.
+    name: verify-gpg-signature
+    builders:
+      - shell: !include-raw: include-raw-verify-gpg-signatures.sh
+
+- builder:
+    name: opendaylight-infra-jjbini
     builders:
       - config-file-provider:
           files:
-            - file-id: 'packer-cloud-env'
-              variable: 'CLOUDENV'
+            - file-id: 'jjbini'
+              target: '$HOME/.config/jenkins_jobs/jenkins_jobs.ini'
+
+- builder:
+    name: distribution-check-wipe
+    # Step zero: Wipe file repositories up front.
+    builders:
       - shell: |
-          cd packer
-          varfiles="../packer/vars/*"
-          templates="../packer/templates/*"
-          provision="../packer/provision/*.sh"
-          for v in $varfiles; do
-              [[ "${v##*/}" =~ ^(cloud-env.*)$ ]] && continue
-              for t in $templates; do
-                  export PACKER_LOG="yes" && \
-                  export PACKER_LOG_PATH="packer-validate-${v##*/}-${t##*/}.log" && \
-                              packer.io validate -var-file=$CLOUDENV \
-                              -var-file=$v $t
-                  if [ $? -ne 0 ]; then
-                      break
-                  fi
-              done
-          done
-          for p in $provision; do
-              /bin/bash -n $p > provision-validate-${p##*/}.log 2>&1
-          done
+          echo "wipe r: the local Maven repository"
+          rm -rfv /tmp/r
+          echo "wipe n: the fake remote (Nexus) repository"
+          rm -rfv /tmp/n
+          echo "wipe t: the transient repository used in some manipulations"
+          rm -rfv /tmp/t
 
+- builder:
+    name: distribution-check-build-project
+    # Step one: Online build of the project, using local repository /tmp/r/ and deploying artifacts to /tmp/n/.
+    # Ordinary SingleFeatureTest failures are detected in the verify job, so we can use "q" profile here.
+    # Arguments:
+    #   pom: Relative path to pom file to use. Typically '$GERRIT_PROJECT/pom.xml'.
+    builders:
+      - maven-target:
+          maven-version: 'mvn33'
+          pom: '{pom}'
+          goals: |
+              clean deploy dependency:tree
+              -DoutputFile=dependency_tree.txt
+              -Pq
+              -DaltDeploymentRepository=fake-nexus::default::file:///tmp/n/
+              {mvn-opts}
+          java-opts:
+            - '-Xmx4096m -XX:MaxPermSize=1024m -Dmaven.compile.fork=true'
+          settings: 'integration-settings'
+          settings-type: cfp
+          global-settings: 'global-settings'
+          global-settings-type: cfp
 
 - builder:
-    name: packer-build
+    name: distribution-check-verify-groupid
+    # Step two: Verify all deployed artifacts belong to the project's groupId.
+    # This is done by moving the allowed directories out of /tmp/n and checking no files remained there.
+    # The correct directory is derived from $GERRIT_PROJECT.
+    # TODO: Verify all deployed artifacts are snapshots.
+    # Arguments:
+    #   gerrit-project: Project name as nexus URI part. Typically '$GERRIT_PROJECT'.
     builders:
-      - config-file-provider:
-          files:
-            - file-id: 'packer-cloud-env'
-              variable: 'CLOUDENV'
       - shell: |
-          cd packer
-          export PACKER_LOG="yes" && \
-          export PACKER_LOG_PATH="packer-build.log" && \
-                      packer.io build -var-file=$CLOUDENV \
-                       -var-file=../packer/vars/{platform}.json \
-                       ../packer/templates/{template}.json
+          mkdir -p /tmp/t/org/opendaylight/{gerrit-project}
+          mv /tmp/n/org/opendaylight/{gerrit-project}/* /tmp/t/org/opendaylight/{gerrit-project}/
+          test -z "`find /tmp/n/ -type f`" || ( echo "ERROR: Mismatched groupId detected (see above)." && false )
+          rm -rf /tmp/n
+          mv /tmp/t /tmp/n
 
 - builder:
-    # TODO: Verify signature after downloading users public key from a locally created
-    # repository instead of the public keymesh. This requires a process in place to get ODL
-    # developers public keys into a local repository without increasing the job thoughput.
-    name: verify-gpg-signature
+    name: distribution-check-download-deps
+    # Step three: Online build of integration distribution.
+    # This step is mainly used for downloading other project artifacts.
+    # Running SingleFeaturesTest here does not seem to be required, so -Pq is used again.
+    # Arguments:
+    #   dist-pom: Relative path to pom file to use. 'distribution/pom.xml' is recommended.
     builders:
-      - shell: !include-raw: include-raw-verify-gpg-signatures.sh
+      - maven-target:
+          maven-version: 'mvn33'
+          pom: '{dist-pom}'
+          goals: |
+              clean install dependency:tree
+              -DoutputFile=dependency_tree.txt
+              -Pq
+              {mvn-opts}
+          java-opts:
+            - '-Xmx1024m -XX:MaxPermSize=256m -Dmaven.compile.fork=true'
+          settings: 'integration-settings'
+          settings-type: cfp
+          global-settings: 'global-settings'
+          global-settings-type: cfp
 
 - builder:
-    name: opendaylight-infra-jjbini
+    name: distribution-check-delete-snapshots
+    # Step four: Delete snapshot artifacts from the local repository.
+    # This is critical to detect orphaned artifacts or missing project-internal dependency declarations.
+    # Also other files related to maven repository resolution are removed,
+    # and then empty directories are removed, in order to simplify debugging.
     builders:
-      - config-file-provider:
-          files:
-            - file-id: 'jjbini'
-              target: '$HOME/.config/jenkins_jobs/jenkins_jobs.ini'
+      - shell: !include-raw-escape: integration-distribution-delete-snaphot-artifacts.sh
+
+- builder:
+    name: distribution-check-configure-remotes
+    # Now the ugly part. It seems that the only way to tell Maven 2+
+    # which remote repositories to use is via settings.xml file.
+    # So we create such a file here, but it needs most of odlparent:settings.xml
+    builders:
+      - shell: |
+          echo '
+          <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
+            https://maven.apache.org/xsd/settings-1.0.0.xsd">
+            <profiles>
+              <profile>
+                <id>opendaylight-release</id>
+                <repositories>
+                  <repository>
+                    <id>opendaylight-mirror</id>
+                    <name>opendaylight</name>
+                    <url>https://nexus.opendaylight.org/content/repositories/public/</url>
+                    <releases><updatePolicy>never</updatePolicy></releases>
+                    <snapshots><enabled>false</enabled></snapshots>
+                  </repository>
+                </repositories>
+                <pluginRepositories>
+                  <pluginRepository>
+                    <id>opendaylight-plugin-mirror</id>
+                    <name>opendaylight-plugin</name>
+                    <url>https://nexus.opendaylight.org/content/repositories/public/</url>
+                    <releases><updatePolicy>never</updatePolicy></releases>
+                    <snapshots><enabled>false</enabled></snapshots>
+                  </pluginRepository>
+                </pluginRepositories>
+              </profile>
+              <profile>
+                <id>file-snapshots</id>
+                <repositories>
+                  <repository>
+                    <id>file-snapshots</id>
+                    <name>file</name>
+                    <url>file:///tmp/n/</url>
+                    <releases><enabled>false</enabled></releases>
+                  </repository>
+                </repositories>
+                <pluginRepositories>
+                  <pluginRepository>
+                    <id>file-plugin-snapshots</id>
+                    <name>file-plugin</name>
+                    <url>file:///tmp/n/</url>
+                    <releases><enabled>false</enabled></releases>
+                  </pluginRepository>
+                </pluginRepositories>
+              </profile>
+            </profiles>
+            <activeProfiles>
+              <activeProfile>file-snapshots</activeProfile>
+              <activeProfile>opendaylight-release</activeProfile>
+            </activeProfiles>
+          </settings>
+          ' > fake_remotes.xml
+          # Notes: The settings are minimal in order to detect breakage scenarios,
+          # while allowing for the following quirks:
+          # * Some plugins seem to have hardcoded repos, for example check-license looks at repository.apache.org
+          # * Some plugin artifacts (related to surefire) are not downloaded when tests are skipped.
+          # * populate-local-repo looks at oss.sonatype.org and does not store things (like guava) to /tmp/r
+
+- builder:
+    name: distribution-check-repeat-build
+    # Step five: Repeat the distribution build but with the new settings.
+    # Here, only the project snapshot artifacts deployed to /tmp/n are available,
+    # which faithfully reproduces conditions in later verify-like job runs.
+    # We cannot use --offline, because: "Cannot access file (file:///tmp/n) in offline mode"
+    # This is where SingleFeatureTest is not skipped.
+    # Arguments:
+    #   dist-pom: Relative path to pom file to use. 'distribution/pom.xml' is recommended.
+    builders:
+      - maven-target:
+          maven-version: 'mvn33'
+          pom: '{dist-pom}'
+          goals: |
+              clean install dependency:tree
+              -DoutputFile=dependency_tree.txt -s fake_remotes.xml
+              -Pq
+              -Dsft.heap.max=4g
+              -DskipTests=false
+              {mvn-opts}
+          java-opts:
+            - '-Xmx1024m -XX:MaxPermSize=256m -Dmaven.compile.fork=true'