git_operations.sh

#!/usr/bin/env bash
# Submodule of deep_copy_submodules
# contains all operations that are git related


# edit the git modules with the new urls
# following this guide
# https://www.w3docs.com/snippets/git/how-to-remove-a-git-submodule.html

source "isolation.sh"

# critical tasks need to be treat with '{ error "FAILURE USING CD" " ${1} was not sucessful"; console_exit; }'
task_add_submodules_local() {
    if [[ $# -ne 1 ]]; then
        { error "@task_add_submodules_local PARAM <1" "size: $#"; return 1; }
    fi
    cd "${1}" || { error "@task_add_submodules_local CD ERROR" "path: ${1}"; return 1; }
    local remote_url="${URL_ARR[1]}/${section}.git"
    # shellcheck disable=SC2154
    for section in "${section_list[@]}"; do
        info "ADDING SUBMODULE LOCALLY"  "SUBMODULE: [${section}] with path: ${1}"
        remote_url="${URL_ARR[1]}/${section}.git"
        git submodule add "${remote_url}" &>tmp.file || { error "@task_add_submodules_local git submodule add error" "$(cat tmp.file)"; return 1; }
        git commit -m "Added the submodule ${section} to the project." || { error "@task_add_submodules_local git commit error" "for section: $section"; return 1; }
    done
}

# needs to parameter
# 1. The remote url
# 2. TMP_PATH -> place for the clone repo
task_clone_remote() {
    if [[ $# -ne 2 ]]; then
        { error "@task_clone_remote Clone Remote $1 - PARAM SIZE not 2" "size: $#"; return 1; }
    fi
    local remote_url="${1}"
    local local_target="${2}"
    [[ -d "$local_target" ]] && rm -rf "$local_target" # empty folder 
    git clone "${remote_url}" "$local_target" &>tmp.file || { error "@task_clone_remote git clone error" "repo: ${remote_url} local:$local_target. $(cat tmp.file)" ; return 1; }
    cd "$2" || { error "@task_clone_remote CD ERROR" "path: ${2}"; return 1; }
    git submodule init &>tmp.file || { error "@task_clone_remote git submodule init error" "$(cat tmp.file)" ; return 1; }
    git submodule update &>tmp.file || { error "@task_clone_remote git submodule update error" "$(cat tmp.file)" ; return 1; } #--remote
}

task_push_changes() {
    if [[ $# -ne 1 ]]; then
        { error "@task_push_changes Param >1" "size: $#"; return 1; }
    fi
    cd "${1}"  || { error "@task_push_changes CD ERROR" "path: ${1}"; return 1; }
    
    local trimmed=$(echo "${URL_ARR[1]}" | sed 's:/*$::')
    local remote_url="${trimmed}/${BASE_PATH}"
    if [[ ! "$remote_url" =~ .git$ ]]; then 
        remote_url="${remote_url}.git"
    fi
    info "PUSH Changes of parent git repo"  "pushing local ${1} to ${remote_url}"
    git remote add "${GIT_REMOTE_NAME}" "${remote_url}"  &>tmp.file  || { error "@task_clone_remote git remote add error" "remote: ${GIT_REMOTE_NAME} url:$remote_url. $(cat tmp.file)"; return 1; }
    git push "${GIT_REMOTE_NAME}" "${GIT_REMOTE_BRANCH}" &>tmp.file  || { error "@task_clone_remote git push error" "remote: ${GIT_REMOTE_NAME} branch:$GIT_REMOTE_BRANCH. $(cat tmp.file)"; return 1; }
    info "PUSH Changes of parent git repo"  "Done pushing"
}


task_remove_submodule() {
    
    if [[ $# -ne 1 ]]; then
        { error "@task_remove_submodule Param >1" "size: $#"; return 1; }
    fi
    # revert tasks
    #
    local submodule=""
    
    # change to base git
    cd "${1}"   || { error "@task_remove_submodule CD ERROR" "path: ${1}"; return 1; }
    
    local removepath="${1}/${submodule}"
    
    info "RM gitmodules" "Removing ${1}/${GIT_MODULE_FILE}"
    
    # remove .gitmodules
    rm "${1}/${GIT_MODULE_FILE}" || { error "@task_remove_submodule RM ERROR" "file: ${1}/${GIT_MODULE_FILE}"; return 1; }
    
    
    # edit .config
    local gitconfig_file="${1}/.git/config"
    local git_module_folder="${1}/.git/modules/"
    info "SED editing git config" "Removing Submodule entries in ${gitconfig_file}"
    # which  ,+2d -> delete line + 2 following lines
    sed -i '/\[submodule .*\]/,+2d' "${gitconfig_file}"  || { error "@task_remove_submodule sed error" "file: ${gitconfig_file}"; return 1; }
    # unstaging submodule cache
    # shellcheck disable=SC2154
    for section in "${section_list[@]}"; do
        info "GITMODULE REMOVING - SUBMODULE"  "[${section}]"
        submodule="${section}"
        
        # remove submodule folder
        removepath="${1}/${submodule}/"
        info "GITMODULE REMOVING - SUBMODULE Remove"  "[${section}] Remove Submodule folder in ${removepath}"
        git rm -r --cached "${removepath}"  || { error "@task_remove_submodule git rm -r --cached error " "file: ${removepath}"; return 1; }
        info "GITMODULE REMOVING - SUBMODULE Remove"  "[${section}] Remove Submodule Cache folder in ${git_module_folder}/${section}"
        rm -rf "${git_module_folder:?}/${section:?}"  || { error "@task_remove_submodule rm -rf error" "file: ${git_module_folder:?}/${section:?}"; return 1; }
        
        # commit changes
        info "GITMODULE REMOVING - Commit changes"  "[${section}] Commit Changes"
        git commit -m "Removed submodule ${section}"  || { error "@task_remove_submodule git commit error" "section: ${section}"; return 1; }
        
        # remove submodule folder
        info "GITMODULE REMOVING - Remove submodule folder"  "[${section}] remove folder: ${removepath}"
        rm -rf  "${removepath}"  || { error "@task_remove_submodule RM -rf error" " file: ${removepath}"; return 1; }
    done
    info "GITMODULE REMOVING" "Done Removing (${section_list[*]})"
}


task_add_submodules_new_remote() {
    if [[ $# -ne 1 ]]; then
        { error "@task_add_submodules_new_remote Param >1" "size: $#"; return 1; }
    fi
    local trimmed=$(echo "${URL_ARR[1]}" | sed 's:/*$::')
    local remote_url="${trimmed}/${section}.git"
    info "GIT USE CREDENTIAL" "value: $GIT_USE_CREDENTIAL_CACHE"
    if [[ "$GIT_USE_CREDENTIAL_CACHE" == "true" ]]; then
        git config credential.helper cache &>tmp.file  || { error "@task_add_submodules_new_remote git config credential.helper cache error" "error: $(cat tmp.file)"; return 1; }
        info "GIT USE CREDENTIAL" "activated."
    fi
    #local remote_url="${URL_ARR[1]}/${section}.git"
    for section in "${section_list[@]}"; do
        info "PUBLISHING TO NEW REMOTE"  "SUBMODULE: [${section}] changing directory ${1}/${section}"
        cd "${1}/${section}" || { error "@task_add_submodules_new_remote CD Error" "file: ${1}/${section}"; }
        remote_url="${trimmed}/${section}.git"
        info "PUBLISHING TO NEW REMOTE"  "SUBMODULE: [${section}] with url: ${remote_url}"
        git remote add "${GIT_REMOTE_NAME}" "${remote_url}" &>tmp.file  || { error "@task_add_submodules_new_remote git remote add error" "remote: ${GIT_REMOTE_NAME} url: ${remote_url}. $(cat tmp.file)"; return 1; }
        info "PWD LOCATION" "$(pwd)"
        git push "${GIT_REMOTE_NAME}" "${GIT_REMOTE_BRANCH}" &>tmp.file || { error "@task_add_submodules_new_remote FAILURE USING git push  ${GIT_REMOTE_NAME} ${GIT_REMOTE_BRANCH} was not sucessful. $(cat tmp.file)"; return 1; }
    done
}

## reverts

revert_clone_remote() {
    info "REVERT clone" "Reverting task 'clone from remote'"
    if [[ "${CREATE_TMP_FOLDER}" == "true" &&  -d "${TMP_PATH}" ]]; then
        rm -rf "${TMP_PATH}"
    fi
    console_exit "Git Operation : Clone Task was not possible ${1}"
}

revert_push_changes() {
    info "REVERT push_changes" "Reverting task 'pushing changes'"
    if [[ "${CREATE_TMP_FOLDER}" == "true" &&  -d "${TMP_PATH}" ]]; then
        rm -rf "${TMP_PATH}"
    fi
    console_exit "Git Operation : Push Task was not possible ${1}"
}
revert_task_add_submodules_local() {
    info "REVERT task_add_submodules_local" "Reverting adding submodule to local copy"
    if [[ "${CREATE_TMP_FOLDER}" == "true" &&  -d "${TMP_PATH}" ]]; then
        rm -rf "${TMP_PATH}"
    fi
    
    console_exit "Git Operation : Adding (local) Task was not possible ${1}"
}

revert_task_add_submodules_new_remote() {
    info "REVERT add_submodules_new_remote" "Reverting adding submodules and abort task"
    if [[ "${CREATE_TMP_FOLDER}" == "true" &&  -d "${TMP_PATH}" ]]; then
        rm -rf "${TMP_PATH}"
    fi
    console_exit "Git Operation : Adding Task was not possible ${1}"
    
}


revert_task_remove_submodules() {
    info "REVERT REMOVE SUBMODULES" "Reverting Submodule and abort task"
    if [[ "${CREATE_TMP_FOLDER}" == "true" &&  -d "${TMP_PATH}" ]]; then
        rm -rf "${TMP_PATH}"
    fi
    console_exit "Git Operation : Removing Task was not possible ${1}"
}
remove_submodules() {
    # template for isolation call
    tmp_string="$*"
    command="task_remove_submodule"
    # shellcheck disable=SC2116
    new_string="$command $(echo "$tmp_string")"
    #echo "$new_string"
    isolated_operation "$new_string" "revert_task_remove_submodules"
}

add_submodules_new_remote() {
    # template for isolation call
    tmp_string="$*"
    command="task_add_submodules_new_remote"
    # shellcheck disable=SC2116
    new_string="$command $(echo "$tmp_string")"
    #echo "$new_string"
    isolated_operation "$new_string" "revert_task_add_submodules_new_remote"
}

add_submodules_local() {
    # template for isolation call
    tmp_string="$*"
    command="task_add_submodules_local"
    # shellcheck disable=SC2116
    new_string="$command $(echo "$tmp_string")"
    #echo "$new_string"
    isolated_operation "$new_string" "revert_task_add_submodules_local"
}
push_changes() {
    # template for isolation call
    tmp_string="$*"
    command="task_push_changes"
    # shellcheck disable=SC2116
    new_string="$command $(echo "$tmp_string")"
    #echo "$new_string"
    isolated_operation "$new_string" "revert_push_changes"
}
clone_remote() {
    # template for isolation call
    tmp_string="$*"
    command="task_clone_remote"
    # shellcheck disable=SC2116
    new_string="$command $(echo "$tmp_string")"
    #echo "$new_string"
    isolated_operation "$new_string" "revert_clone_remote"
}