SettingsControllerTest - Code Metrics - nextcloud/calendar - Measure and Improve Code Quality continuously with Scrutinizer

SettingsControllerTest A
last analyzed 2019-10-16 02:37 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	296
Duplicated Lines	65.54 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	23
lcom	1
cbo	4
dl	194
loc	296
rs	10
c	0
b	0
f	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	27	1
A	testSetViewWithAllowedView()	0	11	1
A	setViewWithAllowedViewDataProvider()	0	7	1
A	testSetViewWithForbiddenView()	7	7	1
A	testSetViewWithConfigException()	12	12	1
A	testGetView()	12	12	1
A	testGetViewWithConfigException()	12	12	1
A	testSetPopoverWithAllowedValue()	0	11	1
A	setPopoverWithAllowedValueDataProvider()	0	6	1
A	testSetPopoverWithForbiddenValue()	7	7	1
A	testSetPopoverWithConfigException()	12	12	1
A	testGetPopover()	12	12	1
A	testGetPopoverWithConfigException()	12	12	1
A	testSetFirstRun()	11	11	1
A	testSetFirstRunWithException()	12	12	1
A	testGetFirstRun()	12	12	1
A	testGetFirstRunWithException()	12	12	1
A	testSetTimezone()	11	11	1
A	testSetTimezoneWithException()	12	12	1
A	testGetTimezone()	12	12	1
A	testGetTimezoneWithException()	12	12	1
A	testGetNotExistingConfig()	7	7	1
A	testSetNotExistingConfig()	7	7	1

How to fix Duplicated Code

<?php
/**
 * Calendar App
 *
 * @author Georg Ehrke
 * @copyright 2016 Georg Ehrke <[email protected]>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library 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 library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\Calendar\Controller;

use PHPUnit\Framework\TestCase;

class SettingsControllerTest extends TestCase {

	private $appName;
	private $request;
	private $userSession;
	private $config;

	private $dummyUser;

	private $controller;

	public function setUp() {
		$this->appName = 'calendar';
		$this->request = $this->getMockBuilder('\OCP\IRequest')
			->disableOriginalConstructor()
			->getMock();
		$this->userSession = $this->getMockBuilder('OCP\IUserSession')
			->disableOriginalConstructor()
			->getMock();
		$this->config = $this->getMockBuilder('OCP\IConfig')
			->disableOriginalConstructor()
			->getMock();

		$this->dummyUser = $this->getMockBuilder('OCP\IUser')
			->disableOriginalConstructor()
			->getMock();

		$this->userSession->expects($this->once())
			->method('getUser')
			->will($this->returnValue($this->dummyUser));

		$this->dummyUser->expects($this->once())
			->method('getUID')
			->will($this->returnValue('user123'));

		$this->controller = new SettingsController($this->appName,
			$this->request, $this->userSession, $this->config);
	}

	/**
	 * @dataProvider setViewWithAllowedViewDataProvider
	 */
	public function testSetViewWithAllowedView($view) {
		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'currentView', $view);

		$actual = $this->controller->setConfig('view', $view);

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function setViewWithAllowedViewDataProvider() {
		return [
			['agendaDay'],
			['agendaWeek'],
			['month'],
		];
	}

	public function testSetViewWithForbiddenView() {

		$actual = $this->controller->setConfig('view','someForbiddenView');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(422, $actual->getStatus());
	}

	public function testSetViewWithConfigException() {

		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'currentView', 'month')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->setConfig('view', 'month');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testGetView() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'currentView', 'month')
			->will($this->returnValue('agendaWeek'));

		$actual = $this->controller->getConfig('view');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals(['value' => 'agendaWeek'], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function testGetViewWithConfigException() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'currentView', 'month')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->getConfig('view');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	/**
	 * @dataProvider setPopoverWithAllowedValueDataProvider
	 */
	public function testSetPopoverWithAllowedValue($value) {
		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'skipPopover', $value);

		$actual = $this->controller->setConfig('skipPopover', $value);

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function setPopoverWithAllowedValueDataProvider() {
		return [
			['yes'],
			['no']
		];
	}

	public function testSetPopoverWithForbiddenValue() {

		$actual = $this->controller->setConfig('skipPopover','someForbiddenValue');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(422, $actual->getStatus());
	}

	public function testSetPopoverWithConfigException() {

		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'skipPopover', 'no')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->setConfig('skipPopover', 'no');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testGetPopover() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'skipPopover', 'no')
			->will($this->returnValue('agendaWeek'));

		$actual = $this->controller->getConfig('skipPopover');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals(['value' => 'agendaWeek'], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function testGetPopoverWithConfigException() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'skipPopover', 'no')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->getConfig('skipPopover');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testSetFirstRun() {

		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'firstRun', 'no');

		$actual = $this->controller->setConfig('firstRun', 'some_random_ignored_value');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function testSetFirstRunWithException() {

		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'firstRun', 'no')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->setConfig('firstRun', 'some_random_ignored_value');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testGetFirstRun() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'firstRun', 'yes')
			->will($this->returnValue('no'));

		$actual = $this->controller->getConfig('firstRun');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals(['value' => 'no'], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function testGetFirstRunWithException() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'firstRun', 'yes')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->getConfig('firstRun');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testSetTimezone() {

		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'timezone', 'Europe/Berlin');

		$actual = $this->controller->setConfig('timezone', 'Europe/Berlin');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function testSetTimezoneWithException() {

		$this->config->expects($this->once())
			->method('setUserValue')
			->with('user123', $this->appName, 'timezone', 'Europe/Berlin')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->setConfig('timezone', 'Europe/Berlin');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testGetTimezone() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'timezone', 'automatic')
			->will($this->returnValue('Europe/Berlin'));

		$actual = $this->controller->getConfig('timezone');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals(['value' => 'Europe/Berlin'], $actual->getData());
		$this->assertEquals(200, $actual->getStatus());
	}

	public function testGetTimezoneWithException() {

		$this->config->expects($this->once())
			->method('getUserValue')
			->with('user123', $this->appName, 'timezone', 'automatic')
			->will($this->throwException(new \Exception));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$actual = $this->controller->getConfig('timezone');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(500, $actual->getStatus());
	}

	public function testGetNotExistingConfig() {

		$actual = $this->controller->getConfig('foo');
		
		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(400, $actual->getStatus());
	}

	public function testSetNotExistingConfig() {

		$actual = $this->controller->setConfig('foo', 'bar');

		$this->assertInstanceOf('OCP\AppFramework\Http\JSONResponse', $actual);
		$this->assertEquals([], $actual->getData());
		$this->assertEquals(400, $actual->getStatus());
	}
}


1			<?php
2			/**
3			* Calendar App
4			*
5			* @author Georg Ehrke
6			* @copyright 2016 Georg Ehrke <[email protected]>
7			*
8			* This library is free software; you can redistribute it and/or
9			* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10			* License as published by the Free Software Foundation; either
11			* version 3 of the License, or any later version.
12			*
13			* This library is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public
19			* License along with this library. If not, see <http://www.gnu.org/licenses/>.
20			*
21			*/
22			namespace OCA\Calendar\Controller;
23
24			use PHPUnit\Framework\TestCase;
25
26			class SettingsControllerTest extends TestCase {
27
28			private $appName;
29			private $request;
30			private $userSession;
31			private $config;
32
33			private $dummyUser;
34
35			private $controller;
36
37			public function setUp() {
38			$this->appName = 'calendar';
39			$this->request = $this->getMockBuilder('\OCP\IRequest')
40			->disableOriginalConstructor()

nextcloud / calendar

SettingsControllerTest A last analyzed 2019-10-16 02:37 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

23 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

SettingsControllerTest A
last analyzed 2019-10-16 02:37 UTC