nextcloud/apps/provisioning_api/tests/Controller/AppConfigControllerTest.php

388 lines
11 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Joas Schilling <coding@schilljs.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @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 <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Provisioning_API\Tests\Controller;
use OCA\Provisioning_API\Controller\AppConfigController;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IRequest;
use Test\TestCase;
/**
* Class AppConfigControllerTest
*
* @package OCA\Provisioning_API\Tests
*/
class AppConfigControllerTest extends TestCase {
/** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
private $config;
/** @var IAppConfig|\PHPUnit\Framework\MockObject\MockObject */
private $appConfig;
protected function setUp(): void {
parent::setUp();
$this->config = $this->createMock(IConfig::class);
$this->appConfig = $this->createMock(IAppConfig::class);
}
/**
* @param string[] $methods
* @return AppConfigController|\PHPUnit\Framework\MockObject\MockObject
*/
protected function getInstance(array $methods = []) {
$request = $this->createMock(IRequest::class);
if (empty($methods)) {
return new AppConfigController(
'provisioning_api',
$request,
$this->config,
$this->appConfig
);
} else {
return $this->getMockBuilder(AppConfigController::class)
->setConstructorArgs([
'provisioning_api',
$request,
$this->config,
$this->appConfig,
])
->setMethods($methods)
->getMock();
}
}
public function testGetApps() {
$this->appConfig->expects($this->once())
->method('getApps')
->willReturn(['apps']);
$result = $this->getInstance()->getApps();
$this->assertInstanceOf(DataResponse::class, $result);
$this->assertSame(Http::STATUS_OK, $result->getStatus());
$this->assertEquals(['data' => ['apps']], $result->getData());
}
public function dataGetKeys() {
return [
['app1 ', null, new \InvalidArgumentException('error'), Http::STATUS_FORBIDDEN],
['app2', ['keys'], null, Http::STATUS_OK],
];
}
/**
* @dataProvider dataGetKeys
* @param string $app
* @param array|null $keys
* @param \Exception|null $throws
* @param int $status
*/
public function testGetKeys($app, $keys, $throws, $status) {
$api = $this->getInstance(['verifyAppId']);
if ($throws instanceof \Exception) {
$api->expects($this->once())
->method('verifyAppId')
->with($app)
->willThrowException($throws);
$this->config->expects($this->never())
->method('getAppKeys');
} else {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
$this->config->expects($this->once())
->method('getAppKeys')
->with($app)
->willReturn($keys);
}
$result = $api->getKeys($app);
$this->assertInstanceOf(DataResponse::class, $result);
$this->assertSame($status, $result->getStatus());
if ($throws instanceof \Exception) {
$this->assertEquals(['data' => ['message' => $throws->getMessage()]], $result->getData());
} else {
$this->assertEquals(['data' => $keys], $result->getData());
}
}
public function dataGetValue() {
return [
['app1', 'key', 'default', null, new \InvalidArgumentException('error'), Http::STATUS_FORBIDDEN],
['app2', 'key', 'default', 'return', null, Http::STATUS_OK],
];
}
/**
* @dataProvider dataGetValue
* @param string $app
* @param string|null $key
* @param string|null $default
* @param string|null $return
* @param \Exception|null $throws
* @param int $status
*/
public function testGetValue($app, $key, $default, $return, $throws, $status) {
$api = $this->getInstance(['verifyAppId']);
if ($throws instanceof \Exception) {
$api->expects($this->once())
->method('verifyAppId')
->with($app)
->willThrowException($throws);
$this->config->expects($this->never())
->method('getAppValue');
} else {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
$this->config->expects($this->once())
->method('getAppValue')
->with($app, $key, $default)
->willReturn($return);
}
$result = $api->getValue($app, $key, $default);
$this->assertInstanceOf(DataResponse::class, $result);
$this->assertSame($status, $result->getStatus());
if ($throws instanceof \Exception) {
$this->assertEquals(['data' => ['message' => $throws->getMessage()]], $result->getData());
} else {
$this->assertEquals(['data' => $return], $result->getData());
}
}
public function dataSetValue() {
return [
['app1', 'key', 'default', new \InvalidArgumentException('error1'), null, Http::STATUS_FORBIDDEN],
['app2', 'key', 'default', null, new \InvalidArgumentException('error2'), Http::STATUS_FORBIDDEN],
['app2', 'key', 'default', null, null, Http::STATUS_OK],
];
}
/**
* @dataProvider dataSetValue
* @param string $app
* @param string|null $key
* @param string|null $value
* @param \Exception|null $appThrows
* @param \Exception|null $keyThrows
* @param int $status
*/
public function testSetValue($app, $key, $value, $appThrows, $keyThrows, $status) {
$api = $this->getInstance(['verifyAppId', 'verifyConfigKey']);
if ($appThrows instanceof \Exception) {
$api->expects($this->once())
->method('verifyAppId')
->with($app)
->willThrowException($appThrows);
$api->expects($this->never())
->method('verifyConfigKey');
$this->config->expects($this->never())
->method('setAppValue');
} elseif ($keyThrows instanceof \Exception) {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
$api->expects($this->once())
->method('verifyConfigKey')
->with($app, $key)
->willThrowException($keyThrows);
$this->config->expects($this->never())
->method('setAppValue');
} else {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
$api->expects($this->once())
->method('verifyConfigKey')
->with($app, $key);
$this->config->expects($this->once())
->method('setAppValue')
->with($app, $key, $value);
}
$result = $api->setValue($app, $key, $value);
$this->assertInstanceOf(DataResponse::class, $result);
$this->assertSame($status, $result->getStatus());
if ($appThrows instanceof \Exception) {
$this->assertEquals(['data' => ['message' => $appThrows->getMessage()]], $result->getData());
} elseif ($keyThrows instanceof \Exception) {
$this->assertEquals(['data' => ['message' => $keyThrows->getMessage()]], $result->getData());
} else {
$this->assertEquals([], $result->getData());
}
}
public function dataDeleteValue() {
return [
['app1', 'key', new \InvalidArgumentException('error1'), null, Http::STATUS_FORBIDDEN],
['app2', 'key', null, new \InvalidArgumentException('error2'), Http::STATUS_FORBIDDEN],
['app2', 'key', null, null, Http::STATUS_OK],
];
}
/**
* @dataProvider dataDeleteValue
* @param string $app
* @param string|null $key
* @param \Exception|null $appThrows
* @param \Exception|null $keyThrows
* @param int $status
*/
public function testDeleteValue($app, $key, $appThrows, $keyThrows, $status) {
$api = $this->getInstance(['verifyAppId', 'verifyConfigKey']);
if ($appThrows instanceof \Exception) {
$api->expects($this->once())
->method('verifyAppId')
->with($app)
->willThrowException($appThrows);
$api->expects($this->never())
->method('verifyConfigKey');
$this->config->expects($this->never())
->method('deleteAppValue');
} elseif ($keyThrows instanceof \Exception) {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
$api->expects($this->once())
->method('verifyConfigKey')
->with($app, $key)
->willThrowException($keyThrows);
$this->config->expects($this->never())
->method('deleteAppValue');
} else {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
$api->expects($this->once())
->method('verifyConfigKey')
->with($app, $key);
$this->config->expects($this->once())
->method('deleteAppValue')
->with($app, $key);
}
$result = $api->deleteKey($app, $key);
$this->assertInstanceOf(DataResponse::class, $result);
$this->assertSame($status, $result->getStatus());
if ($appThrows instanceof \Exception) {
$this->assertEquals(['data' => ['message' => $appThrows->getMessage()]], $result->getData());
} elseif ($keyThrows instanceof \Exception) {
$this->assertEquals(['data' => ['message' => $keyThrows->getMessage()]], $result->getData());
} else {
$this->assertEquals([], $result->getData());
}
}
public function testVerifyAppId() {
$api = $this->getInstance();
$this->invokePrivate($api, 'verifyAppId', ['activity']);
$this->addToAssertionCount(1);
}
public function dataVerifyAppIdThrows() {
return [
['activity..'],
['activity/'],
['activity\\'],
['activity\0'],
];
}
/**
* @dataProvider dataVerifyAppIdThrows
* @param string $app
*/
public function testVerifyAppIdThrows($app) {
$this->expectException(\InvalidArgumentException::class);
$api = $this->getInstance();
$this->invokePrivate($api, 'verifyAppId', [$app]);
}
public function dataVerifyConfigKey() {
return [
['activity', 'abc', ''],
['dav', 'public_route', ''],
['files', 'remote_route', ''],
['core', 'encryption_enabled', 'yes'],
];
}
/**
* @dataProvider dataVerifyConfigKey
* @param string $app
* @param string $key
* @param string $value
*/
public function testVerifyConfigKey($app, $key, $value) {
$api = $this->getInstance();
$this->invokePrivate($api, 'verifyConfigKey', [$app, $key, $value]);
$this->addToAssertionCount(1);
}
public function dataVerifyConfigKeyThrows() {
return [
['activity', 'installed_version', ''],
['calendar', 'enabled', ''],
['contacts', 'types', ''],
['core', 'encryption_enabled', 'no'],
['core', 'encryption_enabled', ''],
['core', 'public_files', ''],
['core', 'public_dav', ''],
['core', 'remote_files', ''],
['core', 'remote_dav', ''],
];
}
/**
* @dataProvider dataVerifyConfigKeyThrows
* @param string $app
* @param string $key
* @param string $value
*/
public function testVerifyConfigKeyThrows($app, $key, $value) {
$this->expectException(\InvalidArgumentException::class);
$api = $this->getInstance();
$this->invokePrivate($api, 'verifyConfigKey', [$app, $key, $value]);
}
}