~bzr-pqm/bzr/bzr.dev

1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
1
# Copyright (C) 2006 by 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
"""Tests for handling of ignore files"""
18
19
from cStringIO import StringIO
20
21
from bzrlib import config, errors, ignores
22
from bzrlib.tests import TestCase, TestCaseInTempDir
23
24
25
class TestParseIgnoreFile(TestCase):
26
27
    def test_parse_fancy(self):
28
        ignored = ignores.parse_ignore_file(StringIO(
29
                './rootdir\n'
30
                'randomfile*\n'
31
                'path/from/ro?t\n'
32
                'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
33
                'dos\r\n'
34
                '\n' # empty line
35
                '#comment\n'
36
                ' xx \n' # whitespace
37
                ))
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
38
        self.assertEqual(set(['./rootdir',
1836.1.25 by John Arbash Meinel
cleanups suggested by Martin.
39
                          'randomfile*',
40
                          'path/from/ro?t',
41
                          u'unicode\xb5',
42
                          'dos',
43
                          ' xx ',
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
44
                         ]), ignored)
1836.1.25 by John Arbash Meinel
cleanups suggested by Martin.
45
1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
46
    def test_parse_empty(self):
47
        ignored = ignores.parse_ignore_file(StringIO(''))
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
48
        self.assertEqual(set([]), ignored)
1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
49
50
1836.1.15 by John Arbash Meinel
Updated WorkingTree to use the new user-level ignores.
51
class TestUserIgnores(TestCaseInTempDir):
1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
52
    
53
    def test_create_if_missing(self):
54
        # $HOME should be set to '.'
55
        ignore_path = config.user_ignore_config_filename()
56
        self.failIfExists(ignore_path)
57
        user_ignores = ignores.get_user_ignores()
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
58
        self.assertEqual(set(ignores.USER_DEFAULTS), user_ignores)
1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
59
60
        self.failUnlessExists(ignore_path)
61
        f = open(ignore_path, 'rb')
62
        try:
63
            entries = ignores.parse_ignore_file(f)
64
        finally:
65
            f.close()
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
66
        self.assertEqual(set(ignores.USER_DEFAULTS), entries)
1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
67
68
    def test_use_existing(self):
69
        patterns = ['*.o', '*.py[co]', u'\xe5*']
1836.1.31 by John Arbash Meinel
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.
70
        ignores._set_user_ignores(patterns)
1836.1.13 by John Arbash Meinel
Adding functions for getting user ignores.
71
72
        user_ignores = ignores.get_user_ignores()
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
73
        self.assertEqual(set(patterns), user_ignores)
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
74
75
    def test_use_empty(self):
1836.1.31 by John Arbash Meinel
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.
76
        ignores._set_user_ignores([])
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
77
        ignore_path = config.user_ignore_config_filename()
1836.1.15 by John Arbash Meinel
Updated WorkingTree to use the new user-level ignores.
78
        self.check_file_contents(ignore_path, '')
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
79
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
80
        self.assertEqual(set([]), ignores.get_user_ignores())
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
81
1836.1.15 by John Arbash Meinel
Updated WorkingTree to use the new user-level ignores.
82
    def test_set(self):
83
        patterns = ['*.py[co]', '*.py[oc]']
1836.1.31 by John Arbash Meinel
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.
84
        ignores._set_user_ignores(patterns)
1836.1.15 by John Arbash Meinel
Updated WorkingTree to use the new user-level ignores.
85
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
86
        self.assertEqual(set(patterns), ignores.get_user_ignores())
1836.1.15 by John Arbash Meinel
Updated WorkingTree to use the new user-level ignores.
87
88
        patterns = ['vim', '*.swp']
1836.1.31 by John Arbash Meinel
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.
89
        ignores._set_user_ignores(patterns)
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
90
        self.assertEqual(set(patterns), ignores.get_user_ignores())
1836.1.15 by John Arbash Meinel
Updated WorkingTree to use the new user-level ignores.
91
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
92
    def test_add(self):
93
        """Test that adding will not duplicate ignores"""
94
        # Create an empty file
1836.1.31 by John Arbash Meinel
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.
95
        ignores._set_user_ignores([])
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
96
97
        patterns = ['foo', './bar', u'b\xe5z']
98
        added = ignores.add_unique_user_ignores(patterns)
99
        self.assertEqual(patterns, added)
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
100
        self.assertEqual(set(patterns), ignores.get_user_ignores())
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
101
102
    def test_add_unique(self):
103
        """Test that adding will not duplicate ignores"""
1836.1.31 by John Arbash Meinel
Make set_user_ignores a private function, and update the doc string to recommend it isn't used.
104
        ignores._set_user_ignores(['foo', './bar', u'b\xe5z'])
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
105
106
        added = ignores.add_unique_user_ignores(['xxx', './bar', 'xxx'])
107
        self.assertEqual(['xxx'], added)
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
108
        self.assertEqual(set(['foo', './bar', u'b\xe5z', 'xxx']),
1836.1.14 by John Arbash Meinel
Adding a helper function that will only add patterns if they are missing.
109
                         ignores.get_user_ignores())
1836.1.28 by John Arbash Meinel
Add a function for adding runtime ignores.
110
111
112
class TestRuntimeIgnores(TestCase):
113
114
    def setUp(self):
115
        TestCase.setUp(self)
116
117
        orig = ignores._runtime_ignores
118
        def restore():
119
            ignores._runtime_ignores = orig
120
        self.addCleanup(restore)
121
        # For the purposes of these tests, we must have no
122
        # runtime ignores
123
        ignores._runtime_ignores = set()
124
125
    def test_add(self):
126
        """Test that we can add an entry to the list."""
127
        self.assertEqual(set(), ignores.get_runtime_ignores())
128
129
        ignores.add_runtime_ignores(['foo'])
130
        self.assertEqual(set(['foo']), ignores.get_runtime_ignores())
131
132
    def test_add_duplicate(self):
133
        """Adding the same ignore twice shouldn't add a new entry."""
134
        ignores.add_runtime_ignores(['foo', 'bar'])
135
        self.assertEqual(set(['foo', 'bar']), ignores.get_runtime_ignores())
136
137
        ignores.add_runtime_ignores(['bar'])
138
        self.assertEqual(set(['foo', 'bar']), ignores.get_runtime_ignores())