N°7331 - Refactor Composer cleanup scripts to be used by other dependencies managers as well

2026-04-26 03:58:45 +02:00 · 2024-03-11 10:55:54 +01:00
parent b934cbe89e
commit d1a4d333eb
16 changed files with 286 additions and 211 deletions
--- a/tests/php-unit-tests/unitary-tests/sources/Dependencies/Composer/iTopComposerTest.php
+++ b/tests/php-unit-tests/unitary-tests/sources/Dependencies/Composer/iTopComposerTest.php
@@ -0,0 +1,144 @@
+<?php
+
+namespace Combodo\iTop\Test\UnitTest\Dependencies\Composer;
+
+use Combodo\iTop\Dependencies\Composer\iTopComposer;
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+
+/**
+ * Copyright (C) 2010-2023 Combodo SARL
+ *
+ *   This file is part of iTop.
+ *
+ *   iTop is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU Affero General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   iTop 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
+ *   along with iTop. If not, see <http: *www.gnu.org/licenses/>
+ *
+ */
+class iTopComposerTest extends ItopTestCase
+{
+
+	protected function setUp(): void
+	{
+		parent::setUp();
+		clearstatcache();
+	}
+
+	/**
+	 * @dataProvider IsTestFolderProvider
+	 * @return void
+	 */
+	public function testIsTestFolder($sDirName, $bIsTest)
+	{
+		$isTestDir = iTopComposer::IsQuestionnableFolder($sDirName);
+		$this->assertIsInt($isTestDir);
+		if (true === $bIsTest) {
+			$this->assertTrue(($isTestDir > 0));
+		} else {
+			$this->assertSame(0, $isTestDir);
+		}
+	}
+
+	public function IsTestFolderProvider()
+	{
+		return [
+			'test'    => ['test', true],
+			'Test'    => ['Test', true],
+			'tests'   => ['tests', true],
+			'Tests'   => ['Tests', true],
+			'testaa'  => ['testaa', false],
+			'Testaa'  => ['Testaa', false],
+			'testsaa' => ['testsaa', false],
+			'Testsaa' => ['Testsaa', false],
+		];
+	}
+
+	public function testListAllTestFoldersAbsPaths()
+	{
+		$oiTopComposer = new iTopComposer();
+		$aDirs = $oiTopComposer->ListAllQuestionnableFoldersAbsPaths();
+
+		$this->assertTrue(is_array($aDirs));
+
+		foreach ($aDirs as $sDir) {
+			$sDirName = basename($sDir);
+			$this->assertMatchesRegularExpression(iTopComposer::QUESTIONNABLE_FOLDER_REGEXP, $sDirName, "Directory not matching test dir : $sDir");
+		}
+
+	}
+
+	public function testListDeniedTestFolderAbsPaths()
+	{
+		$oiTopComposer = new iTopComposer();
+		$aDirs = $oiTopComposer->ListDeniedQuestionnableFolderAbsPaths();
+
+		$this->assertTrue(is_array($aDirs));
+
+		$aDeniedDirWrongFormat = [];
+		foreach ($aDirs as $sDir) {
+			if (false === iTopComposer::IsQuestionnableFolder($sDir)) {
+				$aDeniedDirWrongFormat[] = $sDir;
+			}
+		}
+
+		$this->assertEmpty($aDeniedDirWrongFormat,
+			'There are elements in \Combodo\iTop\Dependencies\Composer\iTopComposer::ListDeniedQuestionnableFolderAbsPaths that are not test dirs :'.var_export($aDeniedDirWrongFormat, true));
+	}
+
+	public function testListAllowedTestFoldersAbsPaths()
+	{
+		$oiTopComposer = new iTopComposer();
+		$aDirs = $oiTopComposer->ListAllowedQuestionnableFoldersAbsPaths();
+
+		$this->assertTrue(is_array($aDirs));
+	}
+
+	/**
+	 * This is NOT a unit test, this test the iTop instance running the test ...
+	 */
+	public function testNoDeniedFolderIsPresentForNow()
+	{
+		$oiTopComposer = new iTopComposer();
+
+		$aDeniedButStillPresent = $oiTopComposer->ListDeniedButStillPresent();
+
+		$this->assertEmpty(
+			$aDeniedButStillPresent,
+			'The iTop instance running this test must not contain any denied test directory, found: '.var_export($aDeniedButStillPresent, true)
+		);
+	}
+
+
+	/**
+	 * This is NOT a unit test, this test the iTop instance running the test ...
+	 */
+	public function testAllFoldersCovered()
+	{
+		$oDependenciesHandler = new iTopComposer();
+		$aAllowedAndDeniedDirs = array_merge(
+			$oDependenciesHandler->ListAllowedQuestionnableFoldersAbsPaths(),
+			$oDependenciesHandler->ListDeniedQuestionnableFolderAbsPaths()
+		);
+
+		$aExistingDirs = $oDependenciesHandler->ListAllQuestionnableFoldersAbsPaths();
+
+		$aMissing = array_diff($aExistingDirs, $aAllowedAndDeniedDirs);
+		$aExtra = array_diff($aAllowedAndDeniedDirs, $aExistingDirs);
+
+		$this->assertEmpty(
+			$aMissing,
+			'Test dirs exists in /lib !'."\n"
+			.'  They must be declared either in the allowed or denied list in '.iTopComposer::class." (see N°2651).\n"
+			.'  List of dirs:'."\n".var_export($aMissing, true)
+		);
+	}
+}