Skip to content

[drivers][adc] test: add a framework testcase with a simulated device - #11974

Open
Yunlk wants to merge 1 commit into
RT-Thread:masterfrom
Yunlk:test/adc-framework-utest
Open

Yunlk wants to merge 1 commit into
RT-Thread:masterfrom
Yunlk:test/adc-framework-utest

Conversation

@Yunlk

@Yunlk Yunlk commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

拉取/合并请求描述:(PR description)

[

为什么提交这份PR (why to submit this PR)

#11972 的清单里 ADC 是 utest 与 QEMU 双空的一项。按 issue 描述的思路("注册好虚拟的 ops,仿造一个模拟设备,把接口入参都测试完整"),先补 utest 这一半——本 PR 不需要任何硬件,也不需要 QEMU 外设模型。

你的解决方案是什么 (what is your solution)

新增 components/drivers/adc/utest/adc_tc.c,用例内注册一个模拟 rt_adc_device,覆盖五个单元:

单元 覆盖点
adc_tc_register_test 设备类为 RT_Device_Class_ADC、ops 指针、按名字查找
adc_tc_enable_disable_test enabled() 收到的 channel 与标志正确,次数可控
adc_tc_read_test rt_adc_read() 返回原始值;convert() 失败时返回 0 而不是旧值
adc_tc_voltage_test 按分辨率与 vref 换算;每次调用恰好 enable / convert / disable 各一次
adc_tc_missing_hooks_test 驱动未提供 enabled() 时返回 -RT_ENOSYS

配置项为 RT_UTEST_ADC(depends on RT_USING_ADC),同时给 adc/SConscript 补上子目录遍历,与 rtc/、spi/ 的既有写法一致。

关于断言设计的一个坑

期望毫伏值写死为常量,不在测试里按同一公式重算:

#define ADC_TC_EXPECTED_MV   805     /* 1000 * 3300 / ((1 << 12) - 1) = 805.8 */

最初我是用 value * vref / ((1 << resolution) - 1) 在测试里自己算期望值的,结果故意把被测公式改错(- 1 改成 - 2)后测试依然通过——因为两边用同一个错的公式,一起错。这一点值得强调:测不出错误的用例等于没写。

改成写死常量后,还发现取值也有讲究:raw = 2048 时 /4095 和 /4094 恰好都得 1650,注入错误仍然过;换成 raw = 1000 才有区分(805 vs 806)。

请提供验证的bsp和config (provide the config and bsp)

  • BSP: bsp/qemu-vexpress-a9
  • .config: RT_USING_ADC=y(走 RT_USING_ADC_V1)、RT_UTEST_ADC=y、RT_UTEST_USING_AUTO_RUN=y
  • action: 未使用 GitHub Actions;本地 QEMU 11.0.0 + arm-none-eabi-gcc 15.2.1,master 1c801efa

正常构建:

[I/utest] [----------] [ testcase ] (components.drivers.adc.framework) started
[I/utest] [==========] utest unit name: (adc_tc_register_test)
[I/utest] [==========] utest unit name: (adc_tc_enable_disable_test)
[I/utest] [==========] utest unit name: (adc_tc_read_test)
[I/utest] [==========] utest unit name: (adc_tc_voltage_test)
[I/utest] [==========] utest unit name: (adc_tc_missing_hooks_test)
[I/utest] [  PASSED  ] [ result   ] testcase (components.drivers.adc.framework)

注入错误(把除法分母改成 - 2)后,如预期失败:

[E/utest] at (adc_tc.c); func: (adc_tc_voltage_test:201);
          msg: ((rt_adc_voltage(dev, 3)) not == (805))

尚未覆盖

  • QEMU 侧:本 PR 只补 utest,没有新增 QEMU 虚拟 ADC 设备。清单里 QEMU 那一栏仍为空。
  • rt_adc_voltage() 里 get_resolution / get_vref / enabled 是直接调用、没有 NULL 判断(对比 rt_adc_enable() 有判断)。驱动若只实现 convert,这三个回调缺失就会空指针。我在 adc_tc_missing_hooks_test 里只覆盖了 rt_adc_enable()/disable() 的 -RT_ENOSYS 路径,没有去调用 rt_adc_voltage(),因为那会崩溃。这个缺口是否要单独修,请维护者判断。

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用clang-format 源码格式化工具确保格式符合RT-Thread代码规范 This PR has been formatted with clang-format and complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

Part of RT-Thread#11972. ADC had neither a utest nor a simulated device, so the framework
was never exercised in CI.

The testcase registers its own simulated rt_adc_device, so no hardware and no
QEMU peripheral model is required, and covers:

  adc_tc_register_test        device class, ops pointer, name lookup
  adc_tc_enable_disable_test  enabled() receives the right channel and flag
  adc_tc_read_test            rt_adc_read() returns the raw value, and 0 when
                              convert() fails instead of a stale value
  adc_tc_voltage_test         scaling by resolution and vref, plus exactly one
                              enable / convert / disable per call
  adc_tc_missing_hooks_test   -RT_ENOSYS when the optional enabled() hook is absent

The expected millivolt value is hardcoded rather than recomputed in the test:
recomputing it with the same formula as the code under test would keep passing
even when the formula is wrong. Verified by injecting a deliberate error
(/ ((1 << res) - 2) instead of - 1): with raw = 2048 that mutation is invisible
because both give 1650, so the case uses raw = 1000, where 805 and 806 differ.
With the mutation in place the test fails as intended:

  [E/utest] at (adc_tc.c); func: (adc_tc_voltage_test:201);
            msg: ((rt_adc_voltage(dev, 3)) not == (805))

Verified on bsp/qemu-vexpress-a9 with RT_UTEST_ADC + RT_UTEST_USING_AUTO_RUN:

  [I/utest] utest unit name: (adc_tc_register_test)
  ...
  [I/utest] utest unit name: (adc_tc_missing_hooks_test)
  [I/utest] [  PASSED  ] testcase (components.drivers.adc.framework)

adc/SConscript gains the usual sub-directory traversal so that utest/ is picked
up, matching what rtc/ and spi/ already do.

Refs RT-Thread#11972
@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • Use workflow from 保持默认分支(通常为 master)
    Keep the default branch (usually master) in Use workflow from
  • 在 branch 输入框填写 PR 分支 test/adc-framework-utest
    Enter PR branch test/adc-framework-utest in the branch field
  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将作为独立提交推送至你的分支。
    The formatting changes will be pushed to your branch as a separate commit.

完成后,提交将自动更新至 test/adc-framework-utest 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the test/adc-framework-utest branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: @Maihuanyi

Changed Files (Click to expand)
  • components/drivers/adc/SConscript
  • components/drivers/adc/utest/Kconfig
  • components/drivers/adc/utest/SConscript
  • components/drivers/adc/utest/adc_tc.c
  • components/utilities/utest/Kconfig

📊 Current Review Status (Last Updated: 2026-11-02 16:09 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant