All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.dkirrane.gitflow.groovy.GitflowCommon.groovy Maven / Gradle / Ivy

There is a newer version: 3.0
Show newest version
/*
 * Copyright (C) 2014 Desmond Kirrane
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.dkirrane.gitflow.groovy

import groovy.io.FileType
import groovy.util.logging.Slf4j

import com.dkirrane.gitflow.groovy.ex.GitflowException
import com.dkirrane.gitflow.groovy.ex.GitflowMergeConflictException

/**
 *
 */
@Slf4j
class GitflowCommon {

    static final Long EXE_TIMEOUT = 120000L
    def envp
    def repoDir

    def prefixes = [:]

    String executeLocal(cmd){
        return executeLocal(cmd, false, null)
    }

    String executeLocal(cmd, ignoreExitCode) {
        return executeLocal(cmd, ignoreExitCode, null)
    }

    String executeLocal(cmd, ignoreExitCode, stdin){
        log.debug ""
        log.debug "Executing command: '${cmd}'"
        log.debug "In directory: '${repoDir}'"

        StringBuilder standard = new StringBuilder(450000)
        StringBuilder error = new StringBuilder(450000)
        def process = cmd.execute(envp, repoDir)
        process.consumeProcessOutput(standard, error)
        process.waitFor()

        log.debug standard.toString()
        log.debug "Exit code: " + process.exitValue()
        if(!ignoreExitCode){
            if (process.exitValue() != 0){
                log.error "ERROR: executing command: '${cmd}'"
                log.error error.toString()
                if(standard.toString().contains("Merge conflict")){
                    throw new GitflowMergeConflictException(standard.toString())
                } else{
                    throw new GitflowException(error.toString())
                }
            }
        } else {
            if(error.toString()) {
                log.warn error.toString()
            }
        }
        return standard.toString().trim()
    }

    Integer executeRemote(cmd){
        log.debug ""
        log.debug "Executing command: '${cmd}'"
        log.debug "In directory: '${repoDir}'"

        StringBuilder standard = new StringBuilder(450000)
        StringBuilder error = new StringBuilder(450000)
        Process process = cmd.execute(envp, repoDir)

        process.consumeProcessOutput(standard, error)
        process.waitForOrKill(EXE_TIMEOUT)

        log.debug standard.toString()
        log.debug "Exit code: " + process.exitValue()

        if(error.toString()) {
            log.warn error.toString()
        }

        return process.exitValue()
    }

    String getOrigin() {
        def remotes = []
        def process = "git remote".execute(envp, repoDir)
        process.in.eachLine { line -> remotes.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) }
        return remotes[0];
    }

    String getOriginURL() {
        return executeLocal("git config --get remote.origin.url", true)
    }

    String getGitflowPrefixes(configName) {
        log.debug "getGitflowPrefixes"
        String configValue;
        if(prefixes?.isEmpty() || !prefixes.containsKey(configName)) {
            def key
            def value
            def process = "git config --get-regexp gitflow".execute(envp, repoDir)
            process.in.eachLine { line ->
                // If the line isn't blank
                if(line.trim()) {
                    // Split into a key and value
                    def props = line.split(' ').collect { it.trim() }
                    log.debug "${props[0]}=${props[1]}"
                    key=props[0]
                    value=props[1]
                    prefixes[key]=value ?: ""
                }
            }
        }
        log.debug "Gitflow config ${prefixes}"

        return prefixes[configName];
    }

    String getMasterBranch() {
        def master = getGitflowPrefixes('gitflow.branch.master')
        log.debug "gitflow.branch.master = ${master}"
        return master
    }

    String getDevelopBranch() {
        def develop = getGitflowPrefixes('gitflow.branch.develop')
        log.debug "gitflow.branch.develop = ${develop}"
        return develop
    }

    String getFeatureBranchPrefix() {
        def prefix = getGitflowPrefixes('gitflow.prefix.feature')
        log.debug "gitflow.prefix.feature = ${prefix}"
        return prefix
    }

    String getReleaseBranchPrefix() {
        def prefix = getGitflowPrefixes('gitflow.prefix.release')
        log.debug "gitflow.prefix.release = ${prefix}"
        return prefix
    }

    String getHotfixBranchPrefix() {
        def prefix = getGitflowPrefixes('gitflow.prefix.hotfix')
        log.debug "gitflow.prefix.hotfix = ${prefix}"
        return prefix
    }

    String getSupportBranchPrefix() {
        def prefix = getGitflowPrefixes('gitflow.prefix.support')
        log.debug "gitflow.prefix.support = ${prefix}"
        return prefix
    }

    String getVersionTagPrefix() {
        def prefix = getGitflowPrefixes('gitflow.prefix.versiontag')
        log.debug "gitflow.prefix.versiontag = ${prefix}"
        return prefix
    }

    List gitMergeConflicts() {
        def mergeConflicts = []

        // http://stackoverflow.com/questions/3065650/whats-the-simplest-way-to-git-a-list-of-conflicted-files
        def process = "git diff --name-only --diff-filter=U".execute(envp, repoDir)
        process.in.eachLine { line -> mergeConflicts.add(new File(repoDir, line)) }

        return mergeConflicts;
    }

    List gitLocalBranches() {
        def localBranches = []

        def process = "git branch --no-color".execute(envp, repoDir)
        process.in.eachLine { line -> localBranches.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) }

        return localBranches;
    }

    List gitRemoteBranches() {
        // git branch -r --no-color
        def remoteBranches = []

        def process = "git branch -r --no-color".execute(envp, repoDir)
        process.in.eachLine { line -> remoteBranches.add(line.replaceAll("^(\\s+)", "")) }

        return remoteBranches;
    }


    List gitAllBranches() {
        return gitLocalBranches() + gitRemoteBranches()
    }

    List gitAllTags() {
        // git tag
        def allTags = []

        def process = "git tag".execute(envp, repoDir)
        process.in.eachLine { line -> allTags.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) }

        return allTags;
    }

    String gitCurrentBranch() {
        Process p = "git branch --no-color".execute(envp, repoDir)
        def localBranches = p.text.trim()

        def matcher = localBranches =~ "\\* .*"

        return matcher[0].replaceAll("^(\\*\\s+|\\s+)", "")
    }

    List gitLocalFeatureBranches() {
        List localFeatureBranches = new ArrayList()

        def process = "git branch --no-color".execute(envp, repoDir)
        process.in.eachLine { line -> localFeatureBranches.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) }

        String prefix = getFeatureBranchPrefix()
        return localFeatureBranches.findAll({ it.startsWith(prefix) })
    }

    List gitLocalReleaseBranches() {
        List localReleaseBranches = new ArrayList()

        def process = "git branch --no-color".execute(envp, repoDir)
        process.in.eachLine { line -> localReleaseBranches.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) }

        String prefix = getReleaseBranchPrefix()
        return localReleaseBranches.findAll({ it.startsWith(prefix) })
    }

    List gitLocalHotfixBranches() {
        List localHotfixBranches = new ArrayList()

        def process = "git branch --no-color".execute(envp, repoDir)
        process.in.eachLine { line -> localHotfixBranches.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) }

        String prefix = getHotfixBranchPrefix()
        return localHotfixBranches.findAll({ it.startsWith(prefix) })
    }

    Boolean gitIsCleanWorkingTree() {
        // Check for unstaged changes in the working tree (exit code is 0 if clean)
        Process wcProcess = "git diff --no-ext-diff --ignore-submodules --quiet --exit-code".execute(envp, repoDir)
        def wcCode =  wcProcess.waitFor();
        log.debug "Working Copy code: " + wcCode;

        // Check for uncommitted changes in the index (exit code is 0 if clean)
        Process idxProcess = "git diff-index --cached --quiet --ignore-submodules HEAD --".execute(envp, repoDir)
        def idxCode =  idxProcess.waitFor();
        log.debug "Stage code: " + idxCode;

        boolean clean = false;
        if(0 != wcCode){
            clean = false
        } else if(0!=idxCode){
            clean = false
        } else{
            clean = true
        }
        return clean
    }

    Boolean gitRepoIsHeadless() {
        // ! git rev-parse --quiet --verify HEAD >/dev/null 2>&1
    }

    Boolean gitLocalBranchExists(String branchName) {
        List brnhs = this.gitLocalBranches()
        return brnhs.contains(branchName)
    }

    Boolean gitRemoteBranchExists(String branchName) {
        def isRemote = false
        def origin = getOrigin()
        if(origin) {
            if(!branchName.startsWith(origin)) {
                branchName = origin + '/' + branchName
            }
            List branches = this.gitRemoteBranches()
            if(branches.contains(branchName)){
                isRemote = true
            }
        } else {
            isRemote = false
        }
        return isRemote
    }

    Boolean gitBranchExists(String branchName) {
        def isLocal = gitLocalBranchExists(branchName)
        def isRemote = gitRemoteBranchExists(branchName)
        return (isLocal || isRemote)
    }

    Boolean gitTagExists(String tagName) {
        List tags = gitAllTags()
        return tags.contains(tagName)
    }

    /**
     * 
     *
     * Tests whether branches and their "origin" counterparts have diverged and
     * need merging first. It returns error codes to provide more detail, like
     * so:
     *
     * # 0 Branch heads point to the same commit
     * # 1 First given branch needs fast-forwarding
     * # 2 Second given branch needs fast-forwarding
     * # 3 Branch needs a real merge
     * # 4 There is no merge base, i.e. the branches have no common ancestors
     *
     * 
*/ Integer gitCompareBranches() { def commit1 = executeLocal("git rev-parse ${1}") def commit2 = executeLocal("git rev-parse ${2}") if (commit1 != commit2){ def base = executeLocal("git merge-base ${commit1} ${commit2}") if (null == base){ return 4 } else if (commit1 == base){ return 1 } else if (commit2 == base){ return 2 } else { return 3 } } else{ return 0 } } /** * Checks whether branch (branch) is succesfully merged into another branch (base) */ Boolean gitIsBranchMergedInto(String branch, String base) { def allMerges = [] def process = "git branch --no-color --contains ${branch}".execute(envp, repoDir) process.in.eachLine { line -> allMerges.add(line.replaceAll("^(\\*\\s+|\\s+)", "")) } return allMerges.any({ it.contains(base) }) } Boolean gitflowHasMasterConfigured() { def master = getMasterBranch() if((master != "") && gitLocalBranchExists(master)){ return true } return false } Boolean gitflowHasDevelopConfigured() { def develop = getDevelopBranch() if((develop != "") && gitLocalBranchExists(develop)){ return true } return false } Boolean gitflowHasPrefixesConfigured() { def feature = getFeatureBranchPrefix() def release = getReleaseBranchPrefix() def hotfix = getHotfixBranchPrefix() def support = getSupportBranchPrefix() def versiontag = getVersionTagPrefix() log.debug("Prefixes feature=${feature}, release=${release}, hotfix=${hotfix}, support=${support}, versiontag=${versiontag}") if(feature && release && hotfix && support){ return true } return false } Boolean gitflowIsInitialized() { def master = getMasterBranch() def develop = getDevelopBranch() if(gitflowHasMasterConfigured() && gitflowHasDevelopConfigured() && (master != develop) && gitflowHasPrefixesConfigured()){ return true } return false } // loading settings that can be overridden using git config public static void gitflowLoadSettings() { // export DOT_GIT_DIR=$(git rev-parse --git-dir 2>/dev/null) // export MASTER_BRANCH=$(git config --get gitflow.branch.master) // export DEVELOP_BRANCH=$(git config --get gitflow.branch.develop) // export ORIGIN=$(git config --get gitflow.origin || echo origin) } void gitflowResolveNameprefix() { } void requireGitRepo() { log.debug("Verifying we are in a Git repo") try { executeLocal("git rev-parse --git-dir") } catch(GitflowException ex) { // repoDir.eachFileRecurse (FileType.FILES) { file -> // log.debug file.path // } throw new GitflowException("Not a valid Git repo '${repoDir}' - ${ex.message}") } } void requireGitflowInitialized() { } void requireCleanWorkingTree() { if(!this.gitIsCleanWorkingTree()){ throw new GitflowException("ERROR: Working tree contains unstaged or uncommited changes. Aborting."); } } void requireLocalBranch(String branchName) { List branches = this.gitLocalBranches() if(!branches.contains(branchName)){ throw new GitflowException("ERROR: Local branch '${branchName}' does not exist and is required. Aborting."); } } void requireRemoteBranch(String branchName) { if(gitRemoteBranchExists(branchName)) { throw new GitflowException("ERROR: Remote branch '${branchName}' does not exist and is required. Aborting."); } } void requireBranch(String branchName) { List branches = gitAllBranches(); if(!branches.contains(branchName)){ throw new GitflowException("ERROR: Branch '${branchName}' does not exist and is required. Aborting."); } } void requireBranchAbsent(String branchName) { List branches = gitAllBranches(); if(branches.contains(branchName)){ throw new GitflowException("ERROR: Branch '${branchName}' already exists. Aborting."); } } void requireTagAbsent(String tagName) { List tags = gitAllTags() if(tags.contains(tagName)){ throw new GitflowException("ERROR: Tag '${tagName}' already exists. Aborting."); } } void requireBranchesEqual(String branch1, String branch2) { } static void main(String[] args) { GitflowCommon common = new GitflowCommon() def local = common.gitLocalBranches() println "\nLocal Branches:" local.each { log.info it } def remotes = common.gitRemoteBranches() println "\nRemote Branches:" remotes.each { log.info it } def allBrns = common.gitAllBranches() println "\nAll Branches:" allBrns.each { log.info it } def tags = common.gitAllTags() println "\nAll Tags:" tags.each { log.info it } def currentBrn = common.gitCurrentBranch() println "\nCurrent Branch: ${currentBrn}" def clean = common.gitIsCleanWorkingTree() println "\nClean WorkingTree: ${clean}" } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy