nextcloud/tests/Core/Command/User/SettingTest.php

467 lines
13 KiB
PHP
Raw Normal View History

2016-06-13 17:04:38 +03:00
<?php
/**
2016-07-13 19:46:27 +03:00
* @author Joas Schilling <coding@schilljs.com>
2016-06-13 17:04:38 +03:00
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace Tests\Core\Command\User;
use OC\Core\Command\User\Setting;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IUserManager;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
2016-06-13 17:04:38 +03:00
use Test\TestCase;
class SettingTest extends TestCase {
/** @var \OCP\IUserManager|\PHPUnit\Framework\MockObject\MockObject */
2016-06-13 17:04:38 +03:00
protected $userManager;
/** @var \OCP\IConfig|\PHPUnit\Framework\MockObject\MockObject */
2016-06-13 17:04:38 +03:00
protected $config;
/** @var \OCP\IDBConnection|\PHPUnit\Framework\MockObject\MockObject */
2016-06-13 17:04:38 +03:00
protected $connection;
/** @var \Symfony\Component\Console\Input\InputInterface|\PHPUnit\Framework\MockObject\MockObject */
2016-06-13 17:04:38 +03:00
protected $consoleInput;
/** @var \Symfony\Component\Console\Output\OutputInterface|\PHPUnit\Framework\MockObject\MockObject */
2016-06-13 17:04:38 +03:00
protected $consoleOutput;
protected function setUp(): void {
2016-06-13 17:04:38 +03:00
parent::setUp();
$this->userManager = $this->getMockBuilder(IUserManager::class)
2016-06-13 17:04:38 +03:00
->disableOriginalConstructor()
->getMock();
$this->config = $this->getMockBuilder(IConfig::class)
2016-06-13 17:04:38 +03:00
->disableOriginalConstructor()
->getMock();
$this->connection = $this->getMockBuilder(IDBConnection::class)
2016-06-13 17:04:38 +03:00
->disableOriginalConstructor()
->getMock();
$this->consoleInput = $this->getMockBuilder(InputInterface::class)
2016-06-13 17:04:38 +03:00
->disableOriginalConstructor()
->getMock();
$this->consoleOutput = $this->getMockBuilder(OutputInterface::class)
2016-06-13 17:04:38 +03:00
->disableOriginalConstructor()
->getMock();
2016-06-13 17:16:16 +03:00
}
public function getCommand(array $methods = []) {
if (empty($methods)) {
return new Setting($this->userManager, $this->config, $this->connection);
} else {
$mock = $this->getMockBuilder('OC\Core\Command\User\Setting')
->setConstructorArgs([
$this->userManager,
$this->config,
$this->connection,
])
->setMethods($methods)
->getMock();
return $mock;
}
2016-06-13 17:04:38 +03:00
}
public function dataCheckInput() {
return [
[
[['uid', 'username']],
[['ignore-missing-user', true]],
[],
false,
false,
],
[
[['uid', 'username']],
[['ignore-missing-user', false]],
[],
null,
'The user "username" does not exist.',
2016-06-13 17:04:38 +03:00
],
[
[['uid', 'username'], ['key', 'configkey']],
[['ignore-missing-user', true]],
[['--default-value', false, true]],
2016-06-13 17:04:38 +03:00
false,
false,
],
[
[['uid', 'username'], ['key', '']],
[['ignore-missing-user', true]],
[['--default-value', false, true]],
2016-06-13 17:04:38 +03:00
false,
'The "default-value" option can only be used when specifying a key.',
],
[
2016-07-14 16:09:47 +03:00
[['uid', 'username'], ['key', 'configkey'], ['value', '']],
2016-06-13 17:04:38 +03:00
[['ignore-missing-user', true]],
2016-07-14 16:09:47 +03:00
[],
2016-06-13 17:04:38 +03:00
false,
false,
],
[
2016-07-14 16:09:47 +03:00
[['uid', 'username'], ['key', ''], ['value', '']],
2016-06-13 17:04:38 +03:00
[['ignore-missing-user', true]],
2016-07-14 16:09:47 +03:00
[],
2016-06-13 17:04:38 +03:00
false,
2016-07-14 16:09:47 +03:00
'The value argument can only be used when specifying a key.',
2016-06-13 17:04:38 +03:00
],
[
2016-07-14 16:09:47 +03:00
[['uid', 'username'], ['key', 'configkey'], ['value', '']],
2016-06-13 17:04:38 +03:00
[['ignore-missing-user', true]],
[['--default-value', false, true]],
2016-06-13 17:04:38 +03:00
false,
2016-07-14 16:09:47 +03:00
'The value argument can not be used together with "default-value".',
2016-06-13 17:04:38 +03:00
],
[
2016-07-14 16:09:47 +03:00
[['uid', 'username'], ['key', 'configkey'], ['value', '']],
2016-06-13 17:04:38 +03:00
[['ignore-missing-user', true], ['update-only', true]],
2016-07-14 16:09:47 +03:00
[],
2016-06-13 17:04:38 +03:00
false,
false,
],
[
2016-07-14 16:09:47 +03:00
[['uid', 'username'], ['key', 'configkey'], ['value', null]],
2016-06-13 17:04:38 +03:00
[['ignore-missing-user', true], ['update-only', true]],
2016-07-14 16:09:47 +03:00
[],
2016-06-13 17:04:38 +03:00
false,
'The "update-only" option can only be used together with "value".',
],
[
[['uid', 'username'], ['key', 'configkey']],
[['ignore-missing-user', true], ['delete', true]],
[],
false,
false,
],
[
[['uid', 'username'], ['key', '']],
[['ignore-missing-user', true], ['delete', true]],
[],
false,
'The "delete" option can only be used when specifying a key.',
],
[
[['uid', 'username'], ['key', 'configkey']],
[['ignore-missing-user', true], ['delete', true]],
[['--default-value', false, true]],
2016-06-13 17:04:38 +03:00
false,
'The "delete" option can not be used together with "default-value".',
],
[
2016-07-14 16:09:47 +03:00
[['uid', 'username'], ['key', 'configkey'], ['value', '']],
2016-06-13 17:04:38 +03:00
[['ignore-missing-user', true], ['delete', true]],
2016-07-14 16:09:47 +03:00
[],
2016-06-13 17:04:38 +03:00
false,
'The "delete" option can not be used together with "value".',
],
[
[['uid', 'username'], ['key', 'configkey']],
[['ignore-missing-user', true], ['delete', true], ['error-if-not-exists', true]],
[],
false,
false,
],
[
[['uid', 'username'], ['key', 'configkey']],
[['ignore-missing-user', true], ['delete', false], ['error-if-not-exists', true]],
[],
false,
'The "error-if-not-exists" option can only be used together with "delete".',
],
];
}
/**
* @dataProvider dataCheckInput
*
2016-06-14 12:31:32 +03:00
* @param array $arguments
* @param array $options
* @param array $parameterOptions
* @param mixed $user
* @param string $expectedException
2016-06-13 17:04:38 +03:00
*/
public function testCheckInput($arguments, $options, $parameterOptions, $user, $expectedException) {
$this->consoleInput->expects($this->any())
->method('getArgument')
->willReturnMap($arguments);
$this->consoleInput->expects($this->any())
->method('getOption')
->willReturnMap($options);
$this->consoleInput->expects($this->any())
->method('hasParameterOption')
->willReturnMap($parameterOptions);
if ($user !== false) {
$this->userManager->expects($this->once())
->method('userExists')
->willReturn($user);
}
2016-06-13 17:16:16 +03:00
$command = $this->getCommand();
2016-06-13 17:04:38 +03:00
try {
2016-06-13 17:16:16 +03:00
$this->invokePrivate($command, 'checkInput', [$this->consoleInput]);
2016-06-13 17:04:38 +03:00
$this->assertFalse($expectedException);
} catch (\InvalidArgumentException $e) {
$this->assertEquals($expectedException, $e->getMessage());
}
}
2016-06-13 17:16:16 +03:00
public function testCheckInputExceptionCatch() {
$command = $this->getCommand(['checkInput']);
$command->expects($this->once())
->method('checkInput')
->willThrowException(new \InvalidArgumentException('test'));
$this->consoleOutput->expects($this->once())
->method('writeln')
->with('<error>test</error>');
$this->assertEquals(1, $this->invokePrivate($command, 'execute', [$this->consoleInput, $this->consoleOutput]));
}
2016-06-14 12:31:32 +03:00
public function dataExecuteDelete() {
return [
['config', false, null, 0],
['config', true, null, 0],
[null, false, null, 0],
[null, true, '<error>The setting does not exist for user "username".</error>', 1],
];
}
/**
* @dataProvider dataExecuteDelete
*
* @param string|null $value
* @param bool $errorIfNotExists
* @param string $expectedLine
* @param int $expectedReturn
*/
public function testExecuteDelete($value, $errorIfNotExists, $expectedLine, $expectedReturn) {
$command = $this->getCommand([
'writeArrayInOutputFormat',
'checkInput',
'getUserSettings',
]);
$this->consoleInput->expects($this->any())
->method('getArgument')
->willReturnMap([
['uid', 'username'],
['app', 'appname'],
['key', 'configkey'],
]);
$command->expects($this->once())
->method('checkInput');
$this->config->expects($this->once())
->method('getUserValue')
->with('username', 'appname', 'configkey', null)
->willReturn($value);
$this->consoleInput->expects($this->atLeastOnce())
->method('hasParameterOption')
->willReturnMap([
['--delete', false, true],
['--error-if-not-exists', false, $errorIfNotExists],
2016-06-14 12:31:32 +03:00
]);
if ($expectedLine === null) {
$this->consoleOutput->expects($this->never())
->method('writeln');
$this->config->expects($this->once())
->method('deleteUserValue')
->with('username', 'appname', 'configkey');
} else {
$this->consoleOutput->expects($this->once())
->method('writeln')
->with($expectedLine);
$this->config->expects($this->never())
->method('deleteUserValue');
}
$this->assertEquals($expectedReturn, $this->invokePrivate($command, 'execute', [$this->consoleInput, $this->consoleOutput]));
}
public function dataExecuteSet() {
return [
['config', false, null, 0],
['config', true, null, 0],
[null, false, null, 0],
[null, true, '<error>The setting does not exist for user "username".</error>', 1],
];
}
/**
* @dataProvider dataExecuteSet
*
* @param string|null $value
* @param bool $updateOnly
* @param string $expectedLine
* @param int $expectedReturn
*/
public function testExecuteSet($value, $updateOnly, $expectedLine, $expectedReturn) {
$command = $this->getCommand([
'writeArrayInOutputFormat',
'checkInput',
'getUserSettings',
]);
2016-07-14 16:09:47 +03:00
$this->consoleInput->expects($this->atLeast(4))
2016-06-14 12:31:32 +03:00
->method('getArgument')
->willReturnMap([
['uid', 'username'],
['app', 'appname'],
['key', 'configkey'],
2016-07-14 16:09:47 +03:00
['value', 'setValue'],
2016-06-14 12:31:32 +03:00
]);
$command->expects($this->once())
->method('checkInput');
$this->config->expects($this->once())
->method('getUserValue')
->with('username', 'appname', 'configkey', null)
->willReturn($value);
$this->consoleInput->expects($this->atLeastOnce())
->method('hasParameterOption')
->willReturnMap([
['--update-only', false, $updateOnly],
2016-06-14 12:31:32 +03:00
]);
if ($expectedLine === null) {
$this->consoleOutput->expects($this->never())
->method('writeln');
2016-07-14 16:09:47 +03:00
$this->consoleInput->expects($this->never())
->method('getOption');
2016-06-14 12:31:32 +03:00
$this->config->expects($this->once())
->method('setUserValue')
->with('username', 'appname', 'configkey', 'setValue');
} else {
$this->consoleOutput->expects($this->once())
->method('writeln')
->with($expectedLine);
$this->config->expects($this->never())
->method('setUserValue');
}
$this->assertEquals($expectedReturn, $this->invokePrivate($command, 'execute', [$this->consoleInput, $this->consoleOutput]));
}
public function dataExecuteGet() {
return [
['config', null, 'config', 0],
[null, 'config', 'config', 0],
[null, null, '<error>The setting does not exist for user "username".</error>', 1],
];
}
/**
* @dataProvider dataExecuteGet
*
* @param string|null $value
* @param string|null $defaultValue
* @param string $expectedLine
* @param int $expectedReturn
*/
public function testExecuteGet($value, $defaultValue, $expectedLine, $expectedReturn) {
$command = $this->getCommand([
'writeArrayInOutputFormat',
'checkInput',
'getUserSettings',
]);
$this->consoleInput->expects($this->any())
->method('getArgument')
->willReturnMap([
['uid', 'username'],
['app', 'appname'],
['key', 'configkey'],
]);
$command->expects($this->once())
->method('checkInput');
$this->config->expects($this->once())
->method('getUserValue')
->with('username', 'appname', 'configkey', null)
->willReturn($value);
if ($value === null) {
if ($defaultValue === null) {
$this->consoleInput->expects($this->atLeastOnce())
->method('hasParameterOption')
->willReturnMap([
['--default-value', false],
]);
} else {
$this->consoleInput->expects($this->atLeastOnce())
->method('hasParameterOption')
->willReturnMap([
['--default-value', false, true],
2016-06-14 12:31:32 +03:00
]);
$this->consoleInput->expects($this->once())
->method('getOption')
->with('default-value')
->willReturn($defaultValue);
}
}
$this->consoleOutput->expects($this->once())
->method('writeln')
->with($expectedLine);
$this->assertEquals($expectedReturn, $this->invokePrivate($command, 'execute', [$this->consoleInput, $this->consoleOutput]));
}
public function testExecuteList() {
$command = $this->getCommand([
'writeArrayInOutputFormat',
'checkInput',
'getUserSettings',
]);
$this->consoleInput->expects($this->any())
->method('getArgument')
->willReturnMap([
['uid', 'username'],
['app', 'appname'],
['key', ''],
]);
$command->expects($this->once())
->method('checkInput');
$command->expects($this->once())
->method('getUserSettings')
->willReturn(['settings']);
$command->expects($this->once())
->method('writeArrayInOutputFormat')
->with($this->consoleInput, $this->consoleOutput, ['settings']);
$this->assertEquals(0, $this->invokePrivate($command, 'execute', [$this->consoleInput, $this->consoleOutput]));
}
2016-06-13 17:04:38 +03:00
}