Add Docker login to Jenkins script to avoid rate limit issue

XinShuYang · XinShuYang · commit 8a5a3b251db7 · 2024-05-29T11:30:52.000+08:00
Enhance Jenkins pipeline by integrating Docker credentials for login to avoid rate limit issues

Signed-off-by: Shuyang Xin &lt;gavinx@vmware.com&gt;
diff --git a/ci/jenkins/docker_login.sh b/ci/jenkins/docker_login.sh
@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+
+# Copyright 2024 Antrea Authors
+#
+# Licensed 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.
+
+DOCKER_REGISTRY=$(head -n1 "${WORKSPACE}/ci/docker-registry")
+
+_usage="Usage: $0 [--docker-user <dockerUser>] [--docker-password <dockerPassword>]
+Run Docker login script.
+        --docker-user             Username for Docker account.
+        --docker-password         Password for Docker account.
+        --registry                The image registry to use."
+
+while [[ $# -gt 0 ]]
+do
+key="$1"
+
+case $key in
+    --docker-user)
+    DOCKER_USERNAME="$2"
+    shift 2
+    ;;
+    --docker-password)
+    DOCKER_PASSWORD="$2"
+    shift 2
+    ;;
+    --registry)
+    DOCKER_REGISTRY="$2"
+    shift 2
+    ;;
+    -h|--help)
+    print_usage
+    exit 0
+    ;;
+    *)    # unknown option
+    echoerr "Unknown option $1"
+    exit 1
+    ;;
+esac
+done
+
+function docker_login() {
+    set +ex
+    for i in `seq 5`; do
+        output=$(echo $2 | docker login --username=$1 --password-stdin 2>/dev/null)
+        # Check if standard output contains "Login Succeeded"
+        if [[ "$output" == *"Login Succeeded"* ]]; then
+            echo "Docker login successful."
+            break
+        else
+            sleep 5s
+            echo "Docker login failed. Retrying"
+        fi
+    done
+    set -ex
+}
+
+# Exit if credentials are not set
+if [[ -z "$DOCKER_USERNAME" || -z "$DOCKER_PASSWORD" ]]; then
+    echo "Error: Docker username or password not provided."
+    exit 1
+fi
+
+# Check if the registry is docker.io or any other acceptable registry
+if [[ "$DOCKER_REGISTRY" == "docker.io" ]]; then
+    echo "Logging into Docker Hub..."
+    docker_login "${DOCKER_USERNAME}" "${DOCKER_PASSWORD}"
+else
+    echo "Registry $DOCKER_REGISTRY is not supported for login by this script."
+fi
diff --git a/ci/jenkins/jobs/macros.yaml b/ci/jenkins/jobs/macros.yaml
@@ -103,7 +103,8 @@
           #!/bin/bash
           set -ex
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
-          ./ci/jenkins/test-vmc.sh --cluster-name "$BUILD_TAG" --testcase e2e --coverage --codecov-token "${CODECOV_TOKEN}" --registry ${DOCKER_REGISTRY} --username "${CAPVC_USERNAME}" --password "${CAPVC_PASSWORD}"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
+          ./ci/jenkins/test-vmc.sh --cluster-name "$BUILD_TAG" --testcase e2e --coverage --codecov-token "${{CODECOV_TOKEN}}" --registry ${{DOCKER_REGISTRY}} --username "${{CAPVC_USERNAME}}" --password "${{CAPVC_PASSWORD}}"
 
 - builder:
     name: builder-conformance
@@ -112,6 +113,7 @@
           #!/bin/bash
           set -ex
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
           ./ci/jenkins/test-vmc.sh --cluster-name "$BUILD_TAG" --testcase '{conformance_type}' --coverage --codecov-token "${{CODECOV_TOKEN}}" --registry ${{DOCKER_REGISTRY}} --username "${{CAPVC_USERNAME}}" --password "${{CAPVC_PASSWORD}}"
 
 - builder:
@@ -128,6 +130,7 @@
           #!/bin/bash
           set -ex
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
           ./ci/jenkins/test.sh --testcase '{e2e_type}' --registry ${{DOCKER_REGISTRY}}
 
 - builder:
@@ -137,6 +140,7 @@
           #!/bin/bash
           set -ex
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
           ./ci/jenkins/test.sh --testcase '{conformance_type}' --registry ${{DOCKER_REGISTRY}}
 
 - builder:
@@ -146,7 +150,8 @@
           #!/bin/bash
           set -e
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
-          ./ci/jenkins/test.sh --testcase e2e --registry ${DOCKER_REGISTRY} --workdir "/home/ubuntu" --kubeconfig "/home/ubuntu/kube.conf" --testbed-type "flexible-ipam"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
+          ./ci/jenkins/test.sh --testcase e2e --registry ${{DOCKER_REGISTRY}} --workdir "/home/ubuntu" --kubeconfig "/home/ubuntu/kube.conf" --testbed-type "flexible-ipam"
 
 - builder:
     name: builder-flow-visibility
@@ -208,6 +213,7 @@
           #!/bin/bash
           set -ex
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
           KIND_TIMEOUT=135
           FULL_CLUSTER_NAME='{kind_cluster_name}'-"${{BUILD_NUMBER}}"
           #  Delete all Kind clusters created more than 135 mins ago. 135 minutes is the timeout 
@@ -231,6 +237,7 @@
           #!/bin/bash
           set -ex
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
           KIND_TIMEOUT=135
           FULL_CLUSTER_NAME='{kind_cluster_name}'-"${{BUILD_NUMBER}}"
           #  Delete all Kind clusters created more than 135 mins ago. 135 minutes is the timeout 
@@ -273,7 +280,8 @@
           #!/bin/bash
           set -e 
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
-          ./ci/jenkins/test-mc.sh --testcase e2e --registry ${DOCKER_REGISTRY} --mc-gateway --codecov-token "${CODECOV_TOKEN}" --coverage --kind
+          ./ci/jenkins/docker_login.sh --docker-user "${{DOCKER_USERNAME}}" --docker-password "${{DOCKER_PASSWORD}}" --registry ${{DOCKER_REGISTRY}}
+          ./ci/jenkins/test-mc.sh --testcase e2e --registry ${{DOCKER_REGISTRY}} --mc-gateway --codecov-token "${CODECOV_TOKEN}" --coverage --kind
             
 - builder:
     name: builder-e2e-jumper
@@ -282,7 +290,8 @@
           #!/bin/bash
           set -e
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
-          ./ci/jenkins/test.sh --testcase e2e --registry ${DOCKER_REGISTRY} --testbed-type jumper
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
+          ./ci/jenkins/test.sh --testcase e2e --registry ${{DOCKER_REGISTRY}} --testbed-type jumper
 
 - builder:
     name: builder-conformance-jumper
@@ -291,6 +300,7 @@
           #!/bin/bash
           set -e
           DOCKER_REGISTRY="$(head -n1 ci/docker-registry)"
+          ./ci/jenkins/docker_login.sh --docker-user ${{DOCKER_USERNAME}} --docker-password ${{DOCKER_PASSWORD}} --registry ${{DOCKER_REGISTRY}}
           ./ci/jenkins/test.sh --testcase '{conformance_type}' --registry ${{DOCKER_REGISTRY}} --testbed-type jumper
 
 - builder:
diff --git a/ci/jenkins/jobs/projects-cloud.yaml b/ci/jenkins/jobs/projects-cloud.yaml
@@ -99,6 +99,12 @@
             - text:
                 credential-id: CAPVC_PASSWORD
                 variable: CAPVC_PASSWORD
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
           publishers:
           - archive:
               allow-empty: true
@@ -211,6 +217,12 @@
             - text:
                 credential-id: CAPVC_PASSWORD
                 variable: CAPVC_PASSWORD
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
           publishers:
           - archive:
               allow-empty: true
@@ -310,6 +322,12 @@
             - text:
                 credential-id: CAPVC_PASSWORD
                 variable: CAPVC_PASSWORD
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
           publishers:
           - archive:
               allow-empty: true
@@ -397,6 +415,12 @@
             - text:
                 credential-id: CAPVC_PASSWORD
                 variable: CAPVC_PASSWORD
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
           publishers:
           - archive:
               allow-empty: true
@@ -509,6 +533,12 @@
             - text:
                 credential-id: CAPVC_PASSWORD
                 variable: CAPVC_PASSWORD
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
           publishers:
           - archive:
               allow-empty: true
@@ -580,6 +610,12 @@
             - text:
                 credential-id: RESOURCEPOOLPATH
                 variable: RESOURCEPOOLPATH
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
       - '{name}-{test_name}-for-gc':
           test_name: workload-cluster
           node: 'antrea-test-node'
diff --git a/ci/jenkins/jobs/projects-lab.yaml b/ci/jenkins/jobs/projects-lab.yaml
@@ -647,6 +647,12 @@
                       - text:
                             credential-id: GOVC_DATASTORE
                             variable: GOVC_DATASTORE
+                      - text:
+                            credential-id: DOCKER_USERNAME
+                            variable: DOCKER_USERNAME
+                      - text:
+                            credential-id: DOCKER_PASSWORD
+                            variable: DOCKER_PASSWORD
             publishers:
                 - archive:
                       allow-empty: true
@@ -703,6 +709,12 @@
                       - text:
                             credential-id: GOVC_DATASTORE
                             variable: GOVC_DATASTORE
+                      - text:
+                            credential-id: DOCKER_USERNAME
+                            variable: DOCKER_USERNAME
+                      - text:
+                            credential-id: DOCKER_PASSWORD
+                            variable: DOCKER_PASSWORD
             publishers:
                 - archive:
                       allow-empty: true
@@ -831,6 +843,12 @@
                       - text:
                             credential-id: GOVC_DATASTORE
                             variable: GOVC_DATASTORE
+                      - text:
+                            credential-id: DOCKER_USERNAME
+                            variable: DOCKER_USERNAME
+                      - text:
+                            credential-id: DOCKER_PASSWORD
+                            variable: DOCKER_PASSWORD
             publishers:
                 - archive:
                       allow-empty: true
@@ -882,6 +900,12 @@
             - text:
                 credential-id: GOVC_DATASTORE
                 variable: GOVC_DATASTORE
+            - text:
+                credential-id: DOCKER_USERNAME
+                variable: DOCKER_USERNAME
+            - text:
+                credential-id: DOCKER_PASSWORD
+                variable: DOCKER_PASSWORD
       - '{name}-{test_name}-for-pull-request':
           test_name: kind-conformance
           node: 'antrea-kind-testbed'
diff --git a/ci/jenkins/test-vmc.sh b/ci/jenkins/test-vmc.sh
@@ -646,14 +646,13 @@ function collect_coverage() {
 }
 
 function cleanup_cluster() {
+    release_static_ip
     echo "=== Cleaning up VMC cluster ${CLUSTER} ==="
     export KUBECONFIG=$KUBECONFIG_PATH
 
     kubectl delete ns ${CLUSTER}
     rm -rf "${GIT_CHECKOUT_DIR}/jenkins"
     echo "=== Cleanup cluster ${CLUSTER} succeeded ==="
-
-    release_static_ip
 }
 
 function garbage_collection() {

Original file line number	Diff line number	Diff line change
`@@ -646,14 +646,13 @@ function collect_coverage() {`
`646`	`646`	`}`
`647`	`647`
`648`	`648`	`function cleanup_cluster() {`
	`649`	`+ release_static_ip`
`649`	`650`	`echo "=== Cleaning up VMC cluster ${CLUSTER} ==="`
`650`	`651`	`export KUBECONFIG=$KUBECONFIG_PATH`
`651`	`652`
`652`	`653`	`kubectl delete ns ${CLUSTER}`
`653`	`654`	`rm -rf "${GIT_CHECKOUT_DIR}/jenkins"`
`654`	`655`	`echo "=== Cleanup cluster ${CLUSTER} succeeded ==="`
`655`		`-`
`656`		`- release_static_ip`
`657`	`656`	`}`
`658`	`657`
`659`	`658`	`function garbage_collection() {`