Tenside\CoreBundle\Controller\SelfTestController

Complexity

Total Complexity

10

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes	4
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getAllTestsAction()	0	16	2
B	getAutoConfigAction()	0	26	5
A	testClassToSlug()	0	12	2
A	prepareTests()	0	17	1

<?php

/**
 * This file is part of tenside/core-bundle.
 *
 * (c) Christian Schiffler <c.schiffler@cyberspectrum.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * This project is provided in good faith and hope to be usable by anyone.
 *
 * @package    tenside/core-bundle
 * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @copyright  2015 Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @license    https://github.com/tenside/core-bundle/blob/master/LICENSE MIT
 * @link       https://github.com/tenside/core-bundle
 * @filesource
 */

namespace Tenside\CoreBundle\Controller;

use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\HttpFoundation\JsonResponse;
use Tenside\Core\SelfTest\Cli\SelfTestCliCanFork;
use Tenside\Core\SelfTest\Cli\SelfTestCliOsChecks;
use Tenside\Core\SelfTest\Php\SelfTestEnvPopulated;
use Tenside\CoreBundle\Annotation\ApiDescription;
use Tenside\Core\SelfTest\Cli\SelfTestCanSpawnProcesses;
use Tenside\Core\SelfTest\Cli\SelfTestCliArguments;
use Tenside\Core\SelfTest\Cli\SelfTestCliRuntime;
use Tenside\Core\SelfTest\Generic\SelfTestCalledViaHttps;
use Tenside\Core\SelfTest\Generic\SelfTestFileOwnerMatches;
use Tenside\Core\SelfTest\Php\SelfTestAllowUrlFopenEnabled;
use Tenside\Core\SelfTest\Php\SelfTestSuhosin;
use Tenside\Core\SelfTest\SelfTest;

/**
 * This class provides the self test entry points.
 */
class SelfTestController extends AbstractController
{
    /**
     * Retrieve the results of all tests.
     *
     * @return JsonResponse
     *
     * @ApiDoc(
     *   section="selftest",
     *   statusCodes = {
     *     200 = "When everything worked out ok"
     *   },
     *   authentication = true,
     *   authenticationRoles = {
     *     "ROLE_MANIPULATE_REQUIREMENTS"
     *   }
     * )
     * @ApiDescription(
     *   response={
     *     "results" = {
     *       "actualType" = "collection",
     *       "subType" = "object",
     *       "description" = "The test results.",
     *       "children" = {
     *         "name" = {
     *           "dataType" = "string",
     *           "description" = "The name of the test"
     *         },
     *         "state" = {
     *           "dataType" = "choice",
     *           "description" = "The test result state.",
     *           "format" = "[FAIL|SKIPPED|SUCCESS|WARNING]"
     *         },
     *         "message" = {
     *           "dataType" = "string",
     *           "description" = "The detailed message of the test result."
     *         },
     *         "explain" = {
     *           "dataType" = "string",
     *           "description" = "Optional description that could hint any problems and/or explain the error further."
     *         }
     *       }
     *     }
     *   }
     * )
     */
    public function getAllTestsAction()
    {
        $tester = $this->prepareTests();

        $data = ['results' => []];
        foreach ($tester->perform() as $result) {
            $data['results'][] = [
                'name'    => $this->testClassToSlug($result->getTestClass()),
                'state'   => $result->getState(),
                'message' => $result->getMessage(),
                'explain' => $result->getExplain(),
            ];
        }

        return JsonResponse::create($data);
    }

    /**
     * Retrieve the automatic generated tenside configuration.
     *
     * The automatic configuration consists of several values.
     *
     * @return JsonResponse
     *
     * @ApiDoc(
     *   section="selftest",
     *   statusCodes = {
     *     200 = "When everything worked out ok"
     *   },
     *   authentication = true,
     *   authenticationRoles = {
     *     "ROLE_MANIPULATE_REQUIREMENTS"
     *   }
     * )
     * @ApiDescription(
     *   response={
     *     "php_cli" = {
     *       "dataType" = "string",
     *       "description" = "The PHP interpreter to run on command line."
     *     },
     *     "php_cli_arguments" = {
     *       "dataType" = "string",
     *       "description" = "Command line arguments to add."
     *     }
     *   }
     * )
     */
    public function getAutoConfigAction()
    {
        $tester = $this->prepareTests();
        $tester->perform();

        $config = $tester->getAutoConfig();
        $result = [];

        if ($phpCli = $config->getPhpCliBinary()) {
            $result['php_cli'] = $phpCli;
        }
        if ($phpArguments = $config->getPhpCliArguments()) {
            $result['php_cli_arguments'] = $phpArguments;
        }
        if ($phpEnvironment = $config->getPhpCliEnvironment()) {
            $result['php_cli_environment'] = $phpEnvironment;
        }

        if ($phpEnvironment = $config->isForceToBackgroundEnabled()) {

$phpEnvironment is not used, you could remove the assignment.

            $result['php_force_background'] = true;
        }

        $result['php_can_fork'] = $config->isForkingAvailable();

        return JsonResponse::create($result);
    }

    /**
     * Create a slug from a test class.
     *
     * @param string $className The class name to convert.
     *
     * @return string
     */
    private function testClassToSlug($className)
    {
        $className = basename(str_replace('\\', '/', $className));

        if ('SelfTest' === substr($className, 0, 8)) {
            $className = substr($className, 8);
        }

        $className = strtolower(substr(preg_replace('#([A-Z])#', '-$1', $className), 1));

        return $className;
    }

    /**
     * Prepare the tests.
     *
     * @return SelfTest
     */
    private function prepareTests()
    {
        $tester = new SelfTest();

        $tester->addTest(new SelfTestCalledViaHttps());
        $tester->addTest(new SelfTestFileOwnerMatches());
        $tester->addTest(new SelfTestAllowUrlFopenEnabled());
        $tester->addTest(new SelfTestSuhosin());
        $tester->addTest(new SelfTestEnvPopulated());
        $tester->addTest(new SelfTestCanSpawnProcesses());
        $tester->addTest(new SelfTestCliRuntime());
        $tester->addTest(new SelfTestCliArguments());
        $tester->addTest(new SelfTestCliCanFork());
        $tester->addTest(new SelfTestCliOsChecks());

        return $tester;
    }
}