Merge lp:~gz/bzr/fix_win32utils_deprecations into lp:bzr

[Martin Packman]

Fix deprecations of win32utils path function unicode wrappers

Fix screwup of deprecation of unicode wrapper methods^Wfunctions in earlier branch. Also adds tests and makes sort-of testable on nix, as I'd actually fixed the mistake but lost it in a shelve dance and didn't realised as these code paths are only exercised on windows.

Changing the fallback method is annoying but unimportant. With Python 2.6 as a minumum version, ctypes should never be unavailable, and get_user_encoding will, unless messed with, return the python equivalent encoding of the GetACP return.

[Martin Packman (gz)]

sent to pqm by email

=== modified file 'bzrlib/tests/test_win32utils.py'
--- bzrlib/tests/test_win32utils.py	2011-12-05 12:50:21 +0000
+++ bzrlib/tests/test_win32utils.py	2011-12-19 10:47:31 +0000
@@ -20,6 +20,7 @@
 
 from bzrlib import (
     osutils,
+    symbol_versioning,
     tests,
     win32utils,
     )
@@ -187,6 +188,51 @@
         self.assertEquals('not-existing', p)
 
 
+class TestLocations(TestCase):
+    """Tests for windows specific path and name retrieving functions"""
+
+    def test__ensure_unicode_deprecated(self):
+        s = "text"
+        u1 = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
+            win32utils._ensure_unicode, s)
+        self.assertEqual(s, u1)
+        self.assertIsInstance(u1, unicode)
+        u2 = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
+            win32utils._ensure_unicode, u1)
+        self.assertIs(u1, u2)
+    
+    def test_appdata_unicode_deprecated(self):
+        self.overrideEnv("APPDATA", "fakepath")
+        s = win32utils.get_appdata_location()
+        u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
+            win32utils.get_appdata_location_unicode)
+        self.assertEqual(s, u)
+        self.assertIsInstance(s, unicode)
+
+    def test_home_unicode_deprecated(self):
+        s = win32utils.get_home_location()
+        u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
+            win32utils.get_home_location_unicode)
+        self.assertEqual(s, u)
+        self.assertIsInstance(s, unicode)
+
+    def test_user_unicode_deprecated(self):
+        self.overrideEnv("USERNAME", "alien")
+        s = win32utils.get_user_name()
+        u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
+            win32utils.get_user_name_unicode)
+        self.assertEqual(s, u)
+        self.assertIsInstance(s, unicode)
+
+    def test_host_unicode_deprecated(self):
+        self.overrideEnv("COMPUTERNAME", "alienbox")
+        s = win32utils.get_host_name()
+        u = self.applyDeprecated(symbol_versioning.deprecated_in((2, 5, 0)),
+            win32utils.get_host_name_unicode)
+        self.assertEqual(s, u)
+        self.assertIsInstance(s, unicode)
+
+
 class TestLocationsCtypes(TestCase):
 
     _test_needs_features = [CtypesFeature]

=== modified file 'bzrlib/win32utils.py'
--- bzrlib/win32utils.py	2011-12-14 18:27:44 +0000
+++ bzrlib/win32utils.py	2011-12-19 10:47:31 +0000
@@ -370,7 +370,7 @@
     return get_environ_unicode('COMPUTERNAME')
 
 
-@symbol_versioning.deprecated_method(
+@symbol_versioning.deprecated_function(
     symbol_versioning.deprecated_in((2, 5, 0)))
 def _ensure_unicode(s):
     if s and type(s) != unicode:
@@ -379,16 +379,16 @@
     return s
 
 
-get_appdata_location_unicode = symbol_versioning.deprecated_method(
+get_appdata_location_unicode = symbol_versioning.deprecated_function(
     symbol_versioning.deprecated_in((2, 5, 0)))(get_appdata_location)
 
-get_home_location_unicode = symbol_versioning.deprecated_method(
+get_home_location_unicode = symbol_versioning.deprecated_function(
     symbol_versioning.deprecated_in((2, 5, 0)))(get_home_location)
 
-get_user_name_unicode = symbol_versioning.deprecated_method(
+get_user_name_unicode = symbol_versioning.deprecated_function(
     symbol_versioning.deprecated_in((2, 5, 0)))(get_user_name)
 
-get_host_name_unicode = symbol_versioning.deprecated_method(
+get_host_name_unicode = symbol_versioning.deprecated_function(
     symbol_versioning.deprecated_in((2, 5, 0)))(get_host_name)
 
 
@@ -592,8 +592,9 @@
 
         Fallback version that should basically never be needed.
         """
+        from bzrlib import osutils
         try:
-            return os.environ[key].decode("mbcs")
+            return os.environ[key].decode(osutils.get_user_encoding())
         except KeyError:
             return default