ReDnAxE / project-quality-inspector

src/Rule/GitRule.php

<?php
/*
 * This file is part of project-quality-inspector.
 *
 * (c) Alexandre GESLIN <alexandre@gesl.in>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ProjectQualityInspector\Rule;

use ProjectQualityInspector\Application\ProcessHelper;
use ProjectQualityInspector\Exception\ExpectationFailedException;

/**
 * Class GitRule
 *
 * @package ProjectQualityInspector\Rule
 */
class GitRule extends AbstractRule
{
    private $commitFormat = '%H|%ci|%cr|%an';
    private $commitFormatKeys = ['commitHash', 'committerDate', 'relativeCommitterDate', 'authorName', 'branchName'];

    public function __construct(array $config, $baseDir)
    {
        parent::__construct($config, $baseDir);
    }

    /**
     * @inheritdoc
     */
    public function evaluate()
    {
        $expectationsFailedExceptions = [];
        $stableBranches = $this->getStableBranches($this->config['remote-branches']);

        try {
            $this->expectsNoMergedBranches($stableBranches, $this->config['threshold-too-many-merged-branches'], $this->config['remote-branches']);

It seems like $stableBranches defined by $this->getStableBranches($this->config['remote-branches']) on line 37 can also be of type null; however, ProjectQualityInspector\Rule\GitRule::expectsNoMergedBranches() does only seem to accept array, maybe add an additional type check?

            $this->addAssertion('expectsNoMergedBranches');
        } catch (ExpectationFailedException $e) {
            $expectationsFailedExceptions[] = $e;
            $this->addAssertion('expectsNoMergedBranches', [['message' => $e->getMessage() . $e->getReason(), 'type' => 'expectsNoMergedBranches']]);
        }

        $notMergedBranchesInfo = $this->listMergedOrNotMergedBranches($stableBranches, false, $this->config['remote-branches']);

It seems like $stableBranches defined by $this->getStableBranches($this->config['remote-branches']) on line 37 can also be of type null; however, ProjectQualityInspector\Rule\GitRule::listMergedOrNotMergedBranches() does only seem to accept array, maybe add an additional type check?

        foreach ($notMergedBranchesInfo as $notMergedBranchInfo) {
            try {
                $this->expectsBranchNotTooBehind($notMergedBranchInfo, $stableBranches);

It seems like $stableBranches defined by $this->getStableBranches($this->config['remote-branches']) on line 37 can also be of type null; however, ProjectQualityInspector\Rule\GitRule::expectsBranchNotTooBehind() does only seem to accept array, maybe add an additional type check?

                $this->addAssertion($notMergedBranchInfo['branchName']);
            } catch (ExpectationFailedException $e) {
                $expectationsFailedExceptions[] = $e;
                $this->addAssertion($notMergedBranchInfo['branchName'], [['message' => $e->getMessage() . $e->getReason(), 'type' => 'expectsBranchNotTooBehind']]);
            }
        }

        if (count($expectationsFailedExceptions)) {
            $this->throwRuleViolationException($expectationsFailedExceptions);
        }
    }

    /**
     * @param array $stableBranches
     * @param int $threshold
     * @param bool $remoteBranches
     *
     * @throws ExpectationFailedException
     */
    private function expectsNoMergedBranches(array $stableBranches, $threshold, $remoteBranches = true)
    {
        if ($mergedBranches = $this->listMergedOrNotMergedBranches($stableBranches, true, $remoteBranches)) {
            if (count($mergedBranches) >= $threshold) {
                $message = sprintf('there is too much remaining merged branches (%s) : %s', count($mergedBranches), $this->stringifyMergedBranches($mergedBranches));
                throw new ExpectationFailedException($mergedBranches, $message);
            }
        }
    }

    /**
     * Compare stable branch first commit after common ancestor of not merged branch and stable branch, and expects days delay do not override limit
     *
     * @param array $notMergedBranchInfo
     * @param array $stableBranches
     *
     * @throws ExpectationFailedException
     */
    private function expectsBranchNotTooBehind(array $notMergedBranchInfo, array $stableBranches)
    {
        foreach ($stableBranches as $stableBranch) {
            $failed = false;
            $lrAheadCommitsCount = $this->getLeftRightAheadCommitsCountAfterMergeBase($stableBranch, $notMergedBranchInfo['branchName']);

            if ($lrAheadCommitsCount[$stableBranch] > 0) {
                $commonAncestorCommitInfo = $this->getMergeBaseCommit($notMergedBranchInfo['branchName'], $stableBranch);
                $stableBranchLastCommitInfo = $this->getBranchLastCommitInfo($stableBranch);

                if ($lrAheadCommitsCount[$stableBranch] >= (int)$this->config['threshold-commits-behind']) {
                    $failed = true;
                }

                $interval = $this->compareCommitInfosDatesDiff($commonAncestorCommitInfo, $stableBranchLastCommitInfo);
                if ((int)$interval->format('%r%a') >= (int)$this->config['threshold-days-behind']) {
                    $failed = true;
                }

                if ($failed) {
                    $message = sprintf('The branch <fg=green>%s</> is behind <fg=green>%s</> by %s commits spread through %s days.', $notMergedBranchInfo['branchName'], $stableBranch, $lrAheadCommitsCount[$stableBranch], (int)$interval->format('%r%a'));
                    $message .= sprintf(' <fg=green>%s</> should update the branch %s', $notMergedBranchInfo['authorName'], $notMergedBranchInfo['branchName']);
                    throw new ExpectationFailedException($notMergedBranchInfo, $message);
                }
            }
        }
    }

    /**
     * Get merged/not merged branches compared to $stablesBranches.
     * If there is multiple stable branches, and $merged = true : list branches that are merged in at least one of the stable branches
     * If there is multiple stable branches, and $merged = false : list branches that are not merged for any of the stable branches
     *
     * @param array $stableBranches
     * @param bool $merged
     * @param bool $remoteBranches
     * @return array
     */
    private function listMergedOrNotMergedBranches(array $stableBranches, $merged = true, $remoteBranches = true)
    {
        $branches = [];
        $mergedOption = ($merged) ? '--merged' : '--no-merged';
        $refsBase = ($remoteBranches) ? 'refs/remotes' : 'refs/heads';

        foreach ($stableBranches as $stableBranch) {
            $result = ProcessHelper::execute(sprintf('for branch in `git for-each-ref %s %s --shell --format=\'%%(refname)\' %s | tr -d \\\' | grep -ve "/HEAD" | grep -ve "%s" | grep -ve "%s"`; do echo `git show --format="%s" $branch | head -n 1`\|$branch; done | sort -r', $mergedOption, $stableBranch, $refsBase, $this->getBranchesRegex('stable-branches-regex'), $this->getBranchesRegex('ignored-branches-regex'), $this->commitFormat), $this->baseDir);

            $branches[$stableBranch] = $this->explodeCommitsArrays($result);

It seems like $result defined by \ProjectQualityInspector\Application\ProcessHelper::execute(sprintf('for branch in `git for-each-ref %s %s --shell --format=\'%%(refname)\' %s | tr -d \\\' | grep -ve "/HEAD" | grep -ve "%s" | grep -ve "%s"`; do echo `git show --format="%s" $branch | head -n 1`\\|$branch; done | sort -r', $mergedOption, $stableBranch, $refsBase, $this->getBranchesRegex('stable-branches-regex'), $this->getBranchesRegex('ignored-branches-regex'), $this->commitFormat), $this->baseDir) on line 134 can also be of type null; however, ProjectQualityInspector\Rule\GitRule::explodeCommitsArrays() does only seem to accept array, maybe add an additional type check?

            if ($merged) {
                foreach ($branches[$stableBranch] as $branchHash => $mergedBranchCommit) {
                    $branches[$stableBranch][$branchHash]['mergeCommit'] = $this->getMergeCommitInfo($stableBranch, $mergedBranchCommit['branchName']);
                }
            }
        }

        if (count($branches) > 1) {
            $branches = ($merged) ? call_user_func_array('array_merge', $branches) : call_user_func_array('array_intersect_key', $branches);
        } else {
            $branches = $branches[$stableBranches[0]];
        }

        return $branches;
    }

    /**
     * Get numbers of commits after common ancestor for $branchLeft and $branchRight (ex: $branchLeft => 2,  $branchRight => 5)
     *
     * @param $branchLeft
     * @param $branchRight
     * @return array
     */
    private function getLeftRightAheadCommitsCountAfterMergeBase($branchLeft, $branchRight)
    {
        $result = ProcessHelper::execute(sprintf('git rev-list --left-right --count %s...%s', $branchLeft, $branchRight), $this->baseDir);
        $result = explode("\t", $result[0]);

        $result = [
            $branchLeft => $result[0],
            $branchRight => $result[1]
        ];

        return $result;
    }

    /**
     * Get common ancestor commit
     *
     * @param string $branchLeft
     * @param string $branchRight
     * @return array
     */
    private function getMergeBaseCommit($branchLeft, $branchRight)
    {
        $commitInfo = null;
        $result = ProcessHelper::execute(sprintf('git merge-base %s %s', $branchLeft, $branchRight), $this->baseDir);

        if (count($result)) {
            $commitInfo = $this->getBranchLastCommitInfo($result[0]);
        }

        return $commitInfo;
    }

    /**
     * Get first commit of $branch after common ancestor commit of $baseBranch and $branch
     *
     * @param string $baseBranch
     * @param string $branch
     * @return array
     */
    private function getBranchFirstCommitInfo($baseBranch, $branch)

This method is not used, and could be removed.

    {
        $branchInfo = null;
        $result = ProcessHelper::execute(sprintf('git log --format="%s" %s..%s | tail -1', $this->commitFormat, $baseBranch, $branch), $this->baseDir);
        if (count($result)) {
            $explodedCommit = explode('|', $result[0]);
            $branchInfo = array_combine(array_slice($this->commitFormatKeys, 0, count($explodedCommit)), $explodedCommit);
            $branchInfo['branchName'] = $branch;
        }

        return $branchInfo;
    }

    /**
     * @param $branchInfoLeft
     * @param $branchInfoRight
     * @return bool|\DateInterval
     */
    private function compareCommitInfosDatesDiff($branchInfoLeft, $branchInfoRight)
    {
        $format = 'Y-m-d H:i:s O';
        $dateLeft = \DateTime::createFromFormat($format, $branchInfoLeft['committerDate']);
        $dateRight = \DateTime::createFromFormat($format, $branchInfoRight['committerDate']);

        return $dateLeft->diff($dateRight);
    }

    /**
     * @param $branch
     * @return array
     */
    private function getBranchLastCommitInfo($branch)
    {
        $result = ProcessHelper::execute(sprintf('git show --format="%s" %s | head -n 1', $this->commitFormat, $branch), $this->baseDir);
        $explodedCommit = explode('|', $result[0]);
        $branchInfo = array_combine(array_slice($this->commitFormatKeys, 0, count($explodedCommit)), $explodedCommit);
        $branchInfo['branchName'] = $branch;

        return $branchInfo;
    }

    /**
     * @param $baseBranch
     * @param $mergedBranch
     * @return array
     */
    private function getMergeCommitInfo($baseBranch, $mergedBranch)
    {
        $branchInfo = [
            'authorName' => 'fast-forward'
        ];

        if ($result = ProcessHelper::execute(sprintf('git show --format="%s" %s ^%s --ancestry-path | head -n 1', $this->commitFormat, $baseBranch, $mergedBranch), $this->baseDir)) {
            $explodedCommit = explode('|', $result[0]);
            $branchInfo = array_combine(array_slice($this->commitFormatKeys, 0, count($explodedCommit)), $explodedCommit);
        }
        $branchInfo['branchName'] = $baseBranch;

        return $branchInfo;
    }

    /**
     * @param bool $remoteBranches
     * @return array
     */
    private function getStableBranches($remoteBranches = true)
    {
        $refsBase = ($remoteBranches) ? 'refs/remotes' : 'refs/heads';

        $result = ProcessHelper::execute(sprintf('git for-each-ref --shell --format=\'%%(refname)\' %s | tr -d \\\' | grep -e "%s"', $refsBase, $this->getBranchesRegex('stable-branches-regex')), $this->baseDir);

        return $result;
    }

    /**
     * @param string $configKey
     * @return string
     */
    private function getBranchesRegex($configKey)
    {
        $branchesRegex = ['^$'];

        if (is_array($this->config[$configKey]) && count($this->config[$configKey])) {
            $branchesRegex = array_map(function ($element) {
                return '\(^[ ]*'.$element.'$\)';
            }, $this->config[$configKey]);
        }

        return implode('\|', $branchesRegex);
    }

    /**
     * @param array $mergedBranches
     * @return string
     */
    private function stringifyMergedBranches(array $mergedBranches)
    {
        $mergedBranches = array_map(function($mergedBranch) {
            return ($mergedBranch['mergeCommit']['authorName'] == 'fast-forward')
                ? sprintf('<fg=green>%s</> - %s by %s, merged in <fg=green>%s</> by %s', $mergedBranch['branchName'], $mergedBranch['relativeCommitterDate'], $mergedBranch['authorName'], $mergedBranch['mergeCommit']['branchName'], $mergedBranch['mergeCommit']['authorName'])
                : sprintf('<fg=green>%s</> - %s by %s, merged %s in <fg=green>%s</> by %s', $mergedBranch['branchName'], $mergedBranch['relativeCommitterDate'], $mergedBranch['authorName'], $mergedBranch['mergeCommit']['relativeCommitterDate'], $mergedBranch['mergeCommit']['branchName'], $mergedBranch['mergeCommit']['authorName']);
        }, $mergedBranches);
        return "\n\t" . implode("\n\t", $mergedBranches);
    }

    /**
     * @param  array  $commits
     * @return array
     */
    private function explodeCommitsArrays(array $commits)
    {
          $explodedCommits = [];

          foreach ($commits as $commit) {
              $explodedCommit = explode('|', $commit);
              $explodedCommit = array_combine(array_slice($this->commitFormatKeys, 0, count($explodedCommit)), $explodedCommit);
              $explodedCommits[$explodedCommit['commitHash']] = $explodedCommit;
          }

          return $explodedCommits;
    }
}