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

fixes #3310 - improves tests documentation #3312

Merged
merged 3 commits into from
May 25, 2020
Merged

Conversation

karlcow
Copy link
Member

@karlcow karlcow commented May 22, 2020

  • Adds documentation for pytests
  • Fixes outdated links to documentation
  • Fixes the table of content
  • Adds a template for Python tests using pytest
  • Adds information about data fixtures

This PR fixes issue #3310

@karlcow karlcow requested a review from miketaylr May 22, 2020 07:00
@karlcow
Copy link
Member Author

karlcow commented May 22, 2020

@miketaylr I kind of did it in the opposite way ;) I changed the documentation, but if you want I can add to this pull request at least one converted file. So we could link the diff to the documentation. WDYT?

@karlcow karlcow marked this pull request as draft May 22, 2020 07:08
@karlcow
Copy link
Member Author

karlcow commented May 22, 2020

Let's make it a draft to not do accidental merge.

@miketaylr
Copy link
Member

I kind of did it in the opposite way ;)

I am shocked 😱

I changed the documentation, but if you want I can add to this pull request at least one converted file. So we could link the diff to the documentation. WDYT?

These are great improvements. r+++++

I think with just the skeleton example you linked, it's enough to learn from. But converting one additional file wouldn't hurt, if you're up to it. Basically, I'll leave it up to you. :)

Copy link
Member

@miketaylr miketaylr left a comment

Choose a reason for hiding this comment

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

r+ in case you want to just merge here.

karlcow added 2 commits May 25, 2020 12:03
* Adds documentation for pytests
* Fixes outdated links to documentation
* Fixes the table of content
* Adds a template for Python tests using pytest
* Adds information about data fixtures
@karlcow karlcow marked this pull request as ready for review May 25, 2020 03:07
@karlcow
Copy link
Member Author

karlcow commented May 25, 2020

@miketaylr what about two files converted. :)

That was an interesting learning process and an opportunity to tweak a couple of things for the tests.

Using some nice features of pytests here and there.

@ksy36 might be interested by the modifications I have done to the tests for console log file.
And i'm happy to answer any questions on the why?

I think it will be fun to convert the other tests. It's not always easy because we have to change the mindset a bit. But in the end this is fun.

@karlcow
Copy link
Member Author

karlcow commented May 25, 2020

ok all green.

@karlcow karlcow merged commit ec9cb3a into webcompat:master May 25, 2020
@miketaylr
Copy link
Member

awesome, thank you!

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

Successfully merging this pull request may close these issues.

2 participants