Add test discovery and runnables for Python files #12080
Comments
JosephTLyons
added
enhancement
|
After thinking about it, it seems like we should bake |
Add runnable tasks for Python, starting with `unittest` from the
standard library. Both `TestCase`s (classes meant to be a unit of
testing) and individual test functions in a `TestCase` will have
runnable icons. For completeness, I also included a task that will run
`unittest` on the current file.
The implementation follows the `unittest` CLI. The unittest module can
be used from the command line to run tests from modules, classes or even
individual test methods:
```
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method
```
```python
import unittest
class TestStringMethods(unittest.TestCase):
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
def test_split(self):
s = 'hello world'
self.assertEqual(s.split(), ['hello', 'world'])
# check that s.split fails when the separator is not a string
with self.assertRaises(TypeError):
s.split(2)
if __name__ == '__main__':
unittest.main()
```
From the snippet provided by `unittest` docs, a user may want to run
test_split independently of the other test functions in the test case.
Hence, I decided to make each test function runnable despite `TestCase`s
being the unit of testing.
## Example of running a `TestCase`
<img width="600" alt="image"
src="https://github.com/zed-industries/zed/assets/16619392/7be38b71-9d51-4b44-9840-f819502d600a">
## Example of running a test function in a `TestCase`
<img width="600" alt="image"
src="https://github.com/zed-industries/zed/assets/16619392/f0b6274c-4fa7-424e-a0f5-1dc723842046">
`unittest` will also run the `setUp` and `tearDown` fixtures.
Eventually, I want to add the more commonly used `pytest` runnables
(perhaps as an extension instead).
Release Notes:
- Added runnable tasks for Python `unittest`.
([#12080](#12080)).
|
@JosephTLyons Should |
|
A python user is likely to go for Ideally, zed checks the project's venv for the presence of What I think may be missing is (1) using different test discovery rules (i.e what's in Less importantly, (2) a solid detection of venv or conda envs (in the meantime, just let users specify a local config for which test runner to use). |
|
Yep, we can now adjust tasks to "fit" user system configuration (e.g. installed test runners and so on). Looking at the venv may be a bit tricky, but doable |
|
+1 to adding pytest support! It would also be nice to be able to debug a test in the IDE |
|
oh damn! i'm ready to use zed in production today! give me pytest plz |
|
FYI @JosephTLyons @osiewicz |
|
FYI @JosephTLyons @osiewicz @rayduck Drogi programiście, możesz pozwolić lwiej części społeczności swobodnie zająć się tworzeniem testów, jeśli wypuścisz pytest. Dear developer, you can free up the lion's share of the community to write tests if you release pytest. |
Check for existing issues
Describe the feature
There are a load of python testing frameworks, but of those, the most popular are:
unittest- Python's stdlib testing frameworkpytest- 3rd party, but likely the most-used testing frameworkIt would be great if we could offer testing support for both
unittestandpytest, as I think that would cover most users. We should include commands to run all tests, for both frameworks, and to discover and run single tests, for both frameworks. All that being said, I'm not sure if our task infrastructure is really set up to handle being able to run tests from different testing frameworks. @osiewicz would know more.Honorable mentions for Python testing frameworks go to ward - its modern, neat, and then one I reach for these days.
If applicable, add mockups / screenshots to help present your vision of the feature
No response
The text was updated successfully, but these errors were encountered: