--- title: "Alat percobaan" version: 3.0 locale: id source: https://docs.djangoproject.com/id/3.0/topics/testing/tools/ canonical: https://djangodocs.dev/id/3.0/topics/testing/tools/ --- # 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](http://seleniumhq.org/) 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](http://seleniumhq.org/) 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`](#django.test.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: ``` >>> 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'>> c.get('/login/') ``` Ini tidak benar: ``` >>> 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`](https://docs.python.org/3/library/urllib.html#module-urllib). - To resolve URLs, the test client uses whatever URLconf is pointed-to by your [`ROOT_URLCONF`](/id/3.0/ref/settings/#std-setting-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: ``` >>> 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, json_encoder=DjangoJSONEncoder, **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: ``` >>> c = Client(HTTP_USER_AGENT='Mozilla/5.0') ``` The values from the `extra` keywords arguments passed to [`get()`](#django.test.Client.get), [`post()`](#django.test.Client.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). The `json_encoder` argument allows setting a custom JSON encoder for the JSON serialization that's described in [`post()`](#django.test.Client.post). The `raise_request_exception` argument allows controlling whether or not exceptions raised during the request should also be raised in the test. Defaults to `True`. > **New in Django 3.0** > > The `raise_request_exception` argument was added. 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: ``` >>> c = Client() >>> c.get('/customers/details/', {'name': 'fred', 'age': 7}) ``` ...will result in the evaluation of a GET request equivalent to: ``` /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: ``` >>> 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()`](/id/3.0/ref/request-response/#django.http.HttpRequest.is_ajax) method. > **spesifikasi CGI** > > The headers sent via `**extra` should follow [CGI](https://www.w3.org/CGI/) specification. > For example, emulating a different "Host" header as sent in the > HTTP request from the browser to the server should be passed > as `HTTP_HOST`. 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: ``` >>> 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: ``` >>> 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: ``` >>> c = Client() >>> c.post('/login/', {'name': 'fred', 'passwd': 'secret'}) ``` ...will result in the evaluation of a POST request to this URL: ``` /login/ ``` ...dengan data POST ini: ``` name=fred&passwd=secret ``` If you provide `content_type` as `application/json`, the `data` is serialized using [`json.dumps()`](https://docs.python.org/3/library/json.html#json.dumps) if it's a dict, list, or tuple. Serialization is performed with [`DjangoJSONEncoder`](/id/3.0/topics/serialization/#django.core.serializers.json.DjangoJSONEncoder) by default, and can be overridden by providing a `json_encoder` argument to [`Client`](#django.test.Client). This serialization also happens for [`put()`](#django.test.Client.put), [`patch()`](#django.test.Client.patch), and [`delete()`](#django.test.Client.delete) requests. > **Changed in Django 2.2** > > The JSON serialization was extended to support lists and tuples. In > older versions, only dicts are serialized. If you provide any other `content_type` (e.g. `text/xml` for an XML payload), the contents of `data` are 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 `', '' ) ``` `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()`](#django.test.SimpleTestCase.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()`](#django.test.SimpleTestCase.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. XML declaration, document type, and comments are ignored. Only the root element and its children are compared. 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()`](#django.test.SimpleTestCase.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`](https://docs.python.org/3/library/json.html#module-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()`](#django.test.SimpleTestCase.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 by applying `transform` to `qs`. By default, this means that the `repr()` of each value in `qs` is compared to the `values`. 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: ``` self.assertNumQueries(7, using='non_default_db') ``` 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: ``` self.assertNumQueries(7, lambda: my_function(using=7)) ``` Anda dapat juga menggunakan ini sebagai pengelola konteks: ``` 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: ``` 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: ``` @tag('slow', 'core') class SampleTestCase(TestCase): ... ``` Subclasses inherit tags from superclasses, and methods inherit tags from their class. Given: ``` @tag('foo') class SampleTestCaseChild(SampleTestCase): @tag('bar') def test(self): ... ``` `SampleTestCaseChild.test` will be labeled with `'slow'`, `'core'`, `'bar'`, and `'foo'`. Kemudian anda dapat memilih percobaan mana dijalankan. Sebagai contoh, untuk hanya menjalankan percobaan cepat: ```console $ ./manage.py test --tag=fast ``` *Windows* ```doscon ...\> manage.py test --tag=fast ``` Atau untuk menjalankan percobaan cepat dan satu ini (bahkan meskipun itu lambat): ```console $ ./manage.py test --tag=fast --tag=core ``` *Windows* ```doscon ...\> manage.py test --tag=fast --tag=core ``` Anda dapat juga tidak menyertakan percobaan dengan etiket. Untuk menjalankan percobaan inti jika mereka tidak lambat: ```console $ ./manage.py test --tag=core --exclude-tag=slow ``` *Windows* ```doscon ...\> manage.py test --tag=core --exclude-tag=slow ``` [`test --exclude-tag`](/id/3.0/ref/django-admin/#cmdoption-test-exclude-tag) has precedence over [`test --tag`](/id/3.0/ref/django-admin/#cmdoption-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](/id/3.0/topics/email/), 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 list of all [`EmailMessage`](/id/3.0/topics/email/#django.core.mail.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`](/id/3.0/topics/email/#module-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: ``` 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](#emptying-test-outbox), 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`: ``` from django.core import mail # Empty the test outbox mail.outbox = [] ``` ## Pengelolaan perintah Perintah pengelolaan dapat dicobakan dengan fungsi [`call_command()`](/id/3.0/ref/django-admin/#django.core.management.call_command). Keluaran dapat dialihkan kedalam instance `StringIO` ``` from io import StringIO from django.core.management import call_command from django.test import TestCase 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`](https://docs.python.org/3/library/unittest.html#unittest.skipIf) and [`@skipUnless`](https://docs.python.org/3/library/unittest.html#unittest.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`](https://docs.python.org/3/library/unittest.html#unittest.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): ``` 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): ``` class MyTests(TestCase): @skipUnlessDBFeature('supports_transactions') def test_transaction_behavior(self): # ... conditional test code pass ```