* @author Morris Jobke * @author Thomas Müller * @author Robin McCorkell * * @copyright Copyright (c) 2015, ownCloud, Inc. * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * 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 Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OC\Core\Command\App; use OC\App\CodeChecker\CodeChecker; use OC\App\CodeChecker\EmptyCheck; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; class CheckCode extends Command { protected $checkers = [ 'private' => '\OC\App\CodeChecker\PrivateCheck', 'deprecation' => '\OC\App\CodeChecker\DeprecationCheck', 'strong-comparison' => '\OC\App\CodeChecker\StrongComparisonCheck', ]; protected function configure() { $this ->setName('app:check-code') ->setDescription('check code to be compliant') ->addArgument( 'app-id', InputArgument::REQUIRED, 'check the specified app' ) ->addOption( 'checker', 'c', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'enable the specified checker(s)', [ 'private', 'deprecation', 'strong-comparison' ] ); } protected function execute(InputInterface $input, OutputInterface $output) { $appId = $input->getArgument('app-id'); $checkList = new EmptyCheck(); foreach ($input->getOption('checker') as $checker) { if (!isset($this->checkers[$checker])) { throw new \InvalidArgumentException('Invalid checker: '.$checker); } $checkerClass = $this->checkers[$checker]; $checkList = new $checkerClass($checkList); } $codeChecker = new CodeChecker($checkList); $codeChecker->listen('CodeChecker', 'analyseFileBegin', function($params) use ($output) { if(OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) { $output->writeln("Analysing {$params}"); } }); $codeChecker->listen('CodeChecker', 'analyseFileFinished', function($filename, $errors) use ($output) { $count = count($errors); // show filename if the verbosity is low, but there are errors in a file if($count > 0 && OutputInterface::VERBOSITY_VERBOSE > $output->getVerbosity()) { $output->writeln("Analysing {$filename}"); } // show error count if there are errros present or the verbosity is high if($count > 0 || OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) { $output->writeln(" {$count} errors"); } usort($errors, function($a, $b) { return $a['line'] >$b['line']; }); foreach($errors as $p) { $line = sprintf("%' 4d", $p['line']); $output->writeln(" line $line: {$p['disallowedToken']} - {$p['reason']}"); } }); $errors = $codeChecker->analyse($appId); if (empty($errors)) { $output->writeln('App is compliant - awesome job!'); return 0; } else { $output->writeln('App is not compliant'); return 101; } } }