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

Fix copypasta in test case descriptions #271

Open
gilles-peskine-arm opened this issue Sep 20, 2019 · 2 comments
Open

Fix copypasta in test case descriptions #271

gilles-peskine-arm opened this issue Sep 20, 2019 · 2 comments
Labels

Comments

@gilles-peskine-arm
Copy link
Collaborator

Description

We evidently have a lot of copypasta in test case descriptions. Mbed-TLS/mbedtls#2843 uncovered 1420 instances of test cases that have the same description. Sometimes the reason is test descriptions that aren't fully precise and could use some additional indications such as “… using this/that algorithm” or “… with an input of this/that length”. Sometimes there are just test cases with different input data and #1, #2, … is adequate. Sometimes test cases were copied and pasted and the test data was changed but not the test description, and the description is incorrect.

#270 added a disambiguator [#1], [#2], … to non-unique test descriptions. Not all incorrect test descriptions are formerly non-unique, but having been non-unique has a strong correlation with being imprecise or incorrect. The comments in #270 contain some analysis of some of the suspicious test descriptions.

Definition of done for this issue: no test case description contains [# anymore. All the descriptions that currently contain [# have been edited to be corrected, or to have a plain # without brackets if they were correct and sufficiently precise.

I expect this to be done partly organically as we modify or expand tests, and partly by working on one module at a time.

Issue request type

[ ] Question
[ ] Enhancement
[x] Bug
@ciarmcom
Copy link
Member

Internal Jira reference: https://jira.arm.com/browse/IOTCRYPT-922

@yanesca yanesca added the good first issue Good for newcomers label Mar 16, 2020
@yanesca
Copy link
Collaborator

yanesca commented Mar 16, 2020

I agree that should do this organically or one module at a time and I think that smaller scale improvements are beneficial as well.

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

No branches or pull requests

3 participants