godotengine/godot

[TRACKER] Unit tests to add or improve

Open

#43,440 创建于 2020年11月10日

在 GitHub 查看
 (254 评论) (52 反应) (0 负责人)C++ (110,708 star) (25,320 fork)batch import
good first issuetopic:teststracker

描述

Our unit test coverage is currently fairly low. We'd like to increase our unit test coverage; any help is welcome.

Interested in writing new unit tests? See the unit tests documentation and compiling instructions. If you have further questions, join the Godot Contributors Chat.

When opening a pull request, please link back to this issue (#43440) in the PR description so that we can keep track of it more easily.

If you have the appropriate permissions, feel free to edit this issue to add new items or check items for which a PR has been opened.

Classes to test

These classes are currently lacking in test coverage, and are therefore highest-priority for receiving unit tests. Deprecated classes are not listed.

[!NOTE]

When a class is listed with "and" along a given list item, it should be submitted in the same pull request whenever possible. Tests for these classes can be in the same file or a different file depending on the size and complexity of the test suite. If in doubt, follow the file organization used in the original class implementation.

Completed classes

These classes currently have good test coverage. Further improvements may be possible by testing methods that were added after the tests were merged.

Non-testable classes

These classes can't be unit-tested for technical reasons. Unit tests always run in headless mode, so they can't do things such as rendering scenes and checking the visual result.

  • CubeMap: Not testable without RenderingServer access.
  • Shader: Not testable without RenderingServer access.
  • VisibleOnScreenNotifier2D: Not testable without RenderingServer access.
  • VisibleOnScreenNotifier3D: Not testable without RenderingServer access.

贡献者指南

技术栈
cpp
领域
testing
议题类型
test
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
C++Godot unit testing framework
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
The issue is a tracker for adding unit tests to Godot classes. All originally listed classes have been completed, but improvements can be made by testing newly added methods or choosing classes not listed. Newcomers should consult the unit testing documentation at https://docs.godotengine.org/en/latest/development/cpp/unit testing.html and compile the engine. They can pick any class that lacks coverage, especially those in the 'Completed classes' section that may need updates for recent changes.