← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_permissions.py

  • Committer: John Arbash Meinel
  • Date: 2006-02-15 15:18:44 UTC
  • mto: (1185.79.1 bzr-jam-pending)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: john@arbash-meinel.com-20060215151844-ce3e3efccd19da3f
Reverting gpg changes, should not be mainline, see gpg_uses_tempfile plugin.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_permissions.py
 
1
# Copyright (C) 2005 by Canonical Ltd
 
2
# -*- coding: utf-8 -*-
 
3
 
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
 
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
 
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
 
 
19
"""Tests for bzr setting permissions.
 
20
 
 
21
Files which are created underneath .bzr/ should inherit its permissions.
 
22
So if the directory is group writable, the files and subdirs should be as well.
 
23
 
 
24
In the future, when we have Repository/Branch/Checkout information, the
 
25
permissions should be inherited individually, rather than all be the same.
 
26
"""
 
27
 
 
28
# TODO: jam 20051215 There are no tests for ftp yet, because we have no ftp server
 
29
# TODO: jam 20051215 Currently the default behavior for 'bzr branch' is just 
 
30
#                    defined by the local umask. This isn't terrible, is it
 
31
#                    the truly desired behavior?
 
32
 
 
33
import os
 
34
import sys
 
35
import stat
 
36
from StringIO import StringIO
 
37
 
 
38
from bzrlib.branch import Branch
 
39
from bzrlib.lockable_files import LockableFiles
 
40
from bzrlib.tests import TestCaseWithTransport, TestSkipped
 
41
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
 
42
from bzrlib.transport import get_transport
 
43
from bzrlib.workingtree import WorkingTree
 
44
 
 
45
 
 
46
def chmod_r(base, file_mode, dir_mode):
 
47
    """Recursively chmod from a base directory"""
 
48
    assert os.path.isdir(base)
 
49
    os.chmod(base, dir_mode)
 
50
    for root, dirs, files in os.walk(base):
 
51
        for d in dirs:
 
52
            p = os.path.join(root, d)
 
53
            os.chmod(p, dir_mode)
 
54
        for f in files:
 
55
            p = os.path.join(root, f)
 
56
            os.chmod(p, file_mode)
 
57
 
 
58
 
 
59
def check_mode_r(test, base, file_mode, dir_mode, include_base=True):
 
60
    """Check that all permissions match
 
61
 
 
62
    :param test: The TestCase being run
 
63
    :param base: The path to the root directory to check
 
64
    :param file_mode: The mode for all files
 
65
    :param dir_mode: The mode for all directories
 
66
    :param include_base: If false, only check the subdirectories
 
67
    """
 
68
    assert os.path.isdir(base)
 
69
    t = get_transport(".")
 
70
    if include_base:
 
71
        test.assertTransportMode(t, base, dir_mode)
 
72
    for root, dirs, files in os.walk(base):
 
73
        for d in dirs:
 
74
            p = os.path.join(root, d)
 
75
            test.assertTransportMode(t, p, dir_mode)
 
76
        for f in files:
 
77
            p = os.path.join(root, f)
 
78
            test.assertTransportMode(t, p, file_mode)
 
79
 
 
80
 
 
81
def assertEqualMode(test, mode, mode_test):
 
82
    test.assertEqual(mode, mode_test,
 
83
                     'mode mismatch %o != %o' % (mode, mode_test))
 
84
 
 
85
 
 
86
class TestPermissions(TestCaseWithTransport):
 
87
 
 
88
    def test_new_files(self):
 
89
        if sys.platform == 'win32':
 
90
            raise TestSkipped('chmod has no effect on win32')
 
91
 
 
92
        t = WorkingTree.create_standalone('.')
 
93
        b = t.branch
 
94
        open('a', 'wb').write('foo\n')
 
95
        t.add('a')
 
96
        t.commit('foo')
 
97
 
 
98
        # Delete them because we are modifying the filesystem underneath them
 
99
        del b, t 
 
100
        chmod_r('.bzr', 0644, 0755)
 
101
        check_mode_r(self, '.bzr', 0644, 0755)
 
102
 
 
103
        b = Branch.open('.')
 
104
        t = b.working_tree()
 
105
        assertEqualMode(self, 0755, b.control_files._dir_mode)
 
106
        assertEqualMode(self, 0644, b.control_files._file_mode)
 
107
 
 
108
        # Modifying a file shouldn't break the permissions
 
109
        open('a', 'wb').write('foo2\n')
 
110
        t.commit('foo2')
 
111
        # The mode should be maintained after commit
 
112
        check_mode_r(self, '.bzr', 0644, 0755)
 
113
 
 
114
        # Adding a new file should maintain the permissions
 
115
        open('b', 'wb').write('new b\n')
 
116
        t.add('b')
 
117
        t.commit('new b')
 
118
        check_mode_r(self, '.bzr', 0644, 0755)
 
119
 
 
120
        del b, t
 
121
        # Recursively update the modes of all files
 
122
        chmod_r('.bzr', 0664, 0775)
 
123
        check_mode_r(self, '.bzr', 0664, 0775)
 
124
        b = Branch.open('.')
 
125
        t = b.working_tree()
 
126
        assertEqualMode(self, 0775, b.control_files._dir_mode)
 
127
        assertEqualMode(self, 0664, b.control_files._file_mode)
 
128
 
 
129
        open('a', 'wb').write('foo3\n')
 
130
        t.commit('foo3')
 
131
        check_mode_r(self, '.bzr', 0664, 0775)
 
132
 
 
133
        open('c', 'wb').write('new c\n')
 
134
        t.add('c')
 
135
        t.commit('new c')
 
136
        check_mode_r(self, '.bzr', 0664, 0775)
 
137
 
 
138
        # Test the group sticky bit
 
139
        del b, t
 
140
        # Recursively update the modes of all files
 
141
        chmod_r('.bzr', 0664, 02775)
 
142
        check_mode_r(self, '.bzr', 0664, 02775)
 
143
        b = Branch.open('.')
 
144
        t = b.working_tree()
 
145
        assertEqualMode(self, 02775, b.control_files._dir_mode)
 
146
        assertEqualMode(self, 0664, b.control_files._file_mode)
 
147
 
 
148
        open('a', 'wb').write('foo4\n')
 
149
        t.commit('foo4')
 
150
        check_mode_r(self, '.bzr', 0664, 02775)
 
151
 
 
152
        open('d', 'wb').write('new d\n')
 
153
        t.add('d')
 
154
        t.commit('new d')
 
155
        check_mode_r(self, '.bzr', 0664, 02775)
 
156
 
 
157
    def test_disable_set_mode(self):
 
158
        # TODO: jam 20051215 Ultimately, this test should probably test that
 
159
        #                    extra chmod calls aren't being made
 
160
        try:
 
161
            transport = get_transport(self.get_url())
 
162
            transport.put('my-lock', StringIO(''))
 
163
            lockable = LockableFiles(transport, 'my-lock')
 
164
            self.assertNotEqual(None, lockable._dir_mode)
 
165
            self.assertNotEqual(None, lockable._file_mode)
 
166
 
 
167
            LockableFiles._set_dir_mode = False
 
168
            transport = get_transport('.')
 
169
            lockable = LockableFiles(transport, 'my-lock')
 
170
            self.assertEqual(None, lockable._dir_mode)
 
171
            self.assertNotEqual(None, lockable._file_mode)
 
172
 
 
173
            LockableFiles._set_file_mode = False
 
174
            transport = get_transport('.')
 
175
            lockable = LockableFiles(transport, 'my-lock')
 
176
            self.assertEqual(None, lockable._dir_mode)
 
177
            self.assertEqual(None, lockable._file_mode)
 
178
 
 
179
            LockableFiles._set_dir_mode = True
 
180
            transport = get_transport('.')
 
181
            lockable = LockableFiles(transport, 'my-lock')
 
182
            self.assertNotEqual(None, lockable._dir_mode)
 
183
            self.assertEqual(None, lockable._file_mode)
 
184
 
 
185
            LockableFiles._set_file_mode = True
 
186
            transport = get_transport('.')
 
187
            lockable = LockableFiles(transport, 'my-lock')
 
188
            self.assertNotEqual(None, lockable._dir_mode)
 
189
            self.assertNotEqual(None, lockable._file_mode)
 
190
        finally:
 
191
            LockableFiles._set_dir_mode = True
 
192
            LockableFiles._set_file_mode = True
 
193
 
 
194
    def test_new_branch(self):
 
195
        if sys.platform == 'win32':
 
196
            raise TestSkipped('chmod has no effect on win32')
 
197
        #FIXME RBC 20060105 should test branch and repository 
 
198
        # permissions ? 
 
199
        # also, these are BzrBranch format specific things..
 
200
        os.mkdir('a')
 
201
        mode = stat.S_IMODE(os.stat('a').st_mode)
 
202
        t = WorkingTree.create_standalone('.')
 
203
        b = t.branch
 
204
        assertEqualMode(self, mode, b.control_files._dir_mode)
 
205
        assertEqualMode(self, mode & ~07111, b.control_files._file_mode)
 
206
 
 
207
        os.mkdir('b')
 
208
        os.chmod('b', 02777)
 
209
        b = Branch.create('b')
 
210
        assertEqualMode(self, 02777, b.control_files._dir_mode)
 
211
        assertEqualMode(self, 00666, b.control_files._file_mode)
 
212
        check_mode_r(self, 'b/.bzr', 00666, 02777)
 
213
 
 
214
        os.mkdir('c')
 
215
        os.chmod('c', 02750)
 
216
        b = Branch.create('c')
 
217
        assertEqualMode(self, 02750, b.control_files._dir_mode)
 
218
        assertEqualMode(self, 00640, b.control_files._file_mode)
 
219
        check_mode_r(self, 'c/.bzr', 00640, 02750)
 
220
 
 
221
        os.mkdir('d')
 
222
        os.chmod('d', 0700)
 
223
        b = Branch.create('d')
 
224
        assertEqualMode(self, 0700, b.control_files._dir_mode)
 
225
        assertEqualMode(self, 0600, b.control_files._file_mode)
 
226
        check_mode_r(self, 'd/.bzr', 00600, 0700)
 
227
 
 
228
 
 
229
class TestSftpPermissions(TestCaseWithSFTPServer):
 
230
 
 
231
    def test_new_files(self):
 
232
        if sys.platform == 'win32':
 
233
            raise TestSkipped('chmod has no effect on win32')
 
234
        # Though it would be nice to test that SFTP to a server
 
235
        # which does support chmod has the right effect
 
236
 
 
237
        from bzrlib.transport.sftp import SFTPTransport
 
238
 
 
239
        # We don't actually use it directly, we just want to
 
240
        # keep the connection open, since StubSFTPServer only
 
241
        # allows 1 connection
 
242
        _transport = SFTPTransport(self._sftp_url)
 
243
 
 
244
        os.mkdir('local')
 
245
        t_local = WorkingTree.create_standalone('local')
 
246
        b_local = t_local.branch
 
247
        open('local/a', 'wb').write('foo\n')
 
248
        t_local.add('a')
 
249
        t_local.commit('foo')
 
250
 
 
251
        # Delete them because we are modifying the filesystem underneath them
 
252
        del b_local, t_local 
 
253
        chmod_r('local/.bzr', 0644, 0755)
 
254
        check_mode_r(self, 'local/.bzr', 0644, 0755)
 
255
 
 
256
        b_local = Branch.open(u'local')
 
257
        t_local = b_local.working_tree()
 
258
        assertEqualMode(self, 0755, b_local.control_files._dir_mode)
 
259
        assertEqualMode(self, 0644, b_local.control_files._file_mode)
 
260
 
 
261
        os.mkdir('sftp')
 
262
        sftp_url = self.get_remote_url('sftp')
 
263
        b_sftp = Branch.create(sftp_url)
 
264
 
 
265
        b_sftp.pull(b_local)
 
266
        del b_sftp
 
267
        chmod_r('sftp/.bzr', 0644, 0755)
 
268
        check_mode_r(self, 'sftp/.bzr', 0644, 0755)
 
269
 
 
270
        b_sftp = Branch.open(sftp_url)
 
271
        assertEqualMode(self, 0755, b_sftp.control_files._dir_mode)
 
272
        assertEqualMode(self, 0644, b_sftp.control_files._file_mode)
 
273
 
 
274
        open('local/a', 'wb').write('foo2\n')
 
275
        t_local.commit('foo2')
 
276
        b_sftp.pull(b_local)
 
277
        # The mode should be maintained after commit
 
278
        check_mode_r(self, 'sftp/.bzr', 0644, 0755)
 
279
 
 
280
        open('local/b', 'wb').write('new b\n')
 
281
        t_local.add('b')
 
282
        t_local.commit('new b')
 
283
        b_sftp.pull(b_local)
 
284
        check_mode_r(self, 'sftp/.bzr', 0644, 0755)
 
285
 
 
286
        del b_sftp
 
287
        # Recursively update the modes of all files
 
288
        chmod_r('sftp/.bzr', 0664, 0775)
 
289
        check_mode_r(self, 'sftp/.bzr', 0664, 0775)
 
290
 
 
291
        b_sftp = Branch.open(sftp_url)
 
292
        assertEqualMode(self, 0775, b_sftp.control_files._dir_mode)
 
293
        assertEqualMode(self, 0664, b_sftp.control_files._file_mode)
 
294
 
 
295
        open('local/a', 'wb').write('foo3\n')
 
296
        t_local.commit('foo3')
 
297
        b_sftp.pull(b_local)
 
298
        check_mode_r(self, 'sftp/.bzr', 0664, 0775)
 
299
 
 
300
        open('local/c', 'wb').write('new c\n')
 
301
        t_local.add('c')
 
302
        t_local.commit('new c')
 
303
        b_sftp.pull(b_local)
 
304
        check_mode_r(self, 'sftp/.bzr', 0664, 0775)
 
305
 
 
306
    def test_sftp_server_modes(self):
 
307
        if sys.platform == 'win32':
 
308
            raise TestSkipped('chmod has no effect on win32')
 
309
 
 
310
        umask = 0022
 
311
        original_umask = os.umask(umask)
 
312
 
 
313
        try:
 
314
            from bzrlib.transport.sftp import SFTPTransport
 
315
            t = SFTPTransport(self._sftp_url)
 
316
            # Direct access should be masked by umask
 
317
            t._sftp_open_exclusive('a', mode=0666).write('foo\n')
 
318
            self.assertTransportMode(t, 'a', 0666 &~umask)
 
319
 
 
320
            # but Transport overrides umask
 
321
            t.put('b', 'txt', mode=0666)
 
322
            self.assertTransportMode(t, 'b', 0666)
 
323
 
 
324
            t._sftp.mkdir('c', mode=0777)
 
325
            self.assertTransportMode(t, 'c', 0777 &~umask)
 
326
 
 
327
            t.mkdir('d', mode=0777)
 
328
            self.assertTransportMode(t, 'd', 0777)
 
329
        finally:
 
330
            os.umask(original_umask)