Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test Smell: it is not a good test practice to use the loop in the test #1038

Open
TestSmell opened this issue Aug 17, 2022 · 4 comments
Open
Assignees

Comments

@TestSmell
Copy link

Hi!

We notice that you use the loop structure in your test cases.
For example, testQualityScoresIntArray() in FastqToolsTest.java
截屏2022-08-17 下午5 17 26

However, using the loop in test cases is not a good test practice.
We analyzed the relevant Stack Overflow posts and summarized four potential negatives it brings:

  1. Loops make the test case more complex
  2. In most cases, a loop can be replaced with a data-driven test that is more readable.
  3. Loops break the assert-for-one-thing thumb rule. I don't mean a single assert statement.
  4. When a test fails, knowing the reason is more complicated.

Solution:
To avoid using the loop in the test, JUnit provides an annotation (i.e., @ParameteredTest), enabling a test case to run multiple times with different parameters.
We provide a usage example here:
image

@josemduarte
Copy link
Contributor

Good point, thanks! Would you be able to provide a pull request?

@tmrpavan
Copy link
Contributor

@josemduarte I would like to work on this. We are using Junit4 is there any chance to migrate Junit5. So this type of test case are easy to write in Junit5

@josemduarte
Copy link
Contributor

Yes we have in fact converted some tests to junit5 and the agreement is that new tests should be junit5.

@tmrpavan
Copy link
Contributor

can you assign this issue to me. I will work on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants