1
# Copyright (C) 2005 by Canonical Ltd
2
# -*- coding: utf-8 -*-
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.
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.
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
19
"""Tests for bzr setting permissions.
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.
24
In the future, when we have Repository/Branch/Checkout information, the
25
permissions should be inherited individually, rather than all be the same.
27
TODO: jam 20051215 There are no tests for ftp yet, because we have no ftp server
28
TODO: jam 20051215 Currently the default behavior for 'bzr branch' is just
29
defined by the local umask. This isn't terrible, is it
30
the truly desired behavior?
37
from bzrlib.branch import Branch
38
from bzrlib.tests import TestCaseInTempDir, TestSkipped
39
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
40
from bzrlib.tests.test_transport import check_mode
43
def chmod_r(base, file_mode, dir_mode):
44
"""Recursively chmod from a base directory"""
45
assert os.path.isdir(base)
46
os.chmod(base, dir_mode)
47
for root, dirs, files in os.walk(base):
49
p = os.path.join(root, d)
52
p = os.path.join(root, f)
53
os.chmod(p, file_mode)
56
def check_mode_r(test, base, file_mode, dir_mode, include_base=True):
57
"""Check that all permissions match
59
:param test: The TestCase being run
60
:param base: The path to the root directory to check
61
:param file_mode: The mode for all files
62
:param dir_mode: The mode for all directories
63
:param include_base: If false, only check the subdirectories
65
assert os.path.isdir(base)
67
check_mode(test, base, dir_mode)
68
for root, dirs, files in os.walk(base):
70
p = os.path.join(root, d)
71
check_mode(test, p, dir_mode)
73
p = os.path.join(root, f)
74
check_mode(test, p, file_mode)
77
def assertEqualMode(test, mode, mode_test):
78
test.assertEqual(mode, mode_test,
79
'mode mismatch %o != %o' % (mode, mode_test))
82
class TestPermissions(TestCaseInTempDir):
84
def test_new_files(self):
85
if sys.platform == 'win32':
86
raise TestSkipped('chmod has no effect on win32')
88
b = Branch.initialize(u'.')
90
open('a', 'wb').write('foo\n')
94
# Delete them because we are modifying the filesystem underneath them
96
chmod_r('.bzr', 0644, 0755)
97
check_mode_r(self, '.bzr', 0644, 0755)
101
assertEqualMode(self, 0755, b.control_files._dir_mode)
102
assertEqualMode(self, 0644, b.control_files._file_mode)
104
# Modifying a file shouldn't break the permissions
105
open('a', 'wb').write('foo2\n')
107
# The mode should be maintained after commit
108
check_mode_r(self, '.bzr', 0644, 0755)
110
# Adding a new file should maintain the permissions
111
open('b', 'wb').write('new b\n')
114
check_mode_r(self, '.bzr', 0644, 0755)
117
# Recursively update the modes of all files
118
chmod_r('.bzr', 0664, 0775)
119
check_mode_r(self, '.bzr', 0664, 0775)
122
assertEqualMode(self, 0775, b.control_files._dir_mode)
123
assertEqualMode(self, 0664, b.control_files._file_mode)
125
open('a', 'wb').write('foo3\n')
127
check_mode_r(self, '.bzr', 0664, 0775)
129
open('c', 'wb').write('new c\n')
132
check_mode_r(self, '.bzr', 0664, 0775)
134
# Test the group sticky bit
136
# Recursively update the modes of all files
137
chmod_r('.bzr', 0664, 02775)
138
check_mode_r(self, '.bzr', 0664, 02775)
141
assertEqualMode(self, 02775, b.control_files._dir_mode)
142
assertEqualMode(self, 0664, b.control_files._file_mode)
144
open('a', 'wb').write('foo4\n')
146
check_mode_r(self, '.bzr', 0664, 02775)
148
open('d', 'wb').write('new d\n')
151
check_mode_r(self, '.bzr', 0664, 02775)
153
def test_disable_set_mode(self):
154
# TODO: jam 20051215 Ultimately, this test should probably test that
155
# extra chmod calls aren't being made
156
import bzrlib.lockable_files
158
b = Branch.initialize(u'.')
159
self.assertNotEqual(None, b.control_files._dir_mode)
160
self.assertNotEqual(None, b.control_files._file_mode)
162
bzrlib.lockable_files.LockableFiles._set_dir_mode = False
163
b = Branch.open(u'.')
164
self.assertEqual(None, b.control_files._dir_mode)
165
self.assertNotEqual(None, b.control_files._file_mode)
167
bzrlib.lockable_files.LockableFiles._set_file_mode = False
168
b = Branch.open(u'.')
169
self.assertEqual(None, b.control_files._dir_mode)
170
self.assertEqual(None, b.control_files._file_mode)
172
bzrlib.lockable_files.LockableFiles._set_dir_mode = True
173
b = Branch.open(u'.')
174
self.assertNotEqual(None, b.control_files._dir_mode)
175
self.assertEqual(None, b.control_files._file_mode)
177
bzrlib.lockable_files.LockableFiles._set_file_mode = True
178
b = Branch.open(u'.')
179
self.assertNotEqual(None, b.control_files._dir_mode)
180
self.assertNotEqual(None, b.control_files._file_mode)
182
bzrlib.lockable_files.LockableFiles._set_dir_mode = True
183
bzrlib.lockable_files.LockableFiles._set_file_mode = True
185
def test_new_branch(self):
186
if sys.platform == 'win32':
187
raise TestSkipped('chmod has no effect on win32')
190
mode = stat.S_IMODE(os.stat('a').st_mode)
191
b = Branch.initialize('a')
192
assertEqualMode(self, mode, b.control_files._dir_mode)
193
assertEqualMode(self, mode & ~07111, b.control_files._file_mode)
197
b = Branch.initialize('b')
198
assertEqualMode(self, 02777, b.control_files._dir_mode)
199
assertEqualMode(self, 00666, b.control_files._file_mode)
200
check_mode_r(self, 'b/.bzr', 00666, 02777)
204
b = Branch.initialize('c')
205
assertEqualMode(self, 02750, b.control_files._dir_mode)
206
assertEqualMode(self, 00640, b.control_files._file_mode)
207
check_mode_r(self, 'c/.bzr', 00640, 02750)
211
b = Branch.initialize('d')
212
assertEqualMode(self, 0700, b.control_files._dir_mode)
213
assertEqualMode(self, 0600, b.control_files._file_mode)
214
check_mode_r(self, 'd/.bzr', 00600, 0700)
217
class TestSftpPermissions(TestCaseWithSFTPServer):
219
def test_new_files(self):
220
if sys.platform == 'win32':
221
raise TestSkipped('chmod has no effect on win32')
222
# Though it would be nice to test that SFTP to a server
223
# which does support chmod has the right effect
225
from bzrlib.transport.sftp import SFTPTransport
227
# We don't actually use it directly, we just want to
228
# keep the connection open, since StubSFTPServer only
229
# allows 1 connection
231
_transport = SFTPTransport(self._sftp_url)
234
b_local = Branch.initialize(u'local')
235
t_local = b_local.working_tree()
236
open('local/a', 'wb').write('foo\n')
238
t_local.commit('foo')
240
# Delete them because we are modifying the filesystem underneath them
242
chmod_r('local/.bzr', 0644, 0755)
243
check_mode_r(self, 'local/.bzr', 0644, 0755)
245
b_local = Branch.open(u'local')
246
t_local = b_local.working_tree()
247
assertEqualMode(self, 0755, b_local.control_files._dir_mode)
248
assertEqualMode(self, 0644, b_local.control_files._file_mode)
251
# Why does self._sftp_url end with a slash????
252
sftp_url = self._sftp_url + 'sftp'
253
b_sftp = Branch.initialize(sftp_url)
257
chmod_r('sftp/.bzr', 0644, 0755)
258
check_mode_r(self, 'sftp/.bzr', 0644, 0755)
260
b_sftp = Branch.open(sftp_url)
261
assertEqualMode(self, 0755, b_sftp.control_files._dir_mode)
262
assertEqualMode(self, 0644, b_sftp.control_files._file_mode)
264
open('local/a', 'wb').write('foo2\n')
265
t_local.commit('foo2')
267
# The mode should be maintained after commit
268
check_mode_r(self, 'sftp/.bzr', 0644, 0755)
270
open('local/b', 'wb').write('new b\n')
272
t_local.commit('new b')
274
check_mode_r(self, 'sftp/.bzr', 0644, 0755)
277
# Recursively update the modes of all files
278
chmod_r('sftp/.bzr', 0664, 0775)
279
check_mode_r(self, 'sftp/.bzr', 0664, 0775)
281
b_sftp = Branch.open(sftp_url)
282
assertEqualMode(self, 0775, b_sftp.control_files._dir_mode)
283
assertEqualMode(self, 0664, b_sftp.control_files._file_mode)
285
open('local/a', 'wb').write('foo3\n')
286
t_local.commit('foo3')
288
check_mode_r(self, 'sftp/.bzr', 0664, 0775)
290
open('local/c', 'wb').write('new c\n')
292
t_local.commit('new c')
294
check_mode_r(self, 'sftp/.bzr', 0664, 0775)
296
def test_sftp_server_modes(self):
297
if sys.platform == 'win32':
298
raise TestSkipped('chmod has no effect on win32')
301
original_umask = os.umask(umask)
304
from bzrlib.transport.sftp import SFTPTransport
306
t = SFTPTransport(self._sftp_url)
307
# Direct access should be masked by umask
308
t._sftp_open_exclusive('a', mode=0666).write('foo\n')
309
check_mode(self, 'a', 0666 &~umask)
311
# but Transport overrides umask
312
t.put('b', 'txt', mode=0666)
313
check_mode(self, 'b', 0666)
315
t._sftp.mkdir('c', mode=0777)
316
check_mode(self, 'c', 0777 &~umask)
318
t.mkdir('d', mode=0777)
319
check_mode(self, 'd', 0777)
321
os.umask(original_umask)