open-dsi
/
nextcloud-server
mirror of https://github.com/nextcloud/server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

split async test bus for easier subclassing

Browse Source
pull/6254/head
Robin Appelman 9 years ago
parent ae0789ef43
commit 9731350ace
6 changed files with 168 additions and 76 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 55
      lib/private/Command/AsyncBus.php
  2. 75
      lib/private/Command/CronBus.php
  3. 4
      lib/private/Server.php
  4. 56
      tests/lib/Command/AsyncBusTest.php
  5. 50
      tests/lib/Command/CronBusTest.php
  6. 4
      tests/lib/TestCase.php

55
lib/private/Command/AsyncBus.php
Unescape View File

@ -24,17 +24,11 @@ namespace OC\Command;
use OCP\Command\IBus;
use OCP\Command\ICommand;
use SuperClosure\Serializer;
/**
* Asynchronous command bus that uses the background job system as backend
*/
class AsyncBus implements IBus {
/**
* @var \OCP\BackgroundJob\IJobList
*/
private $jobList;
abstract class AsyncBus implements IBus {
/**
* List of traits for command which require sync execution
*
@ -42,13 +36,6 @@ class AsyncBus implements IBus {
*/
private $syncTraits = [];
/**
* @param \OCP\BackgroundJob\IJobList $jobList
*/
public function __construct($jobList) {
$this->jobList = $jobList;
}
/**
* Schedule a command to be fired
*
@ -56,12 +43,19 @@ class AsyncBus implements IBus {
*/
public function push($command) {
if ($this->canRunAsync($command)) {
$this->jobList->add($this->getJobClass($command), $this->serializeCommand($command));
$this->queueCommand($command);
} else {
$this->runCommand($command);
}
}
/**
* Queue a command in the bus
*
* @param \OCP\Command\ICommand | callable $command
*/
abstract protected function queueCommand($command);
/**
* Require all commands using a trait to be run synchronous
*
@ -82,37 +76,6 @@ class AsyncBus implements IBus {
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string
*/
private function getJobClass($command) {
if ($command instanceof \Closure) {
return 'OC\Command\ClosureJob';
} else if (is_callable($command)) {
return 'OC\Command\CallableJob';
} else if ($command instanceof ICommand) {
return 'OC\Command\CommandJob';
} else {
throw new \InvalidArgumentException('Invalid command');
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string
*/
private function serializeCommand($command) {
if ($command instanceof \Closure) {
$serializer = new Serializer();
return $serializer->serialize($command);
} else if (is_callable($command) or $command instanceof ICommand) {
return serialize($command);
} else {
throw new \InvalidArgumentException('Invalid command');
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return bool

75
lib/private/Command/CronBus.php
Unescape View File

@ -0,0 +1,75 @@
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @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 OC\Command;
use OCP\Command\ICommand;
use SuperClosure\Serializer;
class CronBus extends AsyncBus {
/**
* @var \OCP\BackgroundJob\IJobList
*/
private $jobList;
/**
* @param \OCP\BackgroundJob\IJobList $jobList
*/
public function __construct($jobList) {
$this->jobList = $jobList;
}
protected function queueCommand($command) {
$this->jobList->add($this->getJobClass($command), $this->serializeCommand($command));
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string
*/
private function getJobClass($command) {
if ($command instanceof \Closure) {
return 'OC\Command\ClosureJob';
} else if (is_callable($command)) {
return 'OC\Command\CallableJob';
} else if ($command instanceof ICommand) {
return 'OC\Command\CommandJob';
} else {
throw new \InvalidArgumentException('Invalid command');
}
}
/**
* @param \OCP\Command\ICommand | callable $command
* @return string
*/
private function serializeCommand($command) {
if ($command instanceof \Closure) {
$serializer = new Serializer();
return $serializer->serialize($command);
} else if (is_callable($command) or $command instanceof ICommand) {
return serialize($command);
} else {
throw new \InvalidArgumentException('Invalid command');
}
}
}

4
lib/private/Server.php
Unescape View File

@ -51,7 +51,7 @@ use OC\AppFramework\Http\Request;
use OC\AppFramework\Utility\SimpleContainer;
use OC\AppFramework\Utility\TimeFactory;
use OC\Authentication\LoginCredentials\Store;
use OC\Command\AsyncBus;
use OC\Command\CronBus;
use OC\Contacts\ContactsMenu\ActionFactory;
use OC\Diagnostics\EventLogger;
use OC\Diagnostics\NullEventLogger;
@ -695,7 +695,7 @@ class Server extends ServerContainer implements IServerContainer {
});
$this->registerService('AsyncCommandBus', function (Server $c) {
$jobList = $c->getJobList();
return new AsyncBus($jobList);
return new CronBus($jobList);
});
$this->registerService('TrustedDomainHelper', function ($c) {
return new TrustedDomainHelper($this->getConfig());

56
tests/lib/Command/AsyncBusTest.php
Unescape View File

@ -12,7 +12,6 @@ namespace Test\Command;
use OC\Command\FileAccess;
use OCP\Command\IBus;
use OCP\Command\ICommand;
use Test\BackgroundJob\DummyJobList;
use Test\TestCase;
class SimpleCommand implements ICommand {
@ -58,7 +57,7 @@ class ThisClosureTest {
}
}
class AsyncBusTest extends TestCase {
abstract class AsyncBusTest extends TestCase {
/**
* Basic way to check output from a command
*
@ -66,11 +65,6 @@ class AsyncBusTest extends TestCase {
*/
public static $lastCommand;
/**
* @var \OCP\BackgroundJob\IJobList
*/
private $jobList;
/**
* @var \OCP\Command\IBus
*/
@ -80,47 +74,60 @@ class AsyncBusTest extends TestCase {
self::$lastCommand = 'static';
}
/**
* @return IBus
*/
protected function getBus() {
if (!$this->bus instanceof IBus) {
$this->bus = $this->createBus();
}
return $this->bus;
}
/**
* @return IBus
*/
abstract protected function createBus();
public function setUp() {
$this->jobList = new DummyJobList();
$this->bus = new \OC\Command\AsyncBus($this->jobList);
self::$lastCommand = '';
}
public function testSimpleCommand() {
$command = new SimpleCommand();
$this->bus->push($command);
$this->getBus()->push($command);
$this->runJobs();
$this->assertEquals('SimpleCommand', self::$lastCommand);
}
public function testStateFullCommand() {
$command = new StateFullCommand('foo');
$this->bus->push($command);
$this->getBus()->push($command);
$this->runJobs();
$this->assertEquals('foo', self::$lastCommand);
}
public function testStaticCallable() {
$this->bus->push(['\Test\Command\AsyncBusTest', 'DummyCommand']);
$this->getBus()->push(['\Test\Command\AsyncBusTest', 'DummyCommand']);
$this->runJobs();
$this->assertEquals('static', self::$lastCommand);
}
public function testMemberCallable() {
$command = new StateFullCommand('bar');
$this->bus->push([$command, 'handle']);
$this->getBus()->push([$command, 'handle']);
$this->runJobs();
$this->assertEquals('bar', self::$lastCommand);
}
public function testFunctionCallable() {
$this->bus->push('\Test\Command\BasicFunction');
$this->getBus()->push('\Test\Command\BasicFunction');
$this->runJobs();
$this->assertEquals('function', self::$lastCommand);
}
public function testClosure() {
$this->bus->push(function () {
$this->getBus()->push(function () {
AsyncBusTest::$lastCommand = 'closure';
});
$this->runJobs();
@ -128,7 +135,7 @@ class AsyncBusTest extends TestCase {
}
public function testClosureSelf() {
$this->bus->push(function () {
$this->getBus()->push(function () {
self::$lastCommand = 'closure-self';
});
$this->runJobs();
@ -139,14 +146,14 @@ class AsyncBusTest extends TestCase {
public function testClosureThis() {
// clean class to prevent phpunit putting closure in $this
$test = new ThisClosureTest();
$test->test($this->bus);
$test->test($this->getBus());
$this->runJobs();
$this->assertEquals('closure-this', self::$lastCommand);
}
public function testClosureBind() {
$state = 'bar';
$this->bus->push(function () use ($state) {
$this->getBus()->push(function () use ($state) {
self::$lastCommand = 'closure-' . $state;
});
$this->runJobs();
@ -154,15 +161,15 @@ class AsyncBusTest extends TestCase {
}
public function testFileFileAccessCommand() {
$this->bus->push(new FilesystemCommand());
$this->getBus()->push(new FilesystemCommand());
$this->assertEquals('', self::$lastCommand);
$this->runJobs();
$this->assertEquals('FileAccess', self::$lastCommand);
}
public function testFileFileAccessCommandSync() {
$this->bus->requireSync('\OC\Command\FileAccess');
$this->bus->push(new FilesystemCommand());
$this->getBus()->requireSync('\OC\Command\FileAccess');
$this->getBus()->push(new FilesystemCommand());
$this->assertEquals('FileAccess', self::$lastCommand);
self::$lastCommand = '';
$this->runJobs();
@ -170,10 +177,5 @@ class AsyncBusTest extends TestCase {
}
private function runJobs() {
$jobs = $this->jobList->getAll();
foreach ($jobs as $job) {
$job->execute($this->jobList);
}
}
abstract protected function runJobs();
}

50
tests/lib/Command/CronBusTest.php
Unescape View File

@ -0,0 +1,50 @@
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @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 Test\Command;
use OC\Command\CronBus;
use Test\BackgroundJob\DummyJobList;
class CronBusTest extends AsyncBusTest {
/**
* @var \OCP\BackgroundJob\IJobList
*/
private $jobList;
public function setUp() {
parent::setUp();
$this->jobList = new DummyJobList();
}
protected function createBus() {
return new CronBus($this->jobList);
}
protected function runJobs() {
$jobs = $this->jobList->getAll();
foreach ($jobs as $job) {
$job->execute($this->jobList);
}
}
}

4
tests/lib/TestCase.php
Unescape View File

@ -190,7 +190,9 @@ abstract class TestCase extends \PHPUnit_Framework_TestCase {
self::assertEquals([], $errors, "There have been xml parsing errors");
}
\OC\Files\Cache\Storage::getGlobalCache()->clearCache();
if ($this->IsDatabaseAccessAllowed()) {
\OC\Files\Cache\Storage::getGlobalCache()->clearCache();
}
// tearDown the traits
$traits = $this->getTestTraits();

Write Preview
Loading…
Cancel
Save