Merge lp:~leonardr/launchpadlib/fake-edge into lp:launchpadlib

[Leonard Richardson]

This branch reinstates the aliases for 'edge', but makes 'edge' equivalent to 'production'. Code like this will work again:

Launchpad.login_with("foo", "edge")
Launchpad.login_with("foo", EDGE_SERVICE_ROOT)

But it will give a DeprecationWarning.

[Leonard Richardson (leonardr)]

I think it would be an excellent idea to stick this branch into the version of launchpadlib found in Maverick.

[Leonard Richardson (leonardr)]

Here's a version of the branch that should be able to go into Maverick: https://code.launchpad.net/~leonardr/launchpadlib/edge-fakery-for-maverick

[lp:~leonardr/launchpadlib/fake-edge]

117. By Leonard Richardson on 2011-02-14

Split out the edge tests.

[Jeroen T. Vermeulen (jtv)]

The technical details went over my head at several points, but what I do understand looks good.

Thanks for splitting up the tests. They're much more specific this way. It'd be nice to have the "warning" tests separated from the "translation" tests as well, but that's getting into matters of taste perhaps.

Jeroen

review: Approve

[Leonard Richardson (leonardr)]

The standalone "translation" tests would just duplicate the "warning" tests and suppress the warning.

=== modified file 'src/launchpadlib/NEWS.txt'
--- src/launchpadlib/NEWS.txt	2011-02-08 15:10:57 +0000
+++ src/launchpadlib/NEWS.txt	2011-02-14 18:28:48 +0000
@@ -2,14 +2,21 @@
 NEWS for launchpadlib
 =====================
 
-1.9.5 (2010-02-08)
+1.9.6 (2011-02-14)
+==================
+
+- Added EDGE_SERVICE_ROOT and the 'edge' alias back, though they both
+  operate on production behind the scenes. Using the 'edge' alias will
+  cause a deprecation warning.
+
+1.9.5 (2011-02-08)
 ==================
 
 - Fixed a bug that prevented the deprecated get_token_and_login code
   from working, and that required that users of get_token_and_login
   get a new token on every usage.
 
-1.9.4 (2010-01-18)
+1.9.4 (2011-01-18)
 ==================
 
 - Removed references to the 'edge' service root, which is being phased out.

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2011-02-07 19:54:03 +0000
+++ src/launchpadlib/__init__.py	2011-02-14 18:28:48 +0000
@@ -14,4 +14,4 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with launchpadlib. If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = '1.9.5'
+__version__ = '1.9.6'

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2011-02-07 20:08:28 +0000
+++ src/launchpadlib/launchpad.py	2011-02-14 18:28:48 +0000
@@ -45,10 +45,11 @@
 from launchpadlib import uris
 
 
-# Import some constants for backwards compatibility. This way, old
+# Set some constants for backwards compatibility. This way, old
 # scripts that have 'from launchpad import STAGING_SERVICE_ROOT' will still
 # work.
-from launchpadlib.uris import STAGING_SERVICE_ROOT
+STAGING_SERVICE_ROOT = 'staging'
+EDGE_SERVICE_ROOT = 'edge'
 OAUTH_REALM = 'https://api.launchpad.net'
 
 

=== modified file 'src/launchpadlib/tests/test_launchpad.py'
--- src/launchpadlib/tests/test_launchpad.py	2011-01-18 21:57:09 +0000
+++ src/launchpadlib/tests/test_launchpad.py	2011-02-14 18:28:48 +0000
@@ -68,23 +68,54 @@
 
     def setUp(self):
         self.aliases = sorted(
-            ['production', 'qastaging', 'staging', 'dogfood', 'dev', 'test_dev'])
+            ['production', 'qastaging', 'staging', 'dogfood', 'dev',
+             'test_dev', 'edge'])
 
     def test_short_names(self):
         # Ensure the short service names are all supported.
         self.assertEqual(sorted(uris.service_roots.keys()), self.aliases)
         self.assertEqual(sorted(uris.web_roots.keys()), self.aliases)
 
+    def test_edge_service_root_is_production(self):
+        # The edge server no longer exists, so if the client wants
+        # edge we give them production.
+        with warnings.catch_warnings(record=True) as caught:
+            warnings.simplefilter("always")
+            self.assertEqual(uris.lookup_service_root('edge'),
+                             uris.lookup_service_root('production'))
+
+            # The lookup caused a deprecation warning.
+            self.assertEqual(len(caught), 1)
+            warning, = caught
+            self.assertTrue(issubclass(warning.category, DeprecationWarning))
+            self.assertTrue("no longer exists" in warning.message.message)
+
+    def test_edge_service_root_is_production(self):
+        # The edge server no longer exists, so if the client wants
+        # edge we give them production.
+        with warnings.catch_warnings(record=True) as caught:
+            warnings.simplefilter("always")
+            self.assertEqual(uris.lookup_web_root('edge'),
+                             uris.lookup_web_root('production'))
+
+            # The lookup caused a deprecation warning.
+            self.assertEqual(len(caught), 1)
+            warning, = caught
+            self.assertTrue(issubclass(warning.category, DeprecationWarning))
+            self.assertTrue("no longer exists" in warning.message.message)
+
     def test_lookups(self):
         """Ensure that short service names turn into long service names."""
 
         # If the service name is a known alias, lookup methods convert
         # it to a URL.
-        for alias in self.aliases:
-            self.assertEqual(
-                uris.lookup_service_root(alias), uris.service_roots[alias])
-            self.assertEqual(
-                uris.lookup_web_root(alias), uris.web_roots[alias])
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            for alias in self.aliases:
+                self.assertEqual(
+                    uris.lookup_service_root(alias), uris.service_roots[alias])
+                self.assertEqual(
+                    uris.lookup_web_root(alias), uris.web_roots[alias])
 
         # If the service name is a valid URL, lookup methods let it
         # through.

=== modified file 'src/launchpadlib/uris.py'
--- src/launchpadlib/uris.py	2011-01-18 21:57:09 +0000
+++ src/launchpadlib/uris.py	2011-02-14 18:28:48 +0000
@@ -28,9 +28,13 @@
     ]
 
 from urlparse import urlparse
+import warnings
 from lazr.uri import URI
 
 LPNET_SERVICE_ROOT = 'https://api.launchpad.net/'
+# Allow code that uses EDGE_SERVICE_ROOT to keep running,
+# even though edge is gone.
+EDGE_SERVICE_ROOT = LPNET_SERVICE_ROOT
 QASTAGING_SERVICE_ROOT = 'https://api.qastaging.launchpad.net/'
 STAGING_SERVICE_ROOT = 'https://api.staging.launchpad.net/'
 DEV_SERVICE_ROOT = 'https://api.launchpad.dev/'
@@ -47,6 +51,7 @@
 
 service_roots = dict(
     production=LPNET_SERVICE_ROOT,
+    edge=LPNET_SERVICE_ROOT,
     qastaging=QASTAGING_SERVICE_ROOT,
     staging=STAGING_SERVICE_ROOT,
     dogfood=DOGFOOD_SERVICE_ROOT,
@@ -57,6 +62,7 @@
 
 web_roots = dict(
     production=LPNET_WEB_ROOT,
+    edge = LPNET_WEB_ROOT,
     qastaging=QASTAGING_WEB_ROOT,
     staging=STAGING_WEB_ROOT,
     dogfood=DOGFOOD_WEB_ROOT,
@@ -67,6 +73,9 @@
 
 def _dereference_alias(root, aliases):
     """Dereference what might a URL or an alias for a URL."""
+    if root == 'edge':
+        warnings.warn(("Launchpad edge server no longer exists. "
+                       "Using 'production' instead."), DeprecationWarning)
     if root in aliases:
         return aliases[root]