Add testing framework for Django to ensure compatibility

[GuptaManan100]

This issue is for tracking the addition of a comprehensive test suite to ensure compatibility with Django framework. For now, Vitess Framework Testing has minimal coverage for Django but we want to add a comprehensive test suite.

The Django docs can be used for this purpose in a very similar fashion to rails testing. The rails testing code is available at Rails Testing that uses the Rails Guides

[abhaykatheria]

This seems really interesting. I have a couple of questions -

• The current Django project doesn't have much functionality to it. Do we need to add more views and models to it ..?
• Django creates a new test DB and rollbacks transactions of every test to make every test independent from others. Can we populate the test_db with the data from production DB and then run tests on it or run tests on the prod DB?(by prod DB I mean vitess's DB)

P.S: I am looking forward to contributing to this project under lfx mentorship program, So I wanted to make a POC before applying :)

[GuptaManan100]

We do not care much about the view, but yes we want to add exhaustive tests for the model layer of django. The idea is to go through the guide of django regarding the model layer https://docs.djangoproject.com/en/3.2/topics/db/ and add tests for all the different values. For example, there a guide regarding the different field types, so to test it, we would create a model which has fields for all types and test that they work perfectly.

I don't think there is any specific requirement to create a test DB, we can use the production DB itself, the way the current test do.

[govindgoel]

This is great, @GuptaManan100 you have provided insights regarding the project so my understanding is that we need to add tests for the model layer of Django. Is this understanding correct please do tell me.

I look forward to contribute to the project under the LFX mentorship program.

[Aniket118]

Hello @GuptaManan100 I have worked on a lot Django based project. I am looking forward to work on this project. Can you please guide me how can I contribute to it?
Is there any criteria?

[GuptaManan100]

This project is meant for LFX program. You can contribute to Vitess or its framework-testing repository on other issues.

[Aniket118]

I have applied it from there can you tell how people will be working on this project? @GuptaManan100

[abhaykatheria]

The framework testing of Django's compatibility is completed as per the Django's guide on model layer. Unsharded testing works with both v3 and gen4 planner, but the sharded tests only work with the gen4 planner and fail on the v3 planner. At present, the vttestserver image is based on the v3 planner and hence the sharded tests are failing in Github actions. The setting up of vschema and sequences is done as described in vitess docs and is inspired by rails6 testing.
The pull requests that solved this issue are -

• Django models CRUD API testing

• Django fields testing

• Testing Django relationships

• Test Django model inheritances

• Django models Refactoring for better readability

• Testing SQL Queries

• Django sharded testing