Merge lp:~mikemc/ubuntuone-storage-protocol/fix-1025950-cert-locs into lp:ubuntuone-storage-protocol

[Mike McCracken]

- Add support for finding SSL certs in packaged mac app. (LP: #1025950)

- Add support for finding SSL certs in packaged mac app. (LP: #1025950)

This branch also adds tests for the ssl cert path finding code for windows and linux.

Tested on all three.

TO TEST:

1. run-tests or run-tests.bat
2. on darwin, use setup-mac.py to create a packaged mac app and run it from command line using something like this:

% U1_DEBUG=1 dist/ubuntuone-control-panel-qt/UbuntuOne.app/Contents/MacOS/ubuntuone-control-panel-qt

Look for any errors regarding the certs path -- there should be none.
(Prior to this branch, you would see something about /etc/ssl/certs not existing)

[dobey (dobey)]

153 + if sys.platform == "win32":
154 + # First open the registry hive
155 + hive = _winreg.ConnectRegistry(None, _winreg.HKEY_LOCAL_MACHINE)
156 + # Open the registry key where Windows stores the Shell Folder locations
157 + key = _winreg.OpenKey(hive, str(
158 + "Software\\Microsoft\\Windows\\CurrentVersion"
159 + "\\Explorer\\Shell Folders"))
160 +
161 + ssl_cert_location = None
162 + for i in range(0, _winreg.QueryInfoKey(key)[1]):
163 + name, value, val_type = _winreg.EnumValue(key, i)
164 + # Common AppData will always be present unless the user
165 + # played with regedit
166 + if name == "Common AppData":
167 + ssl_cert_location = os.path.join(value,
168 + "ubuntuone-storageprotocol")
169 + break

Instead of duplicating all this registry poking code, would it not be better here to use the load_config_paths()[0] value from dirspec.basedir, as it already pokes at the registry to find the standard paths?

review: Needs Information

[lp:~mikemc/ubuntuone-storage-protocol/fix-1025950-cert-locs]

157. By Mike McCracken on 2012-08-10

Remove env vars due to formerly broken buildout

158. By Mike McCracken on 2012-08-10

Add back SYSNAME so we skip cpp tests

159. By Mike McCracken on 2012-08-11

merge with branch

160. By Mike McCracken on 2012-08-11

simplify windows code using dirspec

[Mike McCracken (mikemc)]

> Instead of duplicating all this registry poking code, would it not be better
> here to use the load_config_paths()[0] value from dirspec.basedir, as it
> already pokes at the registry to find the standard paths?

I looked into it and dirspec pokes differently, but apparently comes up with the same answer. So, I'm not sure why this code loops over keys like this.

I've updated it to use dirspec on win32.

[dobey (dobey)]

review: Approve

[lp:~mikemc/ubuntuone-storage-protocol/fix-1025950-cert-locs]

161. By Mike McCracken on 2012-08-15

merge with fix-run-tests

[Alejandro J. Cura (alecu)]

review: Approve

=== modified file 'setup.py'
--- setup.py	2012-06-12 17:03:26 +0000
+++ setup.py	2012-08-15 19:40:28 +0000
@@ -26,7 +26,7 @@
 from distutils.core import setup
 from distutils.spawn import find_executable
 from distutils.command import clean, build
-from ubuntuone.storageprotocol.context import ssl_cert_location
+from ubuntuone.storageprotocol.context import get_cert_location
 
 
 class StorageProtocolBuild(build.build):
@@ -74,7 +74,7 @@
       packages=['ubuntuone',
                 'ubuntuone.storageprotocol'],
       extra_path='ubuntuone-storage-protocol',
-      data_files=[(ssl_cert_location,
+      data_files=[(get_cert_location(),
                    ['data/UbuntuOne-Go_Daddy_CA.pem',
                     'data/ValiCert_Class_2_VA.pem',
                     'data/UbuntuOne-Go_Daddy_Class_2_CA.pem'])],

=== modified file 'tests/test_context.py'
--- tests/test_context.py	2012-08-15 19:40:28 +0000
+++ tests/test_context.py	2012-08-15 19:40:28 +0000
@@ -28,6 +28,7 @@
 # files in the program, then also delete it here.
 
 import os
+import sys
 
 from OpenSSL import crypto, SSL
 from twisted.internet import defer, error, reactor, ssl
@@ -197,3 +198,46 @@
                                                  hostname="localhost")
 
         yield self.verify_context(server_context, client_context)
+
+
+class SSLCertLocationTestCase(unittest.TestCase):
+    """Test determining the cert location."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        yield super(SSLCertLocationTestCase, self).setUp()
+
+    def test_win(self):
+        """Test geting a path when Common AppData is defined."""
+        self.patch(context, "load_config_paths",
+                   lambda x: [os.path.join("returned-value", x)])
+        self.patch(sys, "platform", "win32")
+        path = context.get_cert_location()
+        self.assertEqual(path, os.path.join("returned-value",
+                                            "ubuntuone-storageprotocol"))
+
+    def test_darwin_frozen(self):
+        """Test that we get a path with .app in it on frozen darwin."""
+        self.patch(sys, "platform", "darwin")
+        sys.frozen = "macosx-app"
+        self.addCleanup(delattr, sys, "frozen")
+        self.patch(context, "__file__",
+                   os.path.join("path", "to", "Main.app", "ignore"))
+        path = context.get_cert_location()
+        self.assertEqual(path, os.path.join("path", "to", "Main.app",
+                                            "Contents", "Resources"))
+
+    def test_darwin_unfrozen(self):
+        """Test that we get a source-relative path on unfrozen darwin."""
+        self.patch(sys, "platform", "darwin")
+        self.patch(context, "__file__",
+                   os.path.join("path", "to", "ubuntuone",
+                                "storageprotocol", "context.py"))
+        path = context.get_cert_location()
+        self.assertEqual(path, os.path.join("path", "to", "data"))
+
+    def test_linux(self):
+        """Test that linux gets the right path."""
+        self.patch(sys, "platform", "linux2")
+        path = context.get_cert_location()
+        self.assertEqual(path, "/etc/ssl/certs")

=== modified file 'ubuntuone/storageprotocol/context.py'
--- ubuntuone/storageprotocol/context.py	2012-06-12 16:32:06 +0000
+++ ubuntuone/storageprotocol/context.py	2012-08-15 19:40:28 +0000
@@ -36,27 +36,32 @@
 from twisted.internet import error, ssl
 from twisted.python import log
 
-if sys.platform == "win32":
-    # diable pylint warning, as it may be the wrong platform
-    # pylint: disable=F0401
-    import _winreg
-
-    # First open the registry hive
-    hive = _winreg.ConnectRegistry(None, _winreg.HKEY_LOCAL_MACHINE)
-    # Open the registry key where Windows stores the Shell Folder locations
-    key = _winreg.OpenKey(hive, str(
-            "Software\\Microsoft\\Windows\\CurrentVersion"
-            "\\Explorer\\Shell Folders"))
-    for i in range(0, _winreg.QueryInfoKey(key)[1]):
-        name, value, val_type = _winreg.EnumValue(key, i)
-        # Common AppData will always be present unless the user
-        # played with regedit
-        if name == "Common AppData":
-            ssl_cert_location = os.path.join(value,
-                                             "ubuntuone-storageprotocol")
-            break
-else:
-    ssl_cert_location = '/etc/ssl/certs'
+from dirspec.basedir import load_config_paths
+
+
+def get_cert_location():
+    """Return path to certificate files."""
+
+    if sys.platform == "win32":
+        ssl_cert_location = list(load_config_paths(
+                "ubuntuone-storageprotocol"))[0]
+
+    elif sys.platform == "darwin":
+        if getattr(sys, "frozen", None) is not None:
+            main_app_dir = "".join(__file__.partition(".app")[:-1])
+            main_app_resources_dir = os.path.join(main_app_dir,
+                                                  "Contents",
+                                                  "Resources")
+            ssl_cert_location = main_app_resources_dir
+        else:
+            pkg_dir = os.path.dirname(__file__)
+            src_tree_path = os.path.dirname(os.path.dirname(pkg_dir))
+            ssl_cert_location = os.path.join(src_tree_path,
+                                             "data")
+    else:
+        ssl_cert_location = '/etc/ssl/certs'
+
+    return ssl_cert_location
 
 
 class HostnameVerifyContextFactory(ssl.CertificateOptions):
@@ -88,6 +93,7 @@
 
 def get_certificates():
     """Get a list of certificate paths."""
+    ssl_cert_location = get_cert_location()
     ca_file = ssl.Certificate.loadPEM(file(os.path.join(ssl_cert_location,
                      'UbuntuOne-Go_Daddy_Class_2_CA.pem'), 'r').read())
     ca_file_2 = ssl.Certificate.loadPEM(file(os.path.join(ssl_cert_location,