Inheritance diagram for LiveCodeTest:

Public Member Functions
	testCodeStyle ()

	testCodeMess ()

	testCopyPaste ()

	testStrictTypes ()

Static Public Member Functions
static	setUpBeforeClass ()

static	getWhitelist ( $fileTypes=['php'], $changedFilesBaseDir='', $baseFilesFolder='', $whitelistFile='/_files/whitelist/common.txt')

Static Protected Attributes
static	$reportDir = ''

static	$pathToSource = ''

Detailed Description

Set of tests for static code analysis, e.g. code style, code complexity, copy paste detecting, etc.

Definition at line 20 of file LiveCodeTest.php.

Member Function Documentation

◆ getWhitelist()

static getWhitelist	(	$fileTypes = `['php']`,
		$changedFilesBaseDir = `''`,
		$baseFilesFolder = `''`,
		$whitelistFile = `'/_files/whitelist/common.txt'`
	)

static

Returns whitelist based on blacklist and git changed files

Parameters

array	$fileTypes
string	$changedFilesBaseDir
string	$baseFilesFolder
string	$whitelistFile

Returns: array

Definition at line 75 of file LiveCodeTest.php.

       {
         $changedFiles = self::getChangedFilesList($changedFilesBaseDir);
         if (empty($changedFiles)) {
             return [];
         }
 
         $globPatternsFolder = ('' !== $baseFilesFolder) ? $baseFilesFolder : self::getBaseFilesFolder();
         try {
             $directoriesToCheck = Files::init()->readLists($globPatternsFolder . $whitelistFile);
         } catch (\Exception $e) {
             // no directories matched white list
             return [];
         }
         $targetFiles = self::filterFiles($changedFiles, $fileTypes, $directoriesToCheck);
         return $targetFiles;
     }

◆ setUpBeforeClass()

static setUpBeforeClass ( )

static

Setup basics for all tests

Returns: void

Definition at line 37 of file LiveCodeTest.php.

     {
         self::$pathToSource = BP;
         self::$reportDir = self::$pathToSource . '/dev/tests/static/report';
         if (!is_dir(self::$reportDir)) {
             mkdir(self::$reportDir);
         }
     }

◆ testCodeMess()

testCodeMess ( )

Test code quality using phpmd

Definition at line 282 of file LiveCodeTest.php.

     {
         $reportFile = self::$reportDir . '/phpmd_report.txt';
         $codeMessDetector = new CodeMessDetector(realpath(__DIR__ . '/_files/phpmd/ruleset.xml'), $reportFile);
 
         if (!$codeMessDetector->canRun()) {
             $this->markTestSkipped('PHP Mess Detector is not available.');
         }
 
         $result = $codeMessDetector->run(self::getWhitelist(['php']));
 
         $output = "";
         if (file_exists($reportFile)) {
             $output = file_get_contents($reportFile);
         }
 
         $this->assertEquals(
             Command::EXIT_SUCCESS,
             $result,
             "PHP Code Mess has found error(s):" . PHP_EOL . $output
         );
 
         // delete empty reports
         if (file_exists($reportFile)) {
             unlink($reportFile);
         }
     }

◆ testCodeStyle()

testCodeStyle ( )

Test code quality using phpcs

Definition at line 262 of file LiveCodeTest.php.

     {
         $isFullScan = defined('TESTCODESTYLE_IS_FULL_SCAN') && TESTCODESTYLE_IS_FULL_SCAN === '1';
         $reportFile = self::$reportDir . '/phpcs_report.txt';
         if (!file_exists($reportFile)) {
             touch($reportFile);
         }
         $codeSniffer = new CodeSniffer('Magento', $reportFile, new Wrapper());
         $result = $codeSniffer->run($isFullScan ? $this->getFullWhitelist() : self::getWhitelist(['php', 'phtml']));
         $report = file_get_contents($reportFile);
         $this->assertEquals(
             0,
             $result,
             "PHP Code Sniffer detected {$result} violation(s): " . PHP_EOL . $report
         );
     }

◆ testCopyPaste()

testCopyPaste ( )

Test code quality using phpcpd

Definition at line 313 of file LiveCodeTest.php.

     {
         $reportFile = self::$reportDir . '/phpcpd_report.xml';
         $copyPasteDetector = new CopyPasteDetector($reportFile);
 
         if (!$copyPasteDetector->canRun()) {
             $this->markTestSkipped('PHP Copy/Paste Detector is not available.');
         }
 
         $blackList = [];
         foreach (glob(__DIR__ . '/_files/phpcpd/blacklist/*.txt') as $list) {
             $blackList = array_merge($blackList, file($list, FILE_IGNORE_NEW_LINES));
         }
 
         $copyPasteDetector->setBlackList($blackList);
 
         $result = $copyPasteDetector->run([BP]);
 
         $output = "";
         if (file_exists($reportFile)) {
             $output = file_get_contents($reportFile);
         }
 
         $this->assertTrue(
             $result,
             "PHP Copy/Paste Detector has found error(s):" . PHP_EOL . $output
         );
     }

◆ testStrictTypes()

testStrictTypes ( )

Tests whitelisted files for strict type declarations.

Definition at line 345 of file LiveCodeTest.php.

     {
         $changedFiles = self::getAddedFilesList('');
 
         try {
             $blackList = Files::init()->readLists(
                 self::getBaseFilesFolder() . '/_files/blacklist/strict_type.txt'
             );
         } catch (\Exception $e) {
             // nothing matched black list
             $blackList = [];
         }
 
         $toBeTestedFiles = array_diff(
             self::filterFiles($changedFiles, ['php'], []),
             $blackList
         );
 
         $filesMissingStrictTyping = [];
         foreach ($toBeTestedFiles as $fileName) {
             $file = file_get_contents($fileName);
             if (strstr($file, 'strict_types=1') === false) {
                 $filesMissingStrictTyping[] = $fileName;
             }
         }
 
         $this->assertEquals(
             0,
             count($filesMissingStrictTyping),
             "Following files are missing strict type declaration:"
             . PHP_EOL
             . implode(PHP_EOL, $filesMissingStrictTyping)
         );
     }

Field Documentation

◆ $pathToSource

$pathToSource = ''

staticprotected

Definition at line 30 of file LiveCodeTest.php.

◆ $reportDir

$reportDir = ''