debugPrint() - Code Metrics - Inspection of "add github workflow" - SimpleMachines/SMF2.1 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — release-2.1 (#6367)

by John
created 2020-11-22 07:01 UTC
debugPrint() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	2
eloc	2
c	1
b	0
f	1
nc	2
nop	1
dl	0
loc	4
rs	10
<?php

/**
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines https://www.simplemachines.org
 * @copyright 2020 Simple Machines and individual contributors
 * @license https://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1 RC3
 */

// Debug stuff.
define('DEBUG_MODE', false);

if (DEBUG_MODE)
	debugPrint("--- DEBUG MSGS START ---");

// First, lets do a basic test.  This is non GPG signed commits.
$signedoff = find_signed_off();

// Now Try to test for the GPG if we don't have a message.
if (empty($signedoff))
	$signedoff = find_gpg();

// Nothing yet?  Lets ask your parents.
if (empty($signedoff) && isset($_SERVER['argv'], $_SERVER['argv'][1]) && $_SERVER['argv'][1] == 'travis')
	$signedoff = find_signed_off_parents();

if (DEBUG_MODE)
	debugPrint("--- DEBUG MSGS END ---");

// Nothing?  Well darn.
if (empty($signedoff))
{
	fwrite(STDERR, 'Error: Signed-off-by not found in commit message');
	exit(1);
}
elseif (DEBUG_MODE)
	debugPrint('Valid signed off found');

// Find a commit by Signed Off
function find_signed_off($commit = 'HEAD', $childs = array(), $level = 0)
{
	$commit = trim($commit);

	// Where we are at.
	debugPrint('Attempting to find signed off on commit ' . $commit);

	// To many recrusions here.
	if ($level > 10)
	{
		debugPrint('Recusion limit exceeded on find_signed_off');
		return false;
	}

	// What string tests should we look for?
	$stringTests = array('Signed-off-by:', 'Signed by');

	// Get message data and clean it up, should only need the last line.
	$message = trim(shell_exec('git show -s --format=%B ' . $commit));
	$lines = explode("\n", trim(str_replace("\r", "\n", $message)));
	$lastLine = $lines[count($lines) - 1];

	// Debug info.
	debugPrint('Testing line "' . $lastLine . '"');

	// loop through each test and find one.
	$result = false;
	foreach ($stringTests as $testedString)
	{
		debugPrint('Testing "' . $testedString . '"');

		$result = stripos($lastLine, $testedString);

		// We got a result.
		if ($result !== false)
		{
			debugPrint('Found "' . $testedString . '"');
			break;
		}
	}

	// Debugger.
	$debugMsgs = array(
		'raw body' => '"' . rtrim(shell_exec('git show -s --format=%B ' . $commit)) . '"',
		'body' => '"' . rtrim(shell_exec('git show -s --format=%b ' . $commit)) . '"',
		'commit notes' => '"' . rtrim(shell_exec('git show -s --format=%N ' . $commit)) . '"',
		'ref names' => '"' . rtrim(shell_exec('git show -s --format=%d ' . $commit)) . '"',
		'commit hash' => '"' . rtrim(shell_exec('git show -s --format=%H ' . $commit)) . '"',
		'tree hash' => '"' . rtrim(shell_exec('git show -s --format=%T ' . $commit)) . '"',
		'parent hash' => '"' . rtrim(shell_exec('git show -s --format=%P ' . $commit)) . '"',
		'result' => '"' . $result . '"',
		'result' => '"' . /** @scrutinizer ignore-type */ $result . '"',
		'testedString' => '"' . $testedString . '"',

	);
	debugPrint('Commit ' . $commit . ' at time ' . time() . ": " . rtrim(print_r($debugMsgs, true)));


	// No result and found a merge? Lets go deeper.
	if ($result === false && preg_match('~Merge ([A-Za-z0-9]{40}) into ([A-Za-z0-9]{40})~i', $lastLine, $merges))
	{
		debugPrint('Found Merge, attempting to get more parent commit: ' . $merges[1]);

		return find_signed_off($merges[1], array_merge(array($merges[1]), $childs), ++$level);
	}

	return $result !== false;
}

// Find a commit by GPG
function find_gpg($commit = 'HEAD', $childs = array())
function find_gpg($commit = 'HEAD', /** @scrutinizer ignore-unused */ $childs = array())
{
	$commit = trim($commit);

	debugPrint('Attempting to Find GPG on commit ' . $commit);

	// Get verify commit data.
	$message = trim(shell_exec('git verify-commit ' . $commit . ' -v --raw'));

	// Should we actually test for gpg results?  Perhaps, but it seems doing that with travis may fail since it has no way to verify a GPG signature from GitHub.  GitHub should have prevented a bad GPG from making a commit to a authors repository and could be trusted in most cases it seems.
	$result = strlen($message) > 0;

	// Debugger.
	$debugMsgs = array(
		// Raw body.
		'verify-commit' => '"' . rtrim(shell_exec('git verify-commit ' . $commit . ' -v --raw')) . '"',
		// Result.
		'result' => '"' . $result . '"',
		// Last tested string, or the correct string.
		'message' => '"' . $message . '"',
	);
	debugPrint('Commit ' . $commit . ' at time ' . time() . ": " . rtrim(print_r($debugMsgs, true)));

	return $result;
}

// Looks at all the parents, and tries to find a signed off by somewhere.
function find_signed_off_parents($commit = 'HEAD')
{
	$commit = trim($commit);

	debugPrint('Attempting to find parents on commit ' . $commit);

	$parentsRaw = rtrim(shell_exec('git show -s --format=%P ' . $commit));
	$parents = explode(' ', $parentsRaw);

	// Test each one.
	foreach ($parents as $p)
	{
		$p = trim($p);
		debugPrint('Testing parent of ' . $commit . ' for signed off');

		// Basic tests.
		$test = find_signed_off($p);

		// No, maybe it has a GPG parent.
		if (empty($test))
			$test = find_gpg($p);

		if (!empty($test))
			return $test;
	}

	// Lucked out.
	return false;
}

// Print a debug line
function debugPrint($msg)
{
	if (DEBUG_MODE)
		echo $msg, "\n";
}
SimpleMachines / SMF2.1

Pull Request — release-2.1 (#6367)

debugPrint() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
