tests/src/Core/InstallerTest.php

   1 <?php
   2
   3 // this is in the same namespace as Install for mocking 'function_exists'
   4 namespace Friendica\Core;
   5
   6 use Friendica\Test\MockedTest;
   7 use Friendica\Test\Util\L10nMockTrait;
   8 use Friendica\Test\Util\VFSTrait;
   9
  10 /**
  11  * @runTestsInSeparateProcesses
  12  * @preserveGlobalState disabled
  13  */
  14 class InstallerTest extends MockedTest
  15 {
  16         use VFSTrait;
  17         use L10nMockTrait;
  18
  19         public function setUp()
  20         {
  21                 parent::setUp();
  22
  23                 $this->setUpVfsDir();
  24         }
  25
  26         /**
  27          * Mocking the L10n::t() calls for the function checks
  28          */
  29         private function mockFunctionL10TCalls()
  30         {
  31                 $this->mockL10nT('Apache mod_rewrite module', 1);
  32                 $this->mockL10nT('PDO or MySQLi PHP module', 1);
  33                 $this->mockL10nT('libCurl PHP module', 1);
  34                 $this->mockL10nT('Error: libCURL PHP module required but not installed.', 1);
  35                 $this->mockL10nT('XML PHP module', 1);
  36                 $this->mockL10nT('GD graphics PHP module', 1);
  37                 $this->mockL10nT('Error: GD graphics PHP module with JPEG support required but not installed.', 1);
  38                 $this->mockL10nT('OpenSSL PHP module', 1);
  39                 $this->mockL10nT('Error: openssl PHP module required but not installed.', 1);
  40                 $this->mockL10nT('mb_string PHP module', 1);
  41                 $this->mockL10nT('Error: mb_string PHP module required but not installed.', 1);
  42                 $this->mockL10nT('iconv PHP module', 1);
  43                 $this->mockL10nT('Error: iconv PHP module required but not installed.', 1);
  44                 $this->mockL10nT('POSIX PHP module', 1);
  45                 $this->mockL10nT('Error: POSIX PHP module required but not installed.', 1);
  46         }
  47
  48         private function assertCheckExist($position, $title, $help, $status, $required, $assertionArray)
  49         {
  50                 $this->assertArraySubset([$position => [
  51                         'title' => $title,
  52                         'status' => $status,
  53                         'required' => $required,
  54                         'error_msg' => null,
  55                         'help' => $help]
  56                 ], $assertionArray);
  57         }
  58
  59         /**
  60          * Replaces function_exists results with given mocks
  61          *
  62          * @param array $functions a list from function names and their result
  63          */
  64         private function setFunctions($functions)
  65         {
  66                 global $phpMock;
  67                 $phpMock['function_exists'] = function($function) use ($functions) {
  68                         foreach ($functions as $name => $value) {
  69                                 if ($function == $name) {
  70                                         return $value;
  71                                 }
  72                         }
  73                         return '__phpunit_continue__';
  74                 };
  75         }
  76
  77         /**
  78          * Replaces class_exist results with given mocks
  79          *
  80          * @param array $classes a list from class names and their results
  81          */
  82         private function setClasses($classes)
  83         {
  84                 global $phpMock;
  85                 $phpMock['class_exists'] = function($class) use ($classes) {
  86                         foreach ($classes as $name => $value) {
  87                                 if ($class == $name) {
  88                                         return $value;
  89                                 }
  90                         }
  91                         return '__phpunit_continue__';
  92                 };
  93         }
  94
  95         /**
  96          * @small
  97          */
  98         public function testCheckKeys()
  99         {
 100                 $this->setFunctions(['openssl_pkey_new' => false]);
 101                 $install = new Installer();
 102                 $this->assertFalse($install->checkKeys());
 103
 104                 $this->setFunctions(['openssl_pkey_new' => true]);
 105                 $install = new Installer();
 106                 $this->assertTrue($install->checkKeys());
 107         }
 108
 109         /**
 110          * @small
 111          */
 112         public function testCheckFunctions()
 113         {
 114                 $this->mockFunctionL10TCalls();
 115                 $this->setFunctions(['curl_init' => false, 'imagecreatefromjpeg' => true]);
 116                 $install = new Installer();
 117                 $this->assertFalse($install->checkFunctions());
 118                 $this->assertCheckExist(3,
 119                         'libCurl PHP module',
 120                         'Error: libCURL PHP module required but not installed.',
 121                         false,
 122                         true,
 123                         $install->getChecks());
 124
 125                 $this->mockFunctionL10TCalls();
 126                 $this->setFunctions(['imagecreatefromjpeg' => false]);
 127                 $install = new Installer();
 128                 $this->assertFalse($install->checkFunctions());
 129                 $this->assertCheckExist(4,
 130                         'GD graphics PHP module',
 131                         'Error: GD graphics PHP module with JPEG support required but not installed.',
 132                         false,
 133                         true,
 134                         $install->getChecks());
 135
 136                 $this->mockFunctionL10TCalls();
 137                 $this->setFunctions(['openssl_public_encrypt' => false]);
 138                 $install = new Installer();
 139                 $this->assertFalse($install->checkFunctions());
 140                 $this->assertCheckExist(5,
 141                         'OpenSSL PHP module',
 142                         'Error: openssl PHP module required but not installed.',
 143                         false,
 144                         true,
 145                         $install->getChecks());
 146
 147                 $this->mockFunctionL10TCalls();
 148                 $this->setFunctions(['mb_strlen' => false]);
 149                 $install = new Installer();
 150                 $this->assertFalse($install->checkFunctions());
 151                 $this->assertCheckExist(6,
 152                         'mb_string PHP module',
 153                         'Error: mb_string PHP module required but not installed.',
 154                         false,
 155                         true,
 156                         $install->getChecks());
 157
 158                 $this->mockFunctionL10TCalls();
 159                 $this->setFunctions(['iconv_strlen' => false]);
 160                 $install = new Installer();
 161                 $this->assertFalse($install->checkFunctions());
 162                 $this->assertCheckExist(7,
 163                         'iconv PHP module',
 164                         'Error: iconv PHP module required but not installed.',
 165                         false,
 166                         true,
 167                         $install->getChecks());
 168
 169                 $this->mockFunctionL10TCalls();
 170                 $this->setFunctions(['posix_kill' => false]);
 171                 $install = new Installer();
 172                 $this->assertFalse($install->checkFunctions());
 173                 $this->assertCheckExist(8,
 174                         'POSIX PHP module',
 175                         'Error: POSIX PHP module required but not installed.',
 176                         false,
 177                         true,
 178                         $install->getChecks());
 179
 180                 $this->mockFunctionL10TCalls();
 181                 $this->setFunctions([
 182                         'curl_init' => true,
 183                         'imagecreatefromjpeg' => true,
 184                         'openssl_public_encrypt' => true,
 185                         'mb_strlen' => true,
 186                         'iconv_strlen' => true,
 187                         'posix_kill' => true
 188                 ]);
 189                 $install = new Installer();
 190                 $this->assertTrue($install->checkFunctions());
 191         }
 192
 193         /**
 194          * @small
 195          */
 196         public function testCheckLocalIni()
 197         {
 198                 $this->assertTrue($this->root->hasChild('config/local.config.php'));
 199
 200                 $install = new Installer();
 201                 $this->assertTrue($install->checkLocalIni());
 202
 203                 $this->delConfigFile('local.config.php');
 204
 205                 $this->assertFalse($this->root->hasChild('config/local.config.php'));
 206
 207                 $install = new Installer();
 208                 $this->assertTrue($install->checkLocalIni());
 209         }
 210
 211         /**
 212          * @small
 213          */
 214         public function testCheckHtAccessFail()
 215         {
 216                 // Mocking the CURL Response
 217                 $curlResult = \Mockery::mock('Friendica\Network\CurlResult');
 218                 $curlResult
 219                         ->shouldReceive('getReturnCode')
 220                         ->andReturn('404');
 221                 $curlResult
 222                         ->shouldReceive('getRedirectUrl')
 223                         ->andReturn('');
 224                 $curlResult
 225                         ->shouldReceive('getError')
 226                         ->andReturn('test Error');
 227
 228                 // Mocking the CURL Request
 229                 $networkMock = \Mockery::mock('alias:Friendica\Util\Network');
 230                 $networkMock
 231                         ->shouldReceive('fetchUrlFull')
 232                         ->with('https://test/install/testrewrite')
 233                         ->andReturn($curlResult);
 234                 $networkMock
 235                         ->shouldReceive('fetchUrlFull')
 236                         ->with('http://test/install/testrewrite')
 237                         ->andReturn($curlResult);
 238
 239                 // Mocking that we can use CURL
 240                 $this->setFunctions(['curl_init' => true]);
 241
 242                 $install = new Installer();
 243
 244                 $this->assertFalse($install->checkHtAccess('https://test'));
 245                 $this->assertSame('test Error', $install->getChecks()[0]['error_msg']['msg']);
 246         }
 247
 248         /**
 249          * @small
 250          */
 251         public function testCheckHtAccessWork()
 252         {
 253                 // Mocking the failed CURL Response
 254                 $curlResultF = \Mockery::mock('Friendica\Network\CurlResult');
 255                 $curlResultF
 256                         ->shouldReceive('getReturnCode')
 257                         ->andReturn('404');
 258
 259                 // Mocking the working CURL Response
 260                 $curlResultW = \Mockery::mock('Friendica\Network\CurlResult');
 261                 $curlResultW
 262                         ->shouldReceive('getReturnCode')
 263                         ->andReturn('204');
 264
 265                 // Mocking the CURL Request
 266                 $networkMock = \Mockery::mock('alias:Friendica\Util\Network');
 267                 $networkMock
 268                         ->shouldReceive('fetchUrlFull')
 269                         ->with('https://test/install/testrewrite')
 270                         ->andReturn($curlResultF);
 271                 $networkMock
 272                         ->shouldReceive('fetchUrlFull')
 273                         ->with('http://test/install/testrewrite')
 274                         ->andReturn($curlResultW);
 275
 276                 // Mocking that we can use CURL
 277                 $this->setFunctions(['curl_init' => true]);
 278
 279                 // needed because of "normalise_link"
 280                 require_once __DIR__ . '/../../../include/text.php';
 281
 282                 $install = new Installer();
 283
 284                 $this->assertTrue($install->checkHtAccess('https://test'));
 285         }
 286
 287         /**
 288          * @small
 289          */
 290         public function testImagick()
 291         {
 292                 $imageMock = \Mockery::mock('alias:Friendica\Object\Image');
 293                 $imageMock
 294                         ->shouldReceive('supportedTypes')
 295                         ->andReturn(['image/gif' => 'gif']);
 296
 297                 $this->setClasses(['Imagick' => true]);
 298
 299                 $install = new Installer();
 300
 301                 // even there is no supported type, Imagick should return true (because it is not required)
 302                 $this->assertTrue($install->checkImagick());
 303
 304                 $this->assertCheckExist(1,
 305                         L10n::t('ImageMagick supports GIF'),
 306                         '',
 307                         true,
 308                         false,
 309                         $install->getChecks());
 310         }
 311
 312         /**
 313          * @small
 314          */
 315         public function testImagickNotFound()
 316         {
 317                 $imageMock = \Mockery::mock('alias:Friendica\Object\Image');
 318                 $imageMock
 319                         ->shouldReceive('supportedTypes')
 320                         ->andReturn([]);
 321
 322                 $this->setClasses(['Imagick' => true]);
 323
 324                 $install = new Installer();
 325
 326                 // even there is no supported type, Imagick should return true (because it is not required)
 327                 $this->assertTrue($install->checkImagick());
 328                 $this->assertCheckExist(1,
 329                         L10n::t('ImageMagick supports GIF'),
 330                         '',
 331                         false,
 332                         false,
 333                         $install->getChecks());
 334         }
 335
 336         public function testImagickNotInstalled()
 337         {
 338                 $this->setClasses(['Imagick' => false]);
 339                 $this->mockL10nT('ImageMagick PHP extension is not installed');
 340
 341                 $install = new Installer();
 342
 343                 // even there is no supported type, Imagick should return true (because it is not required)
 344                 $this->assertTrue($install->checkImagick());
 345                 $this->assertCheckExist(0,
 346                         'ImageMagick PHP extension is not installed',
 347                         '',
 348                         false,
 349                         false,
 350                         $install->getChecks());
 351         }
 352 }
 353
 354 /**
 355  * A workaround to replace the PHP native function_exists with a mocked function
 356  *
 357  * @param string $function_name the Name of the function
 358  *
 359  * @return bool true or false
 360  */
 361 function function_exists($function_name)
 362 {
 363         global $phpMock;
 364         if (isset($phpMock['function_exists'])) {
 365                 $result = call_user_func_array($phpMock['function_exists'], func_get_args());
 366                 if ($result !== '__phpunit_continue__') {
 367                         return $result;
 368                 }
 369         }
 370         return call_user_func_array('\function_exists', func_get_args());
 371 }
 372
 373 function class_exists($class_name)
 374 {
 375         global $phpMock;
 376         if (isset($phpMock['class_exists'])) {
 377                 $result = call_user_func_array($phpMock['class_exists'], func_get_args());
 378                 if ($result !== '__phpunit_continue__') {
 379                         return $result;
 380                 }
 381         }
 382         return call_user_func_array('\class_exists', func_get_args());
 383 }