datatracker/ietf/api/tests_serializers_rpc.py at main · Web4application/datatracker · GitHub

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
# Copyright The IETF Trust 2026, All Rights Reserved

from unittest import mock

from django.utils import timezone

from ietf.utils.test_utils import TestCase
from ietf.doc.models import Document
from ietf.doc.factories import WgRfcFactory
from .serializers_rpc import EditableRfcSerializer


class EditableRfcSerializerTests(TestCase):
    def test_create(self):
        serializer = EditableRfcSerializer(
            data={
                "published": timezone.now(),
                "title": "Yadda yadda yadda",
                "authors": [
                    {
                        "titlepage_name": "B. Fett",
                        "is_editor": False,
                        "affiliation": "DBA Galactic Empire",
                        "country": "",
                    },
                ],
                "stream": "ietf",
                "abstract": "A long time ago in a galaxy far, far away...",
                "pages": 3,
                "std_level": "inf",
                "subseries": ["fyi999"],
            }
        )
        self.assertTrue(serializer.is_valid())
        with self.assertRaises(RuntimeError, msg="serializer does not allow create()"):
            serializer.save()

    @mock.patch("ietf.api.serializers_rpc.update_rfc_searchindex_task")
    @mock.patch("ietf.api.serializers_rpc.trigger_red_precomputer_task")
    def test_update(self, mock_trigger_red_task, mock_update_searchindex_task):
        updates = WgRfcFactory.create_batch(2)
        obsoletes = WgRfcFactory.create_batch(2)
        rfc = WgRfcFactory(pages=10)
        updated_by = WgRfcFactory.create_batch(2)
        obsoleted_by = WgRfcFactory.create_batch(2)
        for d in updates:
            rfc.relateddocument_set.create(relationship_id="updates",target=d)
        for d in obsoletes:
            rfc.relateddocument_set.create(relationship_id="updates",target=d)
        for d in updated_by:
            d.relateddocument_set.create(relationship_id="updates",target=rfc)
        for d in obsoleted_by:
            d.relateddocument_set.create(relationship_id="updates",target=rfc)
        serializer = EditableRfcSerializer(
            instance=rfc,
            data={
                "published": timezone.now(),
                "title": "Yadda yadda yadda",
                "authors": [
                    {
                        "titlepage_name": "B. Fett",
                        "is_editor": False,
                        "affiliation": "DBA Galactic Empire",
                        "country": "",
                    },
                ],
                "stream": "ise",
                "abstract": "A long time ago in a galaxy far, far away...",
                "pages": 3,
                "std_level": "inf",
                "subseries": ["fyi999"],
            },
        )
        self.assertTrue(serializer.is_valid())
        result = serializer.save()
        result.refresh_from_db()
        self.assertEqual(result.title, "Yadda yadda yadda")
        self.assertEqual(
            list(
                result.rfcauthor_set.values(
                    "titlepage_name", "is_editor", "affiliation", "country"
                )
            ),
            [
                {
                    "titlepage_name": "B. Fett",
                    "is_editor": False,
                    "affiliation": "DBA Galactic Empire",
                    "country": "",
                },
            ],
        )
        self.assertEqual(result.stream_id, "ise")
        self.assertEqual(
            result.abstract, "A long time ago in a galaxy far, far away..."
        )
        self.assertEqual(result.pages, 3)
        self.assertEqual(result.std_level_id, "inf")
        self.assertEqual(
            result.part_of(),
            [Document.objects.get(name="fyi999")],
        )
        # Confirm that red precomputer was triggered correctly
        self.assertTrue(mock_trigger_red_task.delay.called)
        _, mock_kwargs = mock_trigger_red_task.delay.call_args
        self.assertIn("rfc_number_list", mock_kwargs)
        expected_numbers = sorted(
            [
                d.rfc_number
                for d in [rfc] + updates + obsoletes + updated_by + obsoleted_by
            ]
        )
        self.assertEqual(mock_kwargs["rfc_number_list"], expected_numbers)
        # Confirm that the search index update task was triggered correctly
        self.assertTrue(mock_update_searchindex_task.delay.called)
        self.assertEqual(
            mock_update_searchindex_task.delay.call_args,
            mock.call(rfc.rfc_number),
        )

    @mock.patch("ietf.api.serializers_rpc.update_rfc_searchindex_task")
    @mock.patch("ietf.api.serializers_rpc.trigger_red_precomputer_task")
    def test_partial_update(self, mock_trigger_red_task, mock_update_searchindex_task):
        # We could test other permutations of fields, but authors is a partial update
        # we know we are going to use, so verifying that one in particular.
        updates = WgRfcFactory.create_batch(2)
        obsoletes = WgRfcFactory.create_batch(2)
        rfc = WgRfcFactory(pages=10, abstract="do or do not", title="padawan")
        updated_by = WgRfcFactory.create_batch(2)
        obsoleted_by = WgRfcFactory.create_batch(2)
        for d in updates:
            rfc.relateddocument_set.create(relationship_id="updates",target=d)
        for d in obsoletes:
            rfc.relateddocument_set.create(relationship_id="updates",target=d)
        for d in updated_by:
            d.relateddocument_set.create(relationship_id="updates",target=rfc)
        for d in obsoleted_by:
            d.relateddocument_set.create(relationship_id="updates",target=rfc)
        serializer = EditableRfcSerializer(
            partial=True,
            instance=rfc,
            data={
                "authors": [
                    {
                        "titlepage_name": "B. Fett",
                        "is_editor": False,
                        "affiliation": "DBA Galactic Empire",
                        "country": "",
                    },
                ],
            },
        )
        self.assertTrue(serializer.is_valid())
        result = serializer.save()
        result.refresh_from_db()
        self.assertEqual(rfc.title, "padawan")
        self.assertEqual(
            list(
                result.rfcauthor_set.values(
                    "titlepage_name", "is_editor", "affiliation", "country"
                )
            ),
            [
                {
                    "titlepage_name": "B. Fett",
                    "is_editor": False,
                    "affiliation": "DBA Galactic Empire",
                    "country": "",
                },
            ],
        )
        self.assertEqual(result.stream_id, "ietf")
        self.assertEqual(result.abstract, "do or do not")
        self.assertEqual(result.pages, 10)
        self.assertEqual(result.std_level_id, "ps")
        self.assertEqual(result.part_of(), [])
        # Confirm that the red precomputer was triggered correctly
        self.assertTrue(mock_trigger_red_task.delay.called)
        _, mock_kwargs = mock_trigger_red_task.delay.call_args
        self.assertIn("rfc_number_list", mock_kwargs)
        expected_numbers = sorted(
            [
                d.rfc_number
                for d in [rfc] + updates + obsoletes + updated_by + obsoleted_by
            ]
        )
        self.assertEqual(mock_kwargs["rfc_number_list"], expected_numbers)
        # Confirm that the search index update task was called correctly
        self.assertTrue(mock_update_searchindex_task.delay.called)
        self.assertEqual(
            mock_update_searchindex_task.delay.call_args,
            mock.call(rfc.rfc_number),
        )

        # Test only a field on the Document itself to be sure that it works
        mock_trigger_red_task.delay.reset_mock()
        mock_update_searchindex_task.delay.reset_mock()
        serializer = EditableRfcSerializer(
            partial=True,
            instance=rfc,
            data={"title": "jedi master"},
        )
        self.assertTrue(serializer.is_valid())
        result = serializer.save()
        result.refresh_from_db()
        self.assertEqual(rfc.title, "jedi master")
        # Confirm that the red precomputer was triggered correctly
        self.assertTrue(mock_trigger_red_task.delay.called)
        _, mock_kwargs = mock_trigger_red_task.delay.call_args
        self.assertIn("rfc_number_list", mock_kwargs)
        self.assertEqual(mock_kwargs["rfc_number_list"], expected_numbers)
        # Confirm that the search index update task was called correctly
        self.assertTrue(mock_update_searchindex_task.delay.called)
        self.assertEqual(
            mock_update_searchindex_task.delay.call_args,
            mock.call(rfc.rfc_number),
        )