smb/tests/NotifyHandlerTest.php

<?php
/**
 * Copyright (c) 2016 Robin Appelman <icewind@owncloud.com>
 * This file is licensed under the Licensed under the MIT license:
 * http://opensource.org/licenses/MIT
 */

namespace Icewind\SMB\Test;

use Icewind\SMB\Change;
use Icewind\SMB\Exception\AlreadyExistsException;
use Icewind\SMB\INotifyHandler;
use Icewind\SMB\IShare;

class NotifyHandlerTest extends TestCase {
	/**
	 * @var \Icewind\SMB\Server $server
	 */
	private $server;

	private $config;

	public function setUp() {
		$this->requireBackendEnv('smbclient');
		$this->config = json_decode(file_get_contents(__DIR__ . '/config.json'));
		$this->server = new \Icewind\SMB\Server($this->config->host, $this->config->user, $this->config->password);
	}

	/**
	 * sometimes smb adds modified changes in the mix for shits and giggles
	 *
	 * filter them out so we can compare changes properly
	 *
	 * @param Change[] $changes
	 * @return Change[]
	 */
	private function filterModifiedChanges(array $changes) {
		return array_values(array_filter($changes, function (Change $change) {
			return $change->getCode() !== INotifyHandler::NOTIFY_MODIFIED;
		}));
	}

	public function testGetChanges() {
		$share = $this->server->getShare($this->config->share);
		$process = $share->notify('');

		usleep(1000 * 100);// give it some time to start listening

		$share->put(__FILE__, 'source.txt');
		$share->rename('source.txt', 'target.txt');
		$share->del('target.txt');
		usleep(1000 * 100);// give it some time

		$changes = $process->getChanges();
		$process->stop();
		$expected = [
			new Change(INotifyHandler::NOTIFY_ADDED, 'source.txt'),
			new Change(INotifyHandler::NOTIFY_RENAMED_OLD, 'source.txt'),
			new Change(INotifyHandler::NOTIFY_RENAMED_NEW, 'target.txt'),
			new Change(INotifyHandler::NOTIFY_REMOVED, 'target.txt'),
		];

		$this->assertEquals($expected, $this->filterModifiedChanges($changes));
	}

	public function testChangesSubdir() {
		$share = $this->server->getShare($this->config->share);

		try {
			$share->mkdir('sub');
		} catch (AlreadyExistsException $e) {

		}
		$process = $share->notify('sub');
		usleep(1000 * 100);// give it some time to start listening
		$share->put(__FILE__, 'sub/source.txt');
		$share->del('sub/source.txt');
		usleep(1000 * 100);// give it some time

		$changes = $process->getChanges();
		$process->stop();

		$expected = [
			new Change(INotifyHandler::NOTIFY_ADDED, 'sub/source.txt'),
			new Change(INotifyHandler::NOTIFY_REMOVED, 'sub/source.txt'),
		];

		$share->rmdir('sub');
		$this->assertEquals($expected, $this->filterModifiedChanges($changes));
	}

	public function testListen() {
		$share = $this->server->getShare($this->config->share);
		$process = $share->notify('');

		usleep(1000 * 100);// give it some time to start listening

		$share->put(__FILE__, 'source.txt');
		$share->del('source.txt');

		$results = [];

		// the notify process buffers incoming messages so callback will be triggered for the above changes
		$process->listen(function ($change) use (&$results) {
			$results = $change;
			return false; // stop listening
		});
		$this->assertEquals($results, new Change(INotifyHandler::NOTIFY_ADDED, 'source.txt'));
	}

	public function testStopped() {
		$share = $this->server->getShare($this->config->share);
		$process = $share->notify('');
		$process->stop();
		$this->assertEquals([], $process->getChanges());
	}

	public function testListenAfterGetChanges() {
		$share = $this->server->getShare($this->config->share);
		$process = $share->notify('');

		usleep(1000 * 100);// give it some time to start listening

		$share->put(__FILE__, 'source.txt');
		$share->rename('source.txt', 'target.txt');
		$share->del('target.txt');
		usleep(1000 * 100);// give it some time

		$changes = $process->getChanges();
		$expected = [
			new Change(INotifyHandler::NOTIFY_ADDED, 'source.txt'),
			new Change(INotifyHandler::NOTIFY_RENAMED_OLD, 'source.txt'),
			new Change(INotifyHandler::NOTIFY_RENAMED_NEW, 'target.txt'),
			new Change(INotifyHandler::NOTIFY_REMOVED, 'target.txt'),
		];

		$this->assertEquals($expected, $this->filterModifiedChanges($changes));

		usleep(1000 * 200);

		$share->put(__FILE__, 'source2.txt');
		$share->del('source2.txt');

		$results = null;

		// the notify process buffers incoming messages so callback will be triggered for the above changes
		$process->listen(function ($change) use (&$results) {
			$results = $change;
			return false; // stop listening
		});
		$this->assertNotNull($results);
	}
}