Merge pull request #18369 from owncloud/occ-log

occ commands to manage logging

2 files changed, 302 insertions, 0 deletions

diff --git a/tests/core/command/log/managetest.php b/tests/core/command/log/managetest.php
new file mode 100644
index 00000000000..6fb83347f23
--- /dev/null
+++ b/tests/core/command/log/managetest.php
@@ -0,0 +1,181 @@
+<?php
+/**
+ * @author Robin McCorkell <rmccorkell@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, 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\Log;
+
+
+use OC\Core\Command\Log\Manage;
+use Test\TestCase;
+
+class ManageTest extends TestCase {
+	/** @var \PHPUnit_Framework_MockObject_MockObject */
+	protected $config;
+	/** @var \PHPUnit_Framework_MockObject_MockObject */
+	protected $consoleInput;
+	/** @var \PHPUnit_Framework_MockObject_MockObject */
+	protected $consoleOutput;
+
+	/** @var \Symfony\Component\Console\Command\Command */
+	protected $command;
+
+	protected function setUp() {
+		parent::setUp();
+
+		$config = $this->config = $this->getMockBuilder('OCP\IConfig')
+			->disableOriginalConstructor()
+			->getMock();
+		$this->consoleInput = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+		$this->consoleOutput = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+
+		$this->command = new Manage($config);
+	}
+
+	public function testChangeBackend() {
+		$this->consoleInput->method('getOption')
+			->will($this->returnValueMap([
+				['backend', 'syslog']
+			]));
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('log_type', 'syslog');
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+	public function testChangeLevel() {
+		$this->consoleInput->method('getOption')
+			->will($this->returnValueMap([
+				['level', 'debug']
+			]));
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('loglevel', 0);
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+	public function testChangeTimezone() {
+		$this->consoleInput->method('getOption')
+			->will($this->returnValueMap([
+				['timezone', 'UTC']
+			]));
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('logtimezone', 'UTC');
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+	/**
+	 * @expectedException \InvalidArgumentException
+	 */
+	public function testValidateBackend() {
+		self::invokePrivate($this->command, 'validateBackend', ['notabackend']);
+	}
+
+	/**
+	 * @expectedException \Exception
+	 */
+	public function testValidateTimezone() {
+		// this might need to be changed when humanity colonises Mars
+		self::invokePrivate($this->command, 'validateTimezone', ['Mars/OlympusMons']);
+	}
+
+	public function convertLevelStringProvider() {
+		return [
+			['dEbug', 0],
+			['inFO', 1],
+			['Warning', 2],
+			['wArn', 2],
+			['error', 3],
+			['eRr', 3],
+		];
+	}
+
+	/**
+	 * @dataProvider convertLevelStringProvider
+	 */
+	public function testConvertLevelString($levelString, $expectedInt) {
+		$this->assertEquals($expectedInt,
+			self::invokePrivate($this->command, 'convertLevelString', [$levelString])
+		);
+	}
+
+	/**
+	 * @expectedException \InvalidArgumentException
+	 */
+	public function testConvertLevelStringInvalid() {
+		self::invokePrivate($this->command, 'convertLevelString', ['abc']);
+	}
+
+	public function convertLevelNumberProvider() {
+		return [
+			[0, 'Debug'],
+			[1, 'Info'],
+			[2, 'Warning'],
+			[3, 'Error'],
+		];
+	}
+
+	/**
+	 * @dataProvider convertLevelNumberProvider
+	 */
+	public function testConvertLevelNumber($levelNum, $expectedString) {
+		$this->assertEquals($expectedString,
+			self::invokePrivate($this->command, 'convertLevelNumber', [$levelNum])
+		);
+	}
+
+	/**
+	 * @expectedException \InvalidArgumentException
+	 */
+	public function testConvertLevelNumberInvalid() {
+		self::invokePrivate($this->command, 'convertLevelNumber', [11]);
+	}
+
+	public function testGetConfiguration() {
+		$this->config->expects($this->at(0))
+			->method('getSystemValue')
+			->with('log_type', 'owncloud')
+			->willReturn('log_type_value');
+		$this->config->expects($this->at(1))
+			->method('getSystemValue')
+			->with('loglevel', 2)
+			->willReturn(0);
+		$this->config->expects($this->at(2))
+			->method('getSystemValue')
+			->with('logtimezone', 'UTC')
+			->willReturn('logtimezone_value');
+
+		$this->consoleOutput->expects($this->at(0))
+			->method('writeln')
+			->with('Enabled logging backend: log_type_value');
+		$this->consoleOutput->expects($this->at(1))
+			->method('writeln')
+			->with('Log level: Debug (0)');
+		$this->consoleOutput->expects($this->at(2))
+			->method('writeln')
+			->with('Log timezone: logtimezone_value');
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+}
diff --git a/tests/core/command/log/owncloudtest.php b/tests/core/command/log/owncloudtest.php
new file mode 100644
index 00000000000..3cb05221c37
--- /dev/null
+++ b/tests/core/command/log/owncloudtest.php
@@ -0,0 +1,121 @@
+<?php
+/**
+ * @author Robin McCorkell <rmccorkell@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, 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\Log;
+
+
+use OC\Core\Command\Log\OwnCloud;
+use Test\TestCase;
+
+class OwnCloudTest extends TestCase {
+	/** @var \PHPUnit_Framework_MockObject_MockObject */
+	protected $config;
+	/** @var \PHPUnit_Framework_MockObject_MockObject */
+	protected $consoleInput;
+	/** @var \PHPUnit_Framework_MockObject_MockObject */
+	protected $consoleOutput;
+
+	/** @var \Symfony\Component\Console\Command\Command */
+	protected $command;
+
+	protected function setUp() {
+		parent::setUp();
+
+		$config = $this->config = $this->getMockBuilder('OCP\IConfig')
+			->disableOriginalConstructor()
+			->getMock();
+		$this->consoleInput = $this->getMock('Symfony\Component\Console\Input\InputInterface');
+		$this->consoleOutput = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
+
+		$this->command = new OwnCloud($config);
+	}
+
+	public function testEnable() {
+		$this->consoleInput->method('getOption')
+			->will($this->returnValueMap([
+				['enable', 'true']
+			]));
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('log_type', 'owncloud');
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+	public function testChangeFile() {
+		$this->consoleInput->method('getOption')
+			->will($this->returnValueMap([
+				['file', '/foo/bar/file.log']
+			]));
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('logfile', '/foo/bar/file.log');
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+	public function changeRotateSizeProvider() {
+		return [
+			['42', 42],
+			['0', 0],
+			['1 kB', 1024],
+			['5MB', 5 * 1024 * 1024],
+		];
+	}
+
+	/**
+	 * @dataProvider changeRotateSizeProvider
+	 */
+	public function testChangeRotateSize($optionValue, $configValue) {
+		$this->consoleInput->method('getOption')
+			->will($this->returnValueMap([
+				['rotate-size', $optionValue]
+			]));
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('log_rotate_size', $configValue);
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+	public function testGetConfiguration() {
+		$this->config->method('getSystemValue')
+			->will($this->returnValueMap([
+				['log_type', 'owncloud', 'log_type_value'],
+				['datadirectory', \OC::$SERVERROOT.'/data', '/data/directory/'],
+				['logfile', '/data/directory/owncloud.log', '/var/log/owncloud.log'],
+				['log_rotate_size', 0, 5 * 1024 * 1024],
+			]));
+
+		$this->consoleOutput->expects($this->at(0))
+			->method('writeln')
+			->with('Log backend ownCloud: disabled');
+		$this->consoleOutput->expects($this->at(1))
+			->method('writeln')
+			->with('Log file: /var/log/owncloud.log');
+		$this->consoleOutput->expects($this->at(2))
+			->method('writeln')
+			->with('Rotate at: 5 MB');
+
+		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
+	}
+
+}