comparison sat/test/test_plugin_xep_0313.py @ 4037:524856bd7b19

massive refactoring to switch from camelCase to snake_case: historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a pre-PEP8 code, to use the same coding style as in Twisted. However, snake_case is more readable and it's better to follow PEP8 best practices, so it has been decided to move on full snake_case. Because Libervia has a huge codebase, this ended with a ugly mix of camelCase and snake_case. To fix that, this patch does a big refactoring by renaming every function and method (including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case. This is a massive change, and may result in some bugs.
author Goffi <goffi@goffi.org>
date Sat, 08 Apr 2023 13:54:42 +0200
parents be6d91572633
children
comparison
equal deleted inserted replaced
4036:c4464d7ae97b 4037:524856bd7b19
40 40
41 class XEP_0313Test(helpers.SatTestCase): 41 class XEP_0313Test(helpers.SatTestCase):
42 def setUp(self): 42 def setUp(self):
43 self.host = helpers.FakeSAT() 43 self.host = helpers.FakeSAT()
44 self.plugin = XEP_0313(self.host) 44 self.plugin = XEP_0313(self.host)
45 self.client = self.host.getClient(C.PROFILE[0]) 45 self.client = self.host.get_client(C.PROFILE[0])
46 mam_client = self.plugin.getHandler(C.PROFILE[0]) 46 mam_client = self.plugin.get_handler(C.PROFILE[0])
47 mam_client.makeConnection(self.host.getClient(C.PROFILE[0]).xmlstream) 47 mam_client.makeConnection(self.host.get_client(C.PROFILE[0]).xmlstream)
48 48
49 def test_queryArchive(self): 49 def test_query_archive(self):
50 xml = """ 50 xml = """
51 <iq type='set' id='%s' to='%s'> 51 <iq type='set' id='%s' to='%s'>
52 <query xmlns='urn:xmpp:mam:1'/> 52 <query xmlns='urn:xmpp:mam:1'/>
53 </iq> 53 </iq>
54 """ % ( 54 """ % (
55 ("H_%d" % domish.Element._idCounter), 55 ("H_%d" % domish.Element._idCounter),
56 SERVICE, 56 SERVICE,
57 ) 57 )
58 d = self.plugin.queryArchive(self.client, MAMRequest(), SERVICE_JID) 58 d = self.plugin.queryArchive(self.client, MAMRequest(), SERVICE_JID)
59 d.addCallback( 59 d.addCallback(
60 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 60 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
61 ) 61 )
62 return d 62 return d
63 63
64 def test_queryArchivePubsub(self): 64 def test_query_archive_pubsub(self):
65 xml = """ 65 xml = """
66 <iq type='set' id='%s' to='%s'> 66 <iq type='set' id='%s' to='%s'>
67 <query xmlns='urn:xmpp:mam:1' node='fdp/submitted/capulet.lit/sonnets' /> 67 <query xmlns='urn:xmpp:mam:1' node='fdp/submitted/capulet.lit/sonnets' />
68 </iq> 68 </iq>
69 """ % ( 69 """ % (
72 ) 72 )
73 d = self.plugin.queryArchive( 73 d = self.plugin.queryArchive(
74 self.client, MAMRequest(node="fdp/submitted/capulet.lit/sonnets"), SERVICE_JID 74 self.client, MAMRequest(node="fdp/submitted/capulet.lit/sonnets"), SERVICE_JID
75 ) 75 )
76 d.addCallback( 76 d.addCallback(
77 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 77 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
78 ) 78 )
79 return d 79 return d
80 80
81 def test_queryArchiveWith(self): 81 def test_query_archive_with(self):
82 xml = """ 82 xml = """
83 <iq type='set' id='%s' to='%s'> 83 <iq type='set' id='%s' to='%s'>
84 <query xmlns='urn:xmpp:mam:1'> 84 <query xmlns='urn:xmpp:mam:1'>
85 <x xmlns='jabber:x:data' type='submit'> 85 <x xmlns='jabber:x:data' type='submit'>
86 <field var='FORM_TYPE' type='hidden'> 86 <field var='FORM_TYPE' type='hidden'>
97 SERVICE, 97 SERVICE,
98 ) 98 )
99 form = buildForm(with_jid=JID("juliet@capulet.lit")) 99 form = buildForm(with_jid=JID("juliet@capulet.lit"))
100 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID) 100 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID)
101 d.addCallback( 101 d.addCallback(
102 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 102 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
103 ) 103 )
104 return d 104 return d
105 105
106 def test_queryArchiveStartEnd(self): 106 def test_query_archive_start_end(self):
107 xml = """ 107 xml = """
108 <iq type='set' id='%s' to='%s'> 108 <iq type='set' id='%s' to='%s'>
109 <query xmlns='urn:xmpp:mam:1'> 109 <query xmlns='urn:xmpp:mam:1'>
110 <x xmlns='jabber:x:data' type='submit'> 110 <x xmlns='jabber:x:data' type='submit'>
111 <field var='FORM_TYPE' type='hidden'> 111 <field var='FORM_TYPE' type='hidden'>
127 start = datetime.datetime(2010, 6, 7, 0, 0, 0, tzinfo=tzutc()) 127 start = datetime.datetime(2010, 6, 7, 0, 0, 0, tzinfo=tzutc())
128 end = datetime.datetime(2010, 7, 7, 13, 23, 54, tzinfo=tzutc()) 128 end = datetime.datetime(2010, 7, 7, 13, 23, 54, tzinfo=tzutc())
129 form = buildForm(start=start, end=end) 129 form = buildForm(start=start, end=end)
130 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID) 130 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID)
131 d.addCallback( 131 d.addCallback(
132 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 132 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
133 ) 133 )
134 return d 134 return d
135 135
136 def test_queryArchiveStart(self): 136 def test_query_archive_start(self):
137 xml = """ 137 xml = """
138 <iq type='set' id='%s' to='%s'> 138 <iq type='set' id='%s' to='%s'>
139 <query xmlns='urn:xmpp:mam:1'> 139 <query xmlns='urn:xmpp:mam:1'>
140 <x xmlns='jabber:x:data' type='submit'> 140 <x xmlns='jabber:x:data' type='submit'>
141 <field var='FORM_TYPE' type='hidden'> 141 <field var='FORM_TYPE' type='hidden'>
153 ) 153 )
154 start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc()) 154 start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc())
155 form = buildForm(start=start) 155 form = buildForm(start=start)
156 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID) 156 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID)
157 d.addCallback( 157 d.addCallback(
158 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 158 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
159 ) 159 )
160 return d 160 return d
161 161
162 def test_queryArchiveRSM(self): 162 def test_query_archive_rsm(self):
163 xml = """ 163 xml = """
164 <iq type='set' id='%s' to='%s'> 164 <iq type='set' id='%s' to='%s'>
165 <query xmlns='urn:xmpp:mam:1'> 165 <query xmlns='urn:xmpp:mam:1'>
166 <x xmlns='jabber:x:data' type='submit'> 166 <x xmlns='jabber:x:data' type='submit'>
167 <field var='FORM_TYPE' type='hidden'> 167 <field var='FORM_TYPE' type='hidden'>
183 start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc()) 183 start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc())
184 form = buildForm(start=start) 184 form = buildForm(start=start)
185 rsm = RSMRequest(max_=10) 185 rsm = RSMRequest(max_=10)
186 d = self.plugin.queryArchive(self.client, MAMRequest(form, rsm), SERVICE_JID) 186 d = self.plugin.queryArchive(self.client, MAMRequest(form, rsm), SERVICE_JID)
187 d.addCallback( 187 d.addCallback(
188 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 188 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
189 ) 189 )
190 return d 190 return d
191 191
192 def test_queryArchiveRSMPaging(self): 192 def test_query_archive_rsm_paging(self):
193 xml = """ 193 xml = """
194 <iq type='set' id='%s' to='%s'> 194 <iq type='set' id='%s' to='%s'>
195 <query xmlns='urn:xmpp:mam:1'> 195 <query xmlns='urn:xmpp:mam:1'>
196 <x xmlns='jabber:x:data' type='submit'> 196 <x xmlns='jabber:x:data' type='submit'>
197 <field var='FORM_TYPE' type='hidden'><value>urn:xmpp:mam:1</value></field> 197 <field var='FORM_TYPE' type='hidden'><value>urn:xmpp:mam:1</value></field>
210 start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc()) 210 start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc())
211 form = buildForm(start=start) 211 form = buildForm(start=start)
212 rsm = RSMRequest(max_=10, after="09af3-cc343-b409f") 212 rsm = RSMRequest(max_=10, after="09af3-cc343-b409f")
213 d = self.plugin.queryArchive(self.client, MAMRequest(form, rsm), SERVICE_JID) 213 d = self.plugin.queryArchive(self.client, MAMRequest(form, rsm), SERVICE_JID)
214 d.addCallback( 214 d.addCallback(
215 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 215 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
216 ) 216 )
217 return d 217 return d
218 218
219 def test_queryFields(self): 219 def test_query_fields(self):
220 xml = """ 220 xml = """
221 <iq type='get' id="%s" to='%s'> 221 <iq type='get' id="%s" to='%s'>
222 <query xmlns='urn:xmpp:mam:1'/> 222 <query xmlns='urn:xmpp:mam:1'/>
223 </iq> 223 </iq>
224 """ % ( 224 """ % (
225 ("H_%d" % domish.Element._idCounter), 225 ("H_%d" % domish.Element._idCounter),
226 SERVICE, 226 SERVICE,
227 ) 227 )
228 d = self.plugin.queryFields(self.client, SERVICE_JID) 228 d = self.plugin.queryFields(self.client, SERVICE_JID)
229 d.addCallback( 229 d.addCallback(
230 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 230 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
231 ) 231 )
232 return d 232 return d
233 233
234 def test_queryArchiveFields(self): 234 def test_query_archive_fields(self):
235 xml = """ 235 xml = """
236 <iq type='set' id='%s' to='%s'> 236 <iq type='set' id='%s' to='%s'>
237 <query xmlns='urn:xmpp:mam:1'> 237 <query xmlns='urn:xmpp:mam:1'>
238 <x xmlns='jabber:x:data' type='submit'> 238 <x xmlns='jabber:x:data' type='submit'>
239 <field type='hidden' var='FORM_TYPE'> 239 <field type='hidden' var='FORM_TYPE'>
265 ), 265 ),
266 ] 266 ]
267 form = buildForm(extra_fields=extra_fields) 267 form = buildForm(extra_fields=extra_fields)
268 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID) 268 d = self.plugin.queryArchive(self.client, MAMRequest(form), SERVICE_JID)
269 d.addCallback( 269 d.addCallback(
270 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 270 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
271 ) 271 )
272 return d 272 return d
273 273
274 def test_queryPrefs(self): 274 def test_query_prefs(self):
275 xml = """ 275 xml = """
276 <iq type='get' id='%s' to='%s'> 276 <iq type='get' id='%s' to='%s'>
277 <prefs xmlns='urn:xmpp:mam:1'> 277 <prefs xmlns='urn:xmpp:mam:1'>
278 <always/> 278 <always/>
279 <never/> 279 <never/>
281 </iq> 281 </iq>
282 """ % ( 282 """ % (
283 ("H_%d" % domish.Element._idCounter), 283 ("H_%d" % domish.Element._idCounter),
284 SERVICE, 284 SERVICE,
285 ) 285 )
286 d = self.plugin.getPrefs(self.client, SERVICE_JID) 286 d = self.plugin.get_prefs(self.client, SERVICE_JID)
287 d.addCallback( 287 d.addCallback(
288 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 288 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
289 ) 289 )
290 return d 290 return d
291 291
292 def test_setPrefs(self): 292 def test_set_prefs(self):
293 xml = """ 293 xml = """
294 <iq type='set' id='%s' to='%s'> 294 <iq type='set' id='%s' to='%s'>
295 <prefs xmlns='urn:xmpp:mam:1' default='roster'> 295 <prefs xmlns='urn:xmpp:mam:1' default='roster'>
296 <always> 296 <always>
297 <jid>romeo@montague.lit</jid> 297 <jid>romeo@montague.lit</jid>
307 ) 307 )
308 always = [JID("romeo@montague.lit")] 308 always = [JID("romeo@montague.lit")]
309 never = [JID("montague@montague.lit")] 309 never = [JID("montague@montague.lit")]
310 d = self.plugin.setPrefs(self.client, SERVICE_JID, always=always, never=never) 310 d = self.plugin.setPrefs(self.client, SERVICE_JID, always=always, never=never)
311 d.addCallback( 311 d.addCallback(
312 lambda __: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True) 312 lambda __: self.assert_equal_xml(self.host.get_sent_message_xml(0), xml, True)
313 ) 313 )
314 return d 314 return d