Hier finden Sie eine Beschreibung des Magento 2-Befehls, mit dem die Codeduplizierung überprüft wird.
Der Befehl zum Überprüfen der Codeduplizierung / des Kopierens und Einfügens ist unten aufgeführt.
php bin/magento dev:tests:run static
Dieser Befehl wechselt zuerst in den dev/tests/staticOrdner. Hier sehen Sie die Deklarationsdatei phpunit.xml.dist für diese Testsuite.
<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>
In dieser Datei finden Sie den obigen Code, der definiert, welche Datei für verschiedene Codetests ausgeführt werden soll.
Zum Eingrenzen wird angezeigt,PHP Coding Standard Verification testsuite dass die Datei testsuite / Magento / Test / Php / LiveCodeTest.php ausgeführt wird
Wenn Sie diese Datei öffnen, finden Sie verschiedene Funktionen, mit denen Sie nach verschiedenen Arten von Code-Problemen suchen können. Die auszuführende Funktion isttestCopyPaste
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
);
}
Hier finden Sie einen Code, mit dem alle Dateien / Ordner aus dieser Codeüberprüfung auf die schwarze Liste gesetzt werden.
foreach (glob(__DIR__ . '/_files/phpcpd/blacklist/*.txt') as $list) {
$blackList = array_merge($blackList, file($list, FILE_IGNORE_NEW_LINES));
}
Diese foreachFunktion sucht nach .txtDateien, die im Verzeichnis dev / tests / static / testsuite / Magento / Test / Php / _files / phpcpd / blacklist hinzugefügt wurden . Es liest die Datei und ignoriert alle Ordner, die von der Erkennung des Kopier-Einfüge-Codes ausgeschlossen werden sollen.
Nachdem Sie alle Blacklist-Dateien / -Ordner zum Code hinzugefügt haben, wird der folgende Code ausgeführt.
$result = $copyPasteDetector->run([BP]);
Dieser Code führt die runFunktion der Datei dev / tests / static / framework / Magento / TestFramework / CodingStandard / Tool / CopyPasteDetector.php aus .
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;
}
Hier fügt der Code alle blacklistedOrdner / Dateien in der --excludeListe hinzu.
Danach wird der vendor/bin/phpcpdBefehl ausgeführt.
Hier im Befehl selbst hat Magento
schloss alle
TestDateien per Code aus
--names-exclude "*Test.php"
Es wurden auch alle Code-Duplikate übersprungen, die weniger als 13 Code-Zeilen umfassen
--min-lines 13
Die Ausgabe für diese Befehlsausführung wird der in testCopyPastefunction definierten Datei hinzugefügt . Der Dateiname für die Erkennung durch Kopieren und Einfügen lautet phpcpd_report.xml und befindet sich unter dev / tests / static / report .
Nach erfolgreicher Ausführung des Befehls wird die Ausgabe zu den Berichtsdateien hinzugefügt.