File: test_burndown_chart.py

package info (click to toggle)
odoo 18.0.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 878,716 kB
  • sloc: javascript: 927,937; python: 685,670; xml: 388,524; sh: 1,033; sql: 415; makefile: 26
file content (437 lines) | stat: -rw-r--r-- 22,858 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
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
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

from freezegun import freeze_time
from datetime import datetime

from odoo import Command
from odoo.osv.expression import AND, OR
from odoo.tests.common import tagged, HttpCase
from .test_project_base import TestProjectCommon


class TestBurndownChartCommon(TestProjectCommon):

    @classmethod
    def set_create_date(cls, table, res_id, create_date):
        cls.env.cr.execute("UPDATE {} SET create_date=%s WHERE id=%s".format(table), (create_date, res_id))

    @classmethod
    def setUpClass(cls):
        super().setUpClass()
        cls.current_year = datetime.now().year
        create_date = datetime(cls.current_year - 1, 1, 1)
        Stage = cls.env['project.task.type']
        cls.todo_stage = Stage.create({
            'sequence': 1,
            'name': 'TODO',
        })
        cls.set_create_date('project_task_type', cls.todo_stage.id, create_date)
        cls.in_progress_stage = Stage.create({
            'sequence': 10,
            'name': 'In Progress',
        })
        cls.set_create_date('project_task_type', cls.in_progress_stage.id, create_date)
        cls.testing_stage = Stage.create({
            'sequence': 20,
            'name': 'Testing',
        })
        cls.set_create_date('project_task_type', cls.testing_stage.id, create_date)
        cls.done_stage = Stage.create({
            'sequence': 30,
            'name': 'Done',
        })
        cls.set_create_date('project_task_type', cls.done_stage.id, create_date)
        cls.stages = cls.todo_stage + cls.in_progress_stage + cls.testing_stage + cls.done_stage
        cls.project = cls.env['project.project'].create({
            'name': 'Burndown Chart Test',
            'privacy_visibility': 'employees',
            'alias_name': 'project_burndown_chart',
            'type_ids': [Command.link(stage_id) for stage_id in cls.stages.ids],
        })
        cls.set_create_date('project_project', cls.project.id, create_date)
        cls.project.invalidate_model()
        cls.milestone = cls.env['project.milestone'].with_context({'mail_create_nolog': True}).create({
            'name': 'Test Milestone',
            'project_id': cls.project.id,
        })
        cls.task_a = cls.env['project.task'].create({
            'name': 'Task A',
            'priority': 0,
            'project_id': cls.project.id,
            'stage_id': cls.todo_stage.id,
        })
        cls.set_create_date('project_task', cls.task_a.id, create_date)
        cls.task_b = cls.task_a.copy({
            'name': 'Task B',
            'user_ids': [Command.set([cls.user_projectuser.id, cls.user_projectmanager.id])],
        })
        cls.set_create_date('project_task', cls.task_b.id, create_date)
        cls.task_c = cls.task_a.copy({
            'name': 'Task C',
            'partner_id': cls.partner_1.id,
            'user_ids': [Command.link(cls.user_projectuser.id)],
        })
        cls.set_create_date('project_task', cls.task_c.id, create_date)
        cls.task_d = cls.task_a.copy({
            'name': 'Task D',
            'milestone_id': cls.milestone.id,
            'user_ids': [Command.link(cls.user_projectmanager.id)],
        })
        cls.set_create_date('project_task', cls.task_d.id, create_date)
        cls.task_e = cls.task_a.copy({
            'name': 'Task E',
            'partner_id': cls.partner_1.id,
        })
        cls.set_create_date('project_task', cls.task_e.id, create_date)

        # Create a new task to check if a task without changing its stage is taken into account
        cls.task_f = cls.env['project.task'].create({
            'name': 'Task F',
            'priority': 0,
            'project_id': cls.project.id,
            'milestone_id': cls.milestone.id,
            'stage_id': cls.todo_stage.id,
        })
        cls.set_create_date('project_task', cls.task_f.id, datetime(cls.current_year - 1, 12, 20))

        cls.project_2 = cls.env['project.project'].create({
            'name': 'Burndown Chart Test 2 mySearchTag',
            'privacy_visibility': 'employees',
            'alias_name': 'project_burndown_chart_2',
            'type_ids': [Command.link(stage_id) for stage_id in cls.stages.ids],
        })
        cls.set_create_date('project_project', cls.project_2.id, create_date)
        cls.project.invalidate_model()
        cls.task_g = cls.env['project.task'].create({
            'name': 'Task G',
            'priority': 0,
            'project_id': cls.project_2.id,
            'stage_id': cls.todo_stage.id,
            'user_ids': [Command.link(cls.user_projectuser.id)],
        })
        cls.set_create_date('project_task', cls.task_g.id, create_date)
        cls.task_h = cls.task_g.copy({
            'name': 'Task H',
            'user_ids': [Command.link(cls.user_projectmanager.id)],
        })
        cls.set_create_date('project_task', cls.task_h.id, create_date)

        cls.stage_1, cls.stage_2, cls.stage_3, cls.stage_4 = Stage.create([{
            'sequence': 1,
            'name': '1',
        }, {
            'sequence': 10,
            'name': '2',
        }, {
            'sequence': 20,
            'name': '3',
        }, {
            'sequence': 20,
            'name': '4',
        }])
        cls.stages_bis = cls.stage_1 | cls.stage_2 | cls.stage_3 | cls.stage_4
        cls.set_create_date('project_task_type', cls.stage_1.id, create_date)
        cls.set_create_date('project_task_type', cls.stage_2.id, create_date)
        cls.set_create_date('project_task_type', cls.stage_3.id, create_date)
        cls.set_create_date('project_task_type', cls.stage_4.id, create_date)
        cls.project_1 = cls.env['project.project'].create({
            'name': 'Burndown Chart Test',
            'privacy_visibility': 'employees',
            'alias_name': 'project_burndown_chart_bis',
            'type_ids': [Command.link(stage_id) for stage_id in cls.stages_bis.ids],
        })
        cls.set_create_date('project_project', cls.project_1.id, create_date)
        cls.task_bis = cls.env['project.task'].create({
            'name': 'Task',
            'priority': 0,
            'project_id': cls.project_1.id,
            'stage_id': cls.stage_1.id,
        })
        cls.set_create_date('project_task', cls.task_bis.id, create_date)

        cls.deleted_domain = AND([[('project_id', '!=', False)], [('project_id', '=', cls.project_1.id)]])

        # Precommit to have the records in db and allow to rollback at the end of test
        cls.env.cr.flush()

        with freeze_time('%s-02-10' % (cls.current_year - 1)):
            (cls.task_a + cls.task_b).write({'stage_id': cls.in_progress_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-02-20' % (cls.current_year - 1)):
            cls.task_c.write({'stage_id': cls.in_progress_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-03-15' % (cls.current_year - 1)):
            (cls.task_d + cls.task_e).write({'stage_id': cls.in_progress_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-04-10' % (cls.current_year - 1)):
            (cls.task_a + cls.task_b).write({'stage_id': cls.testing_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-05-12' % (cls.current_year - 1)):
            cls.task_c.write({'stage_id': cls.testing_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-06-25' % (cls.current_year - 1)):
            cls.task_d.write({'stage_id': cls.testing_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-07-25' % (cls.current_year - 1)):
            cls.task_e.write({'stage_id': cls.testing_stage.id})
            cls.env.cr.flush()

        with freeze_time('%s-08-01' % (cls.current_year - 1)):
            cls.task_a.write({'stage_id': cls.done_stage.id, 'state': '1_done'})
            cls.env.cr.flush()

        with freeze_time('%s-09-10' % (cls.current_year - 1)):
            cls.task_b.write({'stage_id': cls.done_stage.id, 'state': '1_done'})
            cls.env.cr.flush()

        with freeze_time('%s-10-05' % (cls.current_year - 1)):
            cls.task_c.write({'stage_id': cls.done_stage.id, 'state': '1_done'})
            cls.task_a.write({'state': '1_canceled'})
            cls.env.cr.flush()

        with freeze_time('%s-11-25' % (cls.current_year - 1)):
            cls.task_d.write({'stage_id': cls.done_stage.id, 'state': '1_done'})
            cls.task_b.write({'state': '1_canceled'})
            cls.env.cr.flush()

        with freeze_time('%s-12-12' % (cls.current_year - 1)):
            cls.task_e.write({'stage_id': cls.done_stage.id, 'state': '1_done'})
            cls.env.cr.flush()

        with freeze_time('%s-12-24' % (cls.current_year - 1)):
            cls.task_f.write({'state': '1_canceled'})
            cls.env.cr.flush()

        with freeze_time('%s-02-10' % (cls.current_year - 1)):
            cls.task_bis.write({'stage_id': cls.stage_2.id})
            cls.env.cr.flush()

        with freeze_time('%s-03-10' % (cls.current_year - 1)):
            (cls.task_bis).write({'stage_id': cls.stage_3.id})
            cls.env.cr.flush()

        with freeze_time('%s-04-10' % (cls.current_year - 1)):
            (cls.task_bis).write({'stage_id': cls.stage_4.id})
            cls.env.cr.flush()

class TestBurndownChart(TestBurndownChartCommon):

    def map_read_group_result(self, read_group_result):
        return {(res['date:month'], res['stage_id'][0]): int(res['__count']) for res in read_group_result if res['stage_id'][1]}

    def map_read_group_is_closed_result(self, read_group_result):
        return {(res['date:month'], res['is_closed']): int(res['__count']) for res in read_group_result}

    def check_read_group_results(self, domain, expected_results_dict):
        read_group_result = self.env['project.task.burndown.chart.report'].read_group(
            domain, ['date', 'stage_id'], ['date:month', 'stage_id'], lazy=False)
        read_group_result_dict = self.map_read_group_result(read_group_result)
        self.assertDictEqual(read_group_result_dict, expected_results_dict)

    def check_read_group_is_closed_results(self, domain, expected_results_dict):
        read_group_result = self.env['project.task.burndown.chart.report'].read_group(
            domain, ['date', 'is_closed'], ['date:month', 'is_closed'], lazy=False)
        read_group_result_dict = self.map_read_group_is_closed_result(read_group_result)
        self.assertDictEqual(read_group_result_dict, expected_results_dict)

    def test_burndown_chart(self):
        burndown_chart_domain = [('project_id', '!=', False)]
        project_domain = [('project_id', '=', self.project.id)]

        # Check that we get the expected results for the complete data of `self.project`.
        project_expected_dict = {
            ('January %s' % (self.current_year - 1), self.todo_stage.id): 5,
            ('February %s' % (self.current_year - 1), self.todo_stage.id): 2,
            ('February %s' % (self.current_year - 1), self.in_progress_stage.id): 3,
            ('March %s' % (self.current_year - 1), self.in_progress_stage.id): 5,
            ('April %s' % (self.current_year - 1), self.in_progress_stage.id): 3,
            ('April %s' % (self.current_year - 1), self.testing_stage.id): 2,
            ('May %s' % (self.current_year - 1), self.in_progress_stage.id): 2,
            ('May %s' % (self.current_year - 1), self.testing_stage.id): 3,
            ('June %s' % (self.current_year - 1), self.in_progress_stage.id): 1,
            ('June %s' % (self.current_year - 1), self.testing_stage.id): 4,
            ('July %s' % (self.current_year - 1), self.testing_stage.id): 5,
            ('August %s' % (self.current_year - 1), self.testing_stage.id): 4,
            ('August %s' % (self.current_year - 1), self.done_stage.id): 1,
            ('September %s' % (self.current_year - 1), self.testing_stage.id): 3,
            ('September %s' % (self.current_year - 1), self.done_stage.id): 2,
            ('October %s' % (self.current_year - 1), self.testing_stage.id): 2,
            ('October %s' % (self.current_year - 1), self.done_stage.id): 3,
            ('November %s' % (self.current_year - 1), self.testing_stage.id): 1,
            ('November %s' % (self.current_year - 1), self.done_stage.id): 4,
            ('December %s' % (self.current_year - 1), self.todo_stage.id): 1,
            ('December %s' % (self.current_year - 1), self.done_stage.id): 5,
        }
        project_expected_is_closed_dict = {
            ('January %s' % (self.current_year - 1), 'open'): 5,
            ('February %s' % (self.current_year - 1), 'open'): 5,
            ('March %s' % (self.current_year - 1), 'open'): 5,
            ('April %s' % (self.current_year - 1), 'open'): 5,
            ('May %s' % (self.current_year - 1), 'open'): 5,
            ('June %s' % (self.current_year - 1), 'open'): 5,
            ('July %s' % (self.current_year - 1), 'open'): 5,
            ('August %s' % (self.current_year - 1), 'open'): 4,
            ('August %s' % (self.current_year - 1), 'closed'): 1,
            ('September %s' % (self.current_year - 1), 'open'): 3,
            ('September %s' % (self.current_year - 1), 'closed'): 2,
            ('October %s' % (self.current_year - 1), 'open'): 2,
            ('October %s' % (self.current_year - 1), 'closed'): 3,
            ('November %s' % (self.current_year - 1), 'open'): 1,
            ('November %s' % (self.current_year - 1), 'closed'): 4,
            ('December %s' % (self.current_year - 1), 'closed'): 6,
        }
        months = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October',
                  'November', 'December']
        current_month = datetime.now().month
        for i in range(current_month):
            month_key = f"{months[i]} {self.current_year}"
            project_expected_dict[(month_key, self.todo_stage.id)] = 1
            project_expected_dict[(month_key, self.done_stage.id)] = 5
            project_expected_is_closed_dict[(month_key, 'closed')] = 6

        # Check that we get the expected results for the complete data of `self.project`.
        self.check_read_group_results(AND([burndown_chart_domain, project_domain]), project_expected_dict)
        self.check_read_group_is_closed_results(AND([burndown_chart_domain, project_domain]), project_expected_is_closed_dict)

        # Check that we get the expected results for the complete data of `self.project` & `self.project_2` using an
        # `ilike` in the domain.
        all_projects_domain_with_ilike = OR([project_domain, [('project_id', 'ilike', 'mySearchTag')]])
        project_expected_dict = {key: val if key[1] != self.todo_stage.id else val + 2 for key, val in project_expected_dict.items()}
        project_expected_is_closed_dict = {key: val if key[1] == 'closed' else val + 2 for key, val in project_expected_is_closed_dict.items()}
        for i in range(2, 11):
            month_key = f"{months[i]} {self.current_year - 1}"
            project_expected_dict[(month_key, self.todo_stage.id)] = 2
        project_expected_is_closed_dict[(f"{months[11]} {self.current_year - 1}", 'open')] = 2
        for i in range(current_month):
            project_expected_is_closed_dict[(f"{months[i]} {self.current_year}", 'open')] = 2
        self.check_read_group_results(AND([burndown_chart_domain, all_projects_domain_with_ilike]), project_expected_dict)
        self.check_read_group_is_closed_results(AND([burndown_chart_domain, all_projects_domain_with_ilike]), project_expected_is_closed_dict)

        date_from, date_to = ('%s-01-01' % (self.current_year - 1), '%s-03-01' % (self.current_year - 1))
        date_from_is_closed, date_to_is_closed = ('%s-10-01' % (self.current_year - 1), '%s-12-01' % (self.current_year - 1))

        date_and_user_domain = [('date', '>=', date_from), ('date', '<', date_to), ('user_ids', 'ilike', 'ProjectUser')]
        complex_domain_expected_dict = {
            ('January %s' % (self.current_year - 1), self.todo_stage.id): 3,
            ('February %s' % (self.current_year - 1), self.todo_stage.id): 1,
            ('February %s' % (self.current_year - 1), self.in_progress_stage.id): 2,
        }
        complex_domain = AND([burndown_chart_domain, all_projects_domain_with_ilike, date_and_user_domain])
        self.check_read_group_results(complex_domain, complex_domain_expected_dict)

        date_and_user_domain = [('date', '>=', date_from_is_closed), ('date', '<', date_to_is_closed), ('user_ids', 'ilike', 'ProjectUser')]
        complex_domain = AND([burndown_chart_domain, all_projects_domain_with_ilike, date_and_user_domain])
        complex_domain_expected_dict = {
            ('October %s' % (self.current_year - 1), 'closed'): 2.0,
            ('October %s' % (self.current_year - 1), 'open'): 1.0,
            ('November %s' % (self.current_year - 1), 'closed'): 2.0,
            ('November %s' % (self.current_year - 1), 'open'): 1.0
        }
        self.check_read_group_is_closed_results(complex_domain, complex_domain_expected_dict)

        date_and_user_domain = [('date', '>=', date_from), ('date', '<', date_to), ('user_ids', 'ilike', 'ProjectManager')]
        milestone_domain = [('milestone_id', 'ilike', 'Test')]
        complex_domain = AND([burndown_chart_domain, all_projects_domain_with_ilike, date_and_user_domain, milestone_domain])
        complex_domain_expected_dict = {
            ('January %s' % (self.current_year - 1), self.todo_stage.id): 1,
            ('February %s' % (self.current_year - 1), self.todo_stage.id): 1,
        }
        self.check_read_group_results(complex_domain, complex_domain_expected_dict)

        date_and_user_domain = [('date', '>=', date_from_is_closed), ('date', '<', date_to_is_closed), ('user_ids', 'ilike', 'ProjectManager')]
        milestone_domain = [('milestone_id', 'ilike', 'Test')]
        complex_domain = AND([burndown_chart_domain, all_projects_domain_with_ilike, date_and_user_domain, milestone_domain])
        complex_domain_expected_dict = {
            ('October %s' % (self.current_year - 1), 'open'): 1.0,
            ('November %s' % (self.current_year - 1), 'closed'): 1.0
        }
        self.check_read_group_is_closed_results(complex_domain, complex_domain_expected_dict)

    def burndown_chart_stage_delete_stage_1(self):
        """
        Currently, this behavior is not working as expected. The key 'Jan year-1, stage_1.id' is not present as expected, but there's an extra unwanted key
        'Jan year-1, stage_2.id' is present instead
        """
        with freeze_time('%s-08-10' % (self.current_year - 1)):
            self.stage_1.unlink()
            self.env.cr.flush()
        expected_dict = self.get_expected_dict()
        del expected_dict[('January %s' % (self.current_year - 1), self.stage_1.id)]
        self.check_read_group_results(self.deleted_domain, expected_dict)

    def burndown_chart_stage_delete_stage_2(self):
        """
        Currently, this behavior is not working as expected. The key 'Feb year-1, stage_2.id' is not present as expected, but there's an extra unwanted key
        'Feb year-1, stage_3.id' is present instead
        """
        with freeze_time('%s-08-10' % (self.current_year - 1)):
            self.stage_2.unlink()
            self.env.cr.flush()
        expected_dict = self.get_expected_dict()
        del expected_dict[('February %s' % (self.current_year - 1), self.stage_2.id)]
        self.check_read_group_results(self.deleted_domain, expected_dict)

    def test_burndown_chart_stage_deleted_3(self):
        with freeze_time('%s-08-10' % (self.current_year - 1)):
            self.stage_3.unlink()
            self.env.cr.flush()
        expected_dict = self.get_expected_dict()
        del expected_dict[('March %s' % (self.current_year - 1), self.stage_3.id)]
        self.check_read_group_results(self.deleted_domain, expected_dict)

    def burndown_chart_all_stage_deleted(self):
        """
        Currently, this behavior is not working as expected. An extra task is added for every month fetched by the query.
        e.a. If the expected dict is :
        {('April 2022', 390): 1, ('May 2022', 390): 1, ('June 2022', 390): 1, ('July 2022', 390): 1, ('August 2022', 390): 1, ('September 2022', 390): 1, etc : 1}
        The fetched dict will be :
        {('January 2022', 389): 1, ('February 2022', 389): 1, ('March 2022', 389): 1, ('April 2022', 390): 2, ('May 2022', 390): 2, ('June 2022', 390): 2, ('July 2022', 390): 2,
        ('August 2022', 390): 2, ('September 2022', 390): 2, etc :2 }
        """
        with freeze_time('%s-08-10' % (self.current_year - 1)):
            (self.stage_1 | self.stage_2 | self.stage_3).unlink()
            self.env.cr.flush()
        expected_dict = self.get_expected_dict()
        del expected_dict[('January %s' % (self.current_year - 1), self.stage_1.id)]
        del expected_dict[('February %s' % (self.current_year - 1), self.stage_2.id)]
        del expected_dict[('March %s' % (self.current_year - 1), self.stage_3.id)]
        self.check_read_group_results(self.deleted_domain, expected_dict)

    def get_expected_dict(self):
        expected_dict = {
            ('January %s' % (self.current_year - 1), self.stage_1.id): 1,
            ('February %s' % (self.current_year - 1), self.stage_2.id): 1,
            ('March %s' % (self.current_year - 1), self.stage_3.id): 1,
            ('April %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('May %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('June %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('July %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('August %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('September %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('October %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('November %s' % (self.current_year - 1), self.stage_4.id): 1,
            ('December %s' % (self.current_year - 1), self.stage_4.id): 1,
        }
        months = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October',
                  'November', 'December']
        current_month = datetime.now().month

        for i in range(current_month):
            month_key = f"{months[i]} {self.current_year}"
            expected_dict[(month_key, self.stage_4.id)] = 1
        return expected_dict


@tagged('-at_install', 'post_install')
class TestBurndownChartTour(HttpCase, TestBurndownChartCommon):

    def test_burndown_chart_tour(self):
        # Test customizing personal stages as a project user
        self.start_tour('/odoo', 'burndown_chart_tour', login="admin")