mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-06 20:07:09 +00:00
Code Issues Projects Releases Wiki Activity

Convert AsyncPool tests into PHPUnit tests

Browse Source
This commit is contained in:
Dylan K. Taylor 2020-05-11 11:26:56 +01:00
parent b7cf4f01f9
commit e3dec95b75
5 changed files with 119 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
tests/phpunit/scheduler/AsyncPoolTest.php Normal file
View File

@ -0,0 +1,74 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\scheduler;
use PHPUnit\Framework\TestCase;
use pocketmine\utils\MainLogger;
use pocketmine\utils\Terminal;
use function define;
use function dirname;
use function microtime;
use function sys_get_temp_dir;
use function tempnam;
use function usleep;
class AsyncPoolTest extends TestCase{
/** @var AsyncPool */
private $pool;
/** @var MainLogger */
private $mainLogger;
public function setUp() : void{
Terminal::init();
@define('pocketmine\\COMPOSER_AUTOLOADER_PATH', dirname(__DIR__, 3) . '/vendor/autoload.php');
$this->mainLogger = new MainLogger(tempnam(sys_get_temp_dir(), "pmlog"));
$this->pool = new AsyncPool(2, 1024, new \BaseClassLoader(), $this->mainLogger);
}
public function tearDown() : void{
$this->pool->shutdown();
$this->mainLogger->shutdown();
$this->mainLogger->join();
}
public function testTaskLeak() : void{
$start = microtime(true);
$this->pool->submitTask(new LeakTestAsyncTask());
while(!LeakTestAsyncTask::$destroyed and microtime(true) < $start + 30){
usleep(50 * 1000);
$this->pool->collectTasks();
}
self::assertTrue(LeakTestAsyncTask::$destroyed, "Task was not destroyed after 30 seconds");
}
public function testPublishProgressRace() : void{
$task = new PublishProgressRaceAsyncTask();
$this->pool->submitTask($task);
while($this->pool->collectTasks()){
usleep(50 * 1000);
}
self::assertTrue(PublishProgressRaceAsyncTask::$success, "Progress was not reported before task completion");
}
}

29
tests/plugins/TesterPlugin/src/pmmp/TesterPlugin/tests/AsyncTaskMemoryLeakTest.php → tests/phpunit/scheduler/LeakTestAsyncTask.php
View File

@ -21,33 +21,12 @@
declare(strict_types=1);
namespace pmmp\TesterPlugin\tests;
namespace pocketmine\scheduler;
use pmmp\TesterPlugin\Test;
use pocketmine\scheduler\AsyncTask;
use function usleep;
class AsyncTaskMemoryLeakTest extends Test{
public function run(){
$this->getPlugin()->getServer()->getAsyncPool()->submitTask(new TestAsyncTask());
}
public function tick(){
if(TestAsyncTask::$destroyed === true){
$this->setResult(Test::RESULT_OK);
}
}
public function getName() : string{
return "AsyncTask memory leak after completion";
}
public function getDescription() : string{
return "Regression test for AsyncTasks objects not being destroyed after completion";
}
}
class TestAsyncTask extends AsyncTask{
class LeakTestAsyncTask extends AsyncTask{
/** @var bool */
public static $destroyed = false;
public function onRun() : void{

40
tests/phpunit/scheduler/PublishProgressRaceAsyncTask.php Normal file
View File

@ -0,0 +1,40 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\scheduler;
class PublishProgressRaceAsyncTask extends AsyncTask{
/** @var bool */
public static $success = false;
public function onRun() : void{
$this->publishProgress("hello");
}
public function onProgressUpdate($progress) : void{
if($progress === "hello"){
// thread local on main thread
self::$success = true;
}
}
}

5
tests/plugins/TesterPlugin/src/pmmp/TesterPlugin/Main.php
View File

@ -42,10 +42,7 @@ class Main extends PluginBase implements Listener{
$this->getServer()->getPluginManager()->registerEvents($this, $this);
$this->getScheduler()->scheduleRepeatingTask(new CheckTestCompletionTask($this), 10);
$this->waitingTests = [
new tests\AsyncTaskMemoryLeakTest($this),
new tests\AsyncTaskPublishProgressRaceTest($this)
];
$this->waitingTests = [];
}
public function onServerCommand(CommandEvent $event){

69
tests/plugins/TesterPlugin/src/pmmp/TesterPlugin/tests/AsyncTaskPublishProgressRaceTest.php
View File

@ -1,69 +0,0 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pmmp\TesterPlugin\tests;
use pmmp\TesterPlugin\Test;
use pocketmine\scheduler\AsyncTask;
class AsyncTaskPublishProgressRaceTest extends Test{
public function getName() : string{
return "Verify progress updates work as expected when finishing task";
}
public function getDescription() : string{
return "Progress updates would be lost when finishing a task before its remaining progress updates were detected.";
}
public function run() : void{
//this test is racy, but it should fail often enough to be a pest if something is broken
$this->getPlugin()->getServer()->getAsyncPool()->submitTask(new class($this) extends AsyncTask{
private const TLS_KEY_TEST = "test";
private static $success = false;
public function __construct(AsyncTaskPublishProgressRaceTest $t){
$this->storeLocal(self::TLS_KEY_TEST, $t);
}
public function onRun() : void{
$this->publishProgress("hello");
}
public function onProgressUpdate($progress) : void{
if($progress === "hello"){
// thread local on main thread
self::$success = true;
}
}
public function onCompletion() : void{
/** @var AsyncTaskPublishProgressRaceTest $t */
$t = $this->fetchLocal(self::TLS_KEY_TEST);
$t->setResult(self::$success ? Test::RESULT_OK : Test::RESULT_FAILED);
}
});
}
}