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
|
###
# Copyright (c) 2005, Jeremiah Fincher
# Copyright (c) 2010-2021, Valentin Lorentz
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
import io
from unittest.mock import patch, Mock
from supybot import conf
from supybot.test import *
from . import plugin
timestamp_re = '[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2} '
patch_open = patch.object(plugin, 'open', create=True)
class ChannelLoggerTestCase(ChannelPluginTestCase):
plugins = ('ChannelLogger',)
config = {
'supybot.plugins.ChannelLogger.flushImmediately': True,
'supybot.plugins.ChannelLogger.enable.:test.#foo': True,
}
def testLogName(self):
self.assertEqual(
self.irc.getCallback('ChannelLogger').getLogName('test', '#foo'),
'#foo.log'
)
self.assertEqual(
self.irc.getCallback('ChannelLogger').getLogName('test', '#f/../oo'),
'#f..oo.log'
)
def testLogDir(self):
self.assertEqual(
self.irc.getCallback('ChannelLogger').getLogDir(self.irc, '#foo'),
conf.supybot.directories.log.dirize('ChannelLogger/test/#foo')
)
self.assertEqual(
self.irc.getCallback('ChannelLogger').getLogDir(self.irc, '#f/../oo'),
conf.supybot.directories.log.dirize('ChannelLogger/test/#f..oo')
)
@patch_open
def testLog(self, mock_open):
mock_open.return_value = Mock()
self.assertIs(
self.irc.getCallback('ChannelLogger').getLog(self.irc, '#foo'),
mock_open.return_value
)
mock_open.assert_called_once_with(
conf.supybot.directories.log.dirize('ChannelLogger/test/#foo/#foo.log'),
encoding='utf-8',
mode='a'
)
# the log file should be cached
mock_open.reset_mock()
self.assertIs(
self.irc.getCallback('ChannelLogger').getLog(self.irc, '#foo'),
mock_open.return_value
)
mock_open.assert_not_called()
@patch_open
def testLogPrivmsg(self, mock_open):
log_file = io.StringIO()
mock_open.return_value = log_file
self.irc.feedMsg(
ircmsgs.privmsg('#foo', 'test message', prefix='foo!bar@baz')
)
self.assertRegex(
log_file.getvalue(),
timestamp_re + '<foo> test message\n'
)
@patch_open
def _testLogRewriteRelayedEmulatedEcho(self, mock_open, relayed):
with conf.supybot.plugins.ChannelLogger.rewriteRelayed.context(True):
log_file = io.StringIO()
mock_open.return_value = log_file
msg = ircmsgs.privmsg(
'#foo', '<someone> test message', prefix='foo!bar@baz'
)
if relayed:
msg.tag('relayedMsg')
self.irc.getCallback('ChannelLogger').outFilter(self.irc, msg)
self.irc.feedMsg(msg)
if relayed:
content = '<someone> test message\n'
else:
content = '<foo> <someone> test message\n'
self.assertRegex(log_file.getvalue(), timestamp_re + content)
def testLogRewriteRelayedEmulatedEcho(self):
self._testLogRewriteRelayedEmulatedEcho(relayed=True)
def testLogRewriteRelayedEmulatedEchoNotRelayed(self):
self._testLogRewriteRelayedEmulatedEcho(relayed=False)
@patch_open
def _testLogRewriteRelayedRealEcho(self, mock_open, relayed):
with conf.supybot.plugins.ChannelLogger.rewriteRelayed.context(True):
log_file = io.StringIO()
mock_open.return_value = log_file
original_caps = self.irc.state.capabilities_ack
self.irc.state.capabilities_ack |= {
'echo-message', 'labeled-response'
}
try:
out_msg = ircmsgs.privmsg('#foo', '<someone> test message')
if relayed:
out_msg.tag('relayedMsg')
self.irc.getCallback('ChannelLogger').outFilter(self.irc, out_msg)
finally:
self.irc.state.capabilities_ack = original_caps
msg = ircmsgs.privmsg(
'#foo', '<someone> test message', prefix='foo!bar@baz'
)
msg.server_tags['label'] = out_msg.server_tags['label']
self.irc.feedMsg(msg)
if relayed:
content = '<someone> test message\n'
else:
content = '<foo> <someone> test message\n'
self.assertRegex(log_file.getvalue(), timestamp_re + content)
def testLogRewriteRelayedRealEcho(self):
self._testLogRewriteRelayedRealEcho(relayed=True)
def testLogRewriteRelayedRealEchoNotRelayed(self):
self._testLogRewriteRelayedRealEcho(relayed=False)
@patch_open
def testLogNotice(self, mock_open):
log_file = io.StringIO()
mock_open.return_value = log_file
self.irc.feedMsg(
ircmsgs.notice('#foo', 'test message', prefix='foo!bar@baz')
)
self.assertRegex(
log_file.getvalue(),
timestamp_re + '-foo- test message\n'
)
@patch_open
def testLogJoinQuit(self, mock_open):
log_file = io.StringIO()
mock_open.return_value = log_file
self.irc.feedMsg(
ircmsgs.join('#foo', prefix='foo!bar@baz')
)
self.irc.feedMsg(
ircmsgs.quit('bye', prefix='foo!bar@baz')
)
self.assertRegex(
log_file.getvalue(),
timestamp_re + r'\*\*\* foo <foo!bar@baz> has joined #foo\n' +
timestamp_re + r'\*\*\* foo <foo!bar@baz> has quit IRC \(bye\)\n'
)
@patch_open
def testNoLogJoinQuit(self, mock_open):
log_file = io.StringIO()
mock_open.return_value = log_file
with conf.supybot.plugins.ChannelLogger.showJoinParts.context(False):
self.irc.feedMsg(
ircmsgs.join('#foo', prefix='foo!bar@baz')
)
self.irc.feedMsg(
ircmsgs.quit('bye', prefix='foo!bar@baz')
)
self.assertRegex(
log_file.getvalue(),
'^$'
)
@patch_open
def testLogAway(self, mock_open):
log_file = io.StringIO()
mock_open.return_value = log_file
self.irc.feedMsg(
ircmsgs.join('#foo', prefix='foo!bar@baz')
)
self.irc.feedMsg(
ircmsgs.IrcMsg(command='AWAY', args=('be right back',),
prefix='foo!bar@baz')
)
self.irc.feedMsg(
ircmsgs.IrcMsg(command='AWAY', args=(), prefix='foo!bar@baz')
)
self.assertRegex(
log_file.getvalue(),
timestamp_re + r'\*\*\* foo <foo!bar@baz> has joined #foo\n' +
timestamp_re + r'\*\*\* foo is now away: be right back\n' +
timestamp_re + r'\*\*\* foo is back\n'
)
@patch_open
def testNoLogAway(self, mock_open):
log_file = io.StringIO()
mock_open.return_value = log_file
self.irc.feedMsg(
ircmsgs.join('#foo', prefix='foo!bar@baz')
)
with conf.supybot.plugins.ChannelLogger.showAway.context(False):
self.irc.feedMsg(
ircmsgs.IrcMsg(command='AWAY', args=('be right back',),
prefix='foo!bar@baz')
)
self.irc.feedMsg(
ircmsgs.IrcMsg(command='AWAY', args=(), prefix='foo!bar@baz')
)
self.assertRegex(
log_file.getvalue(),
timestamp_re + r'\*\*\* foo <foo!bar@baz> has joined #foo\n$'
)
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|
