+ [misc] Add unit tests for gitlabZen::recordWebhookLogs() method

🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-12 08:25:47 +08:00
parent fa207151d3
commit 5c0e91d04b
2 changed files with 133 additions and 0 deletions
@@ -285,4 +285,54 @@ class gitlabZenTest extends baseTest
        if(dao::isError()) return dao::getError();
        return $result;
    }
+
+    /**
+     * Test recordWebhookLogs method.
+     *
+     * @param  string $input
+     * @param  object $result
+     * @access public
+     * @return string|bool
+     */
+    public function recordWebhookLogsTest(string $input, object $result)
+    {
+        global $app;
+
+        /* 加载 control 和 zen 类 */
+        if(!class_exists('gitlab')) require_once $app->getModulePath('', 'gitlab') . 'control.php';
+        if(!class_exists('gitlabZen')) require_once $app->getModulePath('', 'gitlab') . 'zen.php';
+
+        /* 使用反射创建 gitlabZen 实例并初始化 */
+        $reflection = new ReflectionClass('gitlabZen');
+        $zenInstance = $reflection->newInstanceWithoutConstructor();
+        $zenInstance->app = $app;
+        $zenInstance->config = $app->config;
+        $zenInstance->lang = $app->lang;
+        $zenInstance->dao = $app->loadClass('dao');
+
+        /* 通过反射调用 recordWebhookLogs 方法 */
+        $method = $reflection->getMethod('recordWebhookLogs');
+        $method->setAccessible(true);
+
+        /* 获取日志文件路径 */
+        $logFile = $app->getLogRoot() . 'webhook.' . date('Ymd') . '.log.php';
+
+        /* 删除已存在的日志文件,确保测试环境干净 */
+        if(file_exists($logFile)) unlink($logFile);
+
+        /* 调用 zen 方法 */
+        $method->invoke($zenInstance, $input, $result);
+
+        /* 验证日志文件是否创建 */
+        if(!file_exists($logFile)) return 'file_not_created';
+
+        /* 读取日志文件内容 */
+        $logContent = file_get_contents($logFile);
+
+        /* 清理测试日志文件 */
+        unlink($logFile);
+
+        /* 返回日志内容用于验证 */
+        return $logContent;
+    }
 }
@@ -0,0 +1,83 @@
+#!/usr/bin/env php
+<?php
+
+/**
+
+title=测试 gitlabZen::recordWebhookLogs();
+timeout=0
+cid=0
+
+- 测试记录包含issue信息的webhook日志,验证文件包含JSON字符串 @1
+- 测试记录包含bug对象类型的webhook日志,验证文件包含对象类型 @1
+- 测试记录包含story对象类型的webhook日志,验证文件包含对象类型 @1
+- 测试记录包含task对象类型的webhook日志,验证文件包含对象类型 @1
+- 测试记录空JSON内容的webhook日志,验证文件正常创建 @1
+- 测试记录带有特殊字符的webhook日志,验证文件正常处理 @1
+- 测试验证日志文件包含PHP安全头,防止直接访问 @1
+
+*/
+
+include dirname(__FILE__, 5) . '/test/lib/init.php';
+include dirname(__FILE__, 2) . '/lib/zen.class.php';
+
+su('admin');
+
+/* 设置 methodName 避免 gitlab 控制器构造函数报错 */
+global $app;
+$app->setMethodName('test');
+
+$gitlabTest = new gitlabZenTest();
+
+/* 准备测试数据:创建包含issue信息的result对象 */
+$result1 = new stdclass;
+$result1->issue = new stdclass;
+$result1->issue->objectType = 'bug';
+$result1->object = new stdclass;
+$result1->object->id = 123;
+$result1->object->title = 'Test Bug';
+
+$result2 = new stdclass;
+$result2->issue = new stdclass;
+$result2->issue->objectType = 'bug';
+$result2->object = new stdclass;
+$result2->object->id = 456;
+$result2->object->title = 'Bug Report';
+
+$result3 = new stdclass;
+$result3->issue = new stdclass;
+$result3->issue->objectType = 'story';
+$result3->object = new stdclass;
+$result3->object->id = 789;
+$result3->object->title = 'User Story';
+
+$result4 = new stdclass;
+$result4->issue = new stdclass;
+$result4->issue->objectType = 'task';
+$result4->object = new stdclass;
+$result4->object->id = 101;
+$result4->object->title = 'Development Task';
+
+$result5 = new stdclass;
+$result5->issue = new stdclass;
+$result5->issue->objectType = 'bug';
+$result5->object = new stdclass;
+
+$result6 = new stdclass;
+$result6->issue = new stdclass;
+$result6->issue->objectType = 'bug';
+$result6->object = new stdclass;
+$result6->object->title = 'Special <>&"\'';
+
+$result7 = new stdclass;
+$result7->issue = new stdclass;
+$result7->issue->objectType = 'story';
+$result7->object = new stdclass;
+$result7->object->id = 999;
+
+r(strpos($gitlabTest->recordWebhookLogsTest('{"event":"issue","action":"open"}', $result1), '{"event":"issue","action":"open"}') !== false) && p() && e('1'); // 测试记录包含issue信息的webhook日志,验证文件包含JSON字符串
+r(strpos($gitlabTest->recordWebhookLogsTest('{"id":456}', $result2), 'bug') !== false) && p() && e('1'); // 测试记录包含bug对象类型的webhook日志,验证文件包含对象类型
+r(strpos($gitlabTest->recordWebhookLogsTest('{"id":789}', $result3), 'story') !== false) && p() && e('1'); // 测试记录包含story对象类型的webhook日志,验证文件包含对象类型
+r(strpos($gitlabTest->recordWebhookLogsTest('{"id":101}', $result4), 'task') !== false) && p() && e('1'); // 测试记录包含task对象类型的webhook日志,验证文件包含对象类型
+r(strpos($gitlabTest->recordWebhookLogsTest('{}', $result5), '{}') !== false) && p() && e('1'); // 测试记录空JSON内容的webhook日志,验证文件正常创建
+r(strpos($gitlabTest->recordWebhookLogsTest('{"title":"test"}', $result6), 'Special') !== false) && p() && e('1'); // 测试记录带有特殊字符的webhook日志,验证文件正常处理
+r(strpos($gitlabTest->recordWebhookLogsTest('{"test":"data"}', $result7), '<?php die(); ?>') !== false) && p() && e('1'); // 测试验证日志文件包含PHP安全头,防止直接访问