ITOP-4856: Add Feature Branch Manager Script

fb/FBManager.sh

@@ -0,0 +1,186 @@
+#!/bin/bash
+
+# Arguments
+# 1: Configuration file JSON Format See help description
+# 2: Action: create / delete Feature Branch
+
+# EXIT CODES
+# 0 -- OK
+# 1 -- Missing arguments or commands
+# 2 -- Wrong provided argument
+# 3 -- Missing mandatory information in the configuration file
+# 4 -- Wrong provided information or insufficient privileges
+# 5 -- Inability to perform action due to insufficient privileges
+####
+protected_branches_list_regex="^(master|develop|stable\/[0-9.-_a-zA-Z]+)$"
+####
+
+scrdir=$(dirname $(realpath $0))
+source ${scrdir}/_functions.sh
+if [ -z "$1" ] || [[ $1 =~ ^-(h|-help)$ ]]; then
+    print_help
+    exit 0
+fi
+assert_command git
+assert_command jq
+if [ -z "$1" ] || [ ! -f "$1" ]; then
+    echo_err "Config file is missing or invalid"
+    exit 1
+fi
+config_file=$(realpath $1)
+if ! validate_json ${config_file} >/dev/null; then #Suppress only plain message
+    echo_err "Config file is not a valid JSON file!"
+    exit 2
+else
+    echo_ok "Config file \"$1\" is a valid JSON file"
+fi
+shift
+if [[ ! "$1" =~ ^(create|delete)$ ]]; then
+    echo_err "Wrong or Missing action! only create or delete are accepted!"
+    exit 2
+else
+    echo_ok "Action \"$1\" will be performed"
+fi
+
+action=$1
+start_time=$(date +%s);
+rm -rf ${wkdir}* 2>&1 &>/dev/null #Cleanup
+for el in $(cat ${config_file} | jq -c '.[]'); do
+    ## Args Parsing
+    if ! eval $(echo $el | jq -r '. | to_entries | .[] | .key + "=\"" + .value + "\""') 2>&1 &>/dev/null; then
+        echo_err "Could not convert the followig JSON Object to Bash variables!"
+        echo $el | jq
+        exit 3
+    fi
+
+    ## Args Common Checks
+    if [ -z "${git_organization}" ]; then
+        echo_err "Github organization is not specified!"
+        exit 3
+    fi
+
+    if [ -z "${git_repository}" ]; then
+        echo_err "Github repository is not specified!"
+        exit 3
+    fi
+
+    if [ -z "${name}" ]; then
+        echo_err "Github target branch is not specified!"
+        exit 3
+    fi
+
+    if [[ "${name}" =~ ${protected_branches_list_regex} ]]; then
+        echo_err "Github target branch \"${name}\" matches a protected branch"
+        exit 3
+    fi
+
+    ## Prepare repository
+    full_repo_name="${git_organization}/${git_repository}"
+    ssh_url="[email protected]:${full_repo_name}.git"
+
+    ## Check Repository existance and access privileges
+    if ! valid_repo ${ssh_url}; then
+        echo_err "Repository ${full_repo_name} is not exist or insufficient privileges!"
+        exit 4
+    fi
+
+    ## Clone Repository
+    echo_ok "Cloning ${full_repo_name}"
+    local_repo_path="${wkdir}/${full_repo_name}"
+    [ -e ${local_repo_path} ] && rm -rf ${local_repo_path} 2>&1 &>/dev/null #Cleanup
+    if ! git clone ${ssh_url} ${local_repo_path} 2>&1 &>/dev/null; then
+        echo_err "Could not clone ${full_repo_name} !"
+        exit_with_cleanup 4
+    fi
+
+    ## Check if the repository is successfully cloned
+    if [ ! -d ${local_repo_path} ] || [ ! -d "${local_repo_path}/.git" ]; then
+        echo_err "Local repository ${full_repo_name} is not created !"
+        exit_with_cleanup 4
+    else
+        echo_ok "Repository ${full_repo_name} is successfully cloned !"
+    fi
+
+    ## Function Live Definition Make code below more redeable
+    r_git() {
+        git --git-dir=${local_repo_path}/.git $*
+    }
+
+    ## Check if update is unset if yes, use false as default value
+    [ -z "${update}" ] && update="false"
+
+    ## Perform Feature Branch Creation
+    if [[ $action == "create" ]]; then
+
+        ## Check if base branch is unset if yes, use default branch as base one
+        [ -z "${git_base_branch}" ] && git_base_branch=$(r_git symbolic-ref --short HEAD)
+
+        ## Check if target branch is already exist in the Git Repository [ Remote Check ]
+        if [ ! -z "$(r_git ls-remote --heads origin ${name})" ]; then
+            if [[ ${update} == "false" ]]; then
+                echo_err "Branch \"${name}\" already exist!"
+            fi
+            if [[ ${update} == "true" ]]; then
+                echo_warn "Update Mode is Enabled!"
+            else
+                exit_with_cleanup 5
+            fi
+        fi
+
+        current_branch=$(r_git rev-parse --abbrev-ref HEAD)
+        #Default branch protection
+        if [[ "${name}" == "${current_branch}" ]]; then
+            echo_err "Could not recreate the default branch \"${name}\"!"
+            exit_with_cleanup 4
+        fi
+        ## Check if the current branch is the selected base branch if not, check out to it
+        if [[ "${git_base_branch}" != "${current_branch}" ]]; then
+            if ! r_git checkout ${git_base_branch} 2>&1 &>/dev/null; then
+                echo_err "Could not checkout to branch \"${git_base_branch}\" !"
+                exit_with_cleanup 5
+            fi
+            echo_ok "Checked out to base branch \"${git_base_branch}\""
+        else
+            echo_ok "Already on base branch \"${git_base_branch}\""
+        fi
+
+        # Add Force flag for the git push and remove branch as precaution
+        force_flag=""
+        [[ ${update} == "true" ]] && force_flag="-f"
+        r_git branch -D ${name} 2>&1 &>/dev/null
+
+        # Create target branch locally and push to the remote
+        if r_git checkout -b "${name}" && r_git push origin "${name}" ${force_flag} 2>/dev/null; then
+            echo_ok "Branch \"${name}\" has been created!"
+        else
+            echo_err "Could not create branch \"${name}\"!"
+            exit_with_cleanup 5
+        fi
+
+    ## Perform Feature Branch Deletion
+    elif [[ $action == "delete" ]]; then
+        # Default Branch Protection
+        current_branch=$(r_git rev-parse --abbrev-ref HEAD)
+        if [[ "${name}" == "${current_branch}" ]]; then
+            echo_err "Could not delete default branch \"${name}\"!"
+            exit_with_cleanup 4
+        fi
+        ## Check if target branch is already exist in the Git Repository [ Remote Check ]
+        if [ ! -z "$(r_git ls-remote --heads origin ${name})" ]; then
+            echo_ok "Branch \"${name}\" exist"
+            if r_git push origin :${name}; then
+                echo_ok "Branch \"${name}\" has been deleted!"
+
+            else
+                echo_err "Could not delete branch \"${name}\"!"
+                exit_with_cleanup 5
+            fi
+        else
+            echo_ok "Branch \"${name}\" does not exist"
+        fi
+    fi
+    ## Mandatory Common cleanup process for the next iteration
+    rm -rf $(dirname ${local_repo_path}) 2>&1 &>/dev/null #Global Cleanup : dirname = organization folder
+    unset name git_base_branch git_organization git_repository update force_flag
+done
+echo_ok "Finished in $(date -ud "@$(($(date +%s) - $start_time))" +%T)."

fb/_functions.sh

@@ -0,0 +1,63 @@
+wkdir="/tmp/fbmgnfactory"
+
+echo_err() {
+  echo "$(date +'%d/%m/%y %H:%M:%S') |  Error | $*" >>/dev/stderr
+}
+
+echo_ok() {
+  echo "$(date +'%d/%m/%y %H:%M:%S') |  INFO  | $*"
+}
+
+echo_warn() {
+  echo "$(date +'%d/%m/%y %H:%M:%S') |  WARN  | $*"
+}
+
+exit_with_cleanup() {
+ rm -rf $wkdir 2>&1 &>/dev/null
+ exit $1
+}
+
+validate_json() {
+  cat $1 | jq type
+}
+
+assert_command() {
+  if ! hash $1 2>&1 &>/dev/null; then 
+     echo_err "$1 is not installed !"
+     exit 1
+  fi
+}
+
+valid_repo() {
+  [ ! -z "$1" ] && [ ! -z "$(git ls-remote --heads $1 2>/dev/null)" ]
+}
+
+print_help() {
+  cat <<EOF
+**** Feature Branch Manager ****** 
+ ** Created by eXo SWF / ITOP Team
+
+Usage:      $0 <configuration_file.json> <action> 
+
+Actions:    create, delete
+
+Config File Sample:
+
+    [
+        {
+          "name": "Feature/xxxxxxx", 
+          "git_organization": "exo-xxxxx,
+          "git_repository": "eXo-Testing", 
+          "git_base_branch": "stable/xxxxxx", // Optional, Default [create]: default branch
+          "update": "true or false" // Optional, Default: false, [Caution] overwrite remote branch
+        },
+        {
+          "name": "Feature/xxxxxxx",
+           ....
+           .... 
+        }
+    ]
+
+Mandatory commands: git, jq            
+EOF
+}