LDAP User Cleanup

background job for user clean up

adjust user backend for clean up

register background job

remove dead code

dependency injection

make Helper non-static for proper testing

check whether it is OK to run clean up job. Do not forget to pass arguments.

use correct method to get the config from server

methods can be private, proper indirect testing is given

no automatic user deletion

make limit readable for test purposes

make method less complex

add first tests

let preferences accept limit and offset for getUsersForValue

DI via constructor does not work for background jobs

after detecting, now we have retrieving deleted users and their details

we need this method to be public for now

finalize export method, add missing getter

clean up namespaces and get rid of unnecessary files

helper is not static anymore

cleanup according to scrutinizer

add cli tool to show deleted users

uses are necessary after recent namespace change

also remove user from mappings table on deletion

add occ command to delete users

fix use statement

improve output

big fixes / improvements

PHP doc

return true in userExists early for cleaning up deleted users

bump version

control state and interval with one config.php setting, now ldapUserCleanupInterval. 0 will disable it. enabled by default.

improve doc

rename cli method to be consistent with  others

introduce ldapUserCleanupInterval in sample config

don't show last login as unix epoche start when no  login happend

less log output

consistent namespace for OfflineUser

rename GarbageCollector to DeletedUsersIndex and move it to user subdir

fix unit tests

add tests for deleteUser

more test adjustements

4 files changed, 186 insertions, 3 deletions

diff --git a/apps/user_ldap/tests/helper.php b/apps/user_ldap/tests/helper.php
index 07c24d64499..cfd4aebf713 100644
--- a/apps/user_ldap/tests/helper.php
+++ b/apps/user_ldap/tests/helper.php
@@ -23,7 +23,8 @@ class Test_Helper extends \PHPUnit_Framework_TestCase {
 		$result = $statement->execute();
 		$this->assertEquals(2, $result->fetchOne());
 
-		Helper::clearMapping('user');
+		$helper = new Helper();
+		$helper->clearMapping('user');
 
 		$result = $statement->execute();
 		$this->assertEquals(0, $result->fetchOne());
diff --git a/apps/user_ldap/tests/jobs/cleanup.php b/apps/user_ldap/tests/jobs/cleanup.php
new file mode 100644
index 00000000000..687f7e16431
--- /dev/null
+++ b/apps/user_ldap/tests/jobs/cleanup.php
@@ -0,0 +1,164 @@
+<?php
+/**
+ * Copyright (c) 2014 Arthur Schiwon <blizzz@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCA\user_ldap\tests;
+
+class Test_CleanUp extends \PHPUnit_Framework_TestCase {
+	public function getMocks() {
+		$mocks = array();
+		$mocks['userBackend'] =
+			$this->getMockBuilder('\OCA\user_ldap\User_Proxy')
+				->disableOriginalConstructor()
+				->getMock();
+		$mocks['ocConfig']    = $this->getMock('\OCP\IConfig');
+		$mocks['db']          = $this->getMock('\OCP\IDBConnection');
+		$mocks['helper']      = $this->getMock('\OCA\user_ldap\lib\Helper');
+
+		return $mocks;
+	}
+
+	/**
+	 * clean up job must not run when there are disabled configurations
+	 */
+	public function test_runNotAllowedByDisabledConfigurations() {
+		$args = $this->getMocks();
+		$args['helper']->expects($this->exactly(2))
+			->method('getServerConfigurationPrefixes')
+			->will($this->onConsecutiveCalls(
+				array_pad(array(), 4, true),
+				array_pad(array(), 3, true))
+			);
+
+		$args['ocConfig']->expects($this->never())
+			->method('getSystemValue');
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		$result = $bgJob->isCleanUpAllowed();
+		$this->assertSame(false, $result);
+	}
+
+	/**
+	 * clean up job must not run when LDAP Helper is broken i.e.
+	 * returning unexpected results
+	 */
+	public function test_runNotAllowedByBrokenHelper() {
+		$args = $this->getMocks();
+		$args['helper']->expects($this->exactly(2))
+			->method('getServerConfigurationPrefixes')
+			->will($this->returnValue(null)	);
+
+		$args['ocConfig']->expects($this->never())
+			->method('getSystemValue');
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		$result = $bgJob->isCleanUpAllowed();
+		$this->assertSame(false, $result);
+	}
+
+	/**
+	 * clean up job must not run when it is not enabled
+	 */
+	public function test_runNotAllowedBySysConfig() {
+		$args = $this->getMocks();
+		$args['helper']->expects($this->exactly(2))
+			->method('getServerConfigurationPrefixes')
+			->will($this->onConsecutiveCalls(
+				array_pad(array(), 4, true),
+				array_pad(array(), 4, true))
+			);
+
+		$args['ocConfig']->expects($this->once())
+			->method('getSystemValue')
+			->will($this->returnValue(false));
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		$result = $bgJob->isCleanUpAllowed();
+		$this->assertSame(false, $result);
+	}
+
+	/**
+	 * clean up job is allowed to run
+	 */
+	public function test_runIsAllowed() {
+		$args = $this->getMocks();
+		$args['helper']->expects($this->exactly(2))
+			->method('getServerConfigurationPrefixes')
+			->will($this->onConsecutiveCalls(
+				array_pad(array(), 4, true),
+				array_pad(array(), 4, true))
+			);
+
+		$args['ocConfig']->expects($this->once())
+			->method('getSystemValue')
+			->will($this->returnValue(true));
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		$result = $bgJob->isCleanUpAllowed();
+		$this->assertSame(true, $result);
+	}
+
+	/**
+	 * test whether sql is OK
+	 */
+	public function test_getMappedUsers() {
+		$args = $this->getMocks();
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		if(version_compare(\PHPUnit_Runner_Version::id(), '3.8', '<')) {
+			//otherwise we run into
+			//https://github.com/sebastianbergmann/phpunit-mock-objects/issues/103
+			$this->markTestIncomplete();
+		}
+
+		$stmt = $this->getMock('\Doctrine\DBAL\Driver\Statement');
+
+		$args['db']->expects($this->once())
+			->method('prepare')
+			->will($this->returnValue($stmt));
+
+		$bgJob->getMappedUsers(0, $bgJob->getChunkSize());
+	}
+
+	/**
+	 * check whether offset will be reset when it needs to
+	 */
+	public function test_OffsetResetIsNecessary() {
+		$args = $this->getMocks();
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		$result = $bgJob->isOffsetResetNecessary($bgJob->getChunkSize() - 1);
+		$this->assertSame(true, $result);
+	}
+
+	/**
+	 * make sure offset is not reset when it is not due
+	 */
+	public function test_OffsetResetIsNotNecessary() {
+		$args = $this->getMocks();
+
+		$bgJob = new \OCA\User_LDAP\Jobs\CleanUp();
+		$bgJob->setArguments($args);
+
+		$result = $bgJob->isOffsetResetNecessary($bgJob->getChunkSize());
+		$this->assertSame(false, $result);
+	}
+
+}
+
diff --git a/apps/user_ldap/tests/user/manager.php b/apps/user_ldap/tests/user/manager.php
index 7d687867213..5f55448fc09 100644
--- a/apps/user_ldap/tests/user/manager.php
+++ b/apps/user_ldap/tests/user/manager.php
@@ -183,7 +183,7 @@ class Test_User_Manager extends \PHPUnit_Framework_TestCase {
         $access->expects($this->never())
             ->method('dn2username');
 
-        $access->expects($this->exactly(2))
+        $access->expects($this->exactly(1))
             ->method('username2dn')
             ->with($this->equalTo($uid))
             ->will($this->returnValue(false));
diff --git a/apps/user_ldap/tests/user_ldap.php b/apps/user_ldap/tests/user_ldap.php
index c89edc33fa9..6afa9d79e3e 100644
--- a/apps/user_ldap/tests/user_ldap.php
+++ b/apps/user_ldap/tests/user_ldap.php
@@ -121,7 +121,7 @@ class Test_User_Ldap_Direct extends \PHPUnit_Framework_TestCase {
 			   ->method('fetchListOfUsers')
 			   ->will($this->returnCallback(function($filter) {
 					if($filter === 'roland') {
-						return array('dnOfRoland,dc=test');
+						return array(array('dn' => 'dnOfRoland,dc=test'));
 					}
 					return array();
 			   }));
@@ -228,6 +228,24 @@ class Test_User_Ldap_Direct extends \PHPUnit_Framework_TestCase {
 		$this->assertFalse($result);
 	}
 
+	public function testDeleteUserCancel() {
+		$access = $this->getAccessMock();
+		$backend = new UserLDAP($access);
+		$result = $backend->deleteUser('notme');
+		$this->assertFalse($result);
+	}
+
+	public function testDeleteUserSuccess() {
+		$access = $this->getAccessMock();
+		$backend = new UserLDAP($access);
+
+		$pref = \OC::$server->getConfig();
+		$pref->setUserValue('jeremy', 'user_ldap', 'isDeleted', 1);
+
+		$result = $backend->deleteUser('jeremy');
+		$this->assertTrue($result);
+	}
+
 	/**
 	 * Prepares the Access mock for getUsers tests
 	 * @param \OCA\user_ldap\lib\Access $access mock