godotengine/godot

[TRACKER] Unit tests to add or improve

Open

#43,440 opened on Nov 10, 2020

View on GitHub
 (254 comments) (52 reactions) (0 assignees)C++ (110,708 stars) (25,320 forks)batch import
good first issuetopic:teststracker

Description

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.

Contributor guide

Tech stack
cpp
Domain
testing
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
C++Godot unit testing framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.