scripts/lttng-tools/gerrit-depends-on.sh

   1 #!/bin/bash
   2 # shellcheck disable=SC2103
   3 #
   4 # Copyright (C) 2020 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
   5 #
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 set -exu
  20
  21 #Required variables
  22 GERRIT_NAME=${GERRIT_NAME:-}
  23 WORKSPACE=${WORKSPACE:-}
  24 conf=${conf:-}
  25
  26 gerrit_url="https://${GERRIT_NAME}"
  27 gerrit_query="&o=CURRENT_REVISION&o=DOWNLOAD_COMMANDS"
  28 gerrit_json_query=".[0].revisions[.[0].current_revision].ref"
  29 gerrit_json_query_status=".[0].status"
  30
  31 possible_depends_on="lttng-ust|lttng-modules|userspace-rcu|babeltrace"
  32 re="Depends-on: (${possible_depends_on}): ([^'$'\n'']*)"
  33 property_file="${WORKSPACE}/gerrit_custom_dependencies.properties"
  34
  35 # Create the property file even if it ends up being empty
  36 touch "$property_file"
  37
  38 # Move to lttng-tools source directory
  39 pushd "${WORKSPACE}/src/lttng-tools"
  40
  41 git rev-list --format=%B --max-count=1 HEAD | while read -r line; do
  42     # Deactivate debug mode to prevent the gcc warning publisher from picking up
  43     # compiler error present in the commit message.
  44     set +x
  45     if ! [[ ${line} =~ ${re} ]]; then
  46         set -x
  47         continue
  48     fi
  49     set -x
  50
  51     project=${BASH_REMATCH[1]}
  52     gerrit_id=${BASH_REMATCH[2]}
  53
  54     project_sanitize=${BASH_REMATCH[1]//-/_}
  55
  56     if [ "$conf" = "no-ust" ] && [ "$project" = "lttng-ust" ]; then
  57         # No need to checkout lttng-ust for this configuration axis
  58         continue
  59     fi
  60
  61     if [ "$project" = "lttng-modules" ]; then
  62         if [ -d "$WORKSPACE/src/lttng-modules" ]; then
  63             # Remove the regular modules sources to replace them with those
  64             # from the gerrit change
  65             rm -rf "$WORKSPACE/src/lttng-modules"
  66         else
  67             # This job does not require modules sources
  68             continue
  69         fi
  70     fi
  71
  72     # Export the GERRIT_DEP_... into the property file for further jenkins usage
  73     echo "GERRIT_DEP_${project_sanitize^^}=${gerrit_id}" >> "$property_file"
  74     # Deactivate tests for the project
  75     echo "${project_sanitize^^}_RUN_TESTS=no" >> "$property_file"
  76
  77     # Get the change latest ref
  78     case $project in
  79         lttng-*)
  80             # This is necessary since a cherry pick can have the same change id
  81             # across branches. Still this is only valid for projects where the
  82             # branch name fits the same branch name style of the lttng-tools
  83             # project.
  84             # We will need to be much more clever if the situation arise where
  85             # we need to depends-on a cherry picked change id for the
  86             # userspace-rcu or babeltrace project. Until then let's use this
  87             # hack. The quick solution to this is to tell the committer to change
  88             # the change id. We could also be clever and require that the
  89             # "branch name" be included in the `Depends-on` clause.
  90             local_query="${gerrit_url}/changes/?q=change:${gerrit_id}+branch:${GERRIT_BRANCH}${gerrit_query}"
  91             default_branch="${GERRIT_BRANCH}"
  92             ;;
  93         *)
  94             local_query="${gerrit_url}/changes/?q=change:${gerrit_id}${gerrit_query}"
  95             default_branch="master"
  96             ;;
  97     esac
  98
  99     json_doc=$(curl "$local_query" | tail -n+2)
 100     count=$(jq -r '. | length' <<< "$json_doc")
 101     if [ "$count" != "1" ]; then
 102             echo "Expected an array of size 1 got $count"
 103             exit 1
 104     fi
 105
 106     ref=$(jq -r "$gerrit_json_query" <<< "$json_doc")
 107     change_status=$(jq -r "$gerrit_json_query_status" <<< "$json_doc")
 108     if [ "$change_status" == "MERGED" ]; then
 109             # When the change we depends on is merged use master as the ref.
 110             # This is not ideal CI time wise since we do not reuse artifacts.
 111             # This solve a tricky situation where we actually want to use master
 112             # instead of the change available on gerrit. Intermediary changes
 113             # present in master could have an impact on the change under test.
 114             echo "Depends-on change is MERGED. Defaulting to ${default_branch}"
 115             ref="refs/heads/$default_branch"
 116     elif [ "$change_status" == "ABANDONED" ]; then
 117             # We have a situation where the "HEAD" commit for feature branch are
 118             # not merged and abandoned. Default to the master branch and hope
 119             # for the best. This is far from ideal but we need might also need
 120             # to find a better way to handle feature branch here. In the
 121             # meantime use master for such cases.
 122             echo "Depends-on change is ABANDONED. Defaulting to ${default_branch}"
 123             ref="refs/heads/${default_branch}"
 124     fi
 125
 126     # The build.sh script from userspace-rcu expects the source to be located in
 127     # `liburcu` instead of userspace-rcu. Accommodate for this here.
 128     if [ "$project" = "userspace-rcu" ]; then
 129         clone_directory="liburcu"
 130     else
 131         clone_directory="$project"
 132     fi
 133
 134     clone_directory="$WORKSPACE/src/$clone_directory"
 135
 136     git clone "${gerrit_url}/${project}" "$clone_directory"
 137     pushd "$clone_directory"
 138     git fetch "${gerrit_url}/${project}" "$ref"
 139     git checkout FETCH_HEAD
 140     popd
 141 done
 142
 143 popd