2015-08-17 21:40:03 +03:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 17:49:16 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2017-11-06 17:56:42 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2019-12-03 21:57:53 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
2015-08-17 21:40:03 +03:00
|
|
|
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
|
|
|
|
*
|
|
|
|
* @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,
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
2015-08-17 21:40:03 +03:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2015-09-09 18:37:33 +03:00
|
|
|
namespace OCA\Files_Versions\Tests;
|
2015-08-17 21:40:03 +03:00
|
|
|
|
2019-11-22 22:52:10 +03:00
|
|
|
use OCA\Files_Versions\Expiration;
|
2018-10-10 11:17:56 +03:00
|
|
|
use OCP\AppFramework\Utility\ITimeFactory;
|
2017-10-24 16:26:53 +03:00
|
|
|
use OCP\IConfig;
|
2018-10-10 11:17:56 +03:00
|
|
|
use PHPUnit\Framework\MockObject\MockObject;
|
2015-09-09 18:37:33 +03:00
|
|
|
|
2016-05-12 10:49:15 +03:00
|
|
|
class ExpirationTest extends \Test\TestCase {
|
2020-04-10 17:54:27 +03:00
|
|
|
public const SECONDS_PER_DAY = 86400; //60*60*24
|
2015-08-17 21:40:03 +03:00
|
|
|
|
2020-04-09 14:53:40 +03:00
|
|
|
public function expirationData() {
|
2015-08-17 21:40:03 +03:00
|
|
|
$today = 100*self::SECONDS_PER_DAY;
|
|
|
|
$back10Days = (100-10)*self::SECONDS_PER_DAY;
|
|
|
|
$back20Days = (100-20)*self::SECONDS_PER_DAY;
|
|
|
|
$back30Days = (100-30)*self::SECONDS_PER_DAY;
|
|
|
|
$back35Days = (100-35)*self::SECONDS_PER_DAY;
|
|
|
|
|
|
|
|
// it should never happen, but who knows :/
|
|
|
|
$ahead100Days = (100+100)*self::SECONDS_PER_DAY;
|
|
|
|
|
|
|
|
return [
|
|
|
|
// Expiration is disabled - always should return false
|
|
|
|
[ 'disabled', $today, $back10Days, false, false],
|
|
|
|
[ 'disabled', $today, $back10Days, true, false],
|
|
|
|
[ 'disabled', $today, $ahead100Days, true, false],
|
|
|
|
|
|
|
|
// Default: expire in 30 days or earlier when quota requirements are met
|
|
|
|
[ 'auto', $today, $back10Days, false, false],
|
|
|
|
[ 'auto', $today, $back35Days, false, false],
|
|
|
|
[ 'auto', $today, $back10Days, true, true],
|
|
|
|
[ 'auto', $today, $back35Days, true, true],
|
|
|
|
[ 'auto', $today, $ahead100Days, true, true],
|
|
|
|
|
|
|
|
// The same with 'auto'
|
|
|
|
[ 'auto, auto', $today, $back10Days, false, false],
|
|
|
|
[ 'auto, auto', $today, $back35Days, false, false],
|
|
|
|
[ 'auto, auto', $today, $back10Days, true, true],
|
|
|
|
[ 'auto, auto', $today, $back35Days, true, true],
|
|
|
|
|
|
|
|
// Keep for 15 days but expire anytime if space needed
|
|
|
|
[ '15, auto', $today, $back10Days, false, false],
|
|
|
|
[ '15, auto', $today, $back20Days, false, false],
|
|
|
|
[ '15, auto', $today, $back10Days, true, true],
|
|
|
|
[ '15, auto', $today, $back20Days, true, true],
|
|
|
|
[ '15, auto', $today, $ahead100Days, true, true],
|
|
|
|
|
|
|
|
// Expire anytime if space needed, Expire all older than max
|
|
|
|
[ 'auto, 15', $today, $back10Days, false, false],
|
|
|
|
[ 'auto, 15', $today, $back20Days, false, true],
|
|
|
|
[ 'auto, 15', $today, $back10Days, true, true],
|
|
|
|
[ 'auto, 15', $today, $back20Days, true, true],
|
|
|
|
[ 'auto, 15', $today, $ahead100Days, true, true],
|
|
|
|
|
|
|
|
// Expire all older than max OR older than min if space needed
|
|
|
|
[ '15, 25', $today, $back10Days, false, false],
|
|
|
|
[ '15, 25', $today, $back20Days, false, false],
|
|
|
|
[ '15, 25', $today, $back30Days, false, true],
|
|
|
|
[ '15, 25', $today, $back10Days, false, false],
|
|
|
|
[ '15, 25', $today, $back20Days, true, true],
|
|
|
|
[ '15, 25', $today, $back30Days, true, true],
|
|
|
|
[ '15, 25', $today, $ahead100Days, true, false],
|
|
|
|
|
|
|
|
// Expire all older than max OR older than min if space needed
|
|
|
|
// Max<Min case
|
|
|
|
[ '25, 15', $today, $back10Days, false, false],
|
|
|
|
[ '25, 15', $today, $back20Days, false, false],
|
|
|
|
[ '25, 15', $today, $back30Days, false, true],
|
|
|
|
[ '25, 15', $today, $back10Days, false, false],
|
|
|
|
[ '25, 15', $today, $back20Days, true, false],
|
|
|
|
[ '25, 15', $today, $back30Days, true, true],
|
|
|
|
[ '25, 15', $today, $ahead100Days, true, false],
|
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @dataProvider expirationData
|
|
|
|
*
|
|
|
|
* @param string $retentionObligation
|
|
|
|
* @param int $timeNow
|
|
|
|
* @param int $timestamp
|
|
|
|
* @param bool $quotaExceeded
|
|
|
|
* @param string $expectedResult
|
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
public function testExpiration($retentionObligation, $timeNow, $timestamp, $quotaExceeded, $expectedResult) {
|
2015-08-17 21:40:03 +03:00
|
|
|
$mockedConfig = $this->getMockedConfig($retentionObligation);
|
|
|
|
$mockedTimeFactory = $this->getMockedTimeFactory($timeNow);
|
|
|
|
|
|
|
|
$expiration = new Expiration($mockedConfig, $mockedTimeFactory);
|
|
|
|
$actualResult = $expiration->isExpired($timestamp, $quotaExceeded);
|
|
|
|
|
|
|
|
$this->assertEquals($expectedResult, $actualResult);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-04-09 14:53:40 +03:00
|
|
|
public function configData() {
|
2015-08-17 21:40:03 +03:00
|
|
|
return [
|
|
|
|
[ 'disabled', null, null, null],
|
2015-08-20 18:32:41 +03:00
|
|
|
[ 'auto', Expiration::NO_OBLIGATION, Expiration::NO_OBLIGATION, true ],
|
|
|
|
[ 'auto,auto', Expiration::NO_OBLIGATION, Expiration::NO_OBLIGATION, true ],
|
|
|
|
[ 'auto, auto', Expiration::NO_OBLIGATION, Expiration::NO_OBLIGATION, true ],
|
2015-08-17 21:40:03 +03:00
|
|
|
[ 'auto, 3', Expiration::NO_OBLIGATION, 3, true ],
|
|
|
|
[ '5, auto', 5, Expiration::NO_OBLIGATION, true ],
|
|
|
|
[ '3, 5', 3, 5, false ],
|
|
|
|
[ '10, 3', 10, 10, false ],
|
2015-08-20 18:32:41 +03:00
|
|
|
[ 'g,a,r,b,a,g,e', Expiration::NO_OBLIGATION, Expiration::NO_OBLIGATION, true ],
|
|
|
|
[ '-3,8', Expiration::NO_OBLIGATION, Expiration::NO_OBLIGATION, true ]
|
2015-08-17 21:40:03 +03:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @dataProvider configData
|
|
|
|
*
|
|
|
|
* @param string $configValue
|
|
|
|
* @param int $expectedMinAge
|
|
|
|
* @param int $expectedMaxAge
|
|
|
|
* @param bool $expectedCanPurgeToSaveSpace
|
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
public function testParseRetentionObligation($configValue, $expectedMinAge, $expectedMaxAge, $expectedCanPurgeToSaveSpace) {
|
2015-08-17 21:40:03 +03:00
|
|
|
$mockedConfig = $this->getMockedConfig($configValue);
|
|
|
|
$mockedTimeFactory = $this->getMockedTimeFactory(
|
|
|
|
time()
|
|
|
|
);
|
|
|
|
|
|
|
|
$expiration = new Expiration($mockedConfig, $mockedTimeFactory);
|
|
|
|
$this->assertAttributeEquals($expectedMinAge, 'minAge', $expiration);
|
|
|
|
$this->assertAttributeEquals($expectedMaxAge, 'maxAge', $expiration);
|
|
|
|
$this->assertAttributeEquals($expectedCanPurgeToSaveSpace, 'canPurgeToSaveSpace', $expiration);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param int $time
|
2018-10-10 11:17:56 +03:00
|
|
|
* @return ITimeFactory|MockObject
|
2015-08-17 21:40:03 +03:00
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
private function getMockedTimeFactory($time) {
|
2018-10-10 11:17:56 +03:00
|
|
|
$mockedTimeFactory = $this->createMock(ITimeFactory::class);
|
|
|
|
$mockedTimeFactory->expects($this->any())
|
|
|
|
->method('getTime')
|
|
|
|
->willReturn($time);
|
2015-08-17 21:40:03 +03:00
|
|
|
|
|
|
|
return $mockedTimeFactory;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $returnValue
|
2018-10-10 11:17:56 +03:00
|
|
|
* @return IConfig|MockObject
|
2015-08-17 21:40:03 +03:00
|
|
|
*/
|
2020-04-09 14:53:40 +03:00
|
|
|
private function getMockedConfig($returnValue) {
|
2018-10-10 11:17:56 +03:00
|
|
|
$mockedConfig = $this->createMock(IConfig::class);
|
|
|
|
$mockedConfig->expects($this->any())
|
|
|
|
->method('getSystemValue')
|
|
|
|
->willReturn($returnValue);
|
2015-08-17 21:40:03 +03:00
|
|
|
|
|
|
|
return $mockedConfig;
|
|
|
|
}
|
|
|
|
}
|