SierraTecnologia / fabrica

src/Tools/Plugin/SensiolabsInsight.php

<?php

namespace Fabrica\Tools\Plugin;

use Fabrica\Tools;
use Fabrica\Tools\Builder;
use Fabrica\Models\Infra\Ci\Build;
use Fabrica\Tools\Plugin;

/**
 * Sensiolabs Insight Plugin - Allows Sensiolabs Insight testing.
 *
 * @author Eugen Ganshorn <eugen@ganshorn.eu>
 */
class SensiolabsInsight extends Plugin
{
    /**
     * @var string
     */
    protected $userUuid;

    /**
     * @var string
     */
    protected $apiToken;

    /**
     * @var string
     */
    protected $projectUuid;

    /**
     * @var int
     */
    protected $allowedWarnings;

    /**
     * @return string
     */
    public static function pluginName()
    {
        return 'sensiolabs_insight';
    }

    /**
     * {@inheritdoc}
     */
    public function __construct(Builder $builder, Build $build, array $options = [])
    {
        parent::__construct($builder, $build, $options);

        $this->allowedWarnings = 0;
        if (array_key_exists('allowed_warnings', $options)) {
            $this->allowedWarnings = (int)$options['allowed_warnings'];
        }

        if (array_key_exists('user_uuid', $options)) {
            $this->userUuid = $options['user_uuid'];
        }

        if (array_key_exists('api_token', $options)) {
            $this->apiToken = $options['api_token'];
        }

        if (array_key_exists('project_uuid', $options)) {
            $this->projectUuid = $options['project_uuid'];
        }
        
        if (array_key_exists('executable', $options)) {
            $this->executable = $this->builder->interpolate($options['executable']);
        } else {
            $this->executable = $this->findBinary('insight');
        }
    }

    /**
     * Runs Sensiolabs Insights in a specified directory.
     *
     * @throws \Exception
     */
    public function execute()

This method seems to be duplicated in your project.

    {
        $insightBinaryPath = $this->executable;

        $this->executeSensiolabsInsight($insightBinaryPath);

        $errorCount = $this->processReport(trim($this->builder->getLastOutput()));
        $this->build->storeMeta((self::pluginName() . '-warnings'), $errorCount);

        return $this->wasLastExecSuccessful($errorCount);
    }

    /**
     * Process PHPMD's XML output report.
     *
     * @param $xmlString
     *
     * @return int
     *
     * @throws \Exception
     */
    protected function processReport($xmlString)

This method seems to be duplicated in your project.

    {
        $xml = simplexml_load_string($xmlString);

        if ($xml === false) {
            $this->builder->log($xmlString);
            throw new \RuntimeException('Could not process PHPMD report XML.');
        }

        $warnings = 0;

        foreach ($xml->file as $file) {
            $fileName = (string)$file['name'];
            $fileName = str_replace($this->builder->buildPath, '', $fileName);

            foreach ($file->violation as $violation) {
                $warnings++;

                $this->build->reportError(
                    $this->builder,
                    self::pluginName(),
                    (string)$violation,
                    PHPCensor\Model\BuildError::SEVERITY_HIGH,
                    $fileName,
                    (int)$violation['beginline'],
                    (int)$violation['endline']
                );
            }
        }

        return $warnings;
    }

    /**
     * Execute Sensiolabs Insight.
     *
     * @param $binaryPath
     */
    protected function executeSensiolabsInsight($binaryPath)
    {
        $cmd = $binaryPath . ' -n analyze --reference %s %s --api-token %s --user-uuid %s';

        // Run Sensiolabs Insight:
        $this->builder->executeCommand(
            $cmd,
            $this->build->getBranch(),
            $this->projectUuid,
            $this->apiToken,
            $this->userUuid
        );

        $cmd = $binaryPath . ' -n analysis --format pmd %s --api-token %s --user-uuid %s';

        // Run Sensiolabs Insight:
        $this->builder->executeCommand(
            $cmd,
            $this->projectUuid,
            $this->apiToken,
            $this->userUuid
        );
    }

    /**
     * Returns a bool indicating if the error count can be considered a success.
     *
     * @param int $errorCount
     *
     * @return bool
     */
    protected function wasLastExecSuccessful($errorCount)

This method seems to be duplicated in your project.

    {
        $success = true;

        if ($this->allowedWarnings !== -1 && $errorCount > $this->allowedWarnings) {
            $success = false;
            return $success;
        }
        return $success;
    }
}