ankidroid/Anki-Android

[Cleanup]: Add Tests to the code (`@NeedsTest`)

Open

#13,283 opened on Feb 16, 2023

View on GitHub
 (37 comments) (0 reactions) (0 assignees)Kotlin (2,789 forks)batch import
Good First IssueKeep OpenTests

Repository metrics

Stars
 (11,132 stars)
PR merge metrics
 (Avg merge 9d 12h) (93 merged PRs in 30d)

Description

[!NOTE] This issue does not need to be assigned to you before you work on it

A number of paths of the code have been identified as requiring automated testing.

Typically this is regression testing: if a bug has been found, then it's useful to have a unit test which would have failed due to the bug.

  1. Find a usage of @NeedsTest: https://github.com/ankidroid/Anki-Android/blob/main/AnkiDroid/src/main/java/com/ichi2/annotations/NeedsTest.kt a. Ensure that the method(s) you are testing are in use.
  2. Post the test(s) that you're handling on this issue, so people don't duplicate work
  3. Write a unit test (/test, not /androidTest)
  4. Ensure that re-introducing the bug or issue would break the test
  5. Submit a Pull Request

Contributor guide

Research direction
Find a method annotated with @NeedsTest that is in use, write a unit test under /test that would fail if the bug reappeared, and submit a PR.
Tech stack
kotlin
Domain
mobile
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
GitKotlinUnit Testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80