Using class in Python/Django testing to make code more reusable

Question

I need some help with my testing architecture. My code works but it seems ugly for me. Could you take a look :

The goal is to make the same tests for all my pages in Django :

I wrote a unit testing.py

from django.urls import reverse, resolve

class SinglePageTest(object):
    str_reverse = ''
    adresse = ''
    template = None
    template_path = ''
    str_contain = ''

    def initialize(self):
        self.url = reverse(self.str_reverse)
        self.view = resolve(self.adresse)
        self.response = self.client.get(self.url)

    def test_status_200(self):
        self.assertEqual(self.response.status_code, 200)

    def test_templates_home(self):
        self.assertTemplateUsed(self.response, self.template_path)

    def test_contains_HTML(self):
        self.assertContains(self.response,
                            self.str_contain)

    def test_url_resolve(self):
        self.assertEqual(self.view.func.__name__,
                         self.template.as_view().__name__)

When I need to test a page in test.py I do this :

from django.test import TestCase, SimpleTestCase
from DjangoTools.testing import SinglePageTest

class RetrievePassword(SimpleTestCase, SinglePageTest):
    def setUp(self):
        self.str_reverse = 'retrieve-password'
        self.adresse = '/accounts/retrieve-password'
        self.template = RetrievePasswordView
        self.template_path = 'accounts/retrieve-password.html'
        self.str_contain = '<h1> Récupérer le <span class="clr-org">mot de passe</span></h1>'
        super(RetrievePassword, self).setUp()
        SinglePageTest.initialize(self)

The problem is that PyCharm doesn't find the reference for a lot of method in testing.py and that's normal cause I'am using a basic object that doesn't contains these methods.

My questions are :

Is-it well to do like this ?
Can I say that I'm using Mixins ?
How to tell pycharm to find assertTemplateUsed, client.get etc...

Have a nice day,

After using the solution provided unittest is trying to test the testing.py class

Solution of the problem : add to the base class

def setUp(self):
    if self.__class__ is BaseSinglePageTest:
        raise SkipTest("%s is an abstract base class" % self.__class__)
    else:
        super(BaseSinglePageTest, self).setUp()

Yes solution was in it ! Thanks – mevaereR Aug 22 '21 at 09:42 — mevaereR, Aug 22 '21 at 09:42

score 0 · Answer 1 · answered Aug 22 '21 at 09:03

0

Instead of creating mixins, linear inheritance should work nice on this case.

SimpleTestCase <- SinglePageTest <- RetrievePassword

from django.urls import reverse, resolve

class BaseSinglePageTest(SimpleTestCase):
    str_reverse = ''
    adresse = ''
    template = None
    template_path = ''
    str_contain = ''

    def initialize(self):
        self.url = reverse(self.str_reverse)
        self.view = resolve(self.adresse)
        self.response = self.client.get(self.url)

    def test_status_200(self):
        self.assertEqual(self.response.status_code, 200)

    def test_templates_home(self):
        self.assertTemplateUsed(self.response, self.template_path)

    def test_contains_HTML(self):
        self.assertContains(self.response,
                            self.str_contain)

    def test_url_resolve(self):
        self.assertEqual(self.view.func.__name__,
                         self.template.as_view().__name__)

and then use this class like so

from django.test import TestCase, SimpleTestCase
from DjangoTools.testing import SinglePageTest

class RetrievePassword(BaseSinglePageTest):
    def setUp(self):
        self.str_reverse = 'retrieve-password'
        self.adresse = '/accounts/retrieve-password'
        self.template = RetrievePasswordView
        self.template_path = 'accounts/retrieve-password.html'
        self.str_contain = '<h1> Récupérer le <span class="clr-org">mot de passe</span></h1>'
        super(RetrievePassword, self).setUp()
        SinglePageTest.initialize(self)

answered Aug 22 '21 at 09:03

Kryštof Řeháček

1,965
1
16
28

This was my first idea but the testing is occuring now only on BaseSinglePageTest and not on RetrievePassword. – mevaereR Aug 22 '21 at 09:07
what do you mean by "testing is occuring now only on"? – Kryštof Řeháček Aug 22 '21 at 09:08
Strange it works now (I surely made a mistake). Sorry for this first comment. – mevaereR Aug 22 '21 at 09:14
"testing is occuring now only on"? Unittesting was only testing testing.py please see the next post for picture – mevaereR Aug 22 '21 at 09:14
so it's all good? :) – Kryštof Řeháček Aug 22 '21 at 09:16
:) just one thing to do : How to avoid unittest to test in testing.py (please see the first post). I would like to avoid failure in my tests. And thanks a lot ! – mevaereR Aug 22 '21 at 09:19
from unittest import skip @skip("Don't want to test") Skip all tests :( – mevaereR Aug 22 '21 at 09:27
put the `BaseSinglePageTest` outside testing.py – Kryštof Řeháček Aug 22 '21 at 09:32
It does the same, the solution is on the first post. – mevaereR Aug 22 '21 at 09:41

score 0 · Accepted Answer · answered Aug 22 '21 at 09:43

testing.py

from django.test import SimpleTestCase from django.urls import reverse, resolve from unittest import SkipTest

class BaseSinglePageTest(SimpleTestCase):
    str_reverse = ''
    adresse = ''
    template = None
    template_path = ''
    str_contain = ''

    def setUp(self):
        if self.__class__ is BaseSinglePageTest:
            raise SkipTest("%s is an abstract base class" % self.__class__)
        else:
            super(BaseSinglePageTest, self).setUp()

    def initialize(self):
        self.url = reverse(self.str_reverse)
        self.view = resolve(self.adresse)
        self.response = self.client.get(self.url)

    def test_status_200(self):
        self.assertEqual(self.response.status_code, 200)

    def test_templates_home(self):
        self.assertTemplateUsed(self.response, self.template_path)

    def test_contains_HTML(self):
        self.assertContains(self.response,
                            self.str_contain)

    def test_url_resolve(self):
        self.assertEqual(self.view.func.__name__,
                         self.template.as_view().__name__)

test.py

from django.contrib.auth import get_user_model, authenticate

from DjangoTools.tool_test import BaseSinglePageTest

class RetrievePassword(BaseSinglePageTest):
    def setUp(self):
        self.str_reverse = 'retrieve-password'
        self.adresse = '/accounts/retrieve-password'
        self.template = RetrievePasswordView
        self.template_path = 'accounts/retrieve-password.html'
        self.str_contain = '<h1> Récupérer le <span class="clr-org">mot de passe</span></h1>'
        super(RetrievePassword, self).setUp()
        BaseSinglePageTest.initialize(self)

Using class in Python/Django testing to make code more reusable

2 Answers2