<?php
+/**
+ * @copyright Copyright (C) 2010-2023, 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\Arguments;
use Friendica\App\Mode;
-use Friendica\Core\Config;
+use Friendica\Core\Config\ValueObject\Cache;
+use Friendica\Database\Database;
use Friendica\Test\MockedTest;
-use Friendica\Test\Util\DBAMockTrait;
use Friendica\Test\Util\VFSTrait;
+use Friendica\Util\BasePath;
+use Mockery;
+use Mockery\MockInterface;
class ModeTest extends MockedTest
{
use VFSTrait;
- use DBAMockTrait;
- public function setUp()
+ /**
+ * @var BasePath|MockInterface
+ */
+ private $basePathMock;
+
+ /**
+ * @var Database|MockInterface
+ */
+ private $databaseMock;
+
+ /**
+ * @var Cache|MockInterface
+ */
+ private $configCacheMock;
+
+ protected function setUp(): void
{
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.config.php'));
+ self::assertTrue($this->root->hasChild('config/local.config.php'));
$this->delConfigFile('local.config.php');
- $this->assertFalse($this->root->hasChild('config/local.config.php'));
+ self::assertFalse($this->root->hasChild('config/local.config.php'));
+
+ $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
+
+ self::assertTrue($mode->isInstall());
+ self::assertFalse($mode->isNormal());
+
+ self::assertFalse($mode->has(Mode::LOCALCONFIGPRESENT));
+ }
+
+ public function testWithoutDatabase()
+ {
+ $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
+
+ $this->databaseMock->shouldReceive('connected')->andReturn(false)->once();
+
+ $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
+
+ self::assertFalse($mode->isNormal());
+ self::assertTrue($mode->isInstall());
- $mode->determine();
+ self::assertTrue($mode->has(Mode::LOCALCONFIGPRESENT));
+ self::assertFalse($mode->has(Mode::DBAVAILABLE));
+ }
+
+ public function testWithMaintenanceMode()
+ {
+ $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
+
+ $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+ $this->configCacheMock->shouldReceive('get')->with('system', 'maintenance')
+ ->andReturn(true)->once();
+
+ $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
+
+ self::assertFalse($mode->isNormal());
+ self::assertFalse($mode->isInstall());
+
+ self::assertFalse($mode->has(Mode::MAINTENANCEDISABLED));
+ }
+
+ public function testNormalMode()
+ {
+ $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
+
+ $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+ $this->configCacheMock->shouldReceive('get')->with('system', 'maintenance')
+ ->andReturn(false)->once();
- $this->assertTrue($mode->isInstall());
- $this->assertFalse($mode->isNormal());
+ $mode = (new Mode())->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
- $this->assertFalse($mode->has(Mode::LOCALCONFIGPRESENT));
+ self::assertTrue($mode->isNormal());
+ self::assertFalse($mode->isInstall());
+
+ self::assertTrue($mode->has(Mode::MAINTENANCEDISABLED));
}
/**
- * @runInSeparateProcess
- * @preserveGlobalState disabled
+ * Test explicit disabled maintenance (in case you manually disable it)
*/
- public function testWithoutDatabase()
+ public function testDisabledMaintenance()
{
- $this->mockConnected(false, 1);
+ $this->basePathMock->shouldReceive('getPath')->andReturn($this->root->url())->once();
- $mode = new Mode($this->root->url());
- $mode->determine();
+ $this->databaseMock->shouldReceive('connected')->andReturn(true)->once();
+ $this->configCacheMock->shouldReceive('get')->with('system', 'maintenance')
+ ->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::assertTrue($mode->isNormal());
+ self::assertFalse($mode->isInstall());
+
+ self::assertTrue($mode->has(Mode::MAINTENANCEDISABLED));
}
/**
- * @runInSeparateProcess
- * @preserveGlobalState disabled
+ * Test that modes are immutable
*/
- public function testWithoutDatabaseSetup()
+ public function testImmutable()
{
- $this->mockConnected(true, 1);
- $this->mockFetchFirst('SHOW TABLES LIKE \'config\'', false, 1);
+ $this->basePathMock->shouldReceive('getPath')->andReturn(null)->once();
- $mode = new Mode($this->root->url());
- $mode->determine();
+ $mode = new Mode();
- $this->assertFalse($mode->isNormal());
- $this->assertTrue($mode->isInstall());
+ $modeNew = $mode->determine($this->basePathMock, $this->databaseMock, $this->configCacheMock);
- $this->assertTrue($mode->has(Mode::LOCALCONFIGPRESENT));
+ self::assertNotSame($modeNew, $mode);
}
/**
- * @runInSeparateProcess
- * @preserveGlobalState disabled
+ * Test if not called by index is backend
*/
- public function testWithMaintenanceMode()
+ public function testIsBackendNotIsBackend()
{
- $this->mockConnected(true, 1);
- $this->mockFetchFirst('SHOW TABLES LIKE \'config\'', true, 1);
-
- $config = \Mockery::mock('Friendica\Core\Config\Configuration');
- $config
- ->shouldReceive('get')
- ->with('system', 'maintenance', null, false)
- ->andReturn(true)
- ->once();
- // Initialize empty Config
- Config::init($config);
-
- $mode = new Mode($this->root->url());
- $mode->determine();
-
- $this->assertFalse($mode->isNormal());
- $this->assertFalse($mode->isInstall());
-
- $this->assertTrue($mode->has(Mode::DBCONFIGAVAILABLE));
- $this->assertFalse($mode->has(Mode::MAINTENANCEDISABLED));
+ $server = [];
+ $args = new Arguments();
+ $mobileDetect = new MobileDetect();
+
+ $mode = (new Mode())->determineRunMode(true, $server, $args, $mobileDetect);
+
+ self::assertTrue($mode->isBackend());
}
/**
- * @runInSeparateProcess
- * @preserveGlobalState disabled
+ * Test is called by index but module is backend
*/
- public function testNormalMode()
+ public function testIsBackendButIndex()
{
- $this->mockConnected(true, 1);
- $this->mockFetchFirst('SHOW TABLES LIKE \'config\'', true, 1);
-
- $config = \Mockery::mock('Friendica\Core\Config\Configuration');
- $config
- ->shouldReceive('get')
- ->with('system', 'maintenance', null, false)
- ->andReturn(false)
- ->once();
- // Initialize empty Config
- Config::init($config);
-
- $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));
+ $server = [];
+ $args = new Arguments('', '', Mode::BACKEND_MODULES[0]);
+ $mobileDetect = new MobileDetect();
+
+ $mode = (new Mode())->determineRunMode(false, $server, $args, $mobileDetect);
+
+ self::assertTrue($mode->isBackend());
+ }
+
+ /**
+ * Test is called by index and module is not backend
+ */
+ public function testIsNotBackend()
+ {
+ $server = [];
+ $args = new Arguments('', '', Arguments::DEFAULT_MODULE);
+ $mobileDetect = new MobileDetect();
+
+ $mode = (new Mode())->determineRunMode(false, $server, $args, $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',
+ ];
+
+ $args = new Arguments('', '', Arguments::DEFAULT_MODULE);
+ $mobileDetect = new MobileDetect();
+
+ $mode = (new Mode())->determineRunMode(true, $server, $args, $mobileDetect);
+
+ self::assertTrue($mode->isAjax());
+ }
+
+ /**
+ * Test if the call is not nan ajax call
+ */
+ public function testIsNotAjax()
+ {
+ $server = [];
+ $args = new Arguments('', '', Arguments::DEFAULT_MODULE);
+ $mobileDetect = new MobileDetect();
+
+ $mode = (new Mode())->determineRunMode(true, $server, $args, $mobileDetect);
+
+ self::assertFalse($mode->isAjax());
+ }
+
+ /**
+ * Test if the call is a mobile and is a tablet call
+ */
+ public function testIsMobileIsTablet()
+ {
+ $server = [];
+ $args = new Arguments('', '', Arguments::DEFAULT_MODULE);
+ $mobileDetect = Mockery::mock(MobileDetect::class);
+ $mobileDetect->shouldReceive('isMobile')->andReturn(true);
+ $mobileDetect->shouldReceive('isTablet')->andReturn(true);
+
+ $mode = (new Mode())->determineRunMode(true, $server, $args, $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 = [];
+ $args = new Arguments('', '', Arguments::DEFAULT_MODULE);
+ $mobileDetect = Mockery::mock(MobileDetect::class);
+ $mobileDetect->shouldReceive('isMobile')->andReturn(false);
+ $mobileDetect->shouldReceive('isTablet')->andReturn(false);
+
+ $mode = (new Mode())->determineRunMode(true, $server, $args, $mobileDetect);
+
+ self::assertFalse($mode->isMobile());
+ self::assertFalse($mode->isTablet());
}
}