← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/stub_sftp.py

  • Committer: Martin Pool
  • Date: 2006-06-05 18:00:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: mbp@sourcefrog.net-20060605180036-04f5d0cea94ed999
clean up test kipple

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/stub_sftp.py
 
1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""
 
18
A stub SFTP server for loopback SFTP testing.
 
19
Adapted from the one in paramiko's unit tests.
 
20
"""
 
21
 
 
22
import os
 
23
from paramiko import ServerInterface, SFTPServerInterface, SFTPServer, SFTPAttributes, \
 
24
    SFTPHandle, SFTP_OK, AUTH_SUCCESSFUL, OPEN_SUCCEEDED
 
25
 
 
26
from bzrlib.osutils import pathjoin
 
27
from bzrlib.trace import mutter
 
28
 
 
29
 
 
30
class StubServer (ServerInterface):
 
31
 
 
32
    def __init__(self, test_case):
 
33
        ServerInterface.__init__(self)
 
34
        self._test_case = test_case
 
35
 
 
36
    def check_auth_password(self, username, password):
 
37
        # all are allowed
 
38
        self._test_case.log('sftpserver - authorizing: %s' % (username,))
 
39
        return AUTH_SUCCESSFUL
 
40
 
 
41
    def check_channel_request(self, kind, chanid):
 
42
        self._test_case.log('sftpserver - channel request: %s, %s' % (kind, chanid))
 
43
        return OPEN_SUCCEEDED
 
44
 
 
45
 
 
46
class StubSFTPHandle (SFTPHandle):
 
47
    def stat(self):
 
48
        try:
 
49
            return SFTPAttributes.from_stat(os.fstat(self.readfile.fileno()))
 
50
        except OSError, e:
 
51
            return SFTPServer.convert_errno(e.errno)
 
52
 
 
53
    def chattr(self, attr):
 
54
        # python doesn't have equivalents to fchown or fchmod, so we have to
 
55
        # use the stored filename
 
56
        mutter('Changing permissions on %s to %s', self.filename, attr)
 
57
        try:
 
58
            SFTPServer.set_file_attr(self.filename, attr)
 
59
        except OSError, e:
 
60
            return SFTPServer.convert_errno(e.errno)
 
61
 
 
62
 
 
63
class StubSFTPServer (SFTPServerInterface):
 
64
 
 
65
    def __init__(self, server, root, home=None):
 
66
        SFTPServerInterface.__init__(self, server)
 
67
        self.root = root
 
68
        if home is None:
 
69
            self.home = self.root
 
70
        else:
 
71
            self.home = home[len(self.root):]
 
72
        if (len(self.home) > 0) and (self.home[0] == '/'):
 
73
            self.home = self.home[1:]
 
74
        server._test_case.log('sftpserver - new connection')
 
75
 
 
76
    def _realpath(self, path):
 
77
        return self.root + self.canonicalize(path)
 
78
 
 
79
    def canonicalize(self, path):
 
80
        path = path.decode('utf-8')
 
81
        if os.path.isabs(path):
 
82
            return os.path.normpath(path)
 
83
        else:
 
84
            return os.path.normpath('/' + os.path.join(self.home, path))
 
85
 
 
86
    def chattr(self, path, attr):
 
87
        try:
 
88
            SFTPServer.set_file_attr(path, attr)
 
89
        except OSError, e:
 
90
            return SFTPServer.convert_errno(e.errno)
 
91
        return SFTP_OK
 
92
 
 
93
    def list_folder(self, path):
 
94
        path = self._realpath(path)
 
95
        try:
 
96
            out = [ ]
 
97
            flist = os.listdir(path)
 
98
            for fname in flist:
 
99
                attr = SFTPAttributes.from_stat(os.stat(pathjoin(path, fname)))
 
100
                attr.filename = fname
 
101
                out.append(attr)
 
102
            return out
 
103
        except OSError, e:
 
104
            return SFTPServer.convert_errno(e.errno)
 
105
 
 
106
    def stat(self, path):
 
107
        path = self._realpath(path)
 
108
        try:
 
109
            return SFTPAttributes.from_stat(os.stat(path))
 
110
        except OSError, e:
 
111
            return SFTPServer.convert_errno(e.errno)
 
112
 
 
113
    def lstat(self, path):
 
114
        path = self._realpath(path)
 
115
        try:
 
116
            return SFTPAttributes.from_stat(os.lstat(path))
 
117
        except OSError, e:
 
118
            return SFTPServer.convert_errno(e.errno)
 
119
 
 
120
    def open(self, path, flags, attr):
 
121
        path = self._realpath(path)
 
122
        try:
 
123
            if hasattr(os, 'O_BINARY'):
 
124
                flags |= os.O_BINARY
 
125
            if getattr(attr, 'st_mode', None):
 
126
                fd = os.open(path, flags, attr.st_mode)
 
127
            else:
 
128
                fd = os.open(path, flags)
 
129
        except OSError, e:
 
130
            return SFTPServer.convert_errno(e.errno)
 
131
        if (flags & os.O_CREAT) and (attr is not None):
 
132
            attr._flags &= ~attr.FLAG_PERMISSIONS
 
133
            SFTPServer.set_file_attr(path, attr)
 
134
        if flags & os.O_WRONLY:
 
135
            fstr = 'wb'
 
136
        elif flags & os.O_RDWR:
 
137
            fstr = 'rb+'
 
138
        else:
 
139
            # O_RDONLY (== 0)
 
140
            fstr = 'rb'
 
141
        try:
 
142
            f = os.fdopen(fd, fstr)
 
143
        except OSError, e:
 
144
            return SFTPServer.convert_errno(e.errno)
 
145
        fobj = StubSFTPHandle()
 
146
        fobj.filename = path
 
147
        fobj.readfile = f
 
148
        fobj.writefile = f
 
149
        return fobj
 
150
 
 
151
    def remove(self, path):
 
152
        path = self._realpath(path)
 
153
        try:
 
154
            os.remove(path)
 
155
        except OSError, e:
 
156
            return SFTPServer.convert_errno(e.errno)
 
157
        return SFTP_OK
 
158
 
 
159
    def rename(self, oldpath, newpath):
 
160
        oldpath = self._realpath(oldpath)
 
161
        newpath = self._realpath(newpath)
 
162
        try:
 
163
            os.rename(oldpath, newpath)
 
164
        except OSError, e:
 
165
            return SFTPServer.convert_errno(e.errno)
 
166
        return SFTP_OK
 
167
 
 
168
    def mkdir(self, path, attr):
 
169
        path = self._realpath(path)
 
170
        try:
 
171
            # Using getattr() in case st_mode is None or 0
 
172
            # both evaluate to False
 
173
            if getattr(attr, 'st_mode', None):
 
174
                os.mkdir(path, attr.st_mode)
 
175
            else:
 
176
                os.mkdir(path)
 
177
            if attr is not None:
 
178
                attr._flags &= ~attr.FLAG_PERMISSIONS
 
179
                SFTPServer.set_file_attr(path, attr)
 
180
        except OSError, e:
 
181
            return SFTPServer.convert_errno(e.errno)
 
182
        return SFTP_OK
 
183
 
 
184
    def rmdir(self, path):
 
185
        path = self._realpath(path)
 
186
        try:
 
187
            os.rmdir(path)
 
188
        except OSError, e:
 
189
            return SFTPServer.convert_errno(e.errno)
 
190
        return SFTP_OK
 
191
 
 
192
    # removed: chattr, symlink, readlink
 
193
    # (nothing in bzr's sftp transport uses those)