question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[TESTING.md] Enhance TESTING docs with Editor/IDE-Specific Tweaks & Tips

See original GitHub issue

Per https://github.com/exercism/exercism/issues/5791 and other comments and discussions, it has become clear that students could use some additional detail/help with setting up PyTest locally and running tests from their particular IDEs. It might also be nice to give students links to plugins or default config files to ease their setup for a given editor.

This would be for Python 3.8 and above only, and would entail changing/revising:

We can’t cover all OS and IDE combinations, but we should cover the major ones if we can. In particular:

  • PyCharm (free, paid, edu) on Linux, Mac, and Windows
  • VS Code on Linux, Mac, Windows
  • Spyder on Linux, Mac, Windows
  • possibly Sublime, though lower priority
  • possibly JupyterLab, but also lower priority

Additionally, we should have tips on how things change inside a venv/conda env, how they might work inside docker, and how those methods differ from having PyTest installed globally (which is what the instructions assume at the moment). An example of some of this information given for Spyder 4.1.5 is in the comments of issue linked at the top.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
BethanyGcommented, Oct 21, 2021

WOOO HOOO! So happy we’re able to close this! NICE WORK!

1reaction
J08Kcommented, Sep 9, 2021

Heya, I would love to work on this.

TESTS.md I can already see some of the work that has to be done TESTS.md such as a more concise tutorial on installing and using Pytest, since, my assumption, is that most students just want to know how to test their solutions locally. Maybe adding a few options which will help them debug their solutions is good. Possibly out of scope: We could also add a tutorial about creating your own tests, and how to understand the test files themselves. Could be useful?

Shared testing file For the shared testing file, just make sure the basics of testing are in there. Maybe just have a link to TOOLS.md, instead of having links to the downloads of IDEs (most IDEs mentioned do not come out-of-the-box with testing integration installed).

TOOLS.md Will expand TOOLS.md with tutorials to more IDEs and editors (the ones listed in the requirements). I am not fluent with Spyder (used it before though), and have never used JupyterLab before, but I am willing to do that. Will update (if needed) the Visual Studio tutorial, and also make new tutorials, with pictures, for the rest of the IDEs/editors. Could also add handy/recommended extensions for some or all of the IDEs/editors.

Tips and tricks on things changing inside could be a separate subject in TESTING.md, will probably do this last though. Am planning to get this done before we post the new/updated files.

What do you think? Any other additions?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Small but Powerful Tweaks to Help Maintain Your Tests
A few minor changes to your automated test suite can massively improve its maintainability and keep tests running smoothly for the long haul....
Read more >
Documentation testing - GitLab Docs
Documentation link tests. Merge requests containing changes to Markdown ( .md ) files run a docs-lint links job, which runs two types of...
Read more >
DevOps tech: Test data management - Google Cloud
Ways to improve test data management. The following practices can help you use test data more effectively and efficiently: Favor unit tests. Unit...
Read more >
Best practices for writing unit tests - .NET - Microsoft Learn
This article describes some best practices regarding unit test design for your .NET Core and .NET Standard projects. In this guide, you learn ......
Read more >
Load Testing Best Practices | LoadNinja
Load testing doesn't have to be complicated. Review use cases and best practices to better understand how you can improve your load testing...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found