superlint/.automation/cleanup-docker.sh

#!/usr/bin/env bash

################################################################################
############# Cleanup Image on DockerHub @admiralawkbar ########################
################################################################################

# NOTES: This script is used to remove a tagged image on DockerHub
# Its based on being built from a GitHub Action, but could be easily updated
# To be ran in a different medium.
#
# PRE-Requirements:
# - Dockerfile
# - System with Docker installed
# - Global variables met

###########
# Globals #
###########
((LOG_TRACE = LOG_DEBUG = LOG_VERBOSE = LOG_NOTICE = LOG_WARN = LOG_ERROR = "true")) # Enable all loging
export LOG_TRACE LOG_DEBUG LOG_VERBOSE LOG_NOTICE LOG_WARN LOG_ERROR

#########################
# Source Function Files #
#########################
# shellcheck source=/dev/null
source "${GITHUB_WORKSPACE}/lib/functions/log.sh" # Source the function script(s)

################################################################################
############################ FUNCTIONS BELOW ###################################
################################################################################
################################################################################
#### Function Header ###########################################################
Header() {
  info "-------------------------------------------------------"
  info "----- GitHub Actions remove image from DockerHub ------"
  info "-------------------------------------------------------"
}
################################################################################
#### Function ValidateInput ####################################################
ValidateInput() {
  # Need to validate we have the basic variables
  ################
  # Print header #
  ################
  info "----------------------------------------------"
  info "Gathering variables..."
  info "----------------------------------------------"

  ############################
  # Validate GITHUB_WORKSPACE #
  ############################
  if [ -z "${GITHUB_WORKSPACE}" ]; then
    error "Failed to get [GITHUB_WORKSPACE]!"
    fatal "[${GITHUB_WORKSPACE}]"
  else
    info "Successfully found:[GITHUB_WORKSPACE], value:[${GITHUB_WORKSPACE}]"
  fi

  #######################
  # Validate IMAGE_REPO #
  #######################
  if [ -z "${IMAGE_REPO}" ]; then
    # No repo was pulled
    error "Failed to get [IMAGE_REPO]!"
    fatal "[${IMAGE_REPO}]"
  elif [[ ${IMAGE_REPO} == "github/super-linter" ]]; then
    # Found our main repo
    info "Successfully found:[IMAGE_REPO], value:[${IMAGE_REPO}]"
  else
    # This is a fork and we cant pull vars or any info
    warn "No image to cleanup as this is a forked branch, and not being built with current automation!"
    exit 0
  fi

  ##########################
  # Validate IMAGE_VERSION #
  ##########################
  if [ -z "${IMAGE_VERSION}" ]; then
    error "Failed to get [IMAGE_VERSION]!"
    fatal "[${IMAGE_VERSION}]"
  else
    info "Successfully found:[IMAGE_VERSION], value:[${IMAGE_VERSION}]"
  fi

  ############################
  # Validate DOCKER_USERNAME #
  ############################
  if [ -z "${DOCKER_USERNAME}" ]; then
    error "Failed to get [DOCKER_USERNAME]!"
    fatal "[${DOCKER_USERNAME}]"
  else
    info "Successfully found:[DOCKER_USERNAME], value:[${DOCKER_USERNAME}]"
  fi

  ############################
  # Validate DOCKER_PASSWORD #
  ############################
  if [ -z "${DOCKER_PASSWORD}" ]; then
    error "Failed to get [DOCKER_PASSWORD]!"
    fatal "[${DOCKER_PASSWORD}]"
  else
    info "Successfully found:[DOCKER_PASSWORD], value:[********]"
  fi

  ##################################################
  # Check if we need to get the name of the branch #
  ##################################################
  if [[ ${IMAGE_VERSION} != "latest" ]]; then
    ##################################
    # Remove non alpha-numeric chars #
    ##################################
    IMAGE_VERSION=$(echo "${IMAGE_VERSION}" | tr -cd '[:alnum:]')
  else
    #############################################
    # Image is 'latest' and we will not destroy #
    #############################################
    error "Image Tag is set to:[latest]..."
    error "We will never destroy latest..."
    fatal "Bye!"
  fi
}
################################################################################
#### Function LoginToDocker ####################################################
LoginToDocker() {
  ################
  # Print header #
  ################
  info "----------------------------------------------"
  info "Login to DockerHub..."
  info "----------------------------------------------"

  ######################
  # Login to DockerHub #
  ######################
  LOGIN_CMD=$(docker login --username "${DOCKER_USERNAME}" --password "${DOCKER_PASSWORD}" 2>&1)

  #######################
  # Load the error code #
  #######################
  ERROR_CODE=$?

  ##############################
  # Check the shell for errors #
  ##############################
  if [ ${ERROR_CODE} -ne 0 ]; then
    # ERROR
    error "Failed to authenticate to DockerHub!"
    fatal "[${LOGIN_CMD}]"
  else
    # SUCCESS
    info "Successfully authenticated to DockerHub!"
  fi
}
################################################################################
#### Function RemoveImage ######################################################
RemoveImage() {
  ################
  # Print header #
  ################
  info "----------------------------------------------"
  info "Removing the DockerFile image:[${IMAGE_REPO}:${IMAGE_VERSION}]"
  info "----------------------------------------------"

  #####################################
  # Create Token to auth to DockerHub #
  #####################################
  TOKEN=$(curl -s -k \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{\"username\": \"${DOCKER_USERNAME}\", \"password\": \"${DOCKER_PASSWORD}\"}" \
    "https://hub.docker.com/v2/users/login/" | jq -r .token 2>&1)

  #######################
  # Load the ERROR_CODE #
  #######################
  ERROR_CODE=$?

  ##############################
  # Check the shell for errors #
  ##############################
  if [ ${ERROR_CODE} -ne 0 ]; then
    # ERROR
    error "Failed to gain token from DockerHub!"
    fatal "[${TOKEN}]"
  else
    # SUCCESS
    info "Successfully gained auth token from DockerHub!"
  fi

  #################################
  # Remove the tag from DockerHub #
  #################################
  REMOVE_CMD=$(curl "https://hub.docker.com/v2/repositories/${IMAGE_REPO}/tags/${IMAGE_VERSION}/" \
    -X DELETE \
    -H "Authorization: JWT ${TOKEN}" 2>&1)

  #######################
  # Load the ERROR_CODE #
  #######################
  ERROR_CODE=$?

  ##############################
  # Check the shell for errors #
  ##############################
  if [ ${ERROR_CODE} -ne 0 ]; then
    # ERROR
    error "Failed to remove tag from DockerHub!"
    fatal "[${REMOVE_CMD}]"
  else
    # SUCCESS
    info "Successfully [removed] Docker image tag:[${IMAGE_VERSION}] from DockerHub!"
  fi
}
################################################################################
#### Function Footer ###########################################################
Footer() {
  info "-------------------------------------------------------"
  info "The step has completed"
  info "-------------------------------------------------------"
}
################################################################################
################################## MAIN ########################################
################################################################################

##########
# Header #
##########
Header

##################
# Validate Input #
##################
ValidateInput

######################
# Login to DockerHub #
######################
LoginToDocker

####################
# Remove the image #
####################
RemoveImage

##########
# Footer #
##########
Footer