Răsfoiți Sursa

✅ (api-test): admin 用例改用单独的管理员账号,生产上只跑只读部分

- 新增 admin_username / admin_password / admin_token(config.local.php、--admin-*、API_TEST_ADMIN_*),
  没配则 SKIP,配了但无 administrator / root 角色则 FAIL;用到时才登录,失败只试一次
- admin 路由的写入用例只在 config.php 的 admin_write_servers(默认 local、staging)上跑,其余 SKIP
- 401 / 403 仍用普通测试账号

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
visuddhinanda 1 zi în urmă
părinte
comite
371c0f04d1

+ 8 - 0
api-test/README.md

@@ -88,6 +88,14 @@ php run.php --username=alice --password=secret                 # 调 /v3/session
   所以跑全量前要带 `--token=` 或 `--username/--password`。
 - **写操作在所有服务器上都真实执行**(POST 建 / DELETE 删,用垃圾 target_id,测完即删),
   包括 prod。会产生少量垃圾数据,由测试账号定期清理。
+- **管理员用例(`/v3/admin/*`)用单独的管理员账号**,不用上面的测试账号(测试账号会写垃圾数据,
+  不给它管理员权限)。在 `config.local.php` 的 `servers[alias]` 里配 `admin_username` /
+  `admin_password`(或 `admin_token`),也可以用 `--admin-username= --admin-password=` /
+  `--admin-token=` 或环境变量 `API_TEST_ADMIN_*`。没配就 SKIP;配了但账号没有
+  administrator / root 角色就 FAIL。只在跑到管理员用例时才登录。
+  - **管理员在生产上只读**:admin 路由的写入用例(POST,含 422 校验)只在 `config.php` 的
+    `admin_write_servers` 白名单(默认 `local`、`staging`)上跑,其余服务器(含 next / next-cn
+    与未登记的完整 URL)一律 SKIP。401 / 403 用例仍用普通测试账号,各服务器都跑。
 - 登录接口 `POST /v3/sessions {login, password}`:`login` 可以是用户名或邮箱;成功 201
   `{data:{token, user}}`,账号或密码不对 422。**目标服务器还没部署 v3 登录时**,
   改用 `--token=` 直接给 token(v2 / v3 签的 token 一样,可以从 v4 登录后拿)。

+ 12 - 34
api-test/cases/24_admin_credits.php

@@ -8,30 +8,12 @@ use \WikipaliApi\Model\PostApiV3AdminCreditSettlementsRequest;
  * v3 管理后台 · AI 对话积分:/v3/admin/credit-overview、credit-accounts、credit-ledger、
  * credit-adjustments、credit-settlements(仅 root / administrator)。
  *
- * 测试账号是普通用户时只测 401 / 403;是管理员时再测读、422 与写。
+ * 两个账号:401 / 403 用普通测试账号;读与写用单独配置的管理员账号(admin_token(),没配就 SKIP)。
+ * 管理员在生产上只读:写入用例(POST,含 422 校验)走 admin_write_token(),
+ * 只在 config.php 的 admin_write_servers 白名单服务器上跑。
  * 写都是幂等的:结算重复执行结果覆盖;给自己 +1 再 -1 用固定的 ref,每台服务器只入账一次、净额为 0。
  */
 
-/** 测试账号是不是管理员(看 /v3/me 的 roles) */
-function credit_admin(string $token): bool
-{
-    $me = raw('GET', '/v3/me', null, null, $token);
-    assert_status(200, $me, 'me');
-    $roles = $me['body']['data']['roles'] ?? [];
-
-    return (bool) array_intersect(['administrator', 'root'], $roles);
-}
-
-function admin_token_or_skip(): string
-{
-    $token = required_token();
-    if (! credit_admin($token)) {
-        skip('测试账号不是管理员');
-    }
-
-    return $token;
-}
-
 /* ---- 无 token → 401 ---- */
 
 test('GET /v3/admin/credit-overview(无 token)→ 401', function () {
@@ -48,11 +30,7 @@ test('POST /v3/admin/credit-settlements(无 token)→ 401', function () {
 /* ---- 普通用户 → 403 ---- */
 
 test('GET /v3/admin/credit-accounts(非管理员)→ 403', function () {
-    $token = required_token();
-    if (credit_admin($token)) {
-        skip('测试账号是管理员');
-    }
-    $res = request(fn () => api(AdminApi::class, $token)->getApiV3AdminCreditAccountsWithHttpInfo());
+    $res = request(fn () => api(AdminApi::class, required_token())->getApiV3AdminCreditAccountsWithHttpInfo());
     assert_status(403, $res, 'credit-accounts');
     assert_problem($res, 'credit-accounts');
 });
@@ -60,7 +38,7 @@ test('GET /v3/admin/credit-accounts(非管理员)→ 403', function () {
 /* ---- 管理员:读 ---- */
 
 test('GET /v3/admin/credit-overview → 200', function () {
-    $res = request(fn () => api(AdminApi::class, admin_token_or_skip())->getApiV3AdminCreditOverviewWithHttpInfo());
+    $res = request(fn () => api(AdminApi::class, admin_token())->getApiV3AdminCreditOverviewWithHttpInfo());
     assert_status(200, $res, 'credit-overview');
     foreach (['today', 'earn_since', 'policy_version', 'policy', 'totals', 'recent_days', 'last_settlement'] as $key) {
         assert_has_key($key, $res['body']['data'], 'credit-overview.data');
@@ -69,7 +47,7 @@ test('GET /v3/admin/credit-overview → 200', function () {
 });
 
 test('GET /v3/admin/credit-accounts → 200 分页', function () {
-    $res = request(fn () => api(AdminApi::class, admin_token_or_skip())->getApiV3AdminCreditAccountsWithHttpInfo(per_page: 5));
+    $res = request(fn () => api(AdminApi::class, admin_token())->getApiV3AdminCreditAccountsWithHttpInfo(per_page: 5));
     assert_status(200, $res, 'credit-accounts');
     assert_has_key('total', $res['body']['meta'], 'credit-accounts.meta');
     foreach ($res['body']['data'] as $row) {
@@ -80,17 +58,17 @@ test('GET /v3/admin/credit-accounts → 200 分页', function () {
 });
 
 test('GET /v3/admin/credit-ledger(只给 account_id)→ 422', function () {
-    $res = request(fn () => api(AdminApi::class, admin_token_or_skip())->getApiV3AdminCreditLedgerWithHttpInfo(
+    $res = request(fn () => api(AdminApi::class, admin_token())->getApiV3AdminCreditLedgerWithHttpInfo(
         filter_account_id: '00000000-0000-4000-8000-000000000000',
     ));
     assert_status(422, $res, 'credit-ledger');
     assert_field_error('filter.account_type', $res, 'credit-ledger');
 });
 
-/* ---- 管理员:写(幂等) ---- */
+/* ---- 管理员:写(幂等;只在 admin_write_servers 上跑) ---- */
 
 test('POST /v3/admin/credit-settlements → 201(可重复执行)', function () {
-    $res = request(fn () => api(AdminApi::class, admin_token_or_skip())->postApiV3AdminCreditSettlementsWithHttpInfo(
+    $res = request(fn () => api(AdminApi::class, admin_write_token())->postApiV3AdminCreditSettlementsWithHttpInfo(
         new PostApiV3AdminCreditSettlementsRequest(),
     ));
     assert_status(201, $res, 'credit-settlements');
@@ -100,13 +78,13 @@ test('POST /v3/admin/credit-settlements → 201(可重复执行)', function
 test('POST /v3/admin/credit-settlements(未来日期)→ 422', function () {
     $body = new PostApiV3AdminCreditSettlementsRequest();
     $body->setDate(gmdate('Y-m-d', time() + 86400 * 2));
-    $res = request(fn () => api(AdminApi::class, admin_token_or_skip())->postApiV3AdminCreditSettlementsWithHttpInfo($body));
+    $res = request(fn () => api(AdminApi::class, admin_write_token())->postApiV3AdminCreditSettlementsWithHttpInfo($body));
     assert_status(422, $res, 'credit-settlements');
     assert_field_error('date', $res, 'credit-settlements');
 });
 
 test('POST /v3/admin/credit-adjustments:给自己 +1 再 -1(固定 ref,只入账一次)', function () {
-    $token = admin_token_or_skip();
+    $token = admin_write_token();
     $me = raw('GET', '/v3/me', null, null, $token);
     assert_status(200, $me, 'me');
     $me = $me['body']['data']['id'];
@@ -129,7 +107,7 @@ test('POST /v3/admin/credit-adjustments(delta 为 0、缺原因)→ 422', fu
     $body->setUser('nobody');
     $body->setDelta(0);
     $body->setNote('');
-    $res = request(fn () => api(AdminApi::class, admin_token_or_skip())->postApiV3AdminCreditAdjustmentsWithHttpInfo($body));
+    $res = request(fn () => api(AdminApi::class, admin_write_token())->postApiV3AdminCreditAdjustmentsWithHttpInfo($body));
     assert_status(422, $res, 'credit-adjustments');
     assert_field_error('delta', $res, 'credit-adjustments');
 });

+ 7 - 0
api-test/config.local.example.php

@@ -20,6 +20,11 @@ $servers = [
         'username' => 'test',
         'password' => null,
         'token' => null,                       // 填了就直接用,跳过登录
+        // 管理员账号:只给 /v3/admin/* 用例用,与上面的测试账号分开;不配则 SKIP。
+        // 生产上只跑只读用例,写入用例只在 config.php 的 admin_write_servers 上跑。
+        'admin_username' => null,
+        'admin_password' => null,
+        'admin_token' => null,
         'fixtures' => [
             // 讨论写用例挂的句子:必须在测试账号自己的 channel 里、由测试账号编辑过
             // 'discussion_sentence' => 'ee5259be-5d1e-4408-a2a6-566a5773eef1',
@@ -61,6 +66,8 @@ $servers = [
     'next-cn' => [
         'username' => null,
         'password' => null,
+        'admin_username' => null,
+        'admin_password' => null,
         'token' => null,
         'fixtures' => [],
     ],

+ 13 - 0
api-test/config.php

@@ -26,6 +26,13 @@
  *
  * 写操作(POST/DELETE)在**所有服务器上都真实执行**,包括 prod——会产生垃圾数据,
  * 由测试账号定期清理。
+ *
+ * 管理员账号(/v3/admin/* 用例专用,与上面的测试账号分开):
+ *   admin_token > admin_username/admin_password 现登录;来源优先级同上
+ *   (--admin-token / --admin-username / --admin-password > API_TEST_ADMIN_* > servers[alias])。
+ *   没配就 SKIP 管理员用例。只在用到时才登录,不占测试账号的登录限流。
+ *   管理员**只读**;admin 路由的写入用例只在 `admin_write_servers` 里的服务器上跑,
+ *   其余(生产、生产预览、未登记的完整 URL)一律 SKIP。
  */
 
 $local = is_file(__DIR__ . '/config.local.php') ? require __DIR__ . '/config.local.php' : [];
@@ -47,10 +54,16 @@ return [
     'username' => $local['username'] ?? null,
     'password' => $local['password'] ?? null,
     'fixtures' => $local['fixtures'] ?? [],
+    'admin_token' => $local['admin_token'] ?? null,
+    'admin_username' => $local['admin_username'] ?? null,
+    'admin_password' => $local['admin_password'] ?? null,
 
     // 新分组结构:per-server 配置块(username/password/token/fixtures),
     // run.php 解析出实际 server 后从这里选对应那套。
     'local_servers' => $local['servers'] ?? null,
 
+    // 允许跑 admin 路由写入用例的服务器(白名单,按 alias)。不在这里的一律只读。
+    'admin_write_servers' => ['local', 'staging'],
+
     'timeout' => 20,
 ];

+ 15 - 1
api-test/run.php

@@ -4,7 +4,8 @@
  * api-test 入口:装配配置 → 加载用例 → 运行 → 报告。
  *
  * 用法:
- *   php run.php [--server=<alias|URL>] [--token=<bearer>] [--username=<u> --password=<p>] [--filter=<子串>] [--list]
+ *   php run.php [--server=<alias|URL>] [--token=<bearer>] [--username=<u> --password=<p>]
+ *               [--admin-token=<bearer>] [--admin-username=<u> --admin-password=<p>] [--filter=<子串>] [--list]
  *
  * 例:
  *   php run.php                          # 默认 local
@@ -72,12 +73,19 @@ if (is_array($localServers) && $serverKey !== null && isset($localServers[$serve
     $config['username'] = $block['username'] ?? $config['username'];
     $config['password'] = $block['password'] ?? $config['password'];
     $config['fixtures'] = $block['fixtures'] ?? $config['fixtures'];
+    foreach (['admin_token', 'admin_username', 'admin_password'] as $key) {
+        $config[$key] = $block[$key] ?? $config[$key];
+    }
 }
+$config['server_key'] = $serverKey;
 
 // 环境变量覆盖(高于 config.local.php,低于命令行)
 $config['token'] = getenv('API_TEST_TOKEN') ?: $config['token'];
 $config['username'] = getenv('API_TEST_USERNAME') ?: $config['username'];
 $config['password'] = getenv('API_TEST_PASSWORD') ?: $config['password'];
+$config['admin_token'] = getenv('API_TEST_ADMIN_TOKEN') ?: $config['admin_token'];
+$config['admin_username'] = getenv('API_TEST_ADMIN_USERNAME') ?: $config['admin_username'];
+$config['admin_password'] = getenv('API_TEST_ADMIN_PASSWORD') ?: $config['admin_password'];
 
 // 命令行覆盖(最高优先级)
 if (is_string($opts['token'] ?? null) && $opts['token'] !== '') {
@@ -89,6 +97,12 @@ if (is_string($opts['username'] ?? null) && $opts['username'] !== '') {
 if (is_string($opts['password'] ?? null) && $opts['password'] !== '') {
     $config['password'] = $opts['password'];
 }
+foreach (['admin_token', 'admin_username', 'admin_password'] as $key) {
+    $flag = str_replace('_', '-', $key);
+    if (is_string($opts[$flag] ?? null) && $opts[$flag] !== '') {
+        $config[$key] = $opts[$flag];
+    }
+}
 
 $GLOBALS['config'] = $config;
 $GLOBALS['fixtures'] = array_replace(require __DIR__ . '/fixtures.php', $config['fixtures']);

+ 55 - 0
api-test/src/bootstrap.php

@@ -164,6 +164,61 @@ function required_token(): string
     return $token;
 }
 
+/**
+ * 取管理员 token(/v3/admin/* 用例专用,与测试账号分开)。
+ * 没配管理员账号 → SKIP;配了但登录不上、或 /v3/me 的 roles 里没有 administrator / root → FAIL。
+ * 第一次调用时才登录,结果缓存到本次运行结束。
+ */
+function admin_token(): string
+{
+    static $token = null, $error = null;
+    if ($token !== null) {
+        return $token;
+    }
+    if ($error !== null) {
+        throw $error;   // 登录失败只试一次,免得每条用例都去撞登录限流
+    }
+    try {
+        return $token = resolve_admin_token();
+    } catch (Fail|Skip $e) {
+        throw $error = $e;
+    }
+}
+
+function resolve_admin_token(): string
+{
+    $cfg = config();
+    $candidate = $cfg['admin_token'] ?? null;
+    if (! $candidate) {
+        if (! ($cfg['admin_username'] ?? null) || ! ($cfg['admin_password'] ?? null)) {
+            skip('没配管理员账号(admin_username/admin_password 或 admin_token)');
+        }
+        $candidate = login($cfg['admin_username'], $cfg['admin_password']);
+    }
+    $me = raw('GET', '/v3/me', null, null, $candidate);
+    assert_status(200, $me, '管理员账号 /v3/me');
+    $roles = $me['body']['data']['roles'] ?? [];
+    if (! array_intersect(['administrator', 'root'], $roles)) {
+        fail('配置的管理员账号没有 administrator / root 角色');
+    }
+
+    return $candidate;
+}
+
+/**
+ * 取管理员 token,用于 admin 路由的写入用例。
+ * 目标服务器不在 config.php 的 admin_write_servers 白名单里(生产等)→ SKIP,管理员在那里只读。
+ */
+function admin_write_token(): string
+{
+    $cfg = config();
+    if (! in_array($cfg['server_key'] ?? null, $cfg['admin_write_servers'] ?? [], true)) {
+        skip('该服务器禁止 admin 写入(只在 ' . implode(' / ', $cfg['admin_write_servers'] ?? []) . ' 上跑)');
+    }
+
+    return admin_token();
+}
+
 /* ---- 断言 ---- */
 
 function assert_status(int $expected, array $res, string $what): void