quillcraftsman / django-dry-tests Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 1.0 246 KB

Package with new powerful TestCases and Assets to test django application fast. TDD is supported

Home Page: https://drytest.craftsman.lol

License: MIT License

Makefile 5.80% Python 93.46% HTML 0.74%

asserts django test-driven-development testcases tests

django-dry-tests's Introduction

Django DRY Tests

Package with new powerful TestCases and Assets to test django application fast. TDD is supported

You can find Full Project Documentation here

Workflows

Package

Support

Downloads

Languages

Development

Mission

The mission of the Django DRY Tests to design and develop open source python package to test django application

fast
with minimal code duplication
with the ability to use TDD easily
simple and comfortable

Open Source Project

This is the open source project with MIT license. Be free to use, fork, clone and contribute.

Features

Special Request, Response and Form classes to simple set test data
Special SimpleTestCase and TestCase classes with new asserts:
- The main asserts is assertTrueResponse and assertTrueForm. You can use this for most cases.
- Other special asserts (See more in Full Documentation)

Requirements

Django==4 (Lower versions haven't been tested)
See more in Full Documentation

Development Status

Package already available on PyPi
See more in Full Documentation

Install

with pip

pip install django-dry-tests

See more in Full Documentation

Quickstart

To test view

class QuickStartViewSimpleTestCase(SimpleTestCase):
    """
    SimpleTestCase example
    """

    def test_get(self):
        """
        Test Example with django-dry-tests
        :return:
        """
        # Create Request Model
        request = Request(
            url='/quickstart/'
        )

        # Create Response Model to check all view.
        # You can set only one param without others to check it.
        true_response = TrueResponse(
            status_code=200,
            context=Context(
                keys=['quickstart'],  # check that quickstart key in context
                values=['Quickstart'],  # check that "Quickstart" value in context
                items={
                    'quickstart': 'Quickstart'
                },  # check both keys and values in context
                types={
                    'quickstart': str
                }  # check values types without check values
            ),
            content_values = [
                'Quickstart',
                '<h1>Quickstart title</h1>'
            ],  # check values after template will be rendered
        )

        # get url response with Django default Test Client
        current_response = request.get_response(self.client)
        # Use main assert to run all asserts
        self.assertTrueResponse(current_response, true_response)

To test Form

class ExampleFromTestCase(SimpleTestCase):
    """
    Example Form Test Class
    """

    def test_form(self):
        """
        Example Test with django-dry-tests
        :return:
        """
        true_form = TrueForm(  # Set Up TrueForm instance
               Fields(  # TrueForm Fields
                   count=2,  # check fields count
                   names=[
                       'number', 'name'
                   ],  # check field names
                   types={
                       'name': forms.CharField,
                       'number': forms.IntegerField
                   }  # check fields types
               ),
            )
        current_form = ExampleForm()  # Get project form
        self.assertTrueForm(current_form, true_form)  # use this main assert to check all conditions

Contributing

You are welcome! To easy start please check:

django-dry-tests's People

Contributors

Stargazers

Watchers

Forkers

danteonline

django-dry-tests's Issues

Url Params with same name don't work

For example
?token=one&token=two

Improve documentation with using RST instead of MD

Use .rst format for documentation files (May be sphinx or something else)
Automation:
In the requirements block use requirements.txt
In the Development status use setup.py for version and status
For examples how to use package use source code
In developer documentation use Makefile with commands
Create autodocumentation in html for source code

Add 100% test coverage to CI

Using pytest

Compare to forms in context

Test example:

    def test_get(self):
        request = Request(
            url=self.url
        )
        true_response = TrueResponse(
            status_code=200,
            context_values={
                'form': OneTextForm()
            }
        )
        current_response = request.get_url_response(self.client)
        self.assertTrueResponse(current_response, true_response)

Output:

AssertionError: <OneTextForm bound=False, valid=Unknown, fields=(text)> != <OneTextForm bound=False, valid=False, fields=(text)>

Looks like django can't compare two similar forms.

What should we do in this case?

Design and develop asserts for testing django forms

For example:

class TestTwoTextForm(SimpleTestCase):
    """
    One text form test
    """

    def test_fields(self):
        """
        Test available fields
        """
        form = TwoTextForm()
        self.assertEqual(len(form.fields), 2)
        self.assertIn('one_text', form.fields)
        self.assertIn('two_text', form.fields)

assertFormFields maybe and special class for fields

Add initial value to the form Field model

Is your feature request related to a problem? Please describe.
Frequently we use initial value in django model field. We can't test in now with Field model

Describe the solution you'd like

Add new parameter "initial" to the Field model
Add special assert to the TestCaseMixin
Add condition to the main assert assertTrueFrom

Describe alternatives you've considered

Additional context
This is the form example to test initial value:

class LoadTrainingDataForm(forms.Form):
    name = forms.CharField(max_length=128, widget=forms.TextInput(attrs={
        'class': 'form-control'
    }))
    excel_file = forms.FileField(max_length=128, widget=forms.FileInput(attrs={
        'class': 'form-control'
    }))
    sheet_name = forms.IntegerField(required=False, initial=0, widget=forms.NumberInput(attrs={
        'class': 'form-control'
    }))

Add CD to deploy package on PyPi

Using GitHub action

Rename get_url_response to get_response in Request class

It will make method more short and readable
It will change interface and will make package not compatibility with the old versions

Add links to PyPi package page

documentation
website
something else maybe

Design and develop special TestCase (one or many)

has assertStatusCode
has assertRedirect (may be not need, django has similar)
has assertVariableInContext
has assertVatiableInContextEquar (Too long)
...

Add reverted asserts (with Not)

for in_context (not_in_context)
for context_values (values_not_in_context)
for content_values (values_not_in_content)

Or use some different way to check it

Package model hasn't been copied

Package model hasn't been copied with django-dry-tests in 0.2.0 release

Design and develop TestCase class with database

We have SimpleTestCase.
We need TestCase - the similar class but with database

Add required and not required checks to the Form model

Is your feature request related to a problem? Please describe.
Frequently we need to check required fields in the django forms