Chore: Upgrade Jenkins-job-builder to 6.3.0
[releng/global-jjb.git] / shell / docker-login.sh
index a2055a9..73d0603 100644 (file)
@@ -1,5 +1,5 @@
 #!/bin/bash
-# @License EPL-1.0 <http://spdx.org/licenses/EPL-1.0>
+# SPDX-License-Identifier: EPL-1.0
 ##############################################################################
 # Copyright (c) 2017 The Linux Foundation and others.
 #
@@ -8,7 +8,6 @@
 # which accompanies this distribution, and is available at
 # http://www.eclipse.org/legal/epl-v10.html
 ##############################################################################
-
 # Log into a custom hosted docker registry and / or docker.io
 
 # $DOCKER_REGISTRY : Optional
 #                    Listing of all the registry ports to login to
 #                    ex: 10001 10002 10003 10004
 #
+# $DOCKERHUB_REGISTRY: Optional
+#                      Set global Jenkins variable to `docker.io`
+#                      Additionally you will need to add as an entry
+#                      to your projects mvn-settings file with username
+#                      and password creds.  If you are using docker version
+#                      < 17.06.0 you will need to set DOCKERHUB_EMAIL
+#                      to auth to docker.io
+#
 # $SETTINGS_FILE   : Job level variable with maven settings file location
 #
 # $DOCKERHUB_EMAIL : Optional
 #                    Jenkins global variable that defines the email address that
 #                    should be used for logging into DockerHub
-#                    If defined than an attempt to login to docker hub will
-#                    happen
+#                    Note that this will not be used if you are using
+#                    docker version >=17.06.0.
+
+#So here are the cases in docker login
+#1) User logging into nexus no email required regardless of docker version
+#2) User logging into docker.io with docker version <17.06.0  email optional
+#3) User logging into docker.io wiht docker version >= 17.06.0 cannot use email flag
 
+echo "---> docker-login.sh"
 # Ensure we fail the job if any steps fail
 set -eu -o pipefail
 
-# Execute the credential lookup and login to the registry
-do_login() {
+# Check if current version less than desired version
+version_lt() {
+    test "$(echo "$@" | tr " " "\n" | sort -rV | head -n 1)" != "$1";
+}
+
+# Execute the credential lookup and set
+set_creds() {
+    set +x  # Ensure that no other scripts add `set -x` and print passwords
     echo "$1"
     CREDENTIAL=$(xmlstarlet sel -N "x=http://maven.apache.org/SETTINGS/1.0.0" \
         -t -m "/x:settings/x:servers/x:server[starts-with(x:id, '${1}')]" \
@@ -44,35 +63,54 @@ do_login() {
     USER=$(echo "$CREDENTIAL" | cut -f1 -d:)
     PASS=$(echo "$CREDENTIAL" | cut -f2 -d:)
 
-    if [ -z "$USER" ]
-    then
+    if [ -z "$USER" ]; then
         echo "ERROR: No user provided"
         return 1
     fi
 
-    if [ -z "$PASS" ]
-    then
+    if [ -z "$PASS" ]; then
         echo "ERROR: No password provided"
         return 1
     fi
 
-    docker login -u "$USER" -p "$PASS" -e "$2" "$1"
 }
 
-if [ "${REGISTRY:-none}" != 'none' ]
-then
-    for PORT in $REGISTRY_PORTS
-    do
+# Login to the registry
+do_login() {
+    docker_version=$( docker -v | awk '{print $3}')
+    if version_lt "$docker_version" "17.06.0" && \
+       [ "$DOCKERHUB_REGISTRY" == "docker.io" ] && \
+       "$DOCKERHUB_EMAIL:-none" != 'none'
+    then
+        docker login -u "$USER" -p "$PASS" -e "$2" "$1"
+    else
+        docker login -u "$USER" -p "$PASS" "$1"
+    fi
+}
+
+
+### Main ###
+
+# Loop through Registry and Ports to concatentate and login to nexus
+if [ "${DOCKER_REGISTRY:-none}" != 'none' ]; then
+    for PORT in $REGISTRY_PORTS; do
         REGISTRY="${DOCKER_REGISTRY}:${PORT}"
 
         # docker login requests an email address if nothing is passed to it
         # Nexus, however, does not need this and ignores the value
+        set_creds "$REGISTRY"
         do_login "$REGISTRY" none
     done
 fi
 
-# Attempt to login to docker.io only if $DOCKERHUB_EMAIL is configured
-if [ "${DOCKERHUB_EMAIL:-none}" != 'none' ]
-then
-    do_login docker.io "$DOCKERHUB_EMAIL"
+# Login to docker.io after determining if email is needed.
+if [ "${DOCKERHUB_REGISTRY:-none}" != 'none' ]; then
+    set_creds "$DOCKERHUB_REGISTRY"
+    if [ "${DOCKERHUB_EMAIL:-none}" != 'none' ]; then
+        do_login "$DOCKERHUB_REGISTRY" "$DOCKERHUB_EMAIL"
+    else
+        do_login "$DOCKERHUB_REGISTRY" none
+    fi
 fi
+
+echo "---> docker-login.sh ends"