ThinkAdmin/plugin/think-plugs-system/tests/QueueControllerTest.php
邹景立 11377b6761 style(queue): 完善队列进度展示
队列执行弹窗增加状态点、进度文字、任务状态标记和更大的日志面板,并对日志内容进行 HTML 转义,避免任务输出影响页面结构。

优化进度条和日志区域样式,支持成功、执行中和失败状态的不同视觉反馈,同时保留自动滚动查看最新日志。

为队列表格时间与耗时格式化增加前端兜底函数,修正脚本中转义后的  变量输出,并更新测试确保生成脚本可直接执行。
2026-05-21 00:17:01 +08:00

327 lines
13 KiB
PHP

<?php
declare(strict_types=1);
/**
* +----------------------------------------------------------------------
* | ThinkAdmin Plugin
* +----------------------------------------------------------------------
* | Copyright (c) 2014~2026 ThinkAdmin [ thinkadmin.top ]
* +----------------------------------------------------------------------
* | Official Website: https://thinkadmin.top
* +----------------------------------------------------------------------
* | Licensed: https://mit-license.org
* | Disclaimer: https://thinkadmin.top/disclaimer
* | Vip Rights: https://thinkadmin.top/vip-introduce
* +----------------------------------------------------------------------
* | Gitee Repository: https://gitee.com/zoujingli/ThinkAdmin
* | Github Repository: https://github.com/zoujingli/ThinkAdmin
* +----------------------------------------------------------------------
*/
namespace think\admin\tests;
use plugin\system\controller\Queue as QueueController;
use plugin\system\service\LangService;
use plugin\worker\model\SystemQueue;
use plugin\worker\service\ProcessService;
use plugin\worker\service\QueueService;
use think\admin\runtime\RequestContext;
use think\admin\service\QueueService as QueueRuntime;
use think\admin\tests\Support\SqliteIntegrationTestCase;
use think\exception\HttpResponseException;
use think\Request;
/**
* @internal
* @coversNothing
*/
class QueueControllerTest extends SqliteIntegrationTestCase
{
public function testIndexGetRendersPageBuilderMarkup(): void
{
$html = $this->callActionHtml('index');
$this->assertStringContainsString('page-builder-schema', $html);
$this->assertStringContainsString('id="QueueTable"', $html);
$this->assertStringContainsString('class="layui-tab-content"', $html);
$this->assertStringContainsString('系统任务', $html);
$this->assertStringContainsString('data-line="2"', $html);
$this->assertStringContainsString('class="mt10"', $html);
$this->assertStringContainsString('data-queue-message', $html);
$this->assertStringContainsString('批量删除', $html);
$this->assertStringContainsString('const queueStatusUrl = "/api/system/queue/status.html";', $html);
$this->assertStringContainsString('const queueStatusEnabled = false;', $html);
$this->assertStringContainsString('const $queueMessage = $(\'[data-queue-message]\');', $html);
$this->assertStringContainsString('formatQueueTimeSafe', $html);
$this->assertStringNotContainsString('const \\$queueMessage', $html);
$this->assertStringNotContainsString('{$queueStatusUrl}', $html);
$this->assertStringNotContainsString('{$enabled}', $html);
}
public function testIndexRendersEnglishTextsWhenLangSetIsEnUs(): void
{
$this->switchSystemLang('en-us');
$html = $this->callActionHtml('index');
$this->assertStringContainsString('Task Management', $html);
$this->assertStringContainsString('Tasks', $html);
$this->assertStringContainsString('Total', $html);
$this->assertStringContainsString('Pending', $html);
$this->assertStringContainsString('Checking', $html);
$this->assertStringContainsString('Reset', $html);
$this->assertStringContainsString('Log', $html);
$this->assertStringNotContainsString('检查中', $html);
}
public function testIndexFiltersQueueRowsAndBuildsStatusSummary(): void
{
$this->createSystemQueueFixture([
'code' => 'QHIT000000000001',
'title' => '命中任务',
'command' => 'xadmin:test queue --hit',
'status' => 1,
'loops_time' => 0,
'create_time' => '2026-03-10 08:00:00',
]);
$this->createSystemQueueFixture([
'code' => 'QLOCK00000000001',
'title' => '执行任务',
'command' => 'xadmin:test queue --run',
'status' => 2,
'loops_time' => 30,
'create_time' => '2026-03-10 09:00:00',
]);
$this->createSystemQueueFixture([
'code' => 'QDONE00000000001',
'title' => '完成任务',
'command' => 'xadmin:test queue --done',
'status' => 3,
'loops_time' => 0,
'create_time' => '2026-03-10 10:00:00',
]);
$this->createSystemQueueFixture([
'code' => 'QERR000000000001',
'title' => '失败任务',
'command' => 'xadmin:test queue --error',
'status' => 4,
'loops_time' => 0,
'create_time' => '2026-03-10 11:00:00',
]);
$this->createSystemQueueFixture([
'code' => 'QOLD000000000001',
'title' => '跨日任务',
'command' => 'xadmin:test queue --old',
'status' => 1,
'loops_time' => 0,
'create_time' => '2026-03-09 08:00:00',
]);
$result = $this->callIndexController([
'output' => 'json',
'status' => 1,
'title' => '命中',
'create_time' => '2026-03-10 - 2026-03-10',
'_field_' => 'id',
'_order_' => 'asc',
'page' => 1,
'limit' => 20,
]);
$this->assertSame(200, intval($result['code'] ?? 0));
$this->assertSame('JSON-DATA', $result['info'] ?? '');
$this->assertSame(1, intval($result['data']['page']['total'] ?? 0));
$this->assertCount(1, $result['data']['list'] ?? []);
$this->assertSame('QHIT000000000001', $result['data']['list'][0]['code'] ?? '');
$this->assertSame(2, intval($result['data']['extra']['pre'] ?? 0));
$this->assertSame(1, intval($result['data']['extra']['dos'] ?? 0));
$this->assertSame(1, intval($result['data']['extra']['oks'] ?? 0));
$this->assertSame(1, intval($result['data']['extra']['ers'] ?? 0));
}
public function testIndexPaginatesQueuesAndFallsBackToDefaultLimit(): void
{
for ($i = 1; $i <= 21; ++$i) {
$this->createSystemQueueFixture([
'code' => sprintf('QPAGE%011d', $i),
'title' => sprintf('分页任务-%02d', $i),
'command' => sprintf('xadmin:test queue --page=%02d', $i),
'status' => 1,
'create_time' => sprintf('2026-03-10 08:%02d:00', $i % 60),
]);
}
$result = $this->callIndexController([
'output' => 'json',
'status' => 1,
'_field_' => 'id',
'_order_' => 'asc',
'page' => 2,
'limit' => 999,
]);
$this->assertSame(200, intval($result['code'] ?? 0));
$this->assertSame('JSON-DATA', $result['info'] ?? '');
$this->assertSame(21, intval($result['data']['page']['total'] ?? 0));
$this->assertSame(2, intval($result['data']['page']['pages'] ?? 0));
$this->assertSame(2, intval($result['data']['page']['current'] ?? 0));
$this->assertSame(20, intval($result['data']['page']['limit'] ?? 0));
$this->assertCount(1, $result['data']['list'] ?? []);
$this->assertSame('分页任务-21', $result['data']['list'][0]['title'] ?? '');
}
public function testRedoResetsFinishedQueueToWaitingState(): void
{
$queue = $this->createSystemQueueFixture([
'code' => 'QREDO00000000001',
'status' => 4,
'exec_pid' => 12345,
'exec_time' => time() - 300,
'attempts' => 2,
'message' => '旧执行日志',
'exec_desc' => '旧失败结果',
]);
$before = time();
$result = $this->callActionController('redo', [
'code' => 'QREDO00000000001',
]);
$afterQueue = SystemQueue::mk()->where(['id' => $queue->getAttr('id')])->findOrEmpty();
$this->assertSame(200, intval($result['code'] ?? 0));
$this->assertSame('任务重置成功!', $result['info'] ?? '');
$this->assertSame('QREDO00000000001', $result['data'] ?? '');
$this->assertSame(1, intval($afterQueue->getAttr('status')));
$this->assertSame(0, intval($afterQueue->getAttr('exec_pid')));
$this->assertGreaterThanOrEqual($before, intval(SystemQueue::mk()->where(['id' => $queue->getAttr('id')])->value('exec_time')));
}
public function testCleanRegistersScheduledCleanupQueue(): void
{
$result = $this->callActionController('clean');
$queue = SystemQueue::mk()->where(['title' => '定时清理系统运行数据'])->findOrEmpty();
$this->assertSame(200, intval($result['code'] ?? 0));
$this->assertSame('创建任务成功!', $result['info'] ?? '');
$this->assertTrue($queue->isExists());
$this->assertSame('xadmin:queue clean', $queue->getAttr('command'));
$this->assertSame(3600, intval($queue->getAttr('loops_time')));
$this->assertSame($queue->getAttr('code'), $result['data'] ?? '');
}
public function testRemoveDeletesSelectedQueues(): void
{
$first = $this->createSystemQueueFixture(['code' => 'QREMOVE000000001']);
$second = $this->createSystemQueueFixture(['code' => 'QREMOVE000000002']);
$keep = $this->createSystemQueueFixture(['code' => 'QREMOVE000000003']);
$result = $this->callActionController('remove', [
'id' => $first->getAttr('id') . ',' . $second->getAttr('id'),
]);
$this->assertSame(200, intval($result['code'] ?? 0));
$this->assertSame('数据删除成功!', $result['info'] ?? '');
$this->assertSame(0, SystemQueue::mk()->whereIn('id', [$first->getAttr('id'), $second->getAttr('id')])->count());
$this->assertTrue(SystemQueue::mk()->where(['id' => $keep->getAttr('id')])->findOrEmpty()->isExists());
}
protected function defineSchema(): void
{
$this->createSystemQueueTable();
}
protected function afterSchemaCreated(): void
{
$this->app->bind([
ProcessService::BIND_NAME => ProcessService::class,
QueueRuntime::BIND_NAME => QueueService::class,
]);
}
private function callIndexController(array $query): array
{
$request = (new Request())
->withGet($query)
->setMethod('GET')
->setController('queue')
->setAction('index');
$this->bindAdminUser();
$this->setRequestPayload($request, $query);
$this->activateApplicationContext($request);
try {
$controller = new QueueController($this->app);
$controller->index();
self::fail('Expected QueueController::index to throw HttpResponseException.');
} catch (HttpResponseException $exception) {
return json_decode($exception->getResponse()->getContent(), true) ?: [];
}
}
private function callActionController(string $action, array $post = []): array
{
$request = (new Request())
->withGet($post)
->withPost($post)
->setMethod('POST')
->setController('queue')
->setAction($action);
$this->bindAdminUser();
$this->setRequestPayload($request, $post);
$this->activateApplicationContext($request);
try {
$controller = new QueueController($this->app);
$controller->{$action}();
self::fail("Expected QueueController::{$action} to throw HttpResponseException.");
} catch (HttpResponseException $exception) {
return json_decode($exception->getResponse()->getContent(), true) ?: [];
}
}
private function callActionHtml(string $action, array $query = []): string
{
$request = (new Request())
->withGet($query)
->setMethod('GET')
->setController('queue')
->setAction($action);
$this->bindAdminUser();
$this->setRequestPayload($request, $query);
$this->app->instance('request', $request);
try {
$controller = new QueueController($this->app);
$controller->{$action}();
self::fail("Expected QueueController::{$action} to throw HttpResponseException.");
} catch (HttpResponseException $exception) {
return $exception->getResponse()->getContent();
}
}
private function bindAdminUser(): void
{
RequestContext::instance()->setAuth([
'id' => 9101,
'username' => 'tester',
], '', true);
}
private function setRequestPayload(Request $request, array $data): void
{
$property = new \ReflectionProperty(Request::class, 'request');
$property->setAccessible(true);
$property->setValue($request, $data);
}
private function switchSystemLang(string $langSet): void
{
$this->app->lang->switchLangSet($langSet);
LangService::load($this->app, $langSet);
}
}