Oto opis komendy Magento 2 używanej do sprawdzania duplikacji kodu.
Polecenie sprawdzenia duplikacji kodu / kopiuj-wklej znajduje się poniżej.
php bin/magento dev:tests:run static
To polecenie najpierw przejdzie do dev/tests/static
folderu. Tutaj możesz zobaczyć plik deklaracji phpunit.xml.dist dla tego zestawu testów.
<testsuites>
<testsuite name="Less Static Code Analysis">
<file>testsuite/Magento/Test/Less/LiveCodeTest.php</file>
</testsuite>
<testsuite name="Javascript Static Code Analysis">
<file>testsuite/Magento/Test/Js/LiveCodeTest.php</file>
</testsuite>
<testsuite name="PHP Coding Standard Verification">
<file>testsuite/Magento/Test/Php/LiveCodeTest.php</file>
</testsuite>
<testsuite name="Code Integrity Tests">
<directory>testsuite/Magento/Test/Integrity</directory>
</testsuite>
<testsuite name="Xss Unsafe Output Test">
<file>testsuite/Magento/Test/Php/XssPhtmlTemplateTest.php</file>
</testsuite>
</testsuites>
W tym pliku znajdziesz powyższy kod, który określi, który plik ma zostać wykonany dla różnych testów kodu.
W celu zawężenia możesz zobaczyć PHP Coding Standard Verification
testsuite
To spowoduje uruchomienie pliku testsuite / Magento / Test / Php / LiveCodeTest.php
Po otwarciu tego pliku znajdziesz różne funkcje do sprawdzania różnych rodzajów problemów z kodem. Funkcja, która zostanie wykonana totestCopyPaste
public function testCopyPaste()
{
$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
);
}
Tutaj znajdziesz kod, który zostanie użyty do umieszczenia na czarnej liście dowolnego pliku / folderu z tej kontroli kodu.
foreach (glob(__DIR__ . '/_files/phpcpd/blacklist/*.txt') as $list) {
$blackList = array_merge($blackList, file($list, FILE_IGNORE_NEW_LINES));
}
Ta foreach
funkcja sprawdzi, czy .txt
plik jest dodany w lokalizacji dev / test / static / testsuite / Magento / Test / Php / _files / phpcpd / blacklist . Odczyta plik i zignoruje wszystkie foldery, aby wykluczyć z procesu wykrywania kodu wklejania kopii.
Po dodaniu wszystkich plików / folderów z czarnej listy do kodu, będzie on działał poniżej kodu.
$result = $copyPasteDetector->run([BP]);
Ten kod wykona run
funkcję pliku dev / test / static / framework / Magento / TestFramework / CodingStandard / Tool / CopyPasteDetector.php .
public function run(array $whiteList)
{
$blackListStr = ' ';
foreach ($this->blacklist as $file) {
$file = escapeshellarg(trim($file));
if (!$file) {
continue;
}
$blackListStr .= '--exclude ' . $file . ' ';
}
$vendorDir = require BP . '/app/etc/vendor_path.php';
$command = 'php ' . BP . '/' . $vendorDir . '/bin/phpcpd' . ' --log-pmd ' . escapeshellarg(
$this->reportFile
) . ' --names-exclude "*Test.php" --min-lines 13' . $blackListStr . ' ' . implode(' ', $whiteList);
exec($command, $output, $exitCode);
return !(bool)$exitCode;
}
Tutaj kod dodaje wszystkie blacklisted
foldery / pliki z --exclude
listy.
Następnie uruchomi vendor/bin/phpcpd
polecenie.
Tutaj w samym poleceniu ma Magento
wykluczono wszystkie
Test
pliki według kodu
--names-exclude "*Test.php"
Pominął również wszystkie duplikaty kodu, które mają mniej niż 13 linii według kodu
--min-lines 13
Dane wyjściowe do wykonania tego polecenia zostaną dodane do pliku zdefiniowanego w testCopyPaste
funkcji. Nazwa pliku do wykrywania wklejania kopii to phpcpd_report.xml znajdująca się w lokalizacji dev / test / static / report .
Po pomyślnym wykonaniu polecenia dane wyjściowe zostaną dodane do plików raportów.