Skip to content

Unit tests comments compliance#349

Merged
jdsika merged 2 commits intomasterfrom
unit-tests-comments-compliance
Oct 22, 2019
Merged

Unit tests comments compliance#349
jdsika merged 2 commits intomasterfrom
unit-tests-comments-compliance

Conversation

@vkresch
Copy link
Copy Markdown
Contributor

@vkresch vkresch commented Oct 22, 2019

Reference to a related issue in the repository

This PR is based on this issue.

Add a description

This PR is a refactoring of test_cases.py and test_cases_doc.py and uses the builtin python unit testing framework to test the compliance of OSI comments. The test cases are implemented in a modular way which is easy maintainable and extensible with more test cases based on categories such as tabs, comments, messages, etc.. Using the unit testing framework will improve the code quality output of the OSI project.

The .travis.yml contains now the command python -m unittest discover tests which runs the unit tests.

This PR also corrects a small typo of the enum Fog from FOG_UNKOWN --> FOG_UNKNOWN.

Mention a member

@jdsika pls review and let me know your thoughts.

Check the checklist

  • My code and comments follow the style guidelines and contributors guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests / travis ci pass locally with my changes.

@vkresch vkresch added this to the v3.1.3 milestone Oct 22, 2019
@jdsika jdsika added the Quality Quality improvements. label Oct 22, 2019
Comment thread osi_environment.proto
// Visibility is unknown (must not be used in ground truth).
//
FOG_UNKOWN = 0;
FOG_UNKNOWN = 0;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jesus, well spotted!

Copy link
Copy Markdown
Contributor

@jdsika jdsika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jdsika jdsika merged commit b90159b into master Oct 22, 2019
@vkresch vkresch deleted the unit-tests-comments-compliance branch November 5, 2019 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Quality Quality improvements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants