Add repair steps

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
This commit is contained in:
Arthur Schiwon 2017-02-17 18:45:33 +01:00
parent 45615cc940
commit 497ee3e3e6
No known key found for this signature in database
GPG Key ID: 7424F1874854DF23
14 changed files with 710 additions and 2 deletions

View File

@ -9,7 +9,7 @@ A user logs into ownCloud with their LDAP or AD credentials, and is granted acce
</description>
<licence>AGPL</licence>
<author>Dominik Schmidt and Arthur Schiwon</author>
<version>1.2.0</version>
<version>1.2.1</version>
<types>
<authentication/>
</types>
@ -32,4 +32,10 @@ A user logs into ownCloud with their LDAP or AD credentials, and is granted acce
<admin>OCA\User_LDAP\Settings\Admin</admin>
<admin-section>OCA\User_LDAP\Settings\Section</admin-section>
</settings>
<repair-steps>
<post-migration>
<step>OCA\User_LDAP\Migration\UUIDFixInsert</step>
</post-migration>
</repair-steps>
</info>

View File

@ -902,4 +902,12 @@ class Group_LDAP extends BackendUtility implements \OCP\GroupInterface {
public function implementsActions($actions) {
return (bool)(\OC\Group\Backend::COUNT_USERS & $actions);
}
/**
* Return access for LDAP interaction.
* @return Access instance of Access for LDAP interaction
*/
public function getLDAPAccess() {
return $this->access;
}
}

View File

@ -196,4 +196,13 @@ class Group_Proxy extends Proxy implements \OCP\GroupInterface {
//it's the same across all our user backends obviously
return $this->refBackend->implementsActions($actions);
}
/**
* Return access for LDAP interaction.
* @param string $gid
* @return Access instance of Access for LDAP interaction
*/
public function getLDAPAccess($gid) {
return $this->handleRequest($gid, 'getLDAPAccess', []);
}
}

View File

@ -128,6 +128,25 @@ abstract class AbstractMapping {
return $this->modify($query, array($fdn, $uuid));
}
/**
* Updates the UUID based on the given DN
*
* required by Migration/UUIDFix
*
* @param $uuid
* @param $fdn
* @return bool
*/
public function setUUIDbyDN($uuid, $fdn) {
$query = $this->dbc->prepare('
UPDATE `' . $this->getTableName() . '`
SET `directory_uuid` = ?
WHERE `ldap_dn` = ?
');
return $this->modify($query, [$uuid, $fdn]);
}
/**
* Gets the name based on the provided LDAP DN.
* @param string $fdn

View File

@ -0,0 +1,60 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Migration;
use OC\BackgroundJob\QueuedJob;
use OCA\User_LDAP\Mapping\AbstractMapping;
use OCA\User_LDAP\Proxy;
use OCA\User_LDAP\User_Proxy;
abstract class UUIDFix extends QueuedJob {
/** @var AbstractMapping */
protected $mapper;
/** @var Proxy */
protected $proxy;
public function run($argument) {
$isUser = $this->proxy instanceof User_Proxy;
foreach($argument['records'] as $record) {
$access = $this->proxy->getLDAPAccess($record['name']);
$uuid = $access->getUUID($record['dn'], $isUser);
if($uuid === false) {
// record not found, no prob, continue with the next
continue;
}
if($uuid !== $record['uuid']) {
$this->mapper->setUUIDbyDN($uuid, $record['dn']);
}
}
}
/**
* @param Proxy $proxy
*/
public function overrideProxy(Proxy $proxy) {
$this->proxy = $proxy;
}
}

View File

@ -0,0 +1,37 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Migration;
use OCA\User_LDAP\Helper;
use OCA\User_LDAP\ILDAPWrapper;
use OCA\User_LDAP\Mapping\GroupMapping;
use OCA\User_LDAP\User_Proxy;
use OCP\IConfig;
class UUIDFixGroup extends UUIDFix {
public function __construct(GroupMapping $mapper, ILDAPWrapper $ldap, IConfig $config, Helper $helper) {
$this->mapper = $mapper;
$this->proxy = new User_Proxy($helper->getServerConfigurationPrefixes(true), $ldap, $config);
}
}

View File

@ -0,0 +1,90 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Migration;
use OCA\User_LDAP\Mapping\GroupMapping;
use OCA\User_LDAP\Mapping\UserMapping;
use OCP\BackgroundJob\IJobList;
use OCP\IConfig;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
class UUIDFixInsert implements IRepairStep {
/** @var IConfig */
protected $config;
/** @var UserMapping */
protected $userMapper;
/** @var GroupMapping */
protected $groupMapper;
/** @var IJobList */
protected $jobList;
public function __construct(IConfig $config, UserMapping $userMapper, GroupMapping $groupMapper, IJobList $jobList) {
$this->config = $config;
$this->userMapper = $userMapper;
$this->groupMapper = $groupMapper;
$this->jobList = $jobList;
}
/**
* Returns the step's name
*
* @return string
* @since 9.1.0
*/
public function getName() {
return 'Insert UUIDFix background job for user and group batches of 500';
}
/**
* Run repair step.
* Must throw exception on error.
*
* @param IOutput $output
* @throws \Exception in case of failure
* @since 9.1.0
*/
public function run(IOutput $output) {
$installedVersion = $this->config->getAppValue('user_ldap', 'installed_version', '1.2.1');
if(version_compare($installedVersion, '1.2.1') !== -1) {
return;
}
$batchSize = 500;
foreach ([$this->userMapper, $this->groupMapper] as $mapper) {
$offset = 0;
$jobClass = $mapper instanceof UserMapping ? UUIDFixUser::class : UUIDFixGroup::class;
do {
$records = $mapper->getList($offset, $batchSize);
$this->jobList->add($jobClass, ['records' => $records]);
$offset += $batchSize;
} while (count($records) === $batchSize);
}
}
}

View File

@ -0,0 +1,37 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Migration;
use OCA\User_LDAP\Helper;
use OCA\User_LDAP\ILDAPWrapper;
use OCA\User_LDAP\Mapping\UserMapping;
use OCA\User_LDAP\Group_Proxy;
use OCP\IConfig;
class UUIDFixUser extends UUIDFix {
public function __construct(UserMapping $mapper, ILDAPWrapper $ldap, IConfig $config, Helper $helper) {
$this->mapper = $mapper;
$this->proxy = new Group_Proxy($helper->getServerConfigurationPrefixes(true), $ldap, $config);
}
}

View File

@ -127,6 +127,12 @@ abstract class Proxy {
*/
abstract protected function walkBackends($id, $method, $parameters);
/**
* @param string $id
* @return Access
*/
abstract public function getLDAPAccess($id);
/**
* Takes care of the request to the User backend
* @param string $id

View File

@ -26,6 +26,7 @@
namespace OCA\User_LDAP\Tests\Mapping;
use OCA\User_LDAP\Mapping\AbstractMapping;
use OCP\IDBConnection;
abstract class AbstractMappingTest extends \Test\TestCase {
@ -182,7 +183,7 @@ abstract class AbstractMappingTest extends \Test\TestCase {
/**
* tests setDNbyUUID() for successful and unsuccessful update.
*/
public function testSetMethod() {
public function testSetDNMethod() {
list($mapper, $data) = $this->initTest();
$newDN = 'uid=modified,dc=example,dc=org';
@ -196,7 +197,26 @@ abstract class AbstractMappingTest extends \Test\TestCase {
$this->assertFalse($done);
$name = $mapper->getNameByDN($newDN);
$this->assertFalse($name);
}
/**
* tests setUUIDbyDN() for successful and unsuccessful update.
*/
public function testSetUUIDMethod() {
/** @var AbstractMapping $mapper */
list($mapper, $data) = $this->initTest();
$newUUID = 'ABC737-DEF754';
$done = $mapper->setUUIDbyDN($newUUID, 'uid=notme,dc=example,dc=org');
$this->assertFalse($done);
$name = $mapper->getNameByUUID($newUUID);
$this->assertFalse($name);
$done = $mapper->setUUIDbyDN($newUUID, $data[0]['dn']);
$this->assertTrue($done);
$uuid = $mapper->getUUIDByDN($data[0]['dn']);
$this->assertSame($uuid, $newUUID);
}
/**

View File

@ -0,0 +1,197 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Tests\Migration;
use Test\TestCase;
use OCA\User_LDAP\Access;
use OCA\User_LDAP\Helper;
use OCA\User_LDAP\ILDAPWrapper;
use OCA\User_LDAP\Migration\UUIDFixUser;
use OCA\User_LDAP\Mapping\UserMapping;
use OCA\User_LDAP\Mapping\GroupMapping;
use OCA\User_LDAP\User_Proxy;
use OCP\IConfig;
abstract class AbstractUUIDFixTest extends TestCase {
/** @var Helper|\PHPUnit_Framework_MockObject_MockObject */
protected $helper;
/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
protected $config;
/** @var ILDAPWrapper|\PHPUnit_Framework_MockObject_MockObject */
protected $ldap;
/** @var UserMapping|GroupMapping|\PHPUnit_Framework_MockObject_MockObject */
protected $mapper;
/** @var UUIDFixUser */
protected $job;
/** @var User_Proxy|\PHPUnit_Framework_MockObject_MockObject */
protected $proxy;
/** @var Access|\PHPUnit_Framework_MockObject_MockObject */
protected $access;
/** @var bool */
protected $isUser = true;
public function setUp() {
parent::setUp();
$this->ldap = $this->createMock(ILDAPWrapper::class);
$this->config = $this->createMock(IConfig::class);
$this->access = $this->createMock(Access::class);
$this->helper = $this->createMock(Helper::class);
$this->helper->expects($this->any())
->method('getServerConfigurationPrefixes')
->with(true)
->willReturn(['s01', 's03']);
}
protected function mockProxy($className) {
$this->proxy = $this->createMock($className);
$this->proxy->expects($this->any())
->method('getLDAPAccess')
->willReturn($this->access);
}
protected function instantiateJob($className) {
$this->job = new $className($this->mapper, $this->ldap, $this->config, $this->helper);
$this->job->overrideProxy($this->proxy);
}
public function testRunSingleRecord() {
$args = [
'records' => [
0 => [
'name' => 'Someone',
'dn' => 'uid=Someone,dc=Somewhere',
'uuid' => 'kaput'
]
]
];
$correctUUID = '4355-AED3-9D73-03AD';
$this->access->expects($this->once())
->method('getUUID')
->with($args['records'][0]['dn'], $this->isUser)
->willReturn($correctUUID);
$this->mapper->expects($this->once())
->method('setUUIDbyDN')
->with($correctUUID, $args['records'][0]['dn']);
$this->job->run($args);
}
public function testRunValidRecord() {
$correctUUID = '4355-AED3-9D73-03AD';
$args = [
'records' => [
0 => [
'name' => 'Someone',
'dn' => 'uid=Someone,dc=Somewhere',
'uuid' => $correctUUID
]
]
];
$this->access->expects($this->once())
->method('getUUID')
->with($args['records'][0]['dn'], $this->isUser)
->willReturn($correctUUID);
$this->mapper->expects($this->never())
->method('setUUIDbyDN');
$this->job->run($args);
}
public function testRunRemovedRecord() {
$args = [
'records' => [
0 => [
'name' => 'Someone',
'dn' => 'uid=Someone,dc=Somewhere',
'uuid' => 'kaput'
]
]
];
$this->access->expects($this->once())
->method('getUUID')
->with($args['records'][0]['dn'], $this->isUser)
->willReturn(false);
$this->mapper->expects($this->never())
->method('setUUIDbyDN');
$this->job->run($args);
}
public function testRunManyRecords() {
$args = [
'records' => [
0 => [
'name' => 'Someone',
'dn' => 'uid=Someone,dc=Somewhere',
'uuid' => 'kaput'
],
1 => [
'name' => 'kdslkdsaIdsal',
'dn' => 'uid=kdslkdsaIdsal,dc=Somewhere',
'uuid' => 'AED3-4355-03AD-9D73'
],
2 => [
'name' => 'Paperboy',
'dn' => 'uid=Paperboy,dc=Somewhere',
'uuid' => 'kaput'
]
]
];
$correctUUIDs = ['4355-AED3-9D73-03AD', 'AED3-4355-03AD-9D73', 'AED3-9D73-4355-03AD'];
$this->access->expects($this->exactly(3))
->method('getUUID')
->withConsecutive(
[$args['records'][0]['dn'], $this->isUser],
[$args['records'][1]['dn'], $this->isUser],
[$args['records'][2]['dn'], $this->isUser]
)
->willReturnOnConsecutiveCalls($correctUUIDs[0], $correctUUIDs[1], $correctUUIDs[2]);
$this->mapper->expects($this->exactly(2))
->method('setUUIDbyDN')
->withConsecutive(
[$correctUUIDs[0], $args['records'][0]['dn']],
[$correctUUIDs[2], $args['records'][2]['dn']]
);
$this->job->run($args);
}
}

View File

@ -0,0 +1,44 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Group_LDAP\Tests\Migration;
use OCA\User_LDAP\Migration\UUIDFixGroup;
use OCA\User_LDAP\Mapping\GroupMapping;
use OCA\User_LDAP\Group_Proxy;
use OCA\User_LDAP\Tests\Migration\AbstractUUIDFixTest;
class UUIDFixGroupTest extends AbstractUUIDFixTest {
public function setUp() {
$this->isUser = false;
parent::setUp();
$this->isUser = false;
$this->mapper = $this->createMock(GroupMapping::class);
$this->mockProxy(Group_Proxy::class);
$this->instantiateJob(UUIDFixGroup::class);
}
}

View File

@ -0,0 +1,135 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Tests\Migration;
use OCA\User_LDAP\Migration\UUIDFixInsert;
use OCA\User_LDAP\Mapping\UserMapping;
use OCA\User_LDAP\Mapping\GroupMapping;
use OCP\BackgroundJob\IJobList;
use OCP\IConfig;
use OCP\Migration\IOutput;
use Test\TestCase;
class UUIDFixInsertTest extends TestCase {
/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
protected $config;
/** @var UserMapping|\PHPUnit_Framework_MockObject_MockObject */
protected $userMapper;
/** @var GroupMapping|\PHPUnit_Framework_MockObject_MockObject */
protected $groupMapper;
/** @var IJobList|\PHPUnit_Framework_MockObject_MockObject */
protected $jobList;
/** @var UUIDFixInsert */
protected $job;
public function setUp() {
parent::setUp();
$this->jobList = $this->createMock(IJobList::class);
$this->config = $this->createMock(IConfig::class);
$this->userMapper = $this->createMock(UserMapping::class);
$this->groupMapper = $this->createMock(GroupMapping::class);
$this->job = new UUIDFixInsert(
$this->config,
$this->userMapper,
$this->groupMapper,
$this->jobList
);
}
public function testGetName() {
$this->assertSame('Insert UUIDFix background job for user and group batches of 500', $this->job->getName());
}
public function recordProvider() {
$record = [
'dn' => 'cn=somerecord,dc=somewhere',
'name' => 'Something',
'uuid' => 'AB12-3456-CDEF7-8GH9'
];
array_fill(0, 500, $record);
$userBatches = [
0 => array_fill(0, 500, $record),
1 => array_fill(0, 500, $record),
2 => array_fill(0, 13, $record),
];
$groupBatches = [
0 => array_fill(0, 7, $record),
];
return [
['userBatches' => $userBatches, 'groupBatches' => $groupBatches]
];
}
/**
* @dataProvider recordProvider
*/
public function testRun($userBatches, $groupBatches) {
$this->config->expects($this->once())
->method('getAppValue')
->with('user_ldap', 'installed_version', '1.2.1')
->willReturn('1.2.0');
$this->userMapper->expects($this->exactly(3))
->method('getList')
->withConsecutive([0, 500], [500, 500], [1000, 500])
->willReturnOnConsecutiveCalls($userBatches[0], $userBatches[1], $userBatches[2]);
$this->groupMapper->expects($this->exactly(1))
->method('getList')
->with(0, 500)
->willReturn($groupBatches[0]);
$this->jobList->expects($this->exactly(4))
->method('add');
/** @var IOutput $out */
$out = $this->createMock(IOutput::class);
$this->job->run($out);
}
public function testDonNotRun() {
$this->config->expects($this->once())
->method('getAppValue')
->with('user_ldap', 'installed_version', '1.2.1')
->willReturn('1.2.1');
$this->userMapper->expects($this->never())
->method('getList');
$this->groupMapper->expects($this->never())
->method('getList');
$this->jobList->expects($this->never())
->method('add');
/** @var IOutput $out */
$out = $this->createMock(IOutput::class);
$this->job->run($out);
}
}

View File

@ -0,0 +1,40 @@
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Tests\Migration;
use OCA\User_LDAP\Migration\UUIDFixUser;
use OCA\User_LDAP\Mapping\UserMapping;
use OCA\User_LDAP\User_Proxy;
class UUIDFixUserTest extends AbstractUUIDFixTest {
public function setUp() {
$this->isUser = true;
parent::setUp();
$this->mapper = $this->createMock(UserMapping::class);
$this->mockProxy(User_Proxy::class);
$this->instantiateJob(UUIDFixUser::class);
}
}