← 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
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_permissions.py
 
1
# Copyright (C) 2005 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 cStringIO import StringIO
 
37
import urllib
 
38
 
 
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
 
46
 
 
47
 
 
48
def chmod_r(base, file_mode, dir_mode):
 
49
    """Recursively chmod from a base directory"""
 
50
    os.chmod(base, dir_mode)
 
51
    for root, dirs, files in os.walk(base):
 
52
        for d in dirs:
 
53
            p = os.path.join(root, d)
 
54
            os.chmod(p, dir_mode)
 
55
        for f in files:
 
56
            p = os.path.join(root, f)
 
57
            os.chmod(p, file_mode)
 
58
 
 
59
 
 
60
def check_mode_r(test, base, file_mode, dir_mode, include_base=True):
 
61
    """Check that all permissions match
 
62
 
 
63
    :param test: The TestCase being run
 
64
    :param base: The path to the root directory to check
 
65
    :param file_mode: The mode for all files
 
66
    :param dir_mode: The mode for all directories
 
67
    :param include_base: If false, only check the subdirectories
 
68
    """
 
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 = '/'.join([urllib.quote(x) for x in root.split('/\\') + [d]])
 
75
            test.assertTransportMode(t, p, dir_mode)
 
76
        for f in files:
 
77
            p = os.path.join(root, f)
 
78
            p = '/'.join([urllib.quote(x) for x in root.split('/\\') + [f]])
 
79
            test.assertTransportMode(t, p, file_mode)
 
80
 
 
81
 
 
82
class TestPermissions(TestCaseWithTransport):
 
83
 
 
84
    def test_new_files(self):
 
85
        if sys.platform == 'win32':
 
86
            raise TestSkipped('chmod has no effect on win32')
 
87
 
 
88
        t = self.make_branch_and_tree('.')
 
89
        b = t.branch
 
90
        open('a', 'wb').write('foo\n')
 
91
        # ensure check_mode_r works with capital-letter file-ids like TREE_ROOT
 
92
        t.add('a', 'CAPS-ID')
 
93
        t.commit('foo')
 
94
 
 
95
        chmod_r('.bzr', 0644, 0755)
 
96
        check_mode_r(self, '.bzr', 0644, 0755)
 
97
 
 
98
        # although we are modifying the filesystem
 
99
        # underneath the objects, they are not locked, and thus it must
 
100
        # be safe for most operations. But here we want to observe a 
 
101
        # mode change in the control bits, which current do not refresh
 
102
        # when a new lock is taken out.
 
103
        t = WorkingTree.open('.')
 
104
        b = t.branch
 
105
        self.assertEqualMode(0755, b.control_files._dir_mode)
 
106
        self.assertEqualMode(0644, b.control_files._file_mode)
 
107
        self.assertEqualMode(0755, b.bzrdir._get_dir_mode())
 
108
        self.assertEqualMode(0644, b.bzrdir._get_file_mode())
 
109
 
 
110
        # Modifying a file shouldn't break the permissions
 
111
        open('a', 'wb').write('foo2\n')
 
112
        t.commit('foo2')
 
113
        # The mode should be maintained after commit
 
114
        check_mode_r(self, '.bzr', 0644, 0755)
 
115
 
 
116
        # Adding a new file should maintain the permissions
 
117
        open('b', 'wb').write('new b\n')
 
118
        t.add('b')
 
119
        t.commit('new b')
 
120
        check_mode_r(self, '.bzr', 0644, 0755)
 
121
 
 
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('.')
 
126
        b = t.branch
 
127
        self.assertEqualMode(0775, b.control_files._dir_mode)
 
128
        self.assertEqualMode(0664, b.control_files._file_mode)
 
129
        self.assertEqualMode(0775, b.bzrdir._get_dir_mode())
 
130
        self.assertEqualMode(0664, b.bzrdir._get_file_mode())
 
131
 
 
132
        open('a', 'wb').write('foo3\n')
 
133
        t.commit('foo3')
 
134
        check_mode_r(self, '.bzr', 0664, 0775)
 
135
 
 
136
        open('c', 'wb').write('new c\n')
 
137
        t.add('c')
 
138
        t.commit('new c')
 
139
        check_mode_r(self, '.bzr', 0664, 0775)
 
140
 
 
141
    def test_new_files_group_sticky_bit(self):
 
142
        if sys.platform == 'win32':
 
143
            raise TestSkipped('chmod has no effect on win32')
 
144
        elif sys.platform == 'darwin':
 
145
            # OS X creates temp dirs with the 'wheel' group, which users are
 
146
            # not likely to be in, and this prevents us from setting the sgid
 
147
            # bit
 
148
            os.chown(self.test_dir, os.getuid(), os.getgid())
 
149
 
 
150
        t = self.make_branch_and_tree('.')
 
151
        b = t.branch
 
152
 
 
153
        # Test the group sticky bit
 
154
        # Recursively update the modes of all files
 
155
        chmod_r('.bzr', 0664, 02775)
 
156
        check_mode_r(self, '.bzr', 0664, 02775)
 
157
        t = WorkingTree.open('.')
 
158
        b = t.branch
 
159
        self.assertEqualMode(02775, b.control_files._dir_mode)
 
160
        self.assertEqualMode(0664, b.control_files._file_mode)
 
161
        self.assertEqualMode(02775, b.bzrdir._get_dir_mode())
 
162
        self.assertEqualMode(0664, b.bzrdir._get_file_mode())
 
163
 
 
164
        open('a', 'wb').write('foo4\n')
 
165
        t.commit('foo4')
 
166
        check_mode_r(self, '.bzr', 0664, 02775)
 
167
 
 
168
        open('d', 'wb').write('new d\n')
 
169
        t.add('d')
 
170
        t.commit('new d')
 
171
        check_mode_r(self, '.bzr', 0664, 02775)
 
172
 
 
173
 
 
174
class TestSftpPermissions(TestCaseWithSFTPServer):
 
175
 
 
176
    def test_new_files(self):
 
177
        if sys.platform == 'win32':
 
178
            raise TestSkipped('chmod has no effect on win32')
 
179
        # Though it would be nice to test that SFTP to a server
 
180
        # which does support chmod has the right effect
 
181
 
 
182
        # bodge around for stubsftpserver not letting use connect
 
183
        # more than once
 
184
        _t = get_transport(self.get_url())
 
185
 
 
186
        os.mkdir('local')
 
187
        t_local = self.make_branch_and_tree('local')
 
188
        b_local = t_local.branch
 
189
        open('local/a', 'wb').write('foo\n')
 
190
        t_local.add('a')
 
191
        t_local.commit('foo')
 
192
 
 
193
        # Delete them because we are modifying the filesystem underneath them
 
194
        chmod_r('local/.bzr', 0644, 0755)
 
195
        check_mode_r(self, 'local/.bzr', 0644, 0755)
 
196
 
 
197
        t = WorkingTree.open('local')
 
198
        b_local = t.branch
 
199
        self.assertEqualMode(0755, b_local.control_files._dir_mode)
 
200
        self.assertEqualMode(0644, b_local.control_files._file_mode)
 
201
        self.assertEqualMode(0755, b_local.bzrdir._get_dir_mode())
 
202
        self.assertEqualMode(0644, b_local.bzrdir._get_file_mode())
 
203
 
 
204
        os.mkdir('sftp')
 
205
        sftp_url = self.get_url('sftp')
 
206
        b_sftp = BzrDir.create_branch_and_repo(sftp_url)
 
207
 
 
208
        b_sftp.pull(b_local)
 
209
        del b_sftp
 
210
        chmod_r('sftp/.bzr', 0644, 0755)
 
211
        check_mode_r(self, 'sftp/.bzr', 0644, 0755)
 
212
 
 
213
        b_sftp = Branch.open(sftp_url)
 
214
        self.assertEqualMode(0755, b_sftp.control_files._dir_mode)
 
215
        self.assertEqualMode(0644, b_sftp.control_files._file_mode)
 
216
        self.assertEqualMode(0755, b_sftp.bzrdir._get_dir_mode())
 
217
        self.assertEqualMode(0644, b_sftp.bzrdir._get_file_mode())
 
218
 
 
219
        open('local/a', 'wb').write('foo2\n')
 
220
        t_local.commit('foo2')
 
221
        b_sftp.pull(b_local)
 
222
        # The mode should be maintained after commit
 
223
        check_mode_r(self, 'sftp/.bzr', 0644, 0755)
 
224
 
 
225
        open('local/b', 'wb').write('new b\n')
 
226
        t_local.add('b')
 
227
        t_local.commit('new b')
 
228
        b_sftp.pull(b_local)
 
229
        check_mode_r(self, 'sftp/.bzr', 0644, 0755)
 
230
 
 
231
        del b_sftp
 
232
        # Recursively update the modes of all files
 
233
        chmod_r('sftp/.bzr', 0664, 0775)
 
234
        check_mode_r(self, 'sftp/.bzr', 0664, 0775)
 
235
 
 
236
        b_sftp = Branch.open(sftp_url)
 
237
        self.assertEqualMode(0775, b_sftp.control_files._dir_mode)
 
238
        self.assertEqualMode(0664, b_sftp.control_files._file_mode)
 
239
        self.assertEqualMode(0775, b_sftp.bzrdir._get_dir_mode())
 
240
        self.assertEqualMode(0664, b_sftp.bzrdir._get_file_mode())
 
241
 
 
242
        open('local/a', 'wb').write('foo3\n')
 
243
        t_local.commit('foo3')
 
244
        b_sftp.pull(b_local)
 
245
        check_mode_r(self, 'sftp/.bzr', 0664, 0775)
 
246
 
 
247
        open('local/c', 'wb').write('new c\n')
 
248
        t_local.add('c')
 
249
        t_local.commit('new c')
 
250
        b_sftp.pull(b_local)
 
251
        check_mode_r(self, 'sftp/.bzr', 0664, 0775)
 
252
 
 
253
    def test_sftp_server_modes(self):
 
254
        if sys.platform == 'win32':
 
255
            raise TestSkipped('chmod has no effect on win32')
 
256
 
 
257
        umask = 0022
 
258
        original_umask = os.umask(umask)
 
259
 
 
260
        try:
 
261
            t = get_transport(self.get_url())
 
262
            # Direct access should be masked by umask
 
263
            t._sftp_open_exclusive('a', mode=0666).write('foo\n')
 
264
            self.assertTransportMode(t, 'a', 0666 &~umask)
 
265
 
 
266
            # but Transport overrides umask
 
267
            t.put_bytes('b', 'txt', mode=0666)
 
268
            self.assertTransportMode(t, 'b', 0666)
 
269
 
 
270
            t._get_sftp().mkdir('c', mode=0777)
 
271
            self.assertTransportMode(t, 'c', 0777 &~umask)
 
272
 
 
273
            t.mkdir('d', mode=0777)
 
274
            self.assertTransportMode(t, 'd', 0777)
 
275
        finally:
 
276
            os.umask(original_umask)