composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-25 11:38:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°8796 - Add PHP code style validation in iTop and extensions - format whole code base

Browse Source
This commit is contained in:
odain
2025-11-07 15:39:53 +01:00
parent 12f23113f5
commit 890a2568c8
2110 changed files with 53099 additions and 63885 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
tests/php-unit-tests/unitary-tests/setup/MFCompilerTest.php
View File

@@ -11,10 +11,11 @@ use utils;
/**
* @covers \MFCompiler::UseLatestPrecompiledFile
*/
class MFCompilerTest extends ItopTestCase {
class MFCompilerTest extends ItopTestCase
{
/** @var array */
private static $aFoldersToCleanup;
/** @var array */
private static $aRessources;
@@ -23,7 +24,8 @@ class MFCompilerTest extends ItopTestCase {
private $sTmpDir;
public function setUp(): void {
public function setUp(): void
{
parent::setUp();
$this->RequireOnceItopFile('setup/compiler.class.inc.php');
$this->RequireOnceItopFile('setup/modelfactory.class.inc.php');
@@ -33,26 +35,34 @@ class MFCompilerTest extends ItopTestCase {
$this->oMFCompiler = new SubMFCompiler($this->createMock(\ModelFactory::class), '');
}
public function tearDown(): void {
public function tearDown(): void
{
parent::tearDown();
$this->RecurseRmdir($this->sTmpDir);
}
public static function Init(){
if (!is_null(self::$aFoldersToCleanup)){
public static function Init()
{
if (!is_null(self::$aFoldersToCleanup)) {
return;
}
clearstatcache();
$sPrefix = 'scsstest_';
$sAppRootForProvider = dirname(dirname(dirname(dirname(dirname(__FILE__))))) . DIRECTORY_SEPARATOR;
$sTempTargetDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'UseLatestPrecompiledFileProvider';
$sExtensionTargetDir = $sAppRootForProvider . 'extensions/UseLatestPrecompiledFileProvider';
$sSourceDir = $sAppRootForProvider . 'datamodels' . DIRECTORY_SEPARATOR . '2.x';
$sDatamodel2xTargetDir = $sSourceDir . DIRECTORY_SEPARATOR . '/UseLatestPrecompiledFileProvider';
$sAppRootForProvider = dirname(dirname(dirname(dirname(dirname(__FILE__))))).DIRECTORY_SEPARATOR;
$sTempTargetDir = sys_get_temp_dir().DIRECTORY_SEPARATOR.'UseLatestPrecompiledFileProvider';
$sExtensionTargetDir = $sAppRootForProvider.'extensions/UseLatestPrecompiledFileProvider';
$sSourceDir = $sAppRootForProvider.'datamodels'.DIRECTORY_SEPARATOR.'2.x';
$sDatamodel2xTargetDir = $sSourceDir.DIRECTORY_SEPARATOR.'/UseLatestPrecompiledFileProvider';
if (!is_dir($sTempTargetDir)) mkdir($sTempTargetDir);
if (!is_dir($sExtensionTargetDir)) @mkdir($sExtensionTargetDir);
if (!is_dir($sDatamodel2xTargetDir)) @mkdir($sDatamodel2xTargetDir);
if (!is_dir($sTempTargetDir)) {
mkdir($sTempTargetDir);
}
if (!is_dir($sExtensionTargetDir)) {
@mkdir($sExtensionTargetDir);
}
if (!is_dir($sDatamodel2xTargetDir)) {
@mkdir($sDatamodel2xTargetDir);
}
self::$aFoldersToCleanup = [ $sTempTargetDir, $sExtensionTargetDir, $sDatamodel2xTargetDir ];
@@ -60,27 +70,27 @@ class MFCompilerTest extends ItopTestCase {
$iTimeStart = time() - 100;
self::$aRessources['sPostCompilation1'] = tempnam($sTempTargetDir, $sPrefix);
touch(self::$aRessources['sPostCompilation1'], $iTimeStart+=2);
touch(self::$aRessources['sPostCompilation1'], $iTimeStart += 2);
//datamodel XML file in extension folder
self::$aRessources['sPrecompiledInExtensionFile1'] = tempnam($sExtensionTargetDir, $sPrefix);
touch(self::$aRessources['sPrecompiledInExtensionFile1'], $iTimeStart+=2);
self::$aRessources['sPrecompiledInExtensionFileUri1'] = "UseLatestPrecompiledFileProvider" . DIRECTORY_SEPARATOR . basename(self::$aRessources['sPrecompiledInExtensionFile1']);
touch(self::$aRessources['sPrecompiledInExtensionFile1'], $iTimeStart += 2);
self::$aRessources['sPrecompiledInExtensionFileUri1'] = "UseLatestPrecompiledFileProvider".DIRECTORY_SEPARATOR.basename(self::$aRessources['sPrecompiledInExtensionFile1']);
//datamodel XML file in source dir /datamodels/2.x folder
self::$aRessources['sPrecompiledInDataModelXXFile1'] = tempnam($sDatamodel2xTargetDir, $sPrefix);
touch(self::$aRessources['sPrecompiledInDataModelXXFile1'], $iTimeStart+=2);
self::$aRessources['sPrecompiledInDataModelXXFileUri1'] = "UseLatestPrecompiledFileProvider" . DIRECTORY_SEPARATOR . basename(self::$aRessources['sPrecompiledInDataModelXXFile1']);
touch(self::$aRessources['sPrecompiledInDataModelXXFile1'], $iTimeStart += 2);
self::$aRessources['sPrecompiledInDataModelXXFileUri1'] = "UseLatestPrecompiledFileProvider".DIRECTORY_SEPARATOR.basename(self::$aRessources['sPrecompiledInDataModelXXFile1']);
//generate ressources from a previous setup: called postcompiled
self::$aRessources['sPostCompilation2'] = tempnam($sTempTargetDir, $sPrefix);
touch(self::$aRessources['sPostCompilation2'], $iTimeStart+=2);
touch(self::$aRessources['sPostCompilation2'], $iTimeStart += 2);
//simulate copy of /data/models.2.x or extensions ressources during setup in a temp directory
self::$aRessources['sCopiedExtensionFile1'] = $sTempTargetDir . DIRECTORY_SEPARATOR . basename(self::$aRessources['sPrecompiledInExtensionFile1']);
self::$aRessources['sCopiedExtensionFile1'] = $sTempTargetDir.DIRECTORY_SEPARATOR.basename(self::$aRessources['sPrecompiledInExtensionFile1']);
copy(self::$aRessources['sPrecompiledInExtensionFile1'], self::$aRessources['sCopiedExtensionFile1']);
self::$aRessources['sCopiedDataModelXXFile1'] = $sTempTargetDir . DIRECTORY_SEPARATOR . basename(self::$aRessources['sPrecompiledInDataModelXXFile1']);
self::$aRessources['sCopiedDataModelXXFile1'] = $sTempTargetDir.DIRECTORY_SEPARATOR.basename(self::$aRessources['sPrecompiledInDataModelXXFile1']);
copy(self::$aRessources['sPrecompiledInDataModelXXFile1'], self::$aRessources['sCopiedDataModelXXFile1']);
self::$aRessources['sMissingFile'] = tempnam($sTempTargetDir, $sPrefix);
@@ -95,13 +105,13 @@ class MFCompilerTest extends ItopTestCase {
public static function tearDownAfterClass(): void
{
if (is_null(self::$aFoldersToCleanup)){
if (is_null(self::$aFoldersToCleanup)) {
return;
}
foreach (self::$aFoldersToCleanup as $sFolder){
if (is_dir($sFolder)){
foreach (glob("$sFolder/**") as $sFile){
foreach (self::$aFoldersToCleanup as $sFolder) {
if (is_dir($sFolder)) {
foreach (glob("$sFolder/**") as $sFile) {
unlink($sFile);
}
rmdir($sFolder);
@@ -118,40 +128,44 @@ class MFCompilerTest extends ItopTestCase {
* @param string $sThemeDir
* @param ?string $sExpectedReturn
*/
public function testUseLatestPrecompiledFile(string $sTempTargetDir, string $sPrecompiledFileUri, string $sPostCompilationLatestPrecompiledFile, string $sThemeDir, ?string $sExpectedReturn, bool $bDisableThemePrecompilationViaConf = false){
public function testUseLatestPrecompiledFile(string $sTempTargetDir, string $sPrecompiledFileUri, string $sPostCompilationLatestPrecompiledFile, string $sThemeDir, ?string $sExpectedReturn, bool $bDisableThemePrecompilationViaConf = false)
{
// Enable or disable precompilation depending on the test case
utils::GetConfig()->Set('theme.enable_precompilation', !$bDisableThemePrecompilationViaConf);
$sRes = $this->oMFCompiler->UseLatestPrecompiledFile($sTempTargetDir, $sPrecompiledFileUri, $sPostCompilationLatestPrecompiledFile, $sThemeDir);
$this->assertEquals($sExpectedReturn, $sRes);
}
public function UseLatestPrecompiledFileProvider(){
public function UseLatestPrecompiledFileProvider()
{
self::init();
return [
'no precompiled file at all' => $this->BuildProviderUseCaseArray('', self::$aRessources['sMissingFile'], null),
'deactivate precompilation via conf' => $this->BuildProviderUseCaseArray('', self::$aRessources['sPostCompilation1'], null, true),
'no precompiled file configured in precompiled_stylesheet XM section' => $this->BuildProviderUseCaseArray('', self::$aRessources['sPostCompilation1'], self::$aRessources['sPostCompilation1']),
'missing precompiled file in precompiled_stylesheet section' => $this->BuildProviderUseCaseArray(self::$aRessources['sMissingFile'], self::$aRessources['sPostCompilation1'], self::$aRessources['sPostCompilation1'] ),
'no precompiled file generated in previous setup in /data/precompiled_styles' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInExtensionFileUri1'], self::$aRessources['sMissingFile'], self::$aRessources['sCopiedExtensionFile1'] ),
'(extensions) XML precompiled_stylesheet file older than last post setup generated file in /data/precompiled_styles' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInExtensionFileUri1'], self::$aRessources['sPostCompilation2'], self::$aRessources['sPostCompilation2'] ),
'last post setup generated file in /data/precompiled_styles older than (extensions) XML precompiled_stylesheet file' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInExtensionFileUri1'], self::$aRessources['sPostCompilation1'], self::$aRessources['sCopiedExtensionFile1'] ),
'(datamodels/N.x) XML precompiled_stylesheet file older than last post setup generated file in /data/precompiled_styles' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInDataModelXXFileUri1'], self::$aRessources['sPostCompilation2'], self::$aRessources['sPostCompilation2'] ),
'(datamodels/N.x) last post setup generated file in /data/precompiled_styles older than (extensions) XML precompiled_stylesheet file' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInDataModelXXFileUri1'], self::$aRessources['sPostCompilation1'], self::$aRessources['sCopiedDataModelXXFile1'] ),
'missing precompiled file in precompiled_stylesheet section' => $this->BuildProviderUseCaseArray(self::$aRessources['sMissingFile'], self::$aRessources['sPostCompilation1'], self::$aRessources['sPostCompilation1']),
'no precompiled file generated in previous setup in /data/precompiled_styles' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInExtensionFileUri1'], self::$aRessources['sMissingFile'], self::$aRessources['sCopiedExtensionFile1']),
'(extensions) XML precompiled_stylesheet file older than last post setup generated file in /data/precompiled_styles' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInExtensionFileUri1'], self::$aRessources['sPostCompilation2'], self::$aRessources['sPostCompilation2']),
'last post setup generated file in /data/precompiled_styles older than (extensions) XML precompiled_stylesheet file' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInExtensionFileUri1'], self::$aRessources['sPostCompilation1'], self::$aRessources['sCopiedExtensionFile1']),
'(datamodels/N.x) XML precompiled_stylesheet file older than last post setup generated file in /data/precompiled_styles' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInDataModelXXFileUri1'], self::$aRessources['sPostCompilation2'], self::$aRessources['sPostCompilation2']),
'(datamodels/N.x) last post setup generated file in /data/precompiled_styles older than (extensions) XML precompiled_stylesheet file' => $this->BuildProviderUseCaseArray(self::$aRessources['sPrecompiledInDataModelXXFileUri1'], self::$aRessources['sPostCompilation1'], self::$aRessources['sCopiedDataModelXXFile1']),
];
}
private function BuildProviderUseCaseArray(string $sPrecompiledFileUri, string $sPostCompilationLatestPrecompiledFile, $sExpectedReturn, $bDisableThemePrecompilationViaConf = false) : array{
private function BuildProviderUseCaseArray(string $sPrecompiledFileUri, string $sPostCompilationLatestPrecompiledFile, $sExpectedReturn, $bDisableThemePrecompilationViaConf = false): array
{
return [
"sTempTargetDir" => sys_get_temp_dir(),
"sPrecompiledFileUri" => $sPrecompiledFileUri,
"sPostCompilationLatestPrecompiledFile" => $sPostCompilationLatestPrecompiledFile,
"sThemeDir" => "test",
"sExpectedReturn" => $sExpectedReturn,
"bDisableThemePrecompilationViaConf" => $bDisableThemePrecompilationViaConf
"bDisableThemePrecompilationViaConf" => $bDisableThemePrecompilationViaConf,
];
}
public function testCompileThemes(){
public function testCompileThemes()
{
$sFullmoonThemeCompiledFolder = $this->sTmpDir.DIRECTORY_SEPARATOR.'branding'.DIRECTORY_SEPARATOR.'themes'.DIRECTORY_SEPARATOR.'fullmoon'.DIRECTORY_SEPARATOR;
$sXmlDataCustoFilePath = realpath(__DIR__.'/ressources/datamodels/datamodel-branding.xml');
@@ -164,12 +178,11 @@ class MFCompilerTest extends ItopTestCase {
$this->RecurseMkdir($sFullmoonThemeCompiledFolder);
file_put_contents($sFullmoonThemeCompiledFolder.'main.css', "");
$aImportsPaths = array(
$aImportsPaths = [
APPROOT.'css/',
APPROOT.'css/backoffice/main.scss',
$this->sTmpDir.'//',
);
];
$aThemeParameters = [
'variables' => [
@@ -189,8 +202,7 @@ class MFCompilerTest extends ItopTestCase {
$oThemeHandlerService = $this->createMock(\ThemeHandlerService::class);
$oThemeHandlerService->expects($this->exactly(1))
->method("CompileTheme")
->with("fullmoon", true, $this->oMFCompiler->GetCompilationTimeStamp(), $aThemeParameters, $aImportsPaths, $this->sTmpDir . '/');
->with("fullmoon", true, $this->oMFCompiler->GetCompilationTimeStamp(), $aThemeParameters, $aImportsPaths, $this->sTmpDir.'/');
//CompileTheme($sThemeId, $bSetup = false, $sSetupCompilationTimestamp="", $aThemeParameters = null, $aImportsPaths = null, $sWorkingPath = null)
MFCompiler::SetThemeHandlerService($oThemeHandlerService);