Freeseer / freeseer

Designed for capturing presentations at conferences. Pre-fill a list of talks to record, record them, and upload them to YouTube with our YouTube Uploader.
http://freeseer.readthedocs.org
GNU General Public License v3.0
215 stars 110 forks source link

Update the references in contributor testing documentation to refer to pytest instead of unittest. #573

Closed SRomansky closed 9 years ago

SRomansky commented 9 years ago

The testing documentation page currently shows examples of using the unittest framework to create and write tests. However, Freeseer is moving towards pytest for unit testing. Therefore, the documentation page should be updated to refer to pytest instead of unittest. For example, python examples that show how to extend the existing test set with the unittest module should be updated to reflect the pytest module.

related #420 related #484 fix #566

dideler commented 9 years ago

Do you think we should mention in the testing guide that pytest can also run unittest-style tests?

SRomansky commented 9 years ago

I think that would be a good idea, dideler. I will add a note in the gotcha section.

I have also removed the reference to the weird unit test with side effects from the gotcha section and replaced it with a recommendation.

SRomansky commented 9 years ago

I was looking at the tests in the framework folder and found that src/freeseer/tests/framework/presentation.py is actually the test from the original example.. Should I raise an issue to fix it? e.g. some of the tests do not use good naming like 'test_speaker_not_first_param' and the test sets startTime to 'NOW'

dideler commented 9 years ago

I was looking at the tests in the framework folder and found that src/freeseer/tests/framework/presentation.py is actually the test from the original example.. Should I raise an issue to fix it?

That's minor enough that no issue is needed beforehand IMO. Instead of referring to an issue, the PR can refer to this PR for context.

mtomwing commented 9 years ago

My bad :O

dideler commented 9 years ago

:+1:

If @mtomwing also approves, you can squash the commits (be sure to follow our commit message guidelines) and we can merge this in.