source: TI05-delivery/trunk/test/test_embedded.py @ 1195

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/trunk/test/test_embedded.py@1195
Revision 1195, 10.8 KB checked in by spascoe, 13 years ago (diff)

Defined constants used by bbftp in delivery.server.

  • Property svn:executable set to *
Line 
1#!/usr/bin/env python
2"""
3Tests for the bbftp daemon when embedded in Python.
4
5@author: Stephen Pascoe
6@version: $Id$
7"""
8
9import unittest
10import sys, os, signal, time, syslog, stat
11from glob import glob
12import re, tempfile, getopt
13
14HOME = os.path.abspath(os.getenv('NDG_DELIVERY_HOME', os.curdir))
15BUILDDIR = glob('%s/build/lib.*' % HOME)[0]
16BBFTP = glob('%s/src/bbftp-client*/bbftpc/bbftp' % HOME)[0]
17DATADIR = '%s/test/data' % HOME
18VERSION = open('%s/VERSION' % HOME).read()
19NDG_MESSAGE_LEN = 256
20
21NDG_HANDSHAKE = "NDG-Delivery-server %s" % VERSION
22
23sys.path.append(BUILDDIR)
24
25import delivery.server as server
26
27
28class TestAuthHandler(server.BasicClientAuthHandler):
29   
30    def authenticate(self):
31        # Dump the pid so that gdm can pick it up
32        #fh = open('./DS_conn.pid', 'w')
33        #print >>fh, os.getpid()
34        #fh.close()
35        #time.sleep(20)
36       
37        msg = self.recvCStr()
38
39        syslog.syslog(syslog.LOG_DEBUG, 'AuthContext received Auth message: %s' % msg)
40
41        self.send(NDG_HANDSHAKE)
42
43        privatestr = self.recvCStr()
44        syslog.syslog(syslog.LOG_DEBUG, "AuthContext received privatestr: %s" % privatestr)
45
46        return self.makeAuthzHandler(msg, "TestCaseUser")
47
48    def makeAuthzHandler(self, msg, user):
49        return TestAuthzHandler(msg, "TestCaseUser")
50
51class TestAuthzHandler(server.LiberalAuthzHandler):
52    def __init__(self, version, username):
53        super(TestAuthzHandler, self).__init__(username)
54        self.version = version
55
56
57
58
59class TestFailAuthHandler(server.AuthHandler):
60    def authorise(self):
61        raise server.AuthenticationFailure, "TestFailAuthHandler"
62
63
64class TestPermAuthHandler(TestAuthHandler):
65    def makeAuthzHandler(self, msg, user):
66        return TestPermAuthzHandler(msg, "TestCaseUser")
67
68class TestPermAuthzHandler(TestAuthzHandler):
69    """Check's the path's other read permission and authorises accordingly.
70    """
71
72    def authzControl(self, msgcode, transferopt, path):
73        syslog.syslog(syslog.LOG_DEBUG, 'TestPermAuthzHandler.authzControl: msgcode = %s' % hex(msgcode))
74        return self.authzPath(path)
75
76    def authzRetr(self, path):
77        return self.authzPath(path)
78
79    def authzSend(self, path):
80        return self.authzPath(path)
81
82    def authzPath(self, path):
83        mode = stat.S_IMODE(os.stat(path)[stat.ST_MODE])
84        if (mode & 0004):
85            syslog.syslog(syslog.LOG_DEBUG, 'TestPermAuthzHandler OK')
86            return True
87        else:
88            syslog.syslog(syslog.LOG_DEBUG, 'TestPermAuthzHandler FAIL')
89            raise server.AuthorisationFailure, "TestPermAuthzHandler: no read perms"
90
91
92class BaseFixture(unittest.TestCase):
93
94    authContext = TestAuthHandler()
95
96    def setUp(self):
97        # We want to mark the beginning of this test case in syslog
98        syslog.openlog('test_embedded.py', 0, syslog.LOG_LOCAL0)
99        syslog.syslog(syslog.LOG_DEBUG, 'Starting TestCase')
100
101        self._startServer()
102
103    def tearDown(self):
104        self._stopServer()
105        syslog.syslog(syslog.LOG_DEBUG, 'Ended TestCase')
106        syslog.closelog()
107
108    #----------------------------------------------------------------------------------
109
110
111    def _startServer(self):
112        # Start the server and store it's PID
113        self.pid = server.start(self.authContext, ['-l', 'DEBUG'])
114
115    def _stopServer(self):
116        # Stop the server process
117        os.kill(self.pid, signal.SIGTERM)
118        os.waitpid(self.pid, 0)
119        syslog.syslog(syslog.LOG_DEBUG, 'Stopping server')
120
121
122    def _runClient(self, cmd, debug=False, user="testcase", privatestr=None):
123        """Run the client.
124        """
125
126        if debug:
127            f = "-d"
128        else:
129            f = "-m"
130
131        if privatestr == None:
132            p = ""
133        else:
134            p = "-P %s" % repr(privatestr)
135
136        # This is ugly but I need to redirect stderr to stdout
137        fh = os.popen('sh -c "%s %s %s -u %s -r 1 -e \'%s\' localhost" 2>&1 ' % (BBFTP, f, p, user, cmd))
138        return fh
139
140    def _readSyslog(self, logfile="/var/log/bbftpd/bbftpd.log"):
141        """Get all bbftpd messages from syslog for this test case.
142
143        @note: This requires read access to the logfile
144        """
145
146        # Read the logfile into a buffer
147        log = open(logfile).readlines()
148
149        # Find the latest testcase marker
150        start_i = 0
151        for i in xrange(len(log)-1, -1, -1):
152            if re.search('test_embedded.py: Starting TestCase', log[i]):
153                start_i = i+1
154                break
155        if not start_i:
156            raise RuntimeError, "Can't find test case entry in syslog"
157
158        filtered_log = []
159        for line in log[start_i:]:
160            if re.search(r'test_bbftpd.py:|bbftpd .*:', line):
161                filtered_log.append(line)
162
163        return ''.join(filtered_log)
164
165
166    def _findLines(self, lines, string):
167        """Look for lines matching each regular expression in lines.
168       
169        @return: True if all lines are found, else False
170        """
171       
172        for line in lines:
173            if not re.search('^%s$' % line, string, re.M):
174                return False
175           
176        return True
177
178
179    def assertLines(self, lines, string):
180        """Assert that there is a line in string matching each regular expression in lines.
181        """
182
183        for line in lines:
184            self.assert_(re.search('^%s$' % line, string, re.M))
185
186
187
188class AuthOK(BaseFixture):
189    """Test the bbftpd module.
190    """
191   
192    def testStartup(self):
193        lines = self._readSyslog()
194        # Give syslog time to flush it's logs.
195        time.sleep(1)
196        self.assertLines(['.*Starting bbftpd'], lines)
197
198    def testDir(self):
199        """Try connecting the client and listing a directory.
200        """
201
202
203        fh = self._runClient("dir %s" % DATADIR)
204        output = fh.read()
205
206
207        self.assertLines([r'dir .*/data', r' d .*/\.', r' d .*/\.\.',
208                        r' f .*/foo', r' f .*/bar', r' f .*/baz'], output)
209
210        lines = self._readSyslog()
211        self.assertLines(['.*Getting new bbftp connexion.*',
212                          r'.*Authz: MSG_LIST_V2 .*/test/data/\*.*',
213                          r'.*User TestCaseUser disconnected.*'], lines)
214
215
216    def testHandshake(self):
217        """Verify handshake messages are exchanged.
218        """
219
220        fh = self._runClient("dir .", debug=True)
221        output = fh.read()
222
223        self.assertLines(['Received Auth handshake: NDG-Delivery-server %s' % VERSION], output)
224
225        lines = self._readSyslog()
226        self.assertLines(['.*AuthContext received Auth message: NDG-Delivery-client %s' % VERSION], lines)
227
228    def testPrivateStr(self):
229        """Verify the private string is sent to server.
230        """
231
232        fh = self._runClient("dir .", privatestr="testPrivateStr")
233        output = fh.read()
234
235        lines = self._readSyslog()
236        self.assertLines(['.*AuthContext received privatestr: testPrivateStr'], lines)
237
238    def testRetr(self):
239        """Try retrieving a file.
240        """
241
242        tmp = tempfile.mktemp('test_bbftpd')
243        fh = self._runClient("get %s/foo %s" % (DATADIR, tmp))
244
245        # Check the client output
246        output = fh.read()
247
248        self.assertLines(['get.*nogzip'], output)
249
250        # Check retrieved file
251        self.assert_(os.system('diff --brief %s/foo %s' % (DATADIR, tmp)) == 0)
252        os.remove(tmp)
253
254        # Check syslog
255        lines = self._readSyslog()
256        self.assertLines(['.*Authz: RETR .*/foo', '.*GET TestCaseUser .*/foo.*'], lines)
257
258    def testStore(self):
259        """Try storing a file.
260        """
261
262
263        src = '%s/bar' % (DATADIR)
264        dest = '%s/new_bar' % (DATADIR)
265        os.system('cp %s %s' % (src, dest))
266        fh = self._runClient("put %s %s" % (src, dest))
267
268        # Check the client output
269        output = fh.read()
270        self.assertLines(['put .* nogzip'], output)
271
272
273        # Check sent file
274        self.assert_(os.system('diff --brief %s %s' % (dest, src)) == 0)
275        os.remove(dest)
276
277        # Check syslog
278        lines = self._readSyslog()
279        self.assertLines(['.*Authz: STORE .*/new_bar', '.*PUT TestCaseUser .*/new_bar.*'], lines)
280
281
282
283class AuthFail(BaseFixture):
284    authContext = TestFailAuthHandler()
285
286    def test(self):
287        """Fail authorisation
288        """
289
290        fh = self._runClient("dir .", debug=True)
291        output = fh.read()
292
293        lines = self._readSyslog()
294
295        self.assertLines(['.*Error while private authentication.*'], output)
296        self.assertLines(['.*bbftpd_private_auth failed.*'], lines)
297
298
299class Authz(BaseFixture):
300    authContext = TestPermAuthHandler()
301
302    def setUp(self):
303        super(Authz, self).setUp()
304
305        # Set modes on test files
306        os.chmod('%s/bar' % (DATADIR), 0640)
307        os.chmod('%s/foo' % (DATADIR), 0655)
308
309    def testOK(self):
310        """Test dir of a readable file.
311        """
312
313        fh = self._runClient("stat %s/foo" % (DATADIR), debug=True)
314        output = fh.read()
315
316        lines = self._readSyslog()
317
318
319        self.assertLines(['Connection and authentication correct', 'stat /.*/foo OK'], output)
320        self.assertLines(['.*Authz: MSG_STAT .*/foo', '.*TestPermAuthzHandler OK',
321                          '.*TestPermAuthzHandler.*msgcode = %s.*' % hex(server.MSG.STAT)], lines)
322
323    def testFail(self):
324        """Test dir of a non-readable file.
325        """
326
327        fh = self._runClient("stat %s/bar" % (DATADIR), debug=True)
328        output = fh.read()
329
330        lines = self._readSyslog()
331
332        self.assertLines(['BBFTP-ERROR.* ndg_authz_control: AuthorisationFailure.* no read perms',
333                          'stat /.*/bar FAILED'], output)
334        self.assertLines(['.*Authz: MSG_STAT .*/bar', '.* TestPermAuthzHandler FAIL',
335                          '.* ndg_authz_control: AuthorisationFailure.* no read perms'], lines)
336
337
338#
339# Embedded client test case currently segfaults :-(
340#
341## import delivery.bbftpc
342## import StringIO
343
344## class PythonClientAuthOK(AuthOK):
345##     """Repeat AuthOK tests with a python-embedded client.
346##     """
347
348##     def _runClient(self, cmd, debug=False, user="testcase", privatestr=None):
349##         """Run the client.
350##         """
351
352##         #print "Waiting for gdb connect, pid = %d" % os.getpid()
353##         #time.sleep(15)
354
355##         if debug:
356##             f = "-d"
357##         else:
358##             f = "-m"
359
360##         # Tell bbftp to dump output to a file which is then opened for reading.
361##         tmp = tempfile.mktemp('test_bbftpd')
362##         args = ['-e', cmd, f, '-u', user,
363##                 #'-o', tmp, '-f', tmp,
364##                 '-r', '1']
365
366##         if privatestr != None:
367##             args += ['-P', privatestr]
368
369##         args.append('localhost')
370##         print "Running client with args: %s" % (args,)
371
372##         delivery.bbftpc.run(args)
373
374##         #fh = open(tmp)
375##         #os.remove(tmp)
376##         fh = StringIO.StringIO('')
377
378##         return fh
379
380if __name__ == '__main__':
381    unittest.main()
Note: See TracBrowser for help on using the repository browser.