alicloud-observability-pts-test

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: test
分类:测试

OBSERVABILITY PTS Smoke Test

可观测性 PTS 冒烟测试

Prerequisites

前置条件

  • Configure credentials with least privilege (
    ALICLOUD_ACCESS_KEY_ID
    /
    ALICLOUD_ACCESS_KEY_SECRET
    / optional
    ALICLOUD_REGION_ID
    ) if you plan to execute real PTS APIs.
  • Target skill:
    skills/observability/pts/alicloud-observability-pts/
    .
  • Optional online SDK test dependency:
bash
python -m pip install -U alibabacloud_pts20201020 alibabacloud_tea_openapi
  • 如果你计划调用真实的PTS API,请配置最小权限凭证(
    ALICLOUD_ACCESS_KEY_ID
    /
    ALICLOUD_ACCESS_KEY_SECRET
    / 可选参数
    ALICLOUD_REGION_ID
    )。
  • 目标skill:
    skills/observability/pts/alicloud-observability-pts/
  • 可选的线上SDK测试依赖:
bash
python -m pip install -U alibabacloud_pts20201020 alibabacloud_tea_openapi

Test Steps

测试步骤

  1. Run offline script compilation check (no network needed):
bash
python3 tests/common/compile_skill_scripts.py \
  --skill-path skills/observability/pts/alicloud-observability-pts \
  --output output/alicloud-observability-pts-test/compile-check.json
  1. Run metadata API discovery script:
bash
python3 skills/observability/pts/alicloud-observability-pts/scripts/list_openapi_meta_apis.py \
  --product-code PTS \
  --version 2020-10-20 \
  --output-dir output/alicloud-observability-pts-test
  1. Verify generated files and API count:
bash
test -f output/alicloud-observability-pts-test/PTS_2020-10-20_api_docs.json
test -f output/alicloud-observability-pts-test/PTS_2020-10-20_api_list.md
rg -n "API count: [1-9][0-9]*" output/alicloud-observability-pts-test/PTS_2020-10-20_api_list.md
  1. Save request summary, response summary, and raw output under
    output/alicloud-observability-pts-test/
    .
  2. If the call fails, record exact error code/message without guessing.
  1. 运行离线脚本编译检查(无需联网):
bash
python3 tests/common/compile_skill_scripts.py \
  --skill-path skills/observability/pts/alicloud-observability-pts \
  --output output/alicloud-observability-pts-test/compile-check.json
  1. 运行元数据API发现脚本:
bash
python3 skills/observability/pts/alicloud-observability-pts/scripts/list_openapi_meta_apis.py \
  --product-code PTS \
  --version 2020-10-20 \
  --output-dir output/alicloud-observability-pts-test
  1. 验证生成的文件和API数量:
bash
test -f output/alicloud-observability-pts-test/PTS_2020-10-20_api_docs.json
test -f output/alicloud-observability-pts-test/PTS_2020-10-20_api_list.md
rg -n "API count: [1-9][0-9]*" output/alicloud-observability-pts-test/PTS_2020-10-20_api_list.md
  1. 将请求摘要、响应摘要和原始输出保存到
    output/alicloud-observability-pts-test/
    目录下。
  2. 如果调用失败,请记录准确的错误码/错误信息,不要主观猜测。

Optional Online Read-only Check

可选线上只读检查

Run one bounded read-only scene query:
bash
python3 skills/observability/pts/alicloud-observability-pts/scripts/list_pts_scenes.py \
  --region "${ALICLOUD_REGION_ID:-cn-hangzhou}" \
  --page-number 1 \
  --page-size 10 \
  --json \
  --output output/alicloud-observability-pts-test/list-scenes.json
Then verify output contains response metadata:
bash
rg -n '\"RequestId\"|\"Success\"|\"Code\"' output/alicloud-observability-pts-test/list-scenes.json
运行一条受限的只读场景查询:
bash
python3 skills/observability/pts/alicloud-observability-pts/scripts/list_pts_scenes.py \
  --region "${ALICLOUD_REGION_ID:-cn-hangzhou}" \
  --page-number 1 \
  --page-size 10 \
  --json \
  --output output/alicloud-observability-pts-test/list-scenes.json
然后验证输出包含响应元数据:
bash
rg -n '\"RequestId\"|\"Success\"|\"Code\"' output/alicloud-observability-pts-test/list-scenes.json

Pass Criteria

通过标准

  • Script compilation check passes (
    compile-check.json.status=pass
    ).
  • Metadata API discovery succeeds and produces both JSON and markdown output files.
  • API list markdown shows a positive API count.
  • Evidence files exist in
    output/alicloud-observability-pts-test/
    .
  • Optional online read-only check returns a valid PTS response structure.
  • 脚本编译检查通过(
    compile-check.json.status=pass
    )。
  • 元数据API发现执行成功,同时生成JSON和markdown输出文件。
  • API列表markdown文件显示API数量为正。
  • output/alicloud-observability-pts-test/
    目录下存在证据文件。
  • 可选的线上只读检查返回有效的PTS响应结构。

Result Template

结果模板

  • Date: YYYY-MM-DD
  • Skill: skills/observability/pts/alicloud-observability-pts
  • Conclusion: pass / fail
  • Notes:
  • 日期:YYYY-MM-DD
  • Skill:skills/observability/pts/alicloud-observability-pts
  • 结论:pass / fail
  • 备注: