Fakultas Ilmu Komputer UI

README.md 14.4 KB
Newer Older
Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
1
## Repository Tutorial PMPL
Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
2

Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
3
4
5
6
#### **Izzan Fakhril Islam (1606875806)**

**Daftar Tutorial:**

Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
7
8
9
1. Tutorial 1: Web Page Pribadi berbasis *Python* dengan *Unit test*.
2. Tutorial 2: Web Page *Todo List* dengan *Unit test* dan *Functional test*.
3. Tutorial 3: *Test Isolation* pada Django
Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
10

Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
**URL Heroku:** https://pmpl-izzan.herokuapp.com/

## **Penjelasan Tutorial 3**

Berdasarkan buku **Test-Driven Development with Python 2nd Edition,** bab 6, pengerjaan tutorial 3 ini mencakup beberapa hal sebagai berikut:

- Pemisahan berkas-berkas **Unit Test** dan **Functional Test** (*test isolation*)
- Penerapan `LiveServerTestCase` milik Django pada *unit test* dan *functional test* yang berfungsi untuk melakukan *data fetching* pada sebuah *session* tersendiri yang dibentuk oleh Django
- Penerapan **explicit wait** pada penggunaan *functional test* Django

Untuk memisahkan berkas-berkas **Unit Test** dan **Functional Test,** saya telah melakukan pemisahan *file* sejak pengerjaan Tutorial 1, dengan membagi file `tests.py` menjadi `unit_tests.py` dan `functional_tests.py`. Selanjutnya, saya membuat dua buah **CI pipeline job** di *file* `.gitlab-ci.yml` saya, yaitu *job* `FunctionalTest` dan `UnitTest`. Pada *job* `FunctionalTest` berisikan *script* sebagai berikut:

```bash
$ python manage.py test -p "functional_test*.py"
```

Sedangkan pada *job* `UnitTest` berisikan *script* sebagai berikut:

```bash
$ python manage.py test -p "unit_test*.py"
```

Berikut adalah struktur *file* dari project tutorial PMPL (**1606875806-tutorial**) saya:

```
.
├── tutorial
|   ├── __init__.py
|   ├── settings.py
|   ├── urls.py
|   └── wsgi.py
├── tutorial_1
|   ├── __init__.py
|   ├── admin.py
|   ├── apps.py
|   ├── functional_tests.py
|   ├── models.py
|   ├── unit_tests.py
|   ├── urls.py
|   └── views.py
├── tutorial_2
|   ├── __init__.py
|   ├── admin.py
|   ├── apps.py
|   ├── functional_tests.py
|   ├── models.py
|   ├── unit_tests.py
|   ├── urls.py
|   └── views.py
├── tutorial_3
|   ├── __init__.py
|   ├── apps.py
|   ├── functional_tests.py
|   └── unit_tests.py
├── .gitignore
├── .gitlab-ci.yml
├── db.sqlite3
├── deployment.sh
├── manage.py
├── Procfile
└── requirements.txt
```

Selanjutnya, saya menggunakan `LiveServerTestCase`, sebuah *library* dari `django.test` untuk melakukan *functional test* dan *unit test* pada tutorial 3 ini. Salah satu perbedaannya adalah pada baris kode berikut:

```python
class Tutorial2UnitTest(LiveServerTestCase)
```

dimana pada *unit test* ataupun *functional test* kali ini, meng-*extend* class `LiveServerTestCase`, bukan `UnitTest`. Kemudian, saya juga melakukan *data fetching* ke URL yang telah disediakan oleh `LiveServerTestCase`, yaitu sebagai berikut:

```python
response = Client().get(self.live_server_url + "/tutorial-2/")
```

Pada potongan kode diatas, terlihat bahwa URL yang coba di-*fetch* bukan lagi `localhost:8000`, melainkan `self.live_server_url` yang sudah disediakan oleh Django.

Selanjutnya, saya menerapkan ***explicit wait*** pada kode *functional test* tutorial 2 yang saya modifikasi dengan menggunakan *library* `time` bawaan Python. Pada dasarnya, Selenium sebagai *library* untuk *functional test* memiliki fitur bawaan untuk menunggu apabila sebuah halaman telah selesai di-*load*. *Library* tersebut bernama `implicitly_wait`. Namun, secara performa dan akurasi, lebih baik menggunakan *explicit wait* dengan *library* `time` bawaan Python.

Berikut adalah contoh implementasi *explicit wait* pada *functional test* yang telah saya buat:

```Python
def setUp(self):
  [...]
  self.MAX_WAIT = 10
  
def test_input_todo(self):
  start_time = time.time()
  selenium = self.selenium
  selenium.get(self.host)

  todo_date = selenium.find_element_by_id('todo_date')
  todo_date.send_keys('23052019')
  todo_date.send_keys(Keys.TAB)
  todo_date.send_keys('1245')

  todo_text = selenium.find_element_by_id('activity')
  todo_text.send_keys('Dummy')

  selenium.find_element_by_id('todo_submit').click()
  while True:
    try:
      table = selenium.find_element_by_id("todo_table")
      rows = table.find_elements_by_tag_name("td")
      self.assertIn('Dummy', [row.text for row in rows])
      return
    except (AssertionError, WebDriverException) as e:
      if time.time() - start_time > self.MAX_WAIT:
        raise e
        time.sleep(0.5)
```

- Digunakan variabel `MAX_WAIT` sebagai penanda batas waktu untuk melakukan *looping* menunggu halaman selesai di-*load*. Variabel ini bernilai 10 yang berarti 10 detik.
- Diberikan potongan kode `while True` dimana Selenium akan terus mengecek apakah terdapat kata `'Dummy'` dalam daftar tabel yang ditampilkan.
Izzan Fakhril Islam's avatar
Izzan Fakhril Islam committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
- Diberikan *error handling* pada potongan kode `except (AssertionError, WebDriverException) as e` dimana dilakukan pengecekan apakah waktu yang berjalan sudah melebihi nilai `MAX_WAIT`. Jika sudah, maka kedua *exeption* tersebut akan di-*raise* dan test gagal. Sedangkan jika belum, akan dilakukan *sleep* selama 0.5 detik sebelum kembali melakukan pengecekan.

## Penjelasan Tutorial 4

Berdasarkan buku **Test-Driven Development with Python 2nd Edition,** tutorial ini memiliki beberapa keterkaitan dengan materi yang disajikan di bab 7 (**Working Incrementally**), diantaranya adalah sebagai berikut.

- Implementasi *method*-*method* pada *unit test* untuk pengecekan *redirection* dan penggunaan *template file* oleh pada berkas `views.py`. Diantaranya sebagai berikut.

  ```python
  class Tutorial2UnitTest(TestCase):
  
      def test_use_correct_template(self):
          response = self.client.get('/tutorial-2/')
          self.assertTemplateUsed(response, 'tutorial_2.html')
  
      def test_can_save_POST_request_todo(self):
          self.client.post(
              '/tutorial-2/add_todo/',
              data={
                  'date': '2019-09-05T14:31',
                  'activity': DUMMY_TODO_ITEM
              }
          )
          todo_count = TodoList.objects.count()
          new_todo = TodoList.objects.first()
  
          self.assertEqual(todo_count, 1)
          self.assertEqual(getattr(new_todo, 'todo_list'), DUMMY_TODO_ITEM)
  
      def test_can_save_POST_request_todo_commentary(self):
          self.client.post(
              '/tutorial-2/add_todo_commentary/',
              data={
                  'date': '2019-09-12',
                  'comment': DUMMY_TODO_COMMENTARY_ITEM
              }
          )
          todo_commentary_count = TodoListCommentary.objects.count()
          new_todo_commentary = TodoListCommentary.objects.first()
  
          self.assertEqual(todo_commentary_count, 1)
          self.assertEqual(getattr(new_todo_commentary, 'comment'), DUMMY_TODO_COMMENTARY_ITEM)
  
      def test_redirects_after_POST_todo(self):
          response = self.client.post(
              '/tutorial-2/add_todo/',
              data={
                  'date': '2019-09-05T14:31',
                  'activity': DUMMY_TODO_ITEM
              }
          )
          self.assertEqual(response.status_code, 302)
          self.assertRedirects(response, '/tutorial-2/')
  
      def test_redirects_after_POST_todo_commentary(self):
          response = self.client.post(
              '/tutorial-2/add_todo_commentary/',
              data={
                  'date': '2019-09-12',
                  'comment': DUMMY_TODO_COMMENTARY_ITEM
              }
          )
          self.assertEqual(response.status_code, 302)
          self.assertRedirects(response, '/tutorial-2/')
  ```

  Selain itu, saya juga menambahkan implementasi *unit tests* dengan menggunakan `LiveServerTestCase` yaitu sebuah *library* bawaan dari Django, sehingga saya tidak perlu menjalankan perintah `runserver` lagi.

- Pengimplementasian *functional test* yang sudah disesuaikan dengan *unit test* yang diimplementasikan berdasarkan bab 7, sehingga ketika dijalankan *automated script* untuk *unit test* maupun *functional test*, berhasil.

Selanjutnya, untuk pengimplementasian tutorial 4 ini, saya menambahkan **aesthetics test**, yaitu *functional testing* pada CSS dengan menggunakan modul `StaticLiveServerTestCase` yang merupakan bawaan dari Django. Berikut adalah salah satu contoh implementasinya.

```python
def test_layout_and_styling_todo_input_textbox(self):
  selenium = self.selenium
  selenium.get(self.host)
  selenium.set_window_size(1024, 768)

  todo_date = selenium.find_element_by_id('todo_date')
  self.assertAlmostEqual(
    todo_date.location['x'] + todo_date.size['width'] / 2,
    740,
    delta=10
  )

def test_layout_and_styling_todo_commentary_input_textbox(self):
  selenium = self.selenium
  selenium.get(self.host)
  selenium.set_window_size(1024, 768)

  todo_commentary = selenium.find_element_by_id('comment_date')
  self.assertAlmostEqual(
    todo_commentary.location['x'] + todo_commentary.size['width'] / 2,
    780,
    delta=10
  )
```

Untuk *templating languange* pada HTML, saya sudah mengimplementasikan sebelumya, dimulai dari *app* `tutorial-1` dan `tutorial-2`

````html
{% load staticfiles %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="description" content="Tutorial 2 PMPL">
    <meta name="author" content="{{ author }}">
    <!-- bootstrap csss -->
    <link href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">

    <title>
        {% block title %} Tutorial 2 PMPL by {{ author }} - {{ npm }}{% endblock %}
    </title>
</head>
<style>
    @import url(https://fonts.googleapis.com/css?family=Roboto|Roboto+Slab);
    .container, .footer-down, .header-up{
        font-family: "Roboto", "sans-serif";
        font-weight: normal;
    }

</style>
<body style="background-color: darkseagreen">
    <header class="header-up">
        {% include "tutorial_2/../partials/header.html" %}
    </header>
    <content>
        <div class="container">
            {% block content %}

            {% endblock %}
        </div>

    </content>
    <footer class="footer-down">
        <!-- TODO Block Footer dan include footer.html -->
        {% block footer %}
        {% include "tutorial_2/../partials/footer.html" %}
        {% endblock %}
    </footer>

    <!-- Jquery n Bootstrap Script -->
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
    <script type="application/javascript" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
</body>
</html>

````

Dan berikut adalah konten dari `tutorial_2.html` saya.

```html
{% extends "tutorial_2/../layout/base.html" %}

{% block content %}
    <style>
    .form-control {
        @import url(https://fonts.googleapis.com/css?family=Droid+Sans+Mono);
        margin-top: 3px;
        margin-bottom: 3px;
        font-family: "Droid Sans Mono";
    }
    table {
        text-align: left;
        padding: 8px;
        width: 100%;
    }
    </style>
    <h1 align="center" style="font-weight: bold">{{ author }}'s Todo List</h1>
    <br><br>
    <div class="row">
        <div class="col-md-6 col-xs-6">
            <h4>Todo List Table</h4>
            <br>
            <table id="todo_table">
                <tr>
                    <th><h5><b>Date/Time</b></h5></th>
                    <th><h5><b>Todo</b></h5></th>
                </tr>
                {% for todos in todos_dict %}
                    <tr>
                        <td>{{ todos.date }}</td>
                        <td>{{ todos.todo_list }}</td>
                    </tr>
                {% endfor %}
            </table>
            <br>
            <h4>Daily Todo List Comments</h4>
            <br>
            <table id="todo_comment_table">
                <tr>
                    <th><h5><b>Date</b></h5></th>
                    <th><h5><b>Comment</b></h5></th>
                </tr>
                {% for commentary in todos_commentary_dict %}
                    <tr>
                        <td>{{ commentary.date }}</td>
                        <td>{{ commentary.comment }}</td>
                    </tr>
                {% endfor %}
            </table>
            <br>
        </div>
        <div class="col-md-6 col-xs-6">
            <h4><b>Add Todo</b></h4>
            <form method="POST" action="{% url 'tutorial-2:add_todo' %}">
                {% csrf_token %}
                <table>
                    <tr>
                        <td>
                            Date/Time
                        </td>
                        <td>
                            <input type="datetime-local" name="date" id="todo_date" required="required" size="27"/>
                        </td>
                    </tr>
                    <tr>
                        <td>
                            Todo
                        </td>
                        <td>
                            <input type="text" name="activity" id="activity" required="required" size="27">
                        </td>
                    </tr>
                </table>
                <br>
                <button type="submit" id="todo_submit" class="button btn-success">Submit</button>
            </form>
            <br>
            <div class="errornote">
                <p style="color: black; font-family: 'Roboto Slab'">{{ error_msg }}</p>
            </div>
            <h4><b>Add Daily Todo List Comment</b></h4>
            <form method="POST" action="{% url 'tutorial-2:add_todo_commentary' %}">
                {% csrf_token %}
                <table>
                    <tr>
                        <td>
                            Date
                        </td>
                        <td>
                            <input type="date" name="date" id="comment_date" required="required" size="27"/>
                        </td>
                    </tr>
                    <tr>
                        <td>
                            Todo List Comment
                        </td>
                        <td>
                            <input type="text" name="comment" id="comment" required="required" size="27">
                        </td>
                    </tr>
                </table>
                <br>
                <button type="submit" id="comment_submit" class="button btn-success">Submit</button>
            </form>
            <br>
            <div class="errornote">
                <p style="color: black; font-family: 'Roboto Slab'">{{ commentary_error_msg }}</p>
            </div>
        </div>
    </div>
{% endblock %}

```