summaryrefslogtreecommitdiff
path: root/gear/tests/test_gear.py
blob: c700431de032561036163edf00d010b971ba015b (plain)
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
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import socket

import testscenarios
import testtools

import gear
from gear import tests


class ConnectionTestCase(tests.BaseTestCase):

    scenarios = [
        ('both_string',
         dict(host="hostname", port='80')),
        ('string_int',
         dict(host="hostname", port=80)),
        ('none_string',
         dict(host=None, port="80")),
    ]

    def setUp(self):
        super(ConnectionTestCase, self).setUp()
        self.conn = gear.Connection(self.host, self.port)

    def test_params(self):
        self.assertTrue(repr(self.conn).endswith(
            'host: %s port: %s>' % (self.host, self.port)))


class AdminRequestTestCase(tests.BaseTestCase):
    scenarios = [
        ('empty newline', dict(response=b'.\n', remainder=b'')),
        ('empty return', dict(response=b'.\r\n', remainder=b'')),
        ('data newline', dict(response=b'foo\n.\n', remainder=b'')),
        ('data return', dict(response=b'foo\r\n.\r\n', remainder=b'')),
        ('pipeline newline', dict(response=b'foo\n.\nbar',
                                  remainder=b'bar')),
        ('pipeline return', dict(response=b'foo\r\n.\r\nbar',
                                 remainder=b'bar')),
    ]

    def test_full_packet(self):
        req = gear.StatusAdminRequest()
        ret = req.isComplete(self.response)
        self.assertTrue(ret[0])
        self.assertEqual(ret[1], self.remainder)

    def test_partial_packet(self):
        req = gear.StatusAdminRequest()
        for i in range(len(self.response) - len(self.remainder)):
            ret = req.isComplete(self.response[:i])
            self.assertFalse(ret[0])
            self.assertIsNone(ret[1])
        ret = req.isComplete(self.response)
        self.assertTrue(ret[0])
        self.assertEqual(ret[1], self.remainder)


class TestConnection(tests.BaseTestCase):

    def setUp(self):
        super(TestConnection, self).setUp()
        self.patch(socket, 'socket', tests.FakeSocket)
        self.conn = gear.Connection('127.0.0.1', 4730)
        self.conn.connect()
        self.socket = self.conn.conn

    def assertEndOfData(self):
        # End of data
        with testtools.ExpectedException(tests.FakeSocketEOF):
            self.conn.readPacket()

    def test_readPacket_admin(self):
        response = b'test\t0\t0\t1\n.\n'
        req = gear.StatusAdminRequest()
        self.socket._set_data([response])
        self.conn.admin_requests.append(req)
        r1 = self.conn.readPacket()
        self.assertEqual(r1.response, response)
        self.assertEndOfData()

    def test_readPacket_admin_mix(self):
        p1 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 5000)
        )
        response = b'test\t0\t0\t1\n.\n'
        p2 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 5000)
        )
        req = gear.StatusAdminRequest()
        self.conn.admin_requests.append(req)
        self.socket._set_data([p1.toBinary() + response + p2.toBinary()])
        r1 = self.conn.readPacket()
        self.assertEquals(r1, p1)
        ra = self.conn.readPacket()
        self.assertEqual(ra.response, response)
        r2 = self.conn.readPacket()
        self.assertEquals(r2, p2)
        self.assertEndOfData()

    def test_readPacket_large(self):
        p1 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 10000)
        )
        self.socket._set_data([p1.toBinary()])
        r1 = self.conn.readPacket()
        self.assertEquals(r1, p1)
        self.assertEndOfData()

    def test_readPacket_multi_pdu(self):
        p1 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 2600)
        )
        p2 = gear.Packet(
            gear.constants.REQ,
            gear.constants.GRAB_JOB_UNIQ,
            b''
        )
        self.socket._set_data([p1.toBinary()[:1448],
                               p1.toBinary()[1448:] + p2.toBinary()])
        # First packet
        r1 = self.conn.readPacket()
        self.assertEquals(r1, p1)
        # Second packet
        r2 = self.conn.readPacket()
        self.assertEquals(r2, p2)
        self.assertEndOfData()


class TestServerConnection(tests.BaseTestCase):

    def setUp(self):
        super(TestServerConnection, self).setUp()
        self.socket = tests.FakeSocket()
        self.conn = gear.ServerConnection('127.0.0.1', self.socket,
                                          False, 'test')

    def assertEndOfData(self):
        # End of data
        with testtools.ExpectedException(gear.RetryIOError):
            self.conn.readPacket()
        # Still end of data
        with testtools.ExpectedException(gear.RetryIOError):
            self.conn.readPacket()

    def test_readPacket_admin(self):
        command = b'status\n'
        self.socket._set_data([command])
        r1 = self.conn.readPacket()
        self.assertEqual(r1.command, command.strip())
        self.assertEndOfData()

    def test_readPacket_admin_mix(self):
        p1 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 5000)
        )
        command = b'status\n'
        p2 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 5000)
        )
        self.socket._set_data([p1.toBinary() + command + p2.toBinary()])
        r1 = self.conn.readPacket()
        self.assertEquals(r1, p1)
        ra = self.conn.readPacket()
        self.assertEqual(ra.command, command.strip())
        r2 = self.conn.readPacket()
        self.assertEquals(r2, p2)
        self.assertEndOfData()

    def test_readPacket_large(self):
        p1 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 10000)
        )
        self.socket._set_data([p1.toBinary()])
        r1 = self.conn.readPacket()
        self.assertEquals(r1, p1)
        self.assertEndOfData()

    def test_readPacket_multi_pdu(self):
        p1 = gear.Packet(
            gear.constants.REQ,
            gear.constants.WORK_COMPLETE,
            b'H:127.0.0.1:11\x00' + (b'x' * 2600)
        )
        p2 = gear.Packet(
            gear.constants.REQ,
            gear.constants.GRAB_JOB_UNIQ,
            b''
        )
        self.socket._set_data([p1.toBinary()[:1448],
                               p1.toBinary()[1448:] + p2.toBinary()])
        # First half of first packet
        with testtools.ExpectedException(gear.RetryIOError):
            self.conn.readPacket()
        # Second half of first packet
        r1 = self.conn.readPacket()
        self.assertEquals(r1, p1)
        # Second packet
        r2 = self.conn.readPacket()
        self.assertEquals(r2, p2)
        self.assertEndOfData()


class TestClient(tests.BaseTestCase):

    def test_wait_for_server_timeout(self):
        client = gear.Client('client')
        client.addServer('127.0.0.1', 0)
        self.assertRaises(gear.TimeoutError,
                          client.waitForServer, timeout=1)

    def test_handleStatusRes_1(self):
        client = gear.Client()

        packet = gear.Packet(
            gear.constants.RES,
            gear.constants.STATUS_RES,
            b'H:127.0.0.1:11\x001\x001\x00\x00'
        )
        packet.getJob = lambda: gear.Job(b"", b"")
        job = client.handleStatusRes(packet)

        self.assertTrue(job.known)
        self.assertTrue(job.running)

    def test_handleStatusRes_2(self):
        client = gear.Client()

        packet = gear.Packet(
            gear.constants.RES,
            gear.constants.STATUS_RES,
            b'H:127.0.0.1:11\x001\x000\x00\x00'
        )
        packet.getJob = lambda: gear.Job(b"", b"")
        job = client.handleStatusRes(packet)

        self.assertTrue(job.known)
        self.assertFalse(job.running)

    def test_ACL(self):
        acl = gear.ACL()
        acl.add(gear.ACLEntry('worker', register='foo.*'))
        acl.add(gear.ACLEntry('client', invoke='foo.*'))
        acl.add(gear.ACLEntry('manager', grant=True))
        self.assertEqual(len(acl.getEntries()), 3)

        self.assertTrue(acl.canRegister('worker', 'foo-bar'))
        self.assertTrue(acl.canRegister('worker', 'foo'))
        self.assertFalse(acl.canRegister('worker', 'bar-foo'))
        self.assertFalse(acl.canRegister('worker', 'bar'))
        self.assertFalse(acl.canInvoke('worker', 'foo'))
        self.assertFalse(acl.canGrant('worker'))

        self.assertTrue(acl.canInvoke('client', 'foo-bar'))
        self.assertTrue(acl.canInvoke('client', 'foo'))
        self.assertFalse(acl.canInvoke('client', 'bar-foo'))
        self.assertFalse(acl.canInvoke('client', 'bar'))
        self.assertFalse(acl.canRegister('client', 'foo'))
        self.assertFalse(acl.canGrant('client'))

        self.assertFalse(acl.canInvoke('manager', 'bar'))
        self.assertFalse(acl.canRegister('manager', 'foo'))
        self.assertTrue(acl.canGrant('manager'))

        acl.remove('worker')
        acl.remove('client')
        acl.remove('manager')

        self.assertFalse(acl.canRegister('worker', 'foo'))
        self.assertFalse(acl.canInvoke('client', 'foo'))
        self.assertFalse(acl.canGrant('manager'))

        self.assertEqual(len(acl.getEntries()), 0)

    def test_ACL_register(self):
        acl = gear.ACL()
        acl.grantRegister('worker', 'bar.*')
        self.assertTrue(acl.canRegister('worker', 'bar'))
        acl.revokeRegister('worker')
        self.assertFalse(acl.canRegister('worker', 'bar'))

    def test_ACL_invoke(self):
        acl = gear.ACL()
        acl.grantInvoke('client', 'bar.*')
        self.assertTrue(acl.canInvoke('client', 'bar'))
        acl.revokeInvoke('client')
        self.assertFalse(acl.canInvoke('client', 'bar'))

    def test_ACL_grant(self):
        acl = gear.ACL()
        acl.grantGrant('manager')
        self.assertTrue(acl.canGrant('manager'))
        acl.revokeGrant('manager')
        self.assertFalse(acl.canGrant('manager'))

    def test_double_shutdown(self):
        client = gear.Client()
        client.shutdown()
        client.shutdown()


def load_tests(loader, in_tests, pattern):
    return testscenarios.load_tests_apply_scenarios(loader, in_tests, pattern)