]> git.mxchange.org Git - friendica.git/blobdiff - tests/src/App/ModeTest.php
Restructure (P)Config to follow new paradigm
[friendica.git] / tests / src / App / ModeTest.php
index bac553eb8c5b86b7b1b270796fa01495abf79c5d..c3a5c5e72b4f99f0c10edf3f573a9b1bcfcf890e 100644 (file)
 <?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Test\src\App;
 
+use Detection\MobileDetect;
 use Friendica\App\Mode;
+use Friendica\App\Module;
+use Friendica\Core\Config\Cache\Cache;
+use Friendica\Database\Database;
+use Friendica\Test\MockedTest;
 use Friendica\Test\Util\VFSTrait;
-use PHPUnit\Framework\TestCase;
+use Friendica\Util\BasePath;
+use Mockery;
+use Mockery\MockInterface;
 
-/**
- * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- */
-class ModeTest extends TestCase
+class ModeTest extends MockedTest
 {
        use VFSTrait;
 
-       public function setUp()
+       /**
+        * @var BasePath|MockInterface
+        */
+       private $basePathMock;
+
+       /**
+        * @var Database|MockInterface
+        */
+       private $databaseMock;
+
+       /**
+        * @var Cache|MockInterface
+        */
+       private $configCacheMock;
+
+       protected function setUp(): void
        {
-               parent::setUp(); // TODO: Change the autogenerated stub
+               parent::setUp();
 
                $this->setUpVfsDir();
+
+               $this->basePathMock    = Mockery::mock(BasePath::class);
+               $this->databaseMock    = Mockery::mock(Database::class);
+               $this->configCacheMock = Mockery::mock(Cache::class);
        }
 
        public function testItEmpty()
        {
-               $mode = new Mode($this->root->url());
-               $this->assertTrue($mode->isInstall());
-               $this->assertFalse($mode->isNormal());
+               $mode = new Mode();
+               self::assertTrue($mode->isInstall());
+               self::assertFalse($mode->isNormal());
        }
 
        public function testWithoutConfig()
        {
-               $mode = new Mode($this->root->url());
+               $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
 
-               $this->assertTrue($this->root->hasChild('config/local.ini.php'));
+               self::assertTrue($this->root->hasChild('config/local.config.php'));
 
-               $this->delConfigFile('local.ini.php');
+               $this->delConfigFile('local.config.php');
 
-               $this->assertFalse($this->root->hasChild('config/local.ini.php'));
+               self::assertFalse($this->root->hasChild('config/local.config.php'));
 
-               $mode->determine();
+               $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
 
-               $this->assertTrue($mode->isInstall());
-               $this->assertFalse($mode->isNormal());
+               self::assertTrue($mode->isInstall());
+               self::assertFalse($mode->isNormal());
 
-               $this->assertFalse($mode->has(Mode::LOCALCONFIGPRESENT));
+               self::assertFalse($mode->has(Mode::LOCALCONFIGPRESENT));
        }
 
        public function testWithoutDatabase()
        {
-               $dba =  \Mockery::mock('alias:Friendica\Database\DBA');
-               $dba
-                       ->shouldReceive('connected')
-                       ->andReturn(false);
+               $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
 
-               $mode = new Mode($this->root->url());
-               $mode->determine();
+               $this->databaseMock->shouldReceive('connected')->andReturn(false)->once();
 
-               $this->assertFalse($mode->isNormal());
-               $this->assertTrue($mode->isInstall());
+               $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
 
-               $this->assertTrue($mode->has(Mode::LOCALCONFIGPRESENT));
-               $this->assertFalse($mode->has(Mode::DBAVAILABLE));
+               self::assertFalse($mode->isNormal());
+               self::assertTrue($mode->isInstall());
+
+               self::assertTrue($mode->has(Mode::LOCALCONFIGPRESENT));
+               self::assertFalse($mode->has(Mode::DBAVAILABLE));
        }
 
        public function testWithoutDatabaseSetup()
        {
-               $dba =  \Mockery::mock('alias:Friendica\Database\DBA');
-               $dba
-                       ->shouldReceive('connected')
-                       ->andReturn(true);
-               $dba
-                       ->shouldReceive('fetchFirst')
-                       ->with('SHOW TABLES LIKE \'config\'')
-                       ->andReturn(false);
+               $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
+
+               $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+               $this->databaseMock->shouldReceive('fetchFirst')
+                                                  ->with('SHOW TABLES LIKE \'config\'')->andReturn(false)->once();
 
-               $mode = new Mode($this->root->url());
-               $mode->determine();
+               $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
 
-               $this->assertFalse($mode->isNormal());
-               $this->assertTrue($mode->isInstall());
+               self::assertFalse($mode->isNormal());
+               self::assertTrue($mode->isInstall());
 
-               $this->assertTrue($mode->has(Mode::LOCALCONFIGPRESENT));
+               self::assertTrue($mode->has(Mode::LOCALCONFIGPRESENT));
        }
 
        public function testWithMaintenanceMode()
        {
-               $dba =  \Mockery::mock('alias:Friendica\Database\DBA');
-               $dba
-                       ->shouldReceive('connected')
-                       ->andReturn(true);
-               $dba
-                       ->shouldReceive('fetchFirst')
-                       ->with('SHOW TABLES LIKE \'config\'')
-                       ->andReturn(true);
+               $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
 
-               $conf = \Mockery::mock('alias:Friendica\Core\Config');
-               $conf
-                       ->shouldReceive('get')
-                       ->with('system', 'maintenance')
-                       ->andReturn(true);
+               $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+               $this->databaseMock->shouldReceive('fetchFirst')
+                                                  ->with('SHOW TABLES LIKE \'config\'')->andReturn(true)->once();
+               $this->configCacheMock->shouldReceive('get')->with('system', 'maintenance')
+                                                         ->andReturn(true)->once();
 
-               $mode = new Mode($this->root->url());
-               $mode->determine();
+               $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
 
-               $this->assertFalse($mode->isNormal());
-               $this->assertFalse($mode->isInstall());
+               self::assertFalse($mode->isNormal());
+               self::assertFalse($mode->isInstall());
 
-               $this->assertTrue($mode->has(Mode::DBCONFIGAVAILABLE));
-               $this->assertFalse($mode->has(Mode::MAINTENANCEDISABLED));
+               self::assertTrue($mode->has(Mode::DBCONFIGAVAILABLE));
+               self::assertFalse($mode->has(Mode::MAINTENANCEDISABLED));
        }
 
        public function testNormalMode()
        {
-               $dba =  \Mockery::mock('alias:Friendica\Database\DBA');
-               $dba
-                       ->shouldReceive('connected')
-                       ->andReturn(true);
-               $dba
-                       ->shouldReceive('fetchFirst')
-                       ->with('SHOW TABLES LIKE \'config\'')
-                       ->andReturn(true);
-
-               $conf = \Mockery::mock('alias:Friendica\Core\Config');
-               $conf
-                       ->shouldReceive('get')
-                       ->with('system', 'maintenance')
-                       ->andReturn(false);
-
-               $mode = new Mode($this->root->url());
-               $mode->determine();
-
-               $this->assertTrue($mode->isNormal());
-               $this->assertFalse($mode->isInstall());
-
-               $this->assertTrue($mode->has(Mode::DBCONFIGAVAILABLE));
-               $this->assertTrue($mode->has(Mode::MAINTENANCEDISABLED));
+               $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
+
+               $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+               $this->databaseMock->shouldReceive('fetchFirst')
+                                                  ->with('SHOW TABLES LIKE \'config\'')->andReturn(true)->once();
+               $this->configCacheMock->shouldReceive('get')->with('system', 'maintenance')
+                                                         ->andReturn(false)->once();
+               $this->databaseMock->shouldReceive('selectFirst')
+                                                  ->with('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])
+                                                  ->andReturn(['v' => null])->once();
+
+               $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
+
+               self::assertTrue($mode->isNormal());
+               self::assertFalse($mode->isInstall());
+
+               self::assertTrue($mode->has(Mode::DBCONFIGAVAILABLE));
+               self::assertTrue($mode->has(Mode::MAINTENANCEDISABLED));
+       }
+
+       /**
+        * Test explicit disabled maintenance (in case you manually disable it)
+        */
+       public function testDisabledMaintenance()
+       {
+               $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
+
+               $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+               $this->databaseMock->shouldReceive('fetchFirst')
+                                                  ->with('SHOW TABLES LIKE \'config\'')->andReturn(true)->once();
+               $this->configCacheMock->shouldReceive('get')->with('system', 'maintenance')
+                                                         ->andReturn(false)->once();
+               $this->databaseMock->shouldReceive('selectFirst')
+                                                  ->with('config', ['v'], ['cat' => 'system', 'k' => 'maintenance'])
+                                                  ->andReturn(['v' => '0'])->once();
+
+               $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
+
+               self::assertTrue($mode->isNormal());
+               self::assertFalse($mode->isInstall());
+
+               self::assertTrue($mode->has(Mode::DBCONFIGAVAILABLE));
+               self::assertTrue($mode->has(Mode::MAINTENANCEDISABLED));
+       }
+
+       /**
+        * Test that modes are immutable
+        */
+       public function testImmutable()
+       {
+               $this->basePathMock->shouldReceive('getPath')->andReturn(null)->once();
+
+               $mode = new Mode();
+
+               $modeNew = $mode->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
+
+               self::assertNotSame($modeNew, $mode);
+       }
+
+       /**
+        * Test if not called by index is backend
+        */
+       public function testIsBackendNotIsBackend()
+       {
+               $server       = [];
+               $module       = new Module();
+               $mobileDetect = new MobileDetect();
+
+               $mode = (new Mode())->determineRunMode(true, $module, $server, $mobileDetect);
+
+               self::assertTrue($mode->isBackend());
+       }
+
+       /**
+        * Test is called by index but module is backend
+        */
+       public function testIsBackendButIndex()
+       {
+               $server       = [];
+               $module       = new Module(Module::DEFAULT, Module::DEFAULT_CLASS, [], true);
+               $mobileDetect = new MobileDetect();
+
+               $mode = (new Mode())->determineRunMode(false, $module, $server, $mobileDetect);
+
+               self::assertTrue($mode->isBackend());
+       }
+
+       /**
+        * Test is called by index and module is not backend
+        */
+       public function testIsNotBackend()
+       {
+               $server       = [];
+               $module       = new Module(Module::DEFAULT, Module::DEFAULT_CLASS, [], false);
+               $mobileDetect = new MobileDetect();
+
+               $mode = (new Mode())->determineRunMode(false, $module, $server, $mobileDetect);
+
+               self::assertFalse($mode->isBackend());
+       }
+
+       /**
+        * Test if the call is an ajax call
+        */
+       public function testIsAjax()
+       {
+               // This is the server environment variable to determine ajax calls
+               $server = [
+                       'HTTP_X_REQUESTED_WITH' => 'xmlhttprequest',
+               ];
+
+               $module       = new Module(Module::DEFAULT, Module::DEFAULT_CLASS, [], false);
+               $mobileDetect = new MobileDetect();
+
+               $mode = (new Mode())->determineRunMode(true, $module, $server, $mobileDetect);
+
+               self::assertTrue($mode->isAjax());
+       }
+
+       /**
+        * Test if the call is not nan ajax call
+        */
+       public function testIsNotAjax()
+       {
+               $server       = [];
+               $module       = new Module(Module::DEFAULT, Module::DEFAULT_CLASS, [], false);
+               $mobileDetect = new MobileDetect();
+
+               $mode = (new Mode())->determineRunMode(true, $module, $server, $mobileDetect);
+
+               self::assertFalse($mode->isAjax());
+       }
+
+       /**
+        * Test if the call is a mobile and is a tablet call
+        */
+       public function testIsMobileIsTablet()
+       {
+               $server       = [];
+               $module       = new Module(Module::DEFAULT, Module::DEFAULT_CLASS, [], false);
+               $mobileDetect = Mockery::mock(MobileDetect::class);
+               $mobileDetect->shouldReceive('isMobile')->andReturn(true);
+               $mobileDetect->shouldReceive('isTablet')->andReturn(true);
+
+               $mode = (new Mode())->determineRunMode(true, $module, $server, $mobileDetect);
+
+               self::assertTrue($mode->isMobile());
+               self::assertTrue($mode->isTablet());
+       }
+
+
+       /**
+        * Test if the call is not a mobile and is not a tablet call
+        */
+       public function testIsNotMobileIsNotTablet()
+       {
+               $server       = [];
+               $module       = new Module(Module::DEFAULT, Module::DEFAULT_CLASS, [], false);
+               $mobileDetect = Mockery::mock(MobileDetect::class);
+               $mobileDetect->shouldReceive('isMobile')->andReturn(false);
+               $mobileDetect->shouldReceive('isTablet')->andReturn(false);
+
+               $mode = (new Mode())->determineRunMode(true, $module, $server, $mobileDetect);
+
+               self::assertFalse($mode->isMobile());
+               self::assertFalse($mode->isTablet());
        }
 }