Merge lp:~bac/python-jujuclient/tls into lp:~hazmat/python-jujuclient/trunk

[Brad Crittenden]

Force websocket to use TLS.

The default SSL library on OS X attempts to use SSLv2 on connections. When
trying to connect to the juju endpoint with SSLv2 the connection is refused
and no negotiation is tried.

Luckily websocket create_connection has an undocumented kwarg sslopt which can
be used to force TLS.

Without the change all tests fail on OS X. With the change they all pass.

The test suite had failures before this branch was started and they have been
fixed.

The use of time.sleep(4) after calling client.destroy_service is required for
the status to be removed from status calls.

Also a minimal HACKING.rst doc was added to show how to run the tests.

[Brad Crittenden (bac)]

Please take a look.

[Kapil Thangavelu (hazmat)]

Thanks

review: Approve

[Kapil Thangavelu (hazmat)]

comments re sync client

=== added file 'HACKING.rst'
--- HACKING.rst	1970-01-01 00:00:00 +0000
+++ HACKING.rst	2014-06-19 20:55:27 +0000
@@ -0,0 +1,22 @@
+Juju Client Hacking Tips
+========================
+
+Running tests
+-------------
+
+In order to run the tests a Juju environment must be bootstrapped manually for
+the tests to interact.  Do the following to run against an ec2 environment::
+
+    $ juju bootstrap -e ec2
+
+After it is booted, set the dns-name of machine 0 to be JUJU_ENDPOINT::
+
+    $ export JUJU_ENDPOINT=`juju status | \
+      grep dns-name | awk -F': ' '{print "wss://"$2":17070"}'`
+
+You must also set JUJU_AUTH to be the admin-secret from the file in
+$JUJU_HOME/environments/ec2
+
+Once those two environment variables are set you can run the tests with::
+
+    $ python test_jujuclient.py

=== modified file 'jujuclient.py'
--- jujuclient.py	2014-04-27 01:38:13 +0000
+++ jujuclient.py	2014-06-19 20:55:27 +0000
@@ -56,6 +56,7 @@
 import pprint
 import signal
 import socket
+import ssl
 import StringIO
 import time
 import websocket
@@ -176,7 +177,8 @@
             try:
                 self.conn = websocket.create_connection(
                     self._reconnect_params['url'],
-                    origin=self._reconnect_params['origin'])
+                    origin=self._reconnect_params['origin'],
+                    sslopt={'ssl_version': ssl.PROTOCOL_TLSv1})
                 break
             except socket.error as err:
                 if not err.errno in (
@@ -308,7 +310,8 @@
             self.conn = conn
         else:
             self.conn = websocket.create_connection(
-                endpoint, origin=self.endpoint)
+                endpoint, origin=self.endpoint,
+                sslopt={'ssl_version': ssl.PROTOCOL_TLSv1})
 
     def close(self):
         for w in self._watches:
@@ -959,14 +962,11 @@
         for ep in d['Endpoints']:
             svc_rels = self.data.setdefault(
                 'services', {}).setdefault(
-                    ep['ServiceName'], {}).setdefault(
-                        'relations', {})
+                    ep['ServiceName'], {}).setdefault('relations', {})
             svc_rels.setdefault(
                 ep['Relation']['Name'], []).append(ep['RemoteService'])
 
 
-
-
 def main():
     import os
     juju_url, juju_token = (

=== modified file 'test_jujuclient.py'
--- test_jujuclient.py	2014-03-18 11:45:26 +0000
+++ test_jujuclient.py	2014-06-19 20:55:27 +0000
@@ -18,23 +18,35 @@
 
     def assert_service(self, svc_name):
         status = self.client.status()
-        self.assertTrue(svc_name in [
-            svc.get('Name') for svc in status.get('Services', ())])
+        services = status.get('Services', {})
+        self.assertTrue(
+            svc_name in services,
+            "Service {} does not exist".format(svc_name)
+        )
 
     def assert_not_service(self, svc_name):
         status = self.client.status()
-        self.assertTrue(svc_name not in [
-            svc.get('Name') for svc in status.get('Services', ())])
+        services = status.get('Services', {})
+        self.assertFalse(
+            svc_name in services,
+            "Service {} exists".format(svc_name)
+        )
 
     def test_juju_info(self):
         self.assertEqual(
-            self.client.info().keys(),
-            ['DefaultSeries', 'Name', 'ProviderType'])
+            sorted(self.client.info().keys()),
+            ['DefaultSeries', 'Name', 'ProviderType', 'UUID'])
 
     def test_deploy_and_destroy(self):
         self.assert_not_service('db')
-        self.client.deploy('db', 'precise/mysql')
+        self.client.deploy('db', 'precise/mysql-46')
         self.assert_service('db')
+        self.client.destroy_service('db')
+        # XXX: This library claims to be synchronous but destroying a service
+        # takes over 3 seconds to be removed from the status listing.
+        import time
+        time.sleep(4)
+        self.assert_not_service('db')
 
     def test_expose_unexpose(self):
         pass