hbase/dev-support/Jenkinsfile

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
pipeline {
  agent {
    node {
      label 'Hadoop'
    }
  }
  triggers {
    cron('@daily')
  }
  options {
    buildDiscarder(logRotator(numToKeepStr: '30'))
    timeout (time: 6, unit: 'HOURS')
    timestamps()
    skipDefaultCheckout()
  }
  environment {
    TOOLS = "${env.WORKSPACE}/tools"
    // where we check out to across stages
    BASEDIR = "${env.WORKSPACE}/component"
    YETUS_RELEASE = '0.5.0'
    // where we'll write everything from different steps.
    OUTPUT_RELATIVE_GENERAL = 'output-general'
    OUTPUTDIR_GENERAL = "${env.WORKSPACE}/output-general"
    OUTPUT_RELATIVE_JDK7 = 'output-jdk7'
    OUTPUTDIR_JDK7 = "${env.WORKSPACE}/output-jdk7"
    OUTPUT_RELATIVE_JDK8 = 'output-jdk8'
    OUTPUTDIR_JDK8 = "${env.WORKSPACE}/output-jdk8"
    PROJECT = 'hbase'
    PROJET_PERSONALITY = 'https://raw.githubusercontent.com/apache/hbase/master/dev-support/hbase-personality.sh'
    // This section of the docs tells folks not to use the javadoc tag. older branches have our old version of the check for said tag.
    AUTHOR_IGNORE_LIST = 'src/main/asciidoc/_chapters/developer.adoc,dev-support/test-patch.sh'
    WHITESPACE_IGNORE_LIST = '.*/generated/.*'
    // output from surefire; sadly the archive function in yetus only works on file names.
    ARCHIVE_PATTERN_LIST = 'TEST-*.xml,org.apache.h*.txt'
    // These tests currently have known failures. Once they burn down to 0, remove from here so that new problems will cause a failure.
    TESTS_FILTER = 'cc,checkstyle,javac,javadoc,pylint,shellcheck,whitespace,perlcritic,ruby-lint,rubocop'
    BRANCH_SPECIFIC_DOCKERFILE = "${env.BASEDIR}/dev-support/docker/Dockerfile"
    EXCLUDE_TESTS_URL = 'https://builds.apache.org/job/HBase-Find-Flaky-Tests/lastSuccessfulBuild/artifact/excludes/'
  }
  parameters {
    booleanParam(name: 'USE_YETUS_PRERELEASE', defaultValue: false, description: '''Check to use the current HEAD of apache/yetus rather than our configured release.

    Should only be used manually when e.g. there is some non-work-aroundable issue in yetus we are checking a fix for.''')
    booleanParam(name: 'DEBUG', defaultValue: false, description: 'Produce a lot more meta-information.')
  }
  stages {
    stage ('scm checkout') {
      steps {
        dir('component') {
          checkout scm
        }
      }
    }
    stage ('yetus install') {
      steps {
        sh  '''#!/usr/bin/env bash
echo "Ensure we have a copy of Apache Yetus."
if [[ true !=  "${USE_YETUS_PRERELEASE}" ]]; then
  YETUS_DIR="${WORKSPACE}/yetus-${YETUS_RELEASE}"
  echo "Checking for Yetus ${YETUS_RELEASE} in '${YETUS_DIR}'"
  if [ ! -d "${YETUS_DIR}" ]; then
    echo "New download of Apache Yetus version ${YETUS_RELEASE}."
    rm -rf "${WORKSPACE}/.gpg"
    mkdir -p "${WORKSPACE}/.gpg"
    chmod -R 700 "${WORKSPACE}/.gpg"

    echo "install yetus project KEYS"
    curl -L --fail -o "${WORKSPACE}/KEYS_YETUS" https://dist.apache.org/repos/dist/release/yetus/KEYS
    gpg --homedir "${WORKSPACE}/.gpg" --import "${WORKSPACE}/KEYS_YETUS"

    echo "download yetus release ${YETUS_RELEASE}"
    curl -L --fail -O "https://dist.apache.org/repos/dist/release/yetus/${YETUS_RELEASE}/yetus-${YETUS_RELEASE}-bin.tar.gz"
    curl -L --fail -O "https://dist.apache.org/repos/dist/release/yetus/${YETUS_RELEASE}/yetus-${YETUS_RELEASE}-bin.tar.gz.asc"
    echo "verifying yetus release"
    gpg --homedir "${WORKSPACE}/.gpg" --verify "yetus-${YETUS_RELEASE}-bin.tar.gz.asc"
    mv "yetus-${YETUS_RELEASE}-bin.tar.gz" yetus.tar.gz
  else
    echo "Reusing cached download of Apache Yetus version ${YETUS_RELEASE}."
  fi
else
  YETUS_DIR="${WORKSPACE}/yetus-git"
  rm -rf "${YETUS_DIR}"
  echo "downloading from github"
  curl -L --fail https://api.github.com/repos/apache/yetus/tarball/HEAD -o yetus.tar.gz
fi
if [ ! -d "${YETUS_DIR}" ]; then
  echo "unpacking yetus into '${YETUS_DIR}'"
  mkdir -p "${YETUS_DIR}"
  gunzip -c yetus.tar.gz | tar xpf - -C "${YETUS_DIR}" --strip-components 1
fi
        '''
        dir ("${env.TOOLS}") {
          sh """#!/usr/bin/env bash
echo "Downloading Project personality."
curl -L  -o personality.sh "${env.PROJET_PERSONALITY}"
          """
        }
        stash name: 'yetus', includes: "yetus-*/*,yetus-*/**/*,tools/personality.sh"
      }
    }
    stage ('yetus general check') {
      environment {
        // TODO does hadoopcheck need to be jdk specific?
        // Should be things that work with multijdk
        TESTS = 'all,-unit,-findbugs'
        // on branches that don't support jdk7, this will already be JAVA_HOME, so we'll end up not
        // doing multijdk there.
        MULTIJDK = '/usr/lib/jvm/java-8-openjdk-amd64'
        OUTPUT_RELATIVE = "${env.OUTPUT_RELATIVE_GENERAL}"
        OUTPUTDIR = "${env.OUTPUTDIR_GENERAL}"
      }
      steps {
        unstash 'yetus'
        // TODO should this be a download from master, similar to how the personality is?
        sh "${env.BASEDIR}/dev-support/hbase_nightly_yetus.sh"
      }
      post {
        always {
          // env variables don't work in archive? or this has to be relative to WORKSPACE. :(
          archive 'output-general/*'
          archive 'output-general/**/*'
          publishHTML target: [
            allowMissing: true,
            keepAll: true,
            alwaysLinkToLastBuild: true,
            // has to be relative to WORKSPACE :(
            reportDir: 'output-general',
            reportFiles: 'console-report.html',
            reportName: 'General Nightly Build Report'
          ]
        }
      }
    }
    stage ('yetus jdk7 checks') {
      when {
        branch 'branch-1*'
      }
      environment {
        TESTS = 'mvninstall,compile,javac,unit,htmlout'
        OUTPUT_RELATIVE = "${env.OUTPUT_RELATIVE_JDK7}"
        OUTPUTDIR = "${env.OUTPUTDIR_JDK7}"
        // On branches where we do jdk7 checks, jdk7 will be JAVA_HOME already.
      }
      steps {
        unstash 'yetus'
        sh """#!/usr/bin/env bash
          # for branch-1.1 we don't do jdk8 findbugs, so do it here
          if [ "${env.BRANCH_NAME}" == "branch-1.1" ]; then
            TESTS+=",findbugs"
          fi
          "${env.BASEDIR}/dev-support/hbase_nightly_yetus.sh"
        """
      }
      post {
        always {
          junit 'output-jdk7/**/target/**/TEST-*.xml'
          // zip surefire reports.
          sh '''#!/bin/bash -e
            if [ -d "${OUTPUTDIR}/archiver" ]; then
              count=$(find "${OUTPUTDIR}/archiver" -type f | wc -l)
              if [[ 0 -ne ${count} ]]; then
                echo "zipping ${count} archived files"
                zip -q -m -r "${OUTPUTDIR}/test_logs.zip" "${OUTPUTDIR}/archiver"
              else
                echo "No archived files, skipping compressing."
              fi
            else
              echo "No archiver directory, skipping compressing."
            fi
'''
          // env variables don't work in archive? or this has to be relative to WORKSPACE. :(
          archive 'output-jdk7/*'
          archive 'output-jdk7/**/*'
          publishHTML target: [
            allowMissing: true,
            keepAll: true,
            alwaysLinkToLastBuild: true,
            // has to be relative to WORKSPACE :(
            reportDir: 'output-jdk7',
            reportFiles: 'console-report.html',
            reportName: 'JDK7 Nightly Build Report'
          ]
        }
      }
    }
    stage ('yetus jdk8 checks') {
      when {
        not {
          branch 'branch-1.1*'
        }
      }
      environment {
        TESTS = 'mvninstall,compile,javac,unit,findbugs,htmlout'
        OUTPUT_RELATIVE = "${env.OUTPUT_RELATIVE_JDK8}"
        OUTPUTDIR = "${env.OUTPUTDIR_JDK8}"
        // This isn't strictly needed on branches that only support jdk8, but doesn't hurt
        // and is needed on branches that do both jdk7 and jdk8
        SET_JAVA_HOME = '/usr/lib/jvm/java-8-openjdk-amd64'
      }
      steps {
        unstash 'yetus'
        sh "${env.BASEDIR}/dev-support/hbase_nightly_yetus.sh"
      }
      post {
        always {
          junit 'output-jdk8/**/target/**/TEST-*.xml'
          // zip surefire reports.
          sh '''#!/bin/bash -e
            if [ -d "${OUTPUTDIR}/archiver" ]; then
              count=$(find "${OUTPUTDIR}/archiver" -type f | wc -l)
              if [[ 0 -ne ${count} ]]; then
                echo "zipping ${count} archived files"
                zip -q -m -r "${OUTPUTDIR}/test_logs.zip" "${OUTPUTDIR}/archiver"
              else
                echo "No archived files, skipping compressing."
              fi
            else
              echo "No archiver directory, skipping compressing."
            fi
'''
          // env variables don't work in archive? or this has to be relative to WORKSPACE. :(
          archive 'output-jdk8/*'
          archive 'output-jdk8/**/*'
          publishHTML target: [
            allowMissing: true,
            keepAll: true,
            alwaysLinkToLastBuild: true,
            // has to be relative to WORKSPACE :(
            reportDir: 'output-jdk8',
            reportFiles: 'console-report.html',
            reportName: 'JDK8 Nightly Build Report'
          ]
        }
      }
    }
    // This is meant to mimic what a release manager will do to create RCs.
    // See http://hbase.apache.org/book.html#maven.release
    stage ('create source tarball') {
      tools {
        maven 'Maven (latest)'
        // this needs to be set to the jdk that ought to be used to build releases on the branch the Jenkinsfile is stored in.
        jdk "JDK 1.8 (latest)"
      }
      steps {
        sh 'mvn --version --offline'
        dir ("component") {
          sh '''#!/bin/bash -e
            echo "Clean..."
            mvn --batch-mode -DskipTests clean
            echo "Step 3 Build the source tarball"
            mvn -Prelease --batch-mode -Dmaven.repo.local="${WORKSPACE}/.m2-for-repo" install -DskipTests assembly:single -Dassembly.file=hbase-assembly/src/main/assembly/src.xml
'''
        }
        dir ("unpacked_src_tarball") {
          sh '''#!/bin/bash -e
            echo "Unpack the source tarball"
            tar --strip-components=1 -xzf ../component/hbase-assembly/target/hbase-*-src.tar.gz
            echo "Building from source artifact."
            mvn -DskipTests -Prelease --batch-mode -Dmaven.repo.local="${WORKSPACE}/.m2-for-src" clean install assembly:single
            echo "Clean up after checking ability to build."
            mvn -DskipTests --batch-mode clean
'''
        }
        dir ("component") {
          sh '''#!/bin/bash -e
            echo "Clean up the source checkout"
            mvn -DskipTests --batch-mode clean
            echo "Diff against source tree"
            diff --binary --recursive . ../unpacked_src_tarball >../diff_output || true
'''
        }
        // expectation check largely based on HBASE-14952
        sh '''#!/bin/bash -e
          echo "Checking against things we don't expect to include in the source tarball (git related, hbase-native-client, etc.)"
          cat >known_excluded <<END
Only in .: .git
Only in .: .gitattributes
Only in .: .gitignore
Only in .: hbase-native-client
END
          if ! diff known_excluded diff_output >/dev/null ; then
            echo "Any output here are unexpected differences between the source artifact we'd make for an RC and the current branch."
            echo "The expected differences are on the < side and the current differences are on the > side."
            echo "In a given set of differences, '.' refers to the branch in the repo and 'unpacked_src_tarball' refers to what we pulled out of the tarball."
            diff known_excluded diff_output
          else
            echo "Everything looks as expected."
          fi
'''
      }
    }
  }
}