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.
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?
36
from cStringIO import StringIO
39
from bzrlib.branch import Branch
40
from bzrlib.bzrdir import BzrDir
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tests import TestCaseWithTransport, TestSkipped
43
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
44
from bzrlib.transport import get_transport
45
from bzrlib.workingtree import WorkingTree
48
def chmod_r(base, file_mode, dir_mode):
49
"""Recursively chmod from a base directory"""
50
assert os.path.isdir(base)
51
os.chmod(base, dir_mode)
52
for root, dirs, files in os.walk(base):
54
p = os.path.join(root, d)
57
p = os.path.join(root, f)
58
os.chmod(p, file_mode)
61
def check_mode_r(test, base, file_mode, dir_mode, include_base=True):
62
"""Check that all permissions match
64
:param test: The TestCase being run
65
:param base: The path to the root directory to check
66
:param file_mode: The mode for all files
67
:param dir_mode: The mode for all directories
68
:param include_base: If false, only check the subdirectories
70
assert os.path.isdir(base)
71
t = get_transport(".")
73
test.assertTransportMode(t, base, dir_mode)
74
for root, dirs, files in os.walk(base):
76
p = '/'.join([urllib.quote(x) for x in root.split('/\\') + [d]])
77
test.assertTransportMode(t, p, dir_mode)
79
p = os.path.join(root, f)
80
p = '/'.join([urllib.quote(x) for x in root.split('/\\') + [f]])
81
test.assertTransportMode(t, p, file_mode)
84
class TestPermissions(TestCaseWithTransport):
86
def test_new_files(self):
87
if sys.platform == 'win32':
88
raise TestSkipped('chmod has no effect on win32')
90
t = self.make_branch_and_tree('.')
92
open('a', 'wb').write('foo\n')
93
# ensure check_mode_r works with capital-letter file-ids like TREE_ROOT
97
chmod_r('.bzr', 0644, 0755)
98
check_mode_r(self, '.bzr', 0644, 0755)
100
# although we are modifying the filesystem
101
# underneath the objects, they are not locked, and thus it must
102
# be safe for most operations. But here we want to observe a
103
# mode change in the control bits, which current do not refresh
104
# when a new lock is taken out.
105
t = WorkingTree.open('.')
107
self.assertEqualMode(0755, b.control_files._dir_mode)
108
self.assertEqualMode(0644, b.control_files._file_mode)
110
# Modifying a file shouldn't break the permissions
111
open('a', 'wb').write('foo2\n')
113
# The mode should be maintained after commit
114
check_mode_r(self, '.bzr', 0644, 0755)
116
# Adding a new file should maintain the permissions
117
open('b', 'wb').write('new b\n')
120
check_mode_r(self, '.bzr', 0644, 0755)
122
# Recursively update the modes of all files
123
chmod_r('.bzr', 0664, 0775)
124
check_mode_r(self, '.bzr', 0664, 0775)
125
t = WorkingTree.open('.')
127
self.assertEqualMode(0775, b.control_files._dir_mode)
128
self.assertEqualMode(0664, b.control_files._file_mode)
130
open('a', 'wb').write('foo3\n')
132
check_mode_r(self, '.bzr', 0664, 0775)
134
open('c', 'wb').write('new c\n')
137
check_mode_r(self, '.bzr', 0664, 0775)
139
# Test the group sticky bit
140
# Recursively update the modes of all files
141
chmod_r('.bzr', 0664, 02775)
142
check_mode_r(self, '.bzr', 0664, 02775)
143
t = WorkingTree.open('.')
145
self.assertEqualMode(02775, b.control_files._dir_mode)
146
self.assertEqualMode(0664, b.control_files._file_mode)
148
open('a', 'wb').write('foo4\n')
150
check_mode_r(self, '.bzr', 0664, 02775)
152
open('d', 'wb').write('new d\n')
155
check_mode_r(self, '.bzr', 0664, 02775)
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
161
transport = get_transport(self.get_url())
162
transport.put_bytes('my-lock', '')
163
lockable = LockableFiles(transport, 'my-lock', TransportLock)
164
self.assertNotEqual(None, lockable._dir_mode)
165
self.assertNotEqual(None, lockable._file_mode)
167
LockableFiles._set_dir_mode = False
168
transport = get_transport('.')
169
lockable = LockableFiles(transport, 'my-lock', TransportLock)
170
self.assertEqual(None, lockable._dir_mode)
171
self.assertNotEqual(None, lockable._file_mode)
173
LockableFiles._set_file_mode = False
174
transport = get_transport('.')
175
lockable = LockableFiles(transport, 'my-lock', TransportLock)
176
self.assertEqual(None, lockable._dir_mode)
177
self.assertEqual(None, lockable._file_mode)
179
LockableFiles._set_dir_mode = True
180
transport = get_transport('.')
181
lockable = LockableFiles(transport, 'my-lock', TransportLock)
182
self.assertNotEqual(None, lockable._dir_mode)
183
self.assertEqual(None, lockable._file_mode)
185
LockableFiles._set_file_mode = True
186
transport = get_transport('.')
187
lockable = LockableFiles(transport, 'my-lock', TransportLock)
188
self.assertNotEqual(None, lockable._dir_mode)
189
self.assertNotEqual(None, lockable._file_mode)
191
LockableFiles._set_dir_mode = True
192
LockableFiles._set_file_mode = True
195
class TestSftpPermissions(TestCaseWithSFTPServer):
197
def test_new_files(self):
198
if sys.platform == 'win32':
199
raise TestSkipped('chmod has no effect on win32')
200
# Though it would be nice to test that SFTP to a server
201
# which does support chmod has the right effect
203
# bodge around for stubsftpserver not letting use connect
205
_t = get_transport(self.get_url())
208
t_local = self.make_branch_and_tree('local')
209
b_local = t_local.branch
210
open('local/a', 'wb').write('foo\n')
212
t_local.commit('foo')
214
# Delete them because we are modifying the filesystem underneath them
215
chmod_r('local/.bzr', 0644, 0755)
216
check_mode_r(self, 'local/.bzr', 0644, 0755)
218
t = WorkingTree.open('local')
220
self.assertEqualMode(0755, b_local.control_files._dir_mode)
221
self.assertEqualMode(0644, b_local.control_files._file_mode)
224
sftp_url = self.get_url('sftp')
225
b_sftp = BzrDir.create_branch_and_repo(sftp_url)
229
chmod_r('sftp/.bzr', 0644, 0755)
230
check_mode_r(self, 'sftp/.bzr', 0644, 0755)
232
b_sftp = Branch.open(sftp_url)
233
self.assertEqualMode(0755, b_sftp.control_files._dir_mode)
234
self.assertEqualMode(0644, b_sftp.control_files._file_mode)
236
open('local/a', 'wb').write('foo2\n')
237
t_local.commit('foo2')
239
# The mode should be maintained after commit
240
check_mode_r(self, 'sftp/.bzr', 0644, 0755)
242
open('local/b', 'wb').write('new b\n')
244
t_local.commit('new b')
246
check_mode_r(self, 'sftp/.bzr', 0644, 0755)
249
# Recursively update the modes of all files
250
chmod_r('sftp/.bzr', 0664, 0775)
251
check_mode_r(self, 'sftp/.bzr', 0664, 0775)
253
b_sftp = Branch.open(sftp_url)
254
self.assertEqualMode(0775, b_sftp.control_files._dir_mode)
255
self.assertEqualMode(0664, b_sftp.control_files._file_mode)
257
open('local/a', 'wb').write('foo3\n')
258
t_local.commit('foo3')
260
check_mode_r(self, 'sftp/.bzr', 0664, 0775)
262
open('local/c', 'wb').write('new c\n')
264
t_local.commit('new c')
266
check_mode_r(self, 'sftp/.bzr', 0664, 0775)
268
def test_sftp_server_modes(self):
269
if sys.platform == 'win32':
270
raise TestSkipped('chmod has no effect on win32')
273
original_umask = os.umask(umask)
276
t = get_transport(self.get_url())
277
# Direct access should be masked by umask
278
t._sftp_open_exclusive('a', mode=0666).write('foo\n')
279
self.assertTransportMode(t, 'a', 0666 &~umask)
281
# but Transport overrides umask
282
t.put_bytes('b', 'txt', mode=0666)
283
self.assertTransportMode(t, 'b', 0666)
285
t._sftp.mkdir('c', mode=0777)
286
self.assertTransportMode(t, 'c', 0777 &~umask)
288
t.mkdir('d', mode=0777)
289
self.assertTransportMode(t, 'd', 0777)
291
os.umask(original_umask)