djangodocs

Django 1.11
Bahasa Indonesia
Documentation contents

Alat percobaan

Django menyediakan kumpulan kecil alat yang datang dalam mudah ketika menulis percobaan.

Klien percobaan

The test client is a Python class that acts as a dummy Web browser, allowing you to test your views and interact with your Django-powered application programmatically.

Beberapa hal anda dapat lakukan dengan klien percobaan adalah:

  • Simulate GET and POST requests on a URL and observe the response -- everything from low-level HTTP (result headers and status codes) to page content.

  • See the chain of redirects (if any) and check the URL and status code at each step.

  • Test that a given request is rendered by a given Django template, with a template context that contains certain values.

Note that the test client is not intended to be a replacement for Selenium or other "in-browser" frameworks. Django's test client has a different focus. In short:

  • Use Django's test client to establish that the correct template is being rendered and that the template is passed the correct context data.

  • Use in-browser frameworks like Selenium to test rendered HTML and the behavior of Web pages, namely JavaScript functionality. Django also provides special support for those frameworks; see the section on LiveServerTestCase for more details.

A comprehensive test suite should use a combination of both test types.

Ikhtisar dan contoh cepat

To use the test client, instantiate django.test.Client and retrieve Web pages:

Code
>>> from django.test import Client
>>> c = Client()
>>> response = c.post('/login/', {'username': 'john', 'password': 'smith'})
>>> response.status_code
200
>>> response = c.get('/customer/details/')
>>> response.content
b'<!DOCTYPE html...'

As this example suggests, you can instantiate Client from within a session of the Python interactive interpreter.

Catatan sedikit hal-hal penting tentang bagaimana percobaan klien bekerja:

  • The test client does not require the Web server to be running. In fact, it will run just fine with no Web server running at all! That's because it avoids the overhead of HTTP and deals directly with the Django framework. This helps make the unit tests run quickly.

  • When retrieving pages, remember to specify the path of the URL, not the whole domain. For example, this is correct:

    Code
    >>> c.get('/login/')

    Ini tidak benar:

    Code
    >>> c.get('https://www.example.com/login/')

    The test client is not capable of retrieving Web pages that are not powered by your Django project. If you need to retrieve other Web pages, use a Python standard library module such as urllib.

  • To resolve URLs, the test client uses whatever URLconf is pointed-to by your ROOT_URLCONF setting.

  • Although the above example would work in the Python interactive interpreter, some of the test client's functionality, notably the template-related functionality, is only available while tests are running.

    The reason for this is that Django's test runner performs a bit of black magic in order to determine which template was loaded by a given view. This black magic (essentially a patching of Django's template system in memory) only happens during test running.

  • Secara awalan, klien percobaan akan meniadakan pemeriksaan CSRF apapun dilakukan oleh situs anda.

    If, for some reason, you want the test client to perform CSRF checks, you can create an instance of the test client that enforces CSRF checks. To do this, pass in the enforce_csrf_checks argument when you construct your client:

    Code
    >>> from django.test import Client
>>> csrf_client = Client(enforce_csrf_checks=True)

Membuat permintaan

Gunakan kelas django.test.Client untuk membuat permintaan.

class Client(enforce_csrf_checks=False, **defaults)

It requires no arguments at time of construction. However, you can use keywords arguments to specify some default headers. For example, this will send a User-Agent HTTP header in each request:

Code
>>> c = Client(HTTP_USER_AGENT='Mozilla/5.0')

The values from the extra keywords arguments passed to get(), post(), etc. have precedence over the defaults passed to the class constructor.

The enforce_csrf_checks argument can be used to test CSRF protection (see above).

Once you have a Client instance, you can call any of the following methods:

get(path, data=None, follow=False, secure=False, **extra)

Makes a GET request on the provided path and returns a Response object, which is documented below.

The key-value pairs in the data dictionary are used to create a GET data payload. For example:

Code
>>> c = Client()
>>> c.get('/customers/details/', {'name': 'fred', 'age': 7})

...will result in the evaluation of a GET request equivalent to:

Code
/customers/details/?name=fred&age=7

The extra keyword arguments parameter can be used to specify headers to be sent in the request. For example:

Code
>>> c = Client()
>>> c.get('/customers/details/', {'name': 'fred', 'age': 7},
...       HTTP_X_REQUESTED_WITH='XMLHttpRequest')

...will send the HTTP header HTTP_X_REQUESTED_WITH to the details view, which is a good way to test code paths that use the django.http.HttpRequest.is_ajax() method.

If you already have the GET arguments in URL-encoded form, you can use that encoding instead of using the data argument. For example, the previous GET request could also be posed as:

Code
>>> c = Client()
>>> c.get('/customers/details/?name=fred&age=7')

If you provide a URL with both an encoded GET data and a data argument, the data argument will take precedence.

If you set follow to True the client will follow any redirects and a redirect_chain attribute will be set in the response object containing tuples of the intermediate urls and status codes.

If you had a URL /redirect_me/ that redirected to /next/, that redirected to /final/, this is what you'd see:

Code
>>> response = c.get('/redirect_me/', follow=True)
>>> response.redirect_chain
[('http://testserver/next/', 302), ('http://testserver/final/', 302)]

If you set secure to True the client will emulate an HTTPS request.

post(path, data=None, content_type=MULTIPART_CONTENT, follow=False, secure=False, **extra)

Makes a POST request on the provided path and returns a Response object, which is documented below.

The key-value pairs in the data dictionary are used to submit POST data. For example:

Code
>>> c = Client()
>>> c.post('/login/', {'name': 'fred', 'passwd': 'secret'})

...will result in the evaluation of a POST request to this URL:

Code
/login/

...dengan data POST ini:

Code
name=fred&passwd=secret

If you provide content_type (e.g. text/xml for an XML payload), the contents of data will be sent as-is in the POST request, using content_type in the HTTP Content-Type header.

If you don't provide a value for content_type, the values in data will be transmitted with a content type of multipart/form-data. In this case, the key-value pairs in data will be encoded as a multipart message and used to create the POST data payload.

To submit multiple values for a given key -- for example, to specify the selections for a <select multiple> -- provide the values as a list or tuple for the required key. For example, this value of data would submit three selected values for the field named choices:

Code
{'choices': ('a', 'b', 'd')}

Submitting files is a special case. To POST a file, you need only provide the file field name as a key, and a file handle to the file you wish to upload as a value. For example:

Code
>>> c = Client()
>>> with open('wishlist.doc') as fp:
...     c.post('/customers/wishes/', {'name': 'fred', 'attachment': fp})

(The name attachment here is not relevant; use whatever name your file-processing code expects.)

You may also provide any file-like object (e.g., StringIO or BytesIO) as a file handle. If you're uploading to an ImageField, the object needs a name attribute that passes the validate_image_file_extension validator. For example:

Code
>>> from io import BytesIO
>>> img = BytesIO(b'mybinarydata')
>>> img.name = 'myimage.jpg'

Note that if you wish to use the same file handle for multiple post() calls then you will need to manually reset the file pointer between posts. The easiest way to do this is to manually close the file after it has been provided to post(), as demonstrated above.

You should also ensure that the file is opened in a way that allows the data to be read. If your file contains binary data such as an image, this means you will need to open the file in rb (read binary) mode.

The extra argument acts the same as for Client.get().

If the URL you request with a POST contains encoded parameters, these parameters will be made available in the request.GET data. For example, if you were to make the request:

Code
>>> c.post('/login/?visitor=true', {'name': 'fred', 'passwd': 'secret'})

... the view handling this request could interrogate request.POST to retrieve the username and password, and could interrogate request.GET to determine if the user was a visitor.

If you set follow to True the client will follow any redirects and a redirect_chain attribute will be set in the response object containing tuples of the intermediate urls and status codes.

If you set secure to True the client will emulate an HTTPS request.

head(path, data=None, follow=False, secure=False, **extra)

Makes a HEAD request on the provided path and returns a Response object. This method works just like Client.get(), including the follow, secure and extra arguments, except it does not return a message body.

options(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)

Makes an OPTIONS request on the provided path and returns a Response object. Useful for testing RESTful interfaces.

When data is provided, it is used as the request body, and a Content-Type header is set to content_type.

Argumen-argumen follow, secure dan extra bertindak sama seperti Client.get().

put(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)

Makes a PUT request on the provided path and returns a Response object. Useful for testing RESTful interfaces.

When data is provided, it is used as the request body, and a Content-Type header is set to content_type.

Argumen-argumen follow, secure dan extra bertindak sama seperti Client.get().

patch(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)

Makes a PATCH request on the provided path and returns a Response object. Useful for testing RESTful interfaces.

Argumen-argumen follow, secure dan extra bertindak sama seperti Client.get().

delete(path, data='', content_type='application/octet-stream', follow=False, secure=False, **extra)

Makes a DELETE request on the provided path and returns a Response object. Useful for testing RESTful interfaces.

When data is provided, it is used as the request body, and a Content-Type header is set to content_type.

Argumen-argumen follow, secure dan extra bertindak sama seperti Client.get().

trace(path, follow=False, secure=False, **extra)

Makes a TRACE request on the provided path and returns a Response object. Useful for simulating diagnostic probes.

Unlike the other request methods, data is not provided as a keyword parameter in order to comply with RFC 7231 Section 4.3.8, which mandates that TRACE requests must not have a body.

The follow, secure, and extra arguments act the same as for Client.get().

login(**credentials)

If your site uses Django's authentication system and you deal with logging in users, you can use the test client's login() method to simulate the effect of a user logging into the site.

After you call this method, the test client will have all the cookies and session data required to pass any login-based tests that may form part of a view.

The format of the credentials argument depends on which authentication backend you're using (which is configured by your AUTHENTICATION_BACKENDS setting). If you're using the standard authentication backend provided by Django (ModelBackend), credentials should be the user's username and password, provided as keyword arguments:

Code
>>> c = Client()
>>> c.login(username='fred', password='secret')

# Now you can access a view that's only available to logged-in users.

If you're using a different authentication backend, this method may require different credentials. It requires whichever credentials are required by your backend's authenticate() method.

login() returns True if it the credentials were accepted and login was successful.

Akhirnya, anda akan butuh mengingat untuk membuat akun pengguna sebelum anda dapat menggunakan cara ini. Seperti kami jelaskan diatas, percobaan pelari dijalankan menggunakan basisdata percobaan, yang mengandung tidak ada pengguna secara awal. Sebagai hasilnya, akun pengguna sah pada situs produksi anda tidak akan bekerja dibawah kondisi percobaan. Anda akan butuh membuat pengguna sebagai bagian dari deretan percobaan -- salah satu secara manual (menggunakan API model Django) atau dengan perbaikan percobaan. Ingat bahwa jika anda ingin percobaan pengguna anda mempunyai sandi, anda tidak dapat mengatur sandi pengguna dengan mengatur atribut sandi secara langsung -- anda harus menggunakan fungsi set_password() untuk menyimpan sandi campuran dengan benar. Jalan lain, anda dapat menggunakan cara pembantu create_user() untuk membuat sebuah pengguna baru dengan sandi campuran dengan benar.

force_login(user, backend=None)

Jika situs anda menggunakan sistem pembuktian keaslian Django, anda dapat menggunakan cara force_login() untuk menirukan pengaruh dari pengguna masuk kedalam situs. Gunakan cara ini daripada login() ketika sebuah percobaan membutuhkan pengguna untuk masuk dan rincian bagaimana sebuah pengguna masuk tidaklah penting.

Tidak seperti login(), cara ini melewati langkah pembuktian keaslian dan pengecekan: pengguna tidak aktif (is_active=False) diizinkan untuk masuk dan mandat pengguna tidak butuh disediakan.

The user will have its backend attribute set to the value of the backend argument (which should be a dotted Python path string), or to settings.AUTHENTICATION_BACKENDS[0] if a value isn't provided. The authenticate() function called by login() normally annotates the user like this.

This method is faster than login() since the expensive password hashing algorithms are bypassed. Also, you can speed up login() by using a weaker hasher while testing.

logout()

If your site uses Django's authentication system, the logout() method can be used to simulate the effect of a user logging out of your site.

After you call this method, the test client will have all the cookies and session data cleared to defaults. Subsequent requests will appear to come from an AnonymousUser.

Tanggapan percobaan

The get() and post() methods both return a Response object. This Response object is not the same as the HttpResponse object returned by Django views; the test response object has some additional data useful for test code to verify.

Specifically, a Response object has the following attributes:

class Response
client

The test client that was used to make the request that resulted in the response.

content

The body of the response, as a bytestring. This is the final page content as rendered by the view, or any error message.

context

The template Context instance that was used to render the template that produced the response content.

If the rendered page used multiple templates, then context will be a list of Context objects, in the order in which they were rendered.

Regardless of the number of templates used during rendering, you can retrieve context values using the [] operator. For example, the context variable name could be retrieved using:

Code
>>> response = client.get('/foo/')
>>> response.context['name']
'Arthur'
json(**kwargs)

The body of the response, parsed as JSON. Extra keyword arguments are passed to json.loads(). For example:

Code
>>> response = client.get('/foo/')
>>> response.json()['name']
'Arthur'

If the Content-Type header is not "application/json", then a ValueError will be raised when trying to parse the response.

request

Data diminta yang merangsang tanggapan.

wsgi_request

The WSGIRequest instance generated by the test handler that generated the response.

status_code

Keadaan HTTP dari tanggapan, sebagai sebuah integer. Untuk daftar penuh dari kode yang ditentukan, lihat IANA status code registry.

templates

A list of Template instances used to render the final content, in the order they were rendered. For each template in the list, use template.name to get the template's file name, if the template was loaded from a file. (The name is a string such as 'admin/index.html'.)

resolver_match

An instance of ResolverMatch for the response. You can use the func attribute, for example, to verify the view that served the response:

Code
# my_view here is a function based view
self.assertEqual(response.resolver_match.func, my_view)

# class-based views need to be compared by name, as the functions
# generated by as_view() won't be equal
self.assertEqual(response.resolver_match.func.__name__, MyView.as_view().__name__)

Jika URL diberikan tidak ditemukan, mengakses atribut ini akan memunculkan pengecualian Resolver404.

You can also use dictionary syntax on the response object to query the value of any settings in the HTTP headers. For example, you could determine the content type of a response using response['Content-Type'].

Pengecualian

If you point the test client at a view that raises an exception, that exception will be visible in the test case. You can then use a standard try ... except block or assertRaises() to test for exceptions.

The only exceptions that are not visible to the test client are Http404, PermissionDenied, SystemExit, and SuspiciousOperation. Django catches these exceptions internally and converts them into the appropriate HTTP response codes. In these cases, you can check response.status_code in your test.

Keadaan gigih

The test client is stateful. If a response returns a cookie, then that cookie will be stored in the test client and sent with all subsequent get() and post() requests.

Expiration policies for these cookies are not followed. If you want a cookie to expire, either delete it manually or create a new Client instance (which will effectively delete all cookies).

A test client has two attributes that store persistent state information. You can access these properties as part of a test condition.

Client.cookies

A Python SimpleCookie object, containing the current values of all the client cookies. See the documentation of the http.cookies module for more.

Client.session

A dictionary-like object containing session information. See the session documentation for full details.

To modify the session and then save it, it must be stored in a variable first (because a new SessionStore is created every time this property is accessed):

Code
def test_something(self):
    session = self.client.session
    session['somekey'] = 'test'
    session.save()

Mengatur bahasa

When testing applications that support internationalization and localization, you might want to set the language for a test client request. The method for doing so depends on whether or not the LocaleMiddleware is enabled.

If the middleware is enabled, the language can be set by creating a cookie with a name of LANGUAGE_COOKIE_NAME and a value of the language code:

Code
from django.conf import settings

def test_language_using_cookie(self):
    self.client.cookies.load({settings.LANGUAGE_COOKIE_NAME: 'fr'})
    response = self.client.get('/')
    self.assertEqual(response.content, b"Bienvenue sur mon site.")

atau dengan menyertakan kepala HTTP Accept-Language dalam permintaan:

Code
def test_language_using_header(self):
    response = self.client.get('/', HTTP_ACCEPT_LANGUAGE='fr')
    self.assertEqual(response.content, b"Bienvenue sur mon site.")

Lebih rinci adalah dalam Bagaimana Django menemukan pilihan bahasa.

Jika middleware tidak diadakan, bahasa aktif mungkin disetel menggunakan translation.override():

Code
from django.utils import translation

def test_language_using_override(self):
    with translation.override('fr'):
        response = self.client.get('/')
    self.assertEqual(response.content, b"Bienvenue sur mon site.")

Lebih rinci adalah di Explicitly setting the active language.

Contoh

Berikut adalah percobaan satuan sederhana menggunakan percobaan klien:

Code
import unittest
from django.test import Client

class SimpleTest(unittest.TestCase):
    def setUp(self):
        # Every test needs a client.
        self.client = Client()

    def test_details(self):
        # Issue a GET request.
        response = self.client.get('/customer/details/')

        # Check that the response is 200 OK.
        self.assertEqual(response.status_code, 200)

        # Check that the rendered context contains 5 customers.
        self.assertEqual(len(response.context['customers']), 5)

Disediakan kelas-kelas percobaan kasus

Normal Python unit test classes extend a base class of unittest.TestCase. Django provides a few extensions of this base class:

Hierarchy of Django unit testing classes (TestCase subclasses)

Susunan dari satuan kelas-kelas percobaan Django

Converting a normal unittest.TestCase to any of the subclasses is easy: change the base class of your test from unittest.TestCase to the subclass. All of the standard Python unit test functionality will be available, and it will be augmented with some useful additions as described in each section below.

SimpleTestCase

class SimpleTestCase

Sebauh subkelas unittest.TestCase yang menambahkan kegunaan ini:

If your tests make any database queries, use subclasses TransactionTestCase or TestCase.

SimpleTestCase.allow_database_queries

SimpleTestCase disallows database queries by default. This helps to avoid executing write queries which will affect other tests since each SimpleTestCase test isn't run in a transaction. If you aren't concerned about this problem, you can disable this behavior by setting the allow_database_queries class attribute to True on your test class.

TransactionTestCase

class TransactionTestCase

TransactionTestCase mewarisi dari SimpleTestCase untuk menambah beberapa fitur-fitur khusus-basisdata:

  • Resetting the database to a known state at the beginning of each test to ease testing and using the ORM.

  • Basisdata fixtures.

  • Mencoba SimpleTestCase

  • The remaining specialized assert* methods.

Django's TestCase class is a more commonly used subclass of TransactionTestCase that makes use of database transaction facilities to speed up the process of resetting the database to a known state at the beginning of each test. A consequence of this, however, is that some database behaviors cannot be tested within a Django TestCase class. For instance, you cannot test that a block of code is executing within a transaction, as is required when using select_for_update(). In those cases, you should use TransactionTestCase.

TransactionTestCase and TestCase are identical except for the manner in which the database is reset to a known state and the ability for test code to test the effects of commit and rollback:

  • A TransactionTestCase resets the database after the test runs by truncating all tables. A TransactionTestCase may call commit and rollback and observe the effects of these calls on the database.

  • A TestCase, on the other hand, does not truncate tables after a test. Instead, it encloses the test code in a database transaction that is rolled back at the end of the test. This guarantees that the rollback at the end of the test restores the database to its initial state.

TestCase

class TestCase

This is the most common class to use for writing tests in Django. It inherits from TransactionTestCase (and by extension SimpleTestCase). If your Django application doesn't use a database, use SimpleTestCase.

The class:

  • Wraps the tests within two nested atomic() blocks: one for the whole class and one for each test. Therefore, if you want to test some specific database transaction behavior, use TransactionTestCase.

  • Checks deferrable database constraints at the end of each test.

Itu juga menyediakan sebuah metode tambahan:

classmethod TestCase.setUpTestData()

The class-level atomic block described above allows the creation of initial data at the class level, once for the whole TestCase. This technique allows for faster tests as compared to using setUp().

Sebagai contoh:

Code
from django.test import TestCase

class MyTests(TestCase):
    @classmethod
    def setUpTestData(cls):
        # Set up data for the whole TestCase
        cls.foo = Foo.objects.create(bar="Test")
        ...

    def test1(self):
        # Some test using self.foo
        ...

    def test2(self):
        # Some other test using self.foo
        ...

Note that if the tests are run on a database with no transaction support (for instance, MySQL with the MyISAM engine), setUpTestData() will be called before each test, negating the speed benefits.

Be careful not to modify any objects created in setUpTestData() in your test methods. Modifications to in-memory objects from setup work done at the class level will persist between test methods. If you do need to modify them, you could reload them in the setUp() method with refresh_from_db(), for example.

LiveServerTestCase

class LiveServerTestCase

LiveServerTestCase does basically the same as TransactionTestCase with one extra feature: it launches a live Django server in the background on setup, and shuts it down on teardown. This allows the use of automated test clients other than the Django dummy client such as, for example, the Selenium client, to execute a series of functional tests inside a browser and simulate a real user's actions.

The live server listens on localhost and binds to port 0 which uses a free port assigned by the operating system. The server's URL can be accessed with self.live_server_url during the tests.

To demonstrate how to use LiveServerTestCase, let's write a simple Selenium test. First of all, you need to install the selenium package into your Python path:

Shell
$ pip install selenium

Then, add a LiveServerTestCase-based test to your app's tests module (for example: myapp/tests.py). For this example, we'll assume you're using the staticfiles app and want to have static files served during the execution of your tests similar to what we get at development time with DEBUG=True, i.e. without having to collect them using collectstatic. We'll use the StaticLiveServerTestCase subclass which provides that functionality. Replace it with django.test.LiveServerTestCase if you don't need that.

Kode untuk percobaan ini mungkin terlihat seperti berikut:

Code
from django.contrib.staticfiles.testing import StaticLiveServerTestCase
from selenium.webdriver.firefox.webdriver import WebDriver

class MySeleniumTests(StaticLiveServerTestCase):
    fixtures = ['user-data.json']

    @classmethod
    def setUpClass(cls):
        super(MySeleniumTests, cls).setUpClass()
        cls.selenium = WebDriver()
        cls.selenium.implicitly_wait(10)

    @classmethod
    def tearDownClass(cls):
        cls.selenium.quit()
        super(MySeleniumTests, cls).tearDownClass()

    def test_login(self):
        self.selenium.get('%s%s' % (self.live_server_url, '/login/'))
        username_input = self.selenium.find_element_by_name("username")
        username_input.send_keys('myuser')
        password_input = self.selenium.find_element_by_name("password")
        password_input.send_keys('secret')
        self.selenium.find_element_by_xpath('//input[@value="Log in"]').click()

Akhirnya, anda dapat menjalankan percobaan sebagai berikut:

Shell
$ ./manage.py test myapp.tests.MySeleniumTests.test_login

Contoh ini akan otomatis membuka Firefox kemudian pergi ke halaman masuk, masuk mandat dan tekan tombol "Log in". Selenium menawarkan driver-driver lain dalam kasus anda tidak mempunyai Firefox terpasang atau berharap menggunakan peramban lain. Contoh diatas hanya bagian kecil dari apa klien Selenium dapat lakukan; periksa full reference untuk rincian lebih.

Fitur percobaan kasus

Percobaan klien awal

SimpleTestCase.client

Every test case in a django.test.*TestCase instance has access to an instance of a Django test client. This client can be accessed as self.client. This client is recreated for each test, so you don't have to worry about state (such as cookies) carrying over from one test to another.

This means, instead of instantiating a Client in each test:

Code
import unittest
from django.test import Client

class SimpleTest(unittest.TestCase):
    def test_details(self):
        client = Client()
        response = client.get('/customer/details/')
        self.assertEqual(response.status_code, 200)

    def test_index(self):
        client = Client()
        response = client.get('/customer/index/')
        self.assertEqual(response.status_code, 200)

...anda dapat hanya mengacu ke self.client, seperti itu:

Code
from django.test import TestCase

class SimpleTest(TestCase):
    def test_details(self):
        response = self.client.get('/customer/details/')
        self.assertEqual(response.status_code, 200)

    def test_index(self):
        response = self.client.get('/customer/index/')
        self.assertEqual(response.status_code, 200)

Menyesuaian klien percobaan

SimpleTestCase.client_class

If you want to use a different Client class (for example, a subclass with customized behavior), use the client_class class attribute:

Code
from django.test import TestCase, Client

class MyTestClient(Client):
    # Specialized methods for your environment
    ...

class MyTest(TestCase):
    client_class = MyTestClient

    def test_my_stuff(self):
        # Here self.client is an instance of MyTestClient...
        call_some_test_code()

Fixture loading

TransactionTestCase.fixtures

A test case for a database-backed website isn't much use if there isn't any data in the database. Tests are more readable and it's more maintainable to create objects using the ORM, for example in TestCase.setUpTestData(), however, you can also use fixtures.

A fixture is a collection of data that Django knows how to import into a database. For example, if your site has user accounts, you might set up a fixture of fake user accounts in order to populate your database during tests.

The most straightforward way of creating a fixture is to use the manage.py dumpdata command. This assumes you already have some data in your database. See the dumpdata documentation for more details.

Once you've created a fixture and placed it in a fixtures directory in one of your INSTALLED_APPS, you can use it in your unit tests by specifying a fixtures class attribute on your django.test.TestCase subclass:

Code
from django.test import TestCase
from myapp.models import Animal

class AnimalTestCase(TestCase):
    fixtures = ['mammals.json', 'birds']

    def setUp(self):
        # Test definitions as before.
        call_setup_methods()

    def testFluffyAnimals(self):
        # A test that uses the fixtures.
        call_some_test_code()

Ini adalah secara khusus apa yang akan terjadi:

  • At the start of each test, before setUp() is run, Django will flush the database, returning the database to the state it was in directly after migrate was called.

  • Then, all the named fixtures are installed. In this example, Django will install any JSON fixture named mammals, followed by any fixture named birds. See the loaddata documentation for more details on defining and installing fixtures.

For performance reasons, TestCase loads fixtures once for the entire test class, before setUpTestData(), instead of before each test, and it uses transactions to clean the database before each test. In any case, you can be certain that the outcome of a test will not be affected by another test or by the order of test execution.

By default, fixtures are only loaded into the default database. If you are using multiple databases and set multi_db=True, fixtures will be loaded into all databases.

Konfigurasi URLconf

If your application provides views, you may want to include tests that use the test client to exercise those views. However, an end user is free to deploy the views in your application at any URL of their choosing. This means that your tests can't rely upon the fact that your views will be available at a particular URL. Decorate your test class or test method with @override_settings(ROOT_URLCONF=...) for URLconf configuration.

Dukungan banyak-basisdata

TransactionTestCase.multi_db

Django menyetel basisdata percobaan sesuai pada setiap basisdata yang ditentukan dalam pengertian DATABASES dalam berkas pengaturan anda. Bagaimanapun, bagian besar dari waktu diambil untuk menjalankan Django TestCase diskonsumsi dengan memanggil flush yang memastikan bahwa anda telah memiliki basisdata bersih pada awal dari setiap percobaan berjalan. Jika anda mempunyai banyak basisdata, banyak flush dibutuhkan (satu untuk setiap basisdata), yang aktiviatsnya dapat memakan waktu -- khususnya jika percobaan anda tidak butuh mencoba aktivitas banyak-basisdata.

As an optimization, Django only flushes the default database at the start of each test run. If your setup contains multiple databases, and you have a test that requires every database to be clean, you can use the multi_db attribute on the test suite to request a full flush.

Sebagai contoh:

Code
class TestMyViews(TestCase):
    multi_db = True

    def test_index_page_view(self):
        call_some_test_code()

This test case will flush all the test databases before running test_index_page_view.

The multi_db flag also affects into which databases the TransactionTestCase.fixtures are loaded. By default (when multi_db=False), fixtures are only loaded into the default database. If multi_db=True, fixtures are loaded into all databases.

Pengaturan utama

SimpleTestCase.settings()

For testing purposes it's often useful to change a setting temporarily and revert to the original value after running the testing code. For this use case Django provides a standard Python context manager (see PEP 343) called settings(), which can be used like this:

Code
from django.test import TestCase

class LoginTestCase(TestCase):

    def test_login(self):

        # First check for the default behavior
        response = self.client.get('/sekrit/')
        self.assertRedirects(response, '/accounts/login/?next=/sekrit/')

        # Then override the LOGIN_URL setting
        with self.settings(LOGIN_URL='/other/login/'):
            response = self.client.get('/sekrit/')
            self.assertRedirects(response, '/other/login/?next=/sekrit/')

This example will override the LOGIN_URL setting for the code in the with block and reset its value to the previous state afterwards.

SimpleTestCase.modify_settings()

It can prove unwieldy to redefine settings that contain a list of values. In practice, adding or removing values is often sufficient. The modify_settings() context manager makes it easy:

Code
from django.test import TestCase

class MiddlewareTestCase(TestCase):

    def test_cache_middleware(self):
        with self.modify_settings(MIDDLEWARE={
            'append': 'django.middleware.cache.FetchFromCacheMiddleware',
            'prepend': 'django.middleware.cache.UpdateCacheMiddleware',
            'remove': [
                'django.contrib.sessions.middleware.SessionMiddleware',
                'django.contrib.auth.middleware.AuthenticationMiddleware',
                'django.contrib.messages.middleware.MessageMiddleware',
            ],
        }):
            response = self.client.get('/')
            # ...

For each action, you can supply either a list of values or a string. When the value already exists in the list, append and prepend have no effect; neither does remove when the value doesn't exist.

override_settings()

In case you want to override a setting for a test method, Django provides the override_settings() decorator (see PEP 318). It's used like this:

Code
from django.test import TestCase, override_settings

class LoginTestCase(TestCase):

    @override_settings(LOGIN_URL='/other/login/')
    def test_login(self):
        response = self.client.get('/sekrit/')
        self.assertRedirects(response, '/other/login/?next=/sekrit/')

The decorator can also be applied to TestCase classes:

Code
from django.test import TestCase, override_settings

@override_settings(LOGIN_URL='/other/login/')
class LoginTestCase(TestCase):

    def test_login(self):
        response = self.client.get('/sekrit/')
        self.assertRedirects(response, '/other/login/?next=/sekrit/')
modify_settings()

Likewise, Django provides the modify_settings() decorator:

Code
from django.test import TestCase, modify_settings

class MiddlewareTestCase(TestCase):

    @modify_settings(MIDDLEWARE={
        'append': 'django.middleware.cache.FetchFromCacheMiddleware',
        'prepend': 'django.middleware.cache.UpdateCacheMiddleware',
    })
    def test_cache_middleware(self):
        response = self.client.get('/')
        # ...

The decorator can also be applied to test case classes:

Code
from django.test import TestCase, modify_settings

@modify_settings(MIDDLEWARE={
    'append': 'django.middleware.cache.FetchFromCacheMiddleware',
    'prepend': 'django.middleware.cache.UpdateCacheMiddleware',
})
class MiddlewareTestCase(TestCase):

    def test_cache_middleware(self):
        response = self.client.get('/')
        # ...

You can also simulate the absence of a setting by deleting it after settings have been overridden, like this:

Code
@override_settings()
def test_something(self):
    del settings.LOGIN_URL
    ...

When overriding settings, make sure to handle the cases in which your app's code uses a cache or similar feature that retains state even if the setting is changed. Django provides the django.test.signals.setting_changed signal that lets you register callbacks to clean up and otherwise reset state when settings are changed.

Django itu sendiri menggunakan sinyal ini untuk menyetel kembali beragam data:

Pengaturan ditimpa

Setel kembali data

USE_TZ, TIME_ZONE

Zona waktu basisdata

TEMPLATES

Mesin cetakan

SERIALIZATION_MODULES

Serializers cache

LOCALE_PATHS, LANGUAGE_CODE

Terjemahan awalan dan terjemahan dimuat

MEDIA_ROOT, DEFAULT_FILE_STORAGE

Penyimpanan berkas awal

Emptying the test outbox

If you use any of Django's custom TestCase classes, the test runner will clear the contents of the test email outbox at the start of each test case.

Untuk lebih rincian pada layanan surel selama percobaan, lihat Email services dibawah.

Penegasan

As Python's normal unittest.TestCase class implements assertion methods such as assertTrue() and assertEqual(), Django's custom TestCase class provides a number of custom assertion methods that are useful for testing Web applications:

The failure messages given by most of these assertion methods can be customized with the msg_prefix argument. This string will be prefixed to any failure message generated by the assertion. This allows you to provide additional details that may help you to identify the location and cause of a failure in your test suite.

SimpleTestCase.assertRaisesMessage(expected_exception, expected_message, callable, *args, **kwargs)
SimpleTestCase.assertRaisesMessage(expected_exception, expected_message)

Asserts that execution of callable raises expected_exception and that expected_message is found in the exception's message. Any other outcome is reported as a failure. It's a simpler version of unittest.TestCase.assertRaisesRegex() with the difference that expected_message isn't treated as a regular expression.

Jika hanya parameter expected_exception dan expected_message diberikan, mengembalikan sebuah pengelola konteks sehingga kode sedang dicobakan dapat ditulir berderet daripada sebagai sebuah fungsi:

Code
with self.assertRaisesMessage(ValueError, 'invalid literal for int()'):
    int('a')
SimpleTestCase.assertFieldOutput(fieldclass, valid, invalid, field_args=None, field_kwargs=None, empty_value='')

Asserts that a form field behaves correctly with various inputs.

Parameter:

  • fieldclass -- kelas dari bidang yang akan dicoba.

  • valid -- a dictionary mapping valid inputs to their expected cleaned values.

  • invalid -- a dictionary mapping invalid inputs to one or more raised error messages.

  • field_args -- the args passed to instantiate the field.

  • field_kwargs -- the kwargs passed to instantiate the field.

  • empty_value -- keluaran bersih diharapkan untuk masukan dalam empty_values.

For example, the following code tests that an EmailField accepts a@a.com as a valid email address, but rejects aaa with a reasonable error message:

Code
self.assertFieldOutput(EmailField, {'a@a.com': 'a@a.com'}, {'aaa': ['Enter a valid email address.']})
SimpleTestCase.assertFormError(response, form, field, errors, msg_prefix='')

Asserts that a field on a form raises the provided list of errors when rendered on the form.

form adalah nama instance Form telah diberikan dalam konteks cetakan.

field is the name of the field on the form to check. If field has a value of None, non-field errors (errors you can access via form.non_field_errors()) will be checked.

errors is an error string, or a list of error strings, that are expected as a result of form validation.

SimpleTestCase.assertFormsetError(response, formset, form_index, field, errors, msg_prefix='')

Asserts that the formset raises the provided list of errors when rendered.

formset is the name the Formset instance was given in the template context.

form_index is the number of the form within the Formset. If form_index has a value of None, non-form errors (errors you can access via formset.non_form_errors()) will be checked.

field is the name of the field on the form to check. If field has a value of None, non-field errors (errors you can access via form.non_field_errors()) will be checked.

errors is an error string, or a list of error strings, that are expected as a result of form validation.

SimpleTestCase.assertContains(response, text, count=None, status_code=200, msg_prefix='', html=False)

Asserts that a Response instance produced the given status_code and that text appears in the content of the response. If count is provided, text must occur exactly count times in the response.

Setel html menjadi True untuk menangani text sebagai HTML. Perbandingan dengan tanggapan isi akan berdasarkan pada semantik HTML dari kesetaraan karakter-demi-karakter. Ruang kosong adalah diabaikan pada banyak kasus, urutan atribut tidak signifikan. Lihat assertHTMLEqual() untuk rincian lebih.

SimpleTestCase.assertNotContains(response, text, status_code=200, msg_prefix='', html=False)

Tegaskan bahwa instance Response menghasilkan status_code dan text itu diberikan tidak muncul dalam isi dari tanggapan.

Setel html menjadi True untuk menangani text sebagai HTML. Perbandingan dengan tanggapan isi akan berdasarkan pada semantik HTML dari kesetaraan karakter-demi-karakter. Ruang kosong adalah diabaikan pada banyak kasus, urutan atribut tidak signifikan. Lihat assertHTMLEqual() untuk rincian lebih.

SimpleTestCase.assertTemplateUsed(response, template_name, msg_prefix='', count=None)

Tegaskan bahwa cetakan dengan nama diberikan digunakan dalam membangun tanggapan.

Nama adalah sebuah string seperti 'admin/index.html'.

Argumen hitung adalah sebuah integer menunjukkan sejumlah kali cetakan harus dibangun. Awalan adalah None, berarti bahwa cetakan harus dikirim satu atau beberapa kali.

Anda dapat menggunakan ini sebagai pengelola konteks, seperti ini:

Code
with self.assertTemplateUsed('index.html'):
    render_to_string('index.html')
with self.assertTemplateUsed(template_name='index.html'):
    render_to_string('index.html')
SimpleTestCase.assertTemplateNotUsed(response, template_name, msg_prefix='')

Tegaskan bahwa cetakan dengan nama diberikan tidak digunakan dalam membangun tanggapan.

Anda dapat menggunakan ini sebagai pengelola konteks dalam cara sama seperti assertTemplateUsed().

SimpleTestCase.assertRedirects(response, expected_url, status_code=302, target_status_code=200, msg_prefix='', fetch_redirect_response=True)

Tegaskan bahwa tanggapan mengembalikan keadaan pengalihan status_code, dialihkan ke expected_url (termasuk data GET apapun), dan bahwa halaman akhir telah diterima dengan target_status_code.

Jika permintaan anda menggunakan argumen follow, expected_url dan target_status_code akan berupa url dan kode keadaan untuk titik akhir dari rantai pengalihan.

Jika fetch_redirect_response adalah False, halaman akhir tidak akan dimuat. Sejak klien percobaan tidak dapat mengambil URL luar, ini khususnya berguna jika expected_url bukan bagian dari aplikasi Django anda.

Skema ditangani dengan benar ketika membuat perbandingan diantara dua URL. Jika tidak ada skema apapun ditentukan dalam tempat dimana kami mengalihkan, skema permintaan asli digunakan. Jika hadir, skema dalam expected_url adalah satu digunakan untuk membuat perbandingan.

SimpleTestCase.assertHTMLEqual(html1, html2, msg=None)

Tegaskan bahwa string html1 dan html2 adalah sama. Perbandingan berdasarkan pada semantik HTML. Perbandingan mengambil hal-hal berikut kedalam akun:

  • Ruang kosong sebelum dan setelah etiket HTML diabaikan.

  • Semua jenis ruang kosong dianggap setara.

  • Semua etiket buka ditutup mutlak, yaitu ketika sekeliling etiket ditutup atau dokumen HTML berakhir.

  • Etiket kosong adalah setara pada versi penutupan-sendiri mereka.

  • Urutan dari atribut-atribut dari sebuah unsur HTML tidak signifikan.

  • Atribut-atribut tanpa sebuah argumen adalah sama pada atribut-atribut yang sama dalam nama dan nilai (lihat contoh-contoh).

Contoh-contoh berikut adalah percobaan sah dan tidak memunculkan AssertionError apapun:

Code
self.assertHTMLEqual(
    '<p>Hello <b>world!</p>',
    '''<p>
        Hello   <b>world! <b/>
    </p>'''
)
self.assertHTMLEqual(
    '<input type="checkbox" checked="checked" id="id_accept_terms" />',
    '<input id="id_accept_terms" type="checkbox" checked>'
)

html1 dan html2 harus berupa HTML sah. Sebuah AssertionError akan dumunculkan jika satu dari mereka tidak dapat diuraikan.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

SimpleTestCase.assertHTMLNotEqual(html1, html2, msg=None)

Tegaskan bahwa string html1 dan html2 tidak sama. Perbandingan berdasarkan pada semantik HTML. Lihat assertHTMLEqual() untuk rincian.

html1 dan html2 harus berupa HTML sah. Sebuah AssertionError akan dumunculkan jika satu dari mereka tidak dapat diuraikan.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

SimpleTestCase.assertXMLEqual(xml1, xml2, msg=None)

Tegaskan bahwa string xml1 dan xml2 adalah sama. Perbandingan berdasarkan pada semantik XML. Mirip pada assertXMLEqual(), perbandingan dibuat pada isi diurai, dengan demikian hanya perbedaan semantik dipertimbangkan, bukan perbedaan sintaksis. Ketika XML tidak sah dilewatkan dalam parameter apapun, sebuah AssertionError selalu dimunculkan, bahkan jika kedua string adalah mirip.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

SimpleTestCase.assertXMLNotEqual(xml1, xml2, msg=None)

Tegaskan bahwa string xml1 dan xml2 adalah tidak sama. Perbandingan berdasarkan pada semantik XML. Lihat assertXMLEqual() untuk rincian.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

SimpleTestCase.assertInHTML(needle, haystack, count=None, msg_prefix='')

Tegaskan bahwa bagian HTML needle dikandung dalam satu di haystack.

Jika argumen integer count ditentukan, kemudian tambahannya sejumlah dari kejadian needle akan diperiksa secara ketat.

Ruang kosong di banyak kasus diabaikan, dan urutan atribut tidak signifikan. Argumen berlalu harus HTML yang sah.

SimpleTestCase.assertJSONEqual(raw, expected_data, msg=None)

Menegaskan bahwa fragmen JSON raw dan expected_data adalah setara. Aturan ruang kosong bukan-signifikan JSON biasa berlaku sebagai kelas berat dilimpahkan ke pustaka json.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

SimpleTestCase.assertJSONNotEqual(raw, expected_data, msg=None)

Asserts that the JSON fragments raw and expected_data are not equal. See assertJSONEqual() for further details.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

TransactionTestCase.assertQuerysetEqual(qs, values, transform=repr, ordered=True, msg=None)

Tegaskan bahwa sebuah queryset qs mengembalikan daftar tertentu dari nilai values.

The comparison of the contents of qs and values is performed using the function transform; by default, this means that the repr() of each value is compared. Any other callable can be used if repr() doesn't provide a unique or helpful comparison.

By default, the comparison is also ordering dependent. If qs doesn't provide an implicit ordering, you can set the ordered parameter to False, which turns the comparison into a collections.Counter comparison. If the order is undefined (if the given qs isn't ordered and the comparison is against more than one ordered values), a ValueError is raised.

Keluaran dalam rangka kesalahan dapat disesuaikan dengan argumen msg.

TransactionTestCase.assertNumQueries(num, func, *args, **kwargs)

Tegaskan itu ketika func dipanggil dengan *args dan **kwargs yang permintaan basisdata num dijalankan.

If a "using" key is present in kwargs it is used as the database alias for which to check the number of queries. If you wish to call a function with a using parameter you can do it by wrapping the call with a lambda to add an extra parameter:

Code
self.assertNumQueries(7, lambda: my_function(using=7))

Anda dapat juga menggunakan ini sebagai pengelola konteks:

Code
with self.assertNumQueries(2):
    Person.objects.create(name="Aaron")
    Person.objects.create(name="Daniel")

Percobaan etiket

Anda dapat mengetiket percobaan anda sehingga anda dapat dengan mudah menjalankan subset tertentu. Sebagai contoh, anda mungkin melabeli percobaan cepat atau lambat:

Code
from django.test import tag

class SampleTestCase(TestCase):

    @tag('fast')
    def test_fast(self):
        ...

    @tag('slow')
    def test_slow(self):
        ...

    @tag('slow', 'core')
    def test_slow_but_core(self):
        ...

Anda dapat juga mengetiket sebuah kasus percobaan:

Code
@tag('slow', 'core')
class SampleTestCase(TestCase):
    ...

Kemudian anda dapat memilih percobaan mana dijalankan. Sebagai contoh, untuk hanya menjalankan percobaan cepat:

Shell
$ ./manage.py test --tag=fast

Atau untuk menjalankan percobaan cepat dan satu ini (bahkan meskipun itu lambat):

Shell
$ ./manage.py test --tag=fast --tag=core

Anda dapat juga tidak menyertakan percobaan dengan etiket. Untuk menjalankan percobaan inti jika mereka tidak lambat:

Shell
$ ./manage.py test --tag=core --exclude-tag=slow

test --exclude-tag has precedence over test --tag, so if a test has two tags and you select one of them and exclude the other, the test won't be run.

Layanan surel

If any of your Django views send email using Django's email functionality, you probably don't want to send email each time you run a test using that view. For this reason, Django's test runner automatically redirects all Django-sent email to a dummy outbox. This lets you test every aspect of sending email -- from the number of messages sent to the contents of each message -- without actually sending the messages.

The test runner accomplishes this by transparently replacing the normal email backend with a testing backend. (Don't worry -- this has no effect on any other email senders outside of Django, such as your machine's mail server, if you're running one.)

django.core.mail.outbox

During test running, each outgoing email is saved in django.core.mail.outbox. This is a simple list of all EmailMessage instances that have been sent. The outbox attribute is a special attribute that is created only when the locmem email backend is used. It doesn't normally exist as part of the django.core.mail module and you can't import it directly. The code below shows how to access this attribute correctly.

Ini adalah sebuah contoh percobaan yang menguji django.core.mail.outbox untuk panjang dan isi:

Code
from django.core import mail
from django.test import TestCase

class EmailTest(TestCase):
    def test_send_email(self):
        # Send message.
        mail.send_mail(
            'Subject here', 'Here is the message.',
            'from@example.com', ['to@example.com'],
            fail_silently=False,
        )

        # Test that one message has been sent.
        self.assertEqual(len(mail.outbox), 1)

        # Verify that the subject of the first message is correct.
        self.assertEqual(mail.outbox[0].subject, 'Subject here')

As noted previously, the test outbox is emptied at the start of every test in a Django *TestCase. To empty the outbox manually, assign the empty list to mail.outbox:

Code
from django.core import mail

# Empty the test outbox
mail.outbox = []

Pengelolaan perintah

Perintah pengelolaan dapat dicobakan dengan fungsi call_command(). Keluaran dapat dialihkan kedalam instance StringIO

Code
from django.core.management import call_command
from django.test import TestCase
from django.utils.six import StringIO

class ClosepollTest(TestCase):
    def test_command_output(self):
        out = StringIO()
        call_command('closepoll', stdout=out)
        self.assertIn('Expected output', out.getvalue())

Melewati percobaan

The unittest library provides the @skipIf and @skipUnless decorators to allow you to skip tests if you know ahead of time that those tests are going to fail under certain conditions.

For example, if your test requires a particular optional library in order to succeed, you could decorate the test case with @skipIf. Then, the test runner will report that the test wasn't executed and why, instead of failing the test or omitting the test altogether.

Untuk melengkapi perilaku melewati percobaan ini, Django menyediakan dua tambahan penghias melewatkan. Daripada mencoba boolean umum, penghias ini memeriksa kemampuan dari basisdata, dan melewati percobaan jika basisdata tidak mendukung fitur bernama khusus.

The decorators use a string identifier to describe database features. This string corresponds to attributes of the database connection features class. See django.db.backends.BaseDatabaseFeatures class for a full list of database features that can be used as a basis for skipping tests.

skipIfDBFeature(*feature_name_strings)

Skip the decorated test or TestCase if all of the named database features are supported.

Sebagai contoh, percobaan berikut tidak akan dijalankan jika transaksi dukungan basisdata (sebagai contoh, dia tidak akan berjalan dibawah PostgreSQL, tetapi dia dibawah MySQL dengan tabel MyISAM):

Code
class MyTests(TestCase):
    @skipIfDBFeature('supports_transactions')
    def test_transaction_behavior(self):
        # ... conditional test code
        pass
skipUnlessDBFeature(*feature_name_strings)

Lewati percobaan penghias atau TestCase jika salah satu dari fitur basisdata bernama tidak didukung.

Sebagai contoh, percobaan berikut hanya akan dijalankan jika transaksi dukungan basisdata (sebagai contoh, dia akan berjalan dibawah PostgreSQL, tetapi bukan dibawah MySQL dengan tabel MyISAM):

Code
class MyTests(TestCase):
    @skipUnlessDBFeature('supports_transactions')
    def test_transaction_behavior(self):
        # ... conditional test code
        pass

This page as Markdown JSON

Edit this page on GitHub Official version