/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/EncodingAdapter.py

  • Committer: Robert Collins
  • Date: 2008-01-06 20:04:22 UTC
  • mto: (3221.11.1 StackableBranch)
  • mto: This revision was merged to the branch mainline in revision 3226.
  • Revision ID: robertc@robertcollins.net-20080106200422-x8yz6cxotlzltvwp
The bzrdir format registry now accepts an ``alias`` keyword to
register_metadir, used to indicate that a format name is an alias for
some other format and thus should not be reported when describing the
format. (Robert Collins)
-------------- This line and the fmllowing will be ignored --------------

modified:
  NEWS
  bzrlib/bzrdir.py
  bzrlib/info.py
  bzrlib/tests/test_bzrdir.py
  bzrlib/tests/test_info.py

=== modified file 'NEWS'
--- a/NEWS      2008-01-02 22:30:46 +0000
+++ b/NEWS      2008-01-06 20:04:15 +0000
@@ -135,6 +135,11 @@
     * Patience Diff now supports arbitrary python objects, as long as they
       support ``hash()``. (John Arbash Meinel)
 
+    * The bzrdir format registry now accepts an ``alias`` keyword to
+      register_metadir, used to indicate that a format name is an alias for
+      some other format and thus should not be reported when describing the
+      format. (Robert Collins)
+
   API BREAKS:
 
   TESTING:

=== modified file 'bzrlib/bzrdir.py'
--- a/bzrlib/bzrdir.py  2008-01-02 22:30:46 +0000
+++ b/bzrlib/bzrdir.py  2008-01-06 19:41:29 +0000
@@ -2447,12 +2447,22 @@
     e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
     """
 
+    def __init__(self):
+        """Create a BzrDirFormatRegistry."""
+        self._aliases = set()
+        super(BzrDirFormatRegistry, self).__init__()
+
+    def aliases(self):
+        """Return a set of the format names which are aliases."""
+        return frozenset(self._aliases)
+
     def register_metadir(self, key,
              repository_format, help, native=True, deprecated=False,
              branch_format=None,
              tree_format=None,
              hidden=False,
-             experimental=False):
+             experimental=False,
+             alias=False):
         """Register a metadir subformat.
 
         These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
@@ -2491,10 +2501,10 @@
                 bd.repository_format = _load(repository_format)
             return bd
         self.register(key, helper, help, native, deprecated, hidden,
-            experimental)
+            experimental, alias)
 
     def register(self, key, factory, help, native=True, deprecated=False,
-                 hidden=False, experimental=False):
+                 hidden=False, experimental=False, alias=False):
         """Register a BzrDirFormat factory.
         
         The factory must be a callable that takes one parameter: the key.
@@ -2505,11 +2515,15 @@
         """
         registry.Registry.register(self, key, factory, help,
             BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def register_lazy(self, key, module_name, member_name, help, native=True,
-                      deprecated=False, hidden=False, experimental=False):
+        deprecated=False, hidden=False, experimental=False, alias=False):
         registry.Registry.register_lazy(self, key, module_name, member_name,
             help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def set_default(self, key):
         """Set the 'default' key to be a clone of the supplied key.
@@ -2518,6 +2532,7 @@
         """
         registry.Registry.register(self, 'default', self.get(key),
             self.get_help(key), info=self.get_info(key))
+        self._aliases.add('default')
 
     def set_default_repository(self, key):
         """Set the FormatRegistry default and Repository default.
@@ -2670,6 +2685,7 @@
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     hidden=False,
     )
+# The following two formats should always just be aliases.
 format_registry.register_metadir('development',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Current development format. Can convert data to and from pack-0.92 '
@@ -2681,6 +2697,7 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
 format_registry.register_metadir('development-subtree',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
@@ -2693,7 +2710,9 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
+# And the development formats which the will have aliased one of follow:
 format_registry.register_metadir('development0',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Trivial rename of pack-0.92 to provide a development format. '

=== modified file 'bzrlib/info.py'
--- a/bzrlib/info.py    2007-11-06 09:00:25 +0000
+++ b/bzrlib/info.py    2008-01-06 20:01:30 +0000
@@ -440,7 +440,9 @@
         tree.bzrdir.root_transport.base):
         branch = None
         repository = None
-    for key in bzrdir.format_registry.keys():
+    non_aliases = set(bzrdir.format_registry.keys())
+    non_aliases.difference_update(bzrdir.format_registry.aliases())
+    for key in non_aliases:
         format = bzrdir.format_registry.make_bzrdir(key)
         if isinstance(format, bzrdir.BzrDirMetaFormat1):
             if (tree and format.workingtree_format !=
@@ -457,11 +459,12 @@
         candidates.append(key)
     if len(candidates) == 0:
         return 'unnamed'
-    new_candidates = [c for c in candidates if c != 'default']
-    if len(new_candidates) > 0:
-        candidates = new_candidates
+    candidates.sort()
     new_candidates = [c for c in candidates if not
         bzrdir.format_registry.get_info(c).hidden]
     if len(new_candidates) > 0:
+        # If there are any non-hidden formats that match, only return those to
+        # avoid listing hidden formats except when only a hidden format will
+        # do.
         candidates = new_candidates
     return ' or '.join(candidates)

=== modified file 'bzrlib/tests/test_bzrdir.py'
--- a/bzrlib/tests/test_bzrdir.py       2007-12-21 20:32:22 +0000
+++ b/bzrlib/tests/test_bzrdir.py       2008-01-06 19:45:00 +0000
@@ -170,6 +170,16 @@
         finally:
             bzrdir.format_registry.set_default_repository(old_default)
 
+    def test_aliases(self):
+        a_registry = bzrdir.BzrDirFormatRegistry()
+        a_registry.register('weave', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True)
+        a_registry.register('weavealias', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True, alias=True)
+        self.assertEqual(frozenset(['weavealias']), a_registry.aliases())
+    
 
 class SampleBranch(bzrlib.branch.Branch):
     """A dummy branch for guess what, dummy use."""

=== modified file 'bzrlib/tests/test_info.py'
--- a/bzrlib/tests/test_info.py 2007-11-26 13:55:51 +0000
+++ b/bzrlib/tests/test_info.py 2008-01-06 20:02:10 +0000
@@ -126,16 +126,22 @@
 
     def test_describe_tree_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             self.assertTreeDescription(key)
 
     def test_describe_checkout_format(self):
         for key in bzrdir.format_registry.keys():
-            if key in ('default', 'weave', 'experimental'):
-                continue
-            if key.startswith('experimental-'):
-                # these are typically hidden or aliases for other formats
+            if key in bzrdir.format_registry.aliases():
+                # Aliases will not describe correctly in the UI because the
+                # real format is found.
+                continue
+            # legacy: weave does not support checkouts
+            if key == 'weave':
+                continue
+            if bzrdir.format_registry.get_info(key).experimental:
+                # We don't require that experimental formats support checkouts
+                # or describe correctly in the UI.
                 continue
             expected = None
             if key in ('dirstate', 'dirstate-tags', 'dirstate-with-subtree',
@@ -149,7 +155,7 @@
 
     def test_describe_branch_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit'):
@@ -158,7 +164,7 @@
 
     def test_describe_repo_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit', 'dirstate-tags'):

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/EncodingAdapter.py
 
1
# Copyright (C) 2006 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
"""Adapter for running test cases against multiple encodings."""
 
19
 
 
20
from copy import deepcopy
 
21
 
 
22
from bzrlib.tests import TestSuite
 
23
 
 
24
 
 
25
# prefix for micro (1/1000000)
 
26
_mu = u'\xb5'
 
27
 
 
28
# greek letter omega, not to be confused with
 
29
# the Ohm sign, u'\u2126'. Though they are probably identical
 
30
# cp437 can handle the first, but not the second
 
31
_omega = u'\u03a9'
 
32
 
 
33
# smallest error possible, epsilon
 
34
# cp437 handles u03b5, but not u2208 the 'element of' operator
 
35
_epsilon = u'\u03b5'
 
36
 
 
37
# Swedish?
 
38
_erik = u'Erik B\xe5gfors'
 
39
 
 
40
# Swedish 'räksmörgås' means shrimp sandwich
 
41
_shrimp_sandwich = u'r\xe4ksm\xf6rg\xe5s'
 
42
 
 
43
# Arabic, probably only Unicode encodings can handle this one
 
44
_juju = u'\u062c\u0648\u062c\u0648'
 
45
 
 
46
# iso-8859-1 alternative for juju
 
47
_juju_alt = u'j\xfbj\xfa'
 
48
 
 
49
# Russian, 'Alexander' in russian
 
50
_alexander = u'\u0410\u043b\u0435\u043a\u0441\u0430\u043d\u0434\u0440'
 
51
# The word 'test' in Russian
 
52
_russian_test = u'\u0422\u0435\u0441\u0442'
 
53
 
 
54
# Kanji
 
55
# It is a kanji sequence for nihonjin, or Japanese in English.
 
56
# 
 
57
# '\u4eba' being person, 'u\65e5' sun and '\u672c' origin. Ie,
 
58
# sun-origin-person, 'native from the land where the sun rises'. Note, I'm
 
59
# not a fluent speaker, so this is just my crude breakdown.
 
60
# 
 
61
# Wouter van Heyst
 
62
_nihonjin = u'\u65e5\u672c\u4eba'
 
63
 
 
64
# Czech
 
65
# It's what is usually used for showing how fonts look, because it contains
 
66
# most accented characters, ie. in places where Englishman use 'Quick brown fox
 
67
# jumped over a lazy dog'. The literal translation of the Czech version would
 
68
# be something like 'Yellow horse groaned devilish codes'. Actually originally
 
69
# the last word used to be 'ódy' (odes). The 'k' was added as a pun when using
 
70
# the sentece to check whether one has properly set encoding.
 
71
_yellow_horse = (u'\u017dlu\u0165ou\u010dk\xfd k\u016f\u0148'
 
72
                 u' \xfap\u011bl \u010f\xe1belsk\xe9 k\xf3dy')
 
73
_yellow = u'\u017dlu\u0165ou\u010dk\xfd'
 
74
_someone = u'Some\u016f\u0148\u011b'
 
75
_something = u'\u0165ou\u010dk\xfd'
 
76
 
 
77
# Hebrew
 
78
# Shalom -> 'hello' or 'peace', used as a common greeting
 
79
_shalom = u'\u05e9\u05dc\u05d5\u05dd'
 
80
 
 
81
 
 
82
class EncodingTestAdapter(object):
 
83
    """A tool to generate a suite, testing multiple encodings for a single test.
 
84
    
 
85
    This is similar to bzrlib.transport.TransportTestProviderAdapter.
 
86
    It is done by copying the test once for each encoding, and injecting
 
87
    the encoding name, and the list of valid strings for that encoding.
 
88
    Each copy is also given a new id() to make it easy to identify.
 
89
    """
 
90
 
 
91
    _encodings = [
 
92
        # Permutation 1 of utf-8
 
93
        ('utf-8', 1, {'committer':_erik
 
94
                  , 'message':_yellow_horse
 
95
                  , 'filename':_shrimp_sandwich
 
96
                  , 'directory':_nihonjin}),
 
97
        # Permutation 2 of utf-8
 
98
        ('utf-8', 2, {'committer':_alexander
 
99
                  , 'message':u'Testing ' + _mu
 
100
                  , 'filename':_shalom
 
101
                  , 'directory':_juju}),
 
102
        ('iso-8859-1', 0, {'committer':_erik
 
103
                  , 'message':u'Testing ' + _mu
 
104
                  , 'filename':_juju_alt
 
105
                  , 'directory':_shrimp_sandwich}),
 
106
        ('iso-8859-2', 0, {'committer':_someone
 
107
                  , 'message':_yellow_horse
 
108
                  , 'filename':_yellow
 
109
                  , 'directory':_something}),
 
110
        ('cp1251', 0, {'committer':_alexander
 
111
                  , 'message':u'Testing ' + _mu
 
112
                  , 'filename':_russian_test
 
113
                  , 'directory':_russian_test + 'dir'}),
 
114
# The iso-8859-1 tests run on a default windows cp437 installation
 
115
# and it takes a long time to run an extra permutation of the tests
 
116
# But just in case we want to add this back in:
 
117
#        ('cp437', 0, {'committer':_erik
 
118
#                  , 'message':u'Testing ' + _mu
 
119
#                  , 'filename':'file_' + _omega
 
120
#                  , 'directory':_epsilon + '_dir'}),
 
121
    ]
 
122
 
 
123
    def adapt(self, test):
 
124
        result = TestSuite()
 
125
        for encoding, count, info in self._encodings:
 
126
            new_test = deepcopy(test)
 
127
            new_test.encoding = encoding
 
128
            new_test.info = info
 
129
            def make_new_test_id():
 
130
                if count:
 
131
                    new_id = "%s(%s,%s)" % (new_test.id(), encoding, count)
 
132
                else:
 
133
                    new_id = "%s(%s)" % (new_test.id(), encoding)
 
134
                return lambda: new_id
 
135
            new_test.id = make_new_test_id()
 
136
            result.addTest(new_test)
 
137
        return result
 
138
 
 
139