unittest support?

[adamchainz]

As I’ve built inline-snapshot-django, I have thought about unittest support for inline-snapshot. In the Django sphere, unittest remains fairly popular, especially since Django’s testing framework builds upon it. I have encountered enough client projects using it.

I’m not sure I’d have much direct use for unittest support in inline-snapshot, but I think it could help adoption. A simple integration that only offers non-interactive flags, like create and fix, might be an easy starting point.

[15r10nk]

unittests work like this:

from inline_snapshot import snapshot
import unittest

class TestAddNumbers(unittest.TestCase):
    def test_add_positive_numbers(self):
        self.assertEqual(1+2, snapshot())


if __name__ == '__main__':
    unittest.main()

but with the catch that you have to use pytest to run it. I haven't checked if it works in all cases because I rely on unittest/pytest to use == in the implementation. This is also the reason why I haven't documented it (tests are also missing). For now, would it be ok if it works with pytest, or does it need to work when using unittest to run it?

It is technical possible to make it work with unittest only, but this requires some refactoring ... and I'm currently rewriting external() and two rewriting at the same time are not practical.

self.assertEqual(1+2, ...) will also work in the future, but this depends on #197 and will become an insider-only feature.

I'm also very happy to see that you created inline-snapshot-django 🎉 I will add it to the extensions list in the documentation.

[15r10nk]

What also already works is to use unittest to run the tests, because inline-snapshot works in disabled-mode when it is not executed with pytest.

[adamchainz]

or now, would it be ok if it works with pytest, or does it need to work when using unittest to run it?

Yeah, the question here is about using unittest to run tests and adding the --inline-snapshot option to a unittest runner.

I've worked on a few Django projects that exclusively use unittest, and I think it could help if inline-snapshot worked for those projects without needing a port to pytest first.

Anyway, let's see if anyone else requests support!

[15r10nk]

You're not the first to ask about it, I was also asked at PyConDe if Unittest will be supported. It will definitely come.