server/tests/lib/updater.php

<?php
/**
 * @author Lukas Reschke <lukas@owncloud.com>
 * @author Victor Dubiniuk <dubiniuk@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 OC;

use OCP\IConfig;
use OCP\ILogger;

class UpdaterTest extends \Test\TestCase {
	/** @var IConfig */
	private $config;
	/** @var HTTPHelper */
	private $httpHelper;
	/** @var ILogger */
	private $logger;
	/** @var Updater */
	private $updater;

	public function setUp() {
		parent::setUp();
		$this->config = $this->getMockBuilder('\\OCP\\IConfig')
			->disableOriginalConstructor()
			->getMock();
		$this->httpHelper = $this->getMockBuilder('\\OC\\HTTPHelper')
			->disableOriginalConstructor()
			->getMock();
		$this->logger = $this->getMockBuilder('\\OCP\\ILogger')
			->disableOriginalConstructor()
			->getMock();

		$this->updater = new Updater(
			$this->httpHelper,
			$this->config,
			$this->logger
		);
	}

	/**
	 * @param string $baseUrl
	 * @return string
	 */
	private function buildUpdateUrl($baseUrl) {
		return $baseUrl . '?version='.implode('x', \OC_Util::getVersion()).'xinstalledatxlastupdatedatx'.\OC_Util::getChannel().'x'.\OC_Util::getEditionString().'x';
	}

	/**
	 * @return array
	 */
	public function versionCompatibilityTestData() {
		return [
			['1', '2', '1', true],
			['2', '2', '2', true],
			['6.0.5.0', '6.0.6.0', '5.0', true],
			['5.0.6.0', '7.0.4.0', '6.0', false],
			// allow upgrading within the same major release
			['8.0.0.0', '8.0.0.0', '8.0', true],
			['8.0.0.0', '8.0.0.4', '8.0', true],
			['8.0.0.0', '8.0.1.0', '8.0', true],
			['8.0.0.0', '8.0.2.0', '8.0', true],
			// does not allow downgrading within the same major release
			['8.0.1.0', '8.0.0.0', '8.0', false],
			['8.0.2.0', '8.0.1.0', '8.0', false],
			['8.0.0.4', '8.0.0.0', '8.0', false],
			// allows upgrading within the patch version
			['8.0.0.0', '8.0.0.1', '8.0', true],
			['8.0.0.0', '8.0.0.2', '8.0', true],
			// does not allow downgrading within the same major release
			['8.0.0.1', '8.0.0.0', '8.0', false],
			['8.0.0.2', '8.0.0.0', '8.0', false],
			// allow upgrading to the next major release
			['8.0.0.0', '8.1.0.0', '8.0', true],
			['8.0.0.0', '8.1.1.0', '8.0', true],
			['8.0.0.0', '8.1.1.5', '8.0', true],
			['8.0.0.2', '8.1.1.5', '8.0', true],
			['8.1.0.0', '8.2.0.0', '8.1', true],
			['8.1.0.2', '8.2.0.4', '8.1', true],
			['8.1.0.5', '8.2.0.1', '8.1', true],
			['8.1.0.0', '8.2.1.0', '8.1', true],
			['8.1.0.2', '8.2.1.5', '8.1', true],
			['8.1.0.5', '8.2.1.1', '8.1', true],
			// does not allow downgrading to the previous major release
			['8.1.0.0', '8.0.0.0', '7.0', false],
			['8.1.1.0', '8.0.0.0', '7.0', false],
			// does not allow skipping major releases
			['8.0.0.0', '8.2.0.0', '8.1', false],
			['8.0.0.0', '8.2.1.0', '8.1', false],
			['8.0.0.0', '9.0.1.0', '8.2', false],
			['8.0.0.0', '10.0.0.0', '9.3', false],
			// allows updating to the next major release
			['8.2.0.0', '9.0.0.0', '8.2', true],
			['8.2.0.0', '9.0.0.0', '8.2', true],
			['8.2.0.0', '9.0.1.0', '8.2', true],
			['8.2.0.0', '9.0.1.1', '8.2', true],
			['8.2.0.2', '9.0.1.1', '8.2', true],
			['8.2.2.0', '9.0.1.0', '8.2', true],
			['8.2.2.2', '9.0.1.1', '8.2', true],
			['9.0.0.0', '9.1.0.0', '9.0', true],
			['9.0.0.0', '9.1.0.2', '9.0', true],
			['9.0.0.2', '9.1.0.1', '9.0', true],
			['9.1.0.0', '9.2.0.0', '9.1', true],
			['9.2.0.0', '9.3.0.0', '9.2', true],
			['9.3.0.0', '10.0.0.0', '9.3', true],
			// does not allow updating to the next major release (first number)
			['9.0.0.0', '8.2.0.0', '8.1', false],
			// other cases
			['8.0.0.0', '8.1.5.0', '8.0', true],
			['8.2.0.0', '9.0.0.0', '8.2', true],
			['8.2.0.0', '9.1.0.0', '9.0', false],
			['9.0.0.0', '8.1.0.0', '8.0', false],
			['9.0.0.0', '8.0.0.0', '7.0', false],
			['9.1.0.0', '8.0.0.0', '7.0', false],
			['8.2.0.0', '8.1.0.0', '8.0', false],
		];
	}

	public function testSetSimulateStepEnabled() {
		$this->updater->setSimulateStepEnabled(true);
		$this->assertSame(true, $this->invokePrivate($this->updater, 'simulateStepEnabled'));
		$this->updater->setSimulateStepEnabled(false);
		$this->assertSame(false, $this->invokePrivate($this->updater, 'simulateStepEnabled'));
	}

	public function testSetUpdateStepEnabled() {
		$this->updater->setUpdateStepEnabled(true);
		$this->assertSame(true, $this->invokePrivate($this->updater, 'updateStepEnabled'));
		$this->updater->setUpdateStepEnabled(false);
		$this->assertSame(false, $this->invokePrivate($this->updater, 'updateStepEnabled'));
	}

	public function testSetSkip3rdPartyAppsDisable() {
		$this->updater->setSkip3rdPartyAppsDisable(true);
		$this->assertSame(true, $this->invokePrivate($this->updater, 'skip3rdPartyAppsDisable'));
		$this->updater->setSkip3rdPartyAppsDisable(false);
		$this->assertSame(false, $this->invokePrivate($this->updater, 'skip3rdPartyAppsDisable'));
	}

	/**
	 * @dataProvider versionCompatibilityTestData
	 *
	 * @param string $oldVersion
	 * @param string $newVersion
	 * @param bool $result
	 */
	public function testIsUpgradePossible($oldVersion, $newVersion, $allowedVersion, $result) {
		$updater = new Updater($this->httpHelper, $this->config);
		$this->assertSame($result, $updater->isUpgradePossible($oldVersion, $newVersion, $allowedVersion));
	}

	public function testCheckInCache() {
		$expectedResult = [
			'version' => '8.0.4.2',
			'versionstring' => 'ownCloud 8.0.4',
			'url' => 'https://download.owncloud.org/community/owncloud-8.0.4.zip',
			'web' => 'http://doc.owncloud.org/server/8.0/admin_manual/maintenance/upgrade.html',
		];

		$this->config
			->expects($this->at(0))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue(time()));
		$this->config
			->expects($this->at(1))
			->method('getAppValue')
			->with('core', 'lastupdateResult')
			->will($this->returnValue(json_encode($expectedResult)));

		$this->assertSame($expectedResult, $this->updater->check());
	}

	public function testCheckWithoutUpdateUrl() {
		$expectedResult = [
			'version' => '8.0.4.2',
			'versionstring' => 'ownCloud 8.0.4',
			'url' => 'https://download.owncloud.org/community/owncloud-8.0.4.zip',
			'web' => 'http://doc.owncloud.org/server/8.0/admin_manual/maintenance/upgrade.html',
		];

		$this->config
			->expects($this->at(0))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue(0));
		$this->config
			->expects($this->at(1))
			->method('setAppValue')
			->with('core', 'lastupdatedat', $this->isType('integer'));
		$this->config
			->expects($this->at(3))
			->method('getAppValue')
			->with('core', 'installedat')
			->will($this->returnValue('installedat'));
		$this->config
			->expects($this->at(4))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue('lastupdatedat'));
		$this->config
			->expects($this->at(5))
			->method('setAppValue')
			->with('core', 'lastupdateResult', json_encode($expectedResult));

		$updateXml = '<?xml version="1.0"?>
<owncloud>
  <version>8.0.4.2</version>
  <versionstring>ownCloud 8.0.4</versionstring>
  <url>https://download.owncloud.org/community/owncloud-8.0.4.zip</url>
  <web>http://doc.owncloud.org/server/8.0/admin_manual/maintenance/upgrade.html</web>
</owncloud>';
		$this->httpHelper
			->expects($this->once())
			->method('getUrlContent')
			->with($this->buildUpdateUrl('https://updates.owncloud.com/server/'))
			->will($this->returnValue($updateXml));

		$this->assertSame($expectedResult, $this->updater->check());
	}

	public function testCheckWithInvalidXml() {
		$this->config
			->expects($this->at(0))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue(0));
		$this->config
			->expects($this->at(1))
			->method('setAppValue')
			->with('core', 'lastupdatedat', $this->isType('integer'));
		$this->config
			->expects($this->at(3))
			->method('getAppValue')
			->with('core', 'installedat')
			->will($this->returnValue('installedat'));
		$this->config
			->expects($this->at(4))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue('lastupdatedat'));
		$this->config
			->expects($this->at(5))
			->method('setAppValue')
			->with('core', 'lastupdateResult', 'false');

		$updateXml = 'Invalid XML Response!';
		$this->httpHelper
			->expects($this->once())
			->method('getUrlContent')
			->with($this->buildUpdateUrl('https://updates.owncloud.com/server/'))
			->will($this->returnValue($updateXml));

		$this->assertSame([], $this->updater->check());
	}

	public function testCheckWithUpdateUrl() {
		$expectedResult = [
			'version' => '8.0.4.2',
			'versionstring' => 'ownCloud 8.0.4',
			'url' => 'https://download.owncloud.org/community/owncloud-8.0.4.zip',
			'web' => 'http://doc.owncloud.org/server/8.0/admin_manual/maintenance/upgrade.html',
		];

		$this->config
			->expects($this->at(0))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue(0));
		$this->config
			->expects($this->at(1))
			->method('setAppValue')
			->with('core', 'lastupdatedat', $this->isType('integer'));
		$this->config
			->expects($this->at(3))
			->method('getAppValue')
			->with('core', 'installedat')
			->will($this->returnValue('installedat'));
		$this->config
			->expects($this->at(4))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue('lastupdatedat'));
		$this->config
			->expects($this->at(5))
			->method('setAppValue')
			->with('core', 'lastupdateResult', json_encode($expectedResult));

		$updateXml = '<?xml version="1.0"?>
<owncloud>
  <version>8.0.4.2</version>
  <versionstring>ownCloud 8.0.4</versionstring>
  <url>https://download.owncloud.org/community/owncloud-8.0.4.zip</url>
  <web>http://doc.owncloud.org/server/8.0/admin_manual/maintenance/upgrade.html</web>
</owncloud>';
		$this->httpHelper
			->expects($this->once())
			->method('getUrlContent')
			->with($this->buildUpdateUrl('https://myupdater.com/'))
			->will($this->returnValue($updateXml));

		$this->assertSame($expectedResult, $this->updater->check('https://myupdater.com/'));
	}

	public function testCheckWithEmptyValidXmlResponse() {
		$expectedResult = [
			'version' => '',
			'versionstring' => '',
			'url' => '',
			'web' => '',
		];

		$this->config
			->expects($this->at(0))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue(0));
		$this->config
			->expects($this->at(1))
			->method('setAppValue')
			->with('core', 'lastupdatedat', $this->isType('integer'));
		$this->config
			->expects($this->at(3))
			->method('getAppValue')
			->with('core', 'installedat')
			->will($this->returnValue('installedat'));
		$this->config
			->expects($this->at(4))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue('lastupdatedat'));

		$updateXml = '<?xml version="1.0"?>
<owncloud>
  <version></version>
  <versionstring></versionstring>
  <url></url>
  <web></web>
</owncloud>';
		$this->httpHelper
			->expects($this->once())
			->method('getUrlContent')
			->with($this->buildUpdateUrl('https://updates.owncloud.com/server/'))
			->will($this->returnValue($updateXml));

		$this->assertSame($expectedResult, $this->updater->check());
	}

	public function testCheckWithEmptyInvalidXmlResponse() {
		$expectedResult = [];

		$this->config
			->expects($this->at(0))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue(0));
		$this->config
			->expects($this->at(1))
			->method('setAppValue')
			->with('core', 'lastupdatedat', $this->isType('integer'));
		$this->config
			->expects($this->at(3))
			->method('getAppValue')
			->with('core', 'installedat')
			->will($this->returnValue('installedat'));
		$this->config
			->expects($this->at(4))
			->method('getAppValue')
			->with('core', 'lastupdatedat')
			->will($this->returnValue('lastupdatedat'));
		$this->config
			->expects($this->at(5))
			->method('setAppValue')
			->with('core', 'lastupdateResult', json_encode($expectedResult));

		$updateXml = '';
		$this->httpHelper
			->expects($this->once())
			->method('getUrlContent')
			->with($this->buildUpdateUrl('https://updates.owncloud.com/server/'))
			->will($this->returnValue($updateXml));

		$this->assertSame($expectedResult, $this->updater->check());
	}
}