Fix release job script
[releng/global-jjb.git] / shell / release-job.sh
index ccaa782..9ff6799 100644 (file)
 echo "---> release-job.sh"
 set -eu -o pipefail
 
-echo "INFO: creating virtual environment"
-virtualenv -p python3 /tmp/venv
-PATH=/tmp/venv/bin:$PATH
-pipup="python -m pip install -q --upgrade pip lftools jsonschema niet twine yq"
-echo "INFO: $pipup"
-$pipup
+# shellcheck disable=SC1090
+source ~/lf-env.sh
+
+# Version controlled by JJB_VERSION
+lf-activate-venv lftools pip idna==2.9 lftools jsonschema twine yq readline
+
+# show installed versions
+python -m pip --version
+python -m pip freeze
 
 #Functions.
 
 set_variables_common(){
     echo "INFO: Setting common variables"
-    if [[ -z ${LOGS_SERVER:-} ]]; then
-        echo "ERROR: LOGS_SERVER not defined"
+    if [[ -z ${LOGS_SERVER:-} ]] && [[ -z ${CDN_URL:-} ]]; then
+        echo "ERROR: LOGS_SERVER or CDN_URL not defined"
         exit 1
     fi
     NEXUS_PATH="${SILO}/${JENKINS_HOSTNAME}/"
     # Verify if using release file or parameters
     if $USE_RELEASE_FILE ; then
-        release_files=$(git diff-tree -m --no-commit-id -r "$GIT_COMMIT" --name-only -- "releases/" ".releases/")
+        release_files=$(git diff-tree -m --no-commit-id -r "$GIT_COMMIT" "$GIT_COMMIT^1" \
+            --name-only -- "releases/" ".releases/")
         if (( $(grep -c . <<<"$release_files") > 1 )); then
           echo "INFO: RELEASE FILES ARE AS FOLLOWS: $release_files"
-          echo "ERROR: Committing multiple release files in the same commit OR rename/amend of existing files is not supported."
+          echo "ERROR: Adding multiple release files in the same commit"
+          echo "ERROR: OR rename/amend/delete of existing files is not supported."
           exit 1
         else
           release_file="$release_files"
@@ -43,105 +48,129 @@ set_variables_common(){
         release_file="None"
     fi
 
+    if [[ -z ${LOG_DIR:-} ]]; then
+        LOG_DIR=$(yq -r ".log_dir" "$release_file")
+    fi
+    if [[ -n ${LOGS_SERVER:-} ]]; then
+        logs_url="${LOGS_SERVER}/${NEXUS_PATH}${LOG_DIR}"
+    elif [[ -n ${CDN_URL:-} ]]; then
+        logs_url="https://${CDN_URL:-}/logs/${NEXUS_PATH}${LOG_DIR}"
+    fi
+    logs_url=${logs_url%/}  # strip any trailing '/'
+
     # Jenkins parameter drop-down defaults DISTRIBUTION_TYPE to None
+    # in the contain/maven release job; get value from release yaml.
+    # Packagecloud and PyPI jobs set the appropriate value.
     DISTRIBUTION_TYPE="${DISTRIBUTION_TYPE:-None}"
     if [[ $DISTRIBUTION_TYPE == "None" ]]; then
-        DISTRIBUTION_TYPE=$(niet ".distribution_type" "$release_file")
+        if ! DISTRIBUTION_TYPE=$(yq -r ".distribution_type" "$release_file"); then
+            echo "ERROR: Failed to get distribution_type from $release_file"
+            exit 1
+        fi
     fi
 
     PATCH_DIR=$(mktemp -d)
 
+    TAG_RELEASE="${TAG_RELEASE:-None}"
+    if [[ $TAG_RELEASE == "None" ]]; then
+        if grep -q "tag_release" $release_file ; then
+            TAG_RELEASE=$(yq -r .tag_release "$release_file")
+        else
+            TAG_RELEASE=true
+        fi
+    fi
+
     # Displaying Release Information (Common variables)
     printf "\t%-30s\n" RELEASE_ENVIRONMENT_INFO:
     printf "\t%-30s %s\n" RELEASE_FILE: "$release_file"
     printf "\t%-30s %s\n" LOGS_SERVER: "$LOGS_SERVER"
+    printf "\t%-30s %s\n" CDN_URL: "${CDN_URL:-None}"
     printf "\t%-30s %s\n" NEXUS_PATH: "$NEXUS_PATH"
     printf "\t%-30s %s\n" JENKINS_HOSTNAME: "$JENKINS_HOSTNAME"
     printf "\t%-30s %s\n" SILO: "$SILO"
     printf "\t%-30s %s\n" PROJECT: "$PROJECT"
     printf "\t%-30s %s\n" PROJECT-DASHED: "${PROJECT//\//-}"
+    printf "\t%-30s %s\n" TAG_RELEASE: "$TAG_RELEASE"
     printf "\t%-30s %s\n" DISTRIBUTION_TYPE: "$DISTRIBUTION_TYPE"
+    printf "\t%-30s %s\n" OVERRIDE_SEMVER_REGEX: "${OVERRIDE_SEMVER_REGEX:-None}"
 }
 
 set_variables_maven(){
     echo "INFO: Setting maven variables"
     if [[ -z ${VERSION:-} ]]; then
-        VERSION=$(niet ".version" "$release_file")
+        VERSION=$(yq -r ".version" "$release_file")
     fi
     if [[ -z ${GIT_TAG:-} ]]; then
         if grep -q "git_tag" "$release_file" ; then
-            GIT_TAG=$(niet ".git_tag" "$release_file")
+            GIT_TAG=$(yq -r ".git_tag" "$release_file")
         else
             GIT_TAG="$VERSION"
         fi
     fi
     if [[ -z ${LOG_DIR:-} ]]; then
-        LOG_DIR=$(niet ".log_dir" "$release_file")
+        LOG_DIR=$(yq -r ".log_dir" "$release_file")
     fi
-    LOGS_URL="${LOGS_SERVER}/${NEXUS_PATH}${LOG_DIR}"
-    LOGS_URL=${LOGS_URL%/}  # strip any trailing '/'
 
     # Continuing displaying Release Information (Maven)
     printf "\t%-30s\n" RELEASE_MAVEN_INFO:
     printf "\t%-30s %s\n" VERSION: "$VERSION"
     printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
     printf "\t%-30s %s\n" LOG_DIR: "$LOG_DIR"
-    printf "\t%-30s %s\n" LOGS_URL: "$LOGS_URL"
+    printf "\t%-30s %s\n" LOGS_URL: "$logs_url"
 }
 
 set_variables_container(){
     echo "INFO: Setting container variables"
     if [[ -z ${VERSION:-} ]]; then
-        VERSION=$(niet ".container_release_tag" "$release_file")
+        VERSION=$(yq -r ".container_release_tag" "$release_file")
     fi
     if [[ -z ${GIT_TAG:-} ]]; then
         if grep -q "git_tag" "$release_file" ; then
-            GIT_TAG=$(niet ".git_tag" "$release_file")
+            GIT_TAG=$(yq -r ".git_tag" "$release_file")
         else
             GIT_TAG="$VERSION"
         fi
    fi
     if grep -q "container_pull_registry" "$release_file" ; then
-        CONTAINER_PULL_REGISTRY=$(niet ".container_pull_registry" "$release_file")
+        CONTAINER_PULL_REGISTRY=$(yq -r ".container_pull_registry" "$release_file")
     fi
     if grep -q "container_push_registry" "$release_file" ; then
-        CONTAINER_PUSH_REGISTRY=$(niet ".container_push_registry" "$release_file")
+        CONTAINER_PUSH_REGISTRY=$(yq -r ".container_push_registry" "$release_file")
     fi
     # Make sure both pull and push registries are defined
     if [ -z ${CONTAINER_PULL_REGISTRY+x} ] || [ -z ${CONTAINER_PUSH_REGISTRY+x} ]; then
         echo "ERROR: CONTAINER_PULL_REGISTRY and CONTAINER_PUSH_REGISTRY need to be defined"
         exit 1
     fi
-    ref=$(niet ".ref" "$release_file")
+    ref=$(yq -r ".ref" "$release_file")
 
     # Continuing displaying Release Information (Container)
     printf "\t%-30s\n" RELEASE_CONTAINER_INFO:
     printf "\t%-30s %s\n" CONTAINER_RELEASE_TAG: "$VERSION"
     printf "\t%-30s %s\n" CONTAINER_PULL_REGISTRY: "$CONTAINER_PULL_REGISTRY"
     printf "\t%-30s %s\n" CONTAINER_PUSH_REGISTRY: "$CONTAINER_PUSH_REGISTRY"
-    printf "\t%-30s %s\n" GERRIT_REF_TO_TAG: "$ref"
+    printf "\t%-30s %s\n" GIT_REF_TO_TAG: "$ref"
     printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
 }
 
 set_variables_pypi(){
     echo "INFO: Setting pypi variables"
     if [[ -z ${LOG_DIR:-} ]]; then
-        LOG_DIR=$(niet ".log_dir" "$release_file")
+        LOG_DIR=$(yq -r ".log_dir" "$release_file")
     fi
-    LOGS_URL="${LOGS_SERVER}/${NEXUS_PATH}${LOG_DIR}"
-    LOGS_URL=${LOGS_URL%/}  # strip any trailing '/'
+
     if [[ -z ${PYPI_PROJECT:-} ]]; then
-        PYPI_PROJECT=$(niet ".pypi_project" "$release_file")
+        PYPI_PROJECT=$(yq -r ".pypi_project" "$release_file")
     fi
     if [[ -z ${PYTHON_VERSION:-} ]]; then
-        PYTHON_VERSION=$(niet ".python_version" "$release_file")
+        PYTHON_VERSION=$(yq -r ".python_version" "$release_file")
     fi
     if [[ -z ${VERSION:-} ]]; then
-        VERSION=$(niet ".version" "$release_file")
+        VERSION=$(yq -r ".version" "$release_file")
     fi
     if [[ -z ${GIT_TAG:-} ]]; then
         if grep -q "git_tag" "$release_file" ; then
-            GIT_TAG=$(niet ".git_tag" "$release_file")
+            GIT_TAG=$(yq -r ".git_tag" "$release_file")
         else
             GIT_TAG="$VERSION"
         fi
@@ -150,7 +179,7 @@ set_variables_pypi(){
     # Continuing displaying Release Information (pypi)
     printf "\t%-30s\n" RELEASE_PYPI_INFO:
     printf "\t%-30s %s\n" LOG_DIR: "$LOG_DIR"
-    printf "\t%-30s %s\n" LOGS_URL: "$LOGS_URL"
+    printf "\t%-30s %s\n" LOGS_URL: "$logs_url"
     printf "\t%-30s %s\n" PYPI_INDEX: "$PYPI_INDEX" # from job configuration
     printf "\t%-30s %s\n" PYPI_PROJECT: "$PYPI_PROJECT"
     printf "\t%-30s %s\n" PYTHON_VERSION: "$PYTHON_VERSION"
@@ -161,31 +190,29 @@ set_variables_pypi(){
 set_variables_packagecloud(){
      echo "INFO: Setting packagecloud variables"
      if [[ -z ${VERSION:-} ]]; then
-         VERSION=$(niet ".version" "$release_file")
+         VERSION=$(yq -r ".version" "$release_file")
      fi
      if [[ -z ${GIT_TAG:-} ]]; then
          if grep -q "git_tag" $release_file ; then
-             GIT_TAG=$(niet ".git_tag" "$release_file")
+             GIT_TAG=$(yq -r ".git_tag" "$release_file")
          else
              GIT_TAG="$VERSION"
          fi
      fi
      if [[ -z ${LOG_DIR:-} ]]; then
-         LOG_DIR=$(niet ".log_dir" "$release_file")
+         LOG_DIR=$(yq -r ".log_dir" "$release_file")
      fi
      if [[ -z ${REF:-} ]]; then
-         REF=$(niet ".ref" "$release_file")
+         REF=$(yq -r ".ref" "$release_file")
      fi
      if [[ -z ${PACKAGE_NAME:-} ]]; then
-         PACKAGE_NAME=$(niet ".package_name" "$release_file")
+         PACKAGE_NAME=$(yq -r ".package_name" "$release_file")
      fi
-     logs_url="${LOGS_SERVER}/${NEXUS_PATH}${LOG_DIR}"
-     logs_url=${logs_url%/}  # strip any trailing '/'
 
      printf "\t%-30s %s\n" PACKAGE_NAME: "$PACKAGE_NAME"
      printf "\t%-30s %s\n" LOG_DIR: "$LOG_DIR"
      printf "\t%-30s %s\n" LOGS_URL: "$logs_url"
-     printf "\t%-30s %s\n" GERRIT_REF_TO_TAG: "$REF"
+     printf "\t%-30s %s\n" GIT_REF_TO_TAG: "$REF"
      printf "\t%-30s %s\n" VERSION: "$VERSION"
      printf "\t%-30s %s\n" GIT_TAG: "$GIT_TAG"
 }
@@ -196,22 +223,33 @@ verify_schema(){
 }
 
 verify_version(){
-    # Verify allowed patterns "#.#.#" (SemVer) or "v#.#.#"
+
+    # Override the regex for projects that do not follow https://semver.org
+    OVERRIDE_SEMVER_REGEX="${OVERRIDE_SEMVER_REGEX:-None}"
+    if [[ $OVERRIDE_SEMVER_REGEX == "None" ]]; then
+        # Use the semver regex taken from https://github.com/fsaintjacques/semver-tool
+        semver_regex="^[vV]?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(\-(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(\.(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$"
+    else
+        semver_regex="${OVERRIDE_SEMVER_REGEX}"
+    fi
+
+    # Verify SemVer "#.#.#" (SemVer) or "v#.#.#"
     echo "INFO: Verifying version $VERSION"
-    allowed_version_regex="^((v?)([0-9]+)\.([0-9]+)\.([0-9]+))$"
-    if [[ $VERSION =~ $allowed_version_regex ]]; then
+    if [[ $VERSION =~ $semver_regex ]]; then
         echo "INFO: The version $VERSION is valid"
     else
         echo "ERROR: The version $VERSION is not valid"
         echo "ERROR: Valid versions are \"#.#.#\" (SemVer) or \"v#.#.#\""
-        echo "ERROR: See https://semver.org/ for more details on SemVer"
+        echo "ERROR: Valid version will be matched against \"${semver_regex}\""
+        echo "ERROR: Refer to https://semver.org/ for more details on SemVer"
+        echo "ERROR: Refer SemVer examples from https://github.com/fsaintjacques/semver-tool/#examples"
         exit 1
     fi
 }
 
 verify_version_match_release(){
-    echo "INFO: Fetching console log from $LOGS_URL"
-    wget -P /tmp "${LOGS_URL}/"console.log.gz
+    echo "INFO: Fetching console log from $logs_url"
+    wget -P /tmp "${logs_url}/"console.log.gz
     echo "INFO: Searching for uploaded step and version $VERSION in job log"
     if zgrep "Successfully uploaded" /tmp/console.log.gz | grep "$VERSION"; then
         echo "INFO: found expected strings in job log"
@@ -224,8 +262,8 @@ verify_version_match_release(){
 
 # check prerequisites to detect mistakes in the release YAML file
 verify_pypi_match_release(){
-    echo "INFO: Fetching console log from $LOGS_URL"
-    wget -q -P /tmp "${LOGS_URL}/"console.log.gz
+    echo "INFO: Fetching console log from $logs_url"
+    wget -q -P /tmp "${logs_url}/"console.log.gz
     echo "INFO: Searching for uploaded step, project $PYPI_PROJECT and version $VERSION in job log"
     # pypi-upload.sh generates success message with file list
     if zgrep -i "uploaded" /tmp/console.log.gz | grep "$PYPI_PROJECT" | grep "$VERSION" ; then
@@ -250,8 +288,19 @@ verify_packagecloud_match_release(){
 
 # sigul is only available on Centos
 # TODO: write tag-github-repo function
-tag-gerrit-repo(){
-    echo "INFO: tag gerrit with $GIT_TAG"
+tag-git-repo(){
+    if [[ $TAG_RELEASE == false ]]; then
+       echo "INFO: Skipping code repo tag"
+       return
+    fi
+
+    if [[ -z ${GERRIT_URL:-} ]]; then
+        GIT_REPO_BASE=github
+    else
+        GIT_REPO_BASE=gerrit
+    fi
+
+    echo "INFO: tag repo with $GIT_TAG"
     # Import public signing key
     gpg --import "$SIGNING_PUBKEY"
     if type=$(git cat-file -t "$GIT_TAG"); then
@@ -272,12 +321,16 @@ tag-gerrit-repo(){
         ########## Merge Part ##############
         if [[ "$JOB_NAME" =~ "merge" ]] && [[ "$DRY_RUN" = false ]]; then
             echo "INFO: Running merge, pushing tag"
-            gerrit_ssh=$(echo "$GERRIT_URL" | awk -F"/" '{print $3}')
-            git remote set-url origin ssh://"$RELEASE_USERNAME"@"$gerrit_ssh":29418/"$PROJECT"
+            if [[ $GIT_REPO_BASE == "gerrit" ]]; then
+                gerrit_ssh=$(echo "$GERRIT_URL" | awk -F"/" '{print $3}')
+                git remote set-url origin ssh://"$RELEASE_USERNAME"@"$gerrit_ssh":29418/"$PROJECT"
+                echo -e "Host $gerrit_ssh\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
+                chmod 600 ~/.ssh/config
+            else
+                git remote set-url origin "$GIT_CLONE_URL""$RELEASE_USERNAME"/"$PROJECT".git
+            fi
             git config user.name "$RELEASE_USERNAME"
             git config user.email "$RELEASE_EMAIL"
-            echo -e "Host $gerrit_ssh\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
-            chmod 600 ~/.ssh/config
             git push origin "$GIT_TAG"
         fi
     fi
@@ -310,11 +363,12 @@ nexus_release(){
 
 container_release_file(){
     echo "INFO: Processing container release"
+    docker --version
     local lfn_umbrella
     lfn_umbrella="$(echo "$GERRIT_URL" | awk -F"." '{print $2}')"
 
-    for namequoted in $(cat $release_file | yq '.containers[].name'); do
-        versionquoted=$(cat $release_file | yq ".containers[] |select(.name==$namequoted) |.version")
+    for namequoted in $(yq '.containers[].name' $release_file); do
+        versionquoted=$(yq ".containers[] |select(.name==$namequoted) |.version" $release_file)
 
         #Remove extra yaml quotes
         name="${namequoted#\"}"
@@ -345,16 +399,16 @@ container_release_file(){
 
     echo "INFO: Merge will tag ref: $ref"
     git checkout "$ref"
-    tag-gerrit-repo
+    tag-git-repo
 }
 
 maven_release_file(){
     echo "INFO: Processing maven release"
-    echo "INFO: wget -P $PATCH_DIR ${LOGS_URL}/staging-repo.txt.gz"
-    wget -P "$PATCH_DIR" "${LOGS_URL}/"staging-repo.txt.gz
+    echo "INFO: wget -P $PATCH_DIR ${logs_url}/staging-repo.txt.gz"
+    wget -P "$PATCH_DIR" "${logs_url}/"staging-repo.txt.gz
     pushd "$PATCH_DIR"
-        echo "INFO: wget ${LOGS_URL}/patches/{${PROJECT//\//-}.bundle,taglist.log.gz}"
-        wget "${LOGS_URL}"/patches/{"${PROJECT//\//-}".bundle,taglist.log.gz}
+        echo "INFO: wget ${logs_url}/patches/{${PROJECT//\//-}.bundle,taglist.log.gz}"
+        wget "${logs_url}"/patches/{"${PROJECT//\//-}".bundle,taglist.log.gz}
         gunzip taglist.log.gz
         cat "$PATCH_DIR"/taglist.log
     popd
@@ -362,7 +416,7 @@ maven_release_file(){
     git fetch "$PATCH_DIR/${PROJECT//\//-}.bundle"
     git merge --ff-only FETCH_HEAD
     nexus_release
-    tag-gerrit-repo
+    tag-git-repo
 }
 
 # calls pip to download binary and source distributions from the specified index,
@@ -407,7 +461,7 @@ pypi_release_file(){
         echo "INFO: uploading $filecount distributions to repo $REPOSITORY"
         $cmd
     fi
-    tag-gerrit-repo
+    tag-git-repo
 }
 
 packagecloud_verify(){
@@ -437,7 +491,7 @@ packagecloud_promote(){
         | echo "INFO: Promoted package location: \
         https://packagecloud.io$(yq -r .package_html_url)"
     git checkout "$REF"
-    tag-gerrit-repo
+    tag-git-repo
 }
 
 ##############################  End Function Declarations  ################################