Merge lp:~xnox/ubuntu-dev-tools/drop-mox into lp:~ubuntu-dev/ubuntu-dev-tools/trunk

[Dimitri John Ledkov]

Drop mox.

mox is not ported to python3, everything else is.

This is mostly equivalent, however, I do not assert call counts / call list of mocks. If this is critical, let me know and I can expand the tests to include that.

[Daniel Holbach (dholbach)]

This appears to have been merged already.

=== modified file 'debian/control'
--- debian/control	2014-01-06 21:48:08 +0000
+++ debian/control	2014-12-16 09:17:30 +0000
@@ -19,7 +19,6 @@
                python-distro-info (>= 0.4~),
                python-httplib2,
                python-launchpadlib (>= 1.5.7),
-               python-mox,
                python-setuptools,
                python-soappy,
                python-unittest2
 
=== modified file 'ubuntutools/test/test_archive.py'
--- ubuntutools/test/test_archive.py	2014-02-25 20:46:10 +0000
+++ ubuntutools/test/test_archive.py	2014-12-16 09:17:30 +0000
@@ -20,13 +20,14 @@
 import os.path
 import shutil
 import StringIO
+from io import BytesIO
 import tempfile
 import types
 import urllib2
 
 import debian.deb822
 import httplib2
-import mox
+import mock
 
 import ubuntutools.archive
 from ubuntutools.config import UDTConfig
@@ -44,15 +45,11 @@
         ex_pkg.cleanup()
 
 
-class DscVerificationTestCase(mox.MoxTestBase, unittest.TestCase):
+class DscVerificationTestCase(unittest.TestCase):
     def setUp(self):
-        super(DscVerificationTestCase, self).setUp()
         with open('test-data/example_1.0-1.dsc', 'rb') as f:
             self.dsc = ubuntutools.archive.Dsc(f.read())
 
-    def tearDown(self):
-        super(DscVerificationTestCase, self).tearDown()
-
     def test_good(self):
         self.assertTrue(self.dsc.verify_file(
             'test-data/example_1.0.orig.tar.gz'))
@@ -68,10 +65,10 @@
         with open(fn, 'rb') as f:
             data = f.read()
         data = data[:-1] + chr(ord(data[-1]) ^ 8)
-        self.mox.StubOutWithMock(__builtin__, 'open')
-        open(fn, 'rb').AndReturn(StringIO.StringIO(data))
-        self.mox.ReplayAll()
-        self.assertFalse(self.dsc.verify_file(fn))
+        m = mock.MagicMock(name='open', spec=open)
+        m.return_value = BytesIO(data)
+        with mock.patch('__builtin__.open', m):
+            self.assertFalse(self.dsc.verify_file(fn))
 
     def test_sha1(self):
         del self.dsc['Checksums-Sha256']
@@ -85,26 +82,31 @@
         self.test_bad()
 
 
-class LocalSourcePackageTestCase(mox.MoxTestBase, unittest.TestCase):
+class LocalSourcePackageTestCase(unittest.TestCase):
     SourcePackage = ubuntutools.archive.UbuntuSourcePackage
 
     def setUp(self):
-        super(LocalSourcePackageTestCase, self).setUp()
         self.workdir = tempfile.mkdtemp(prefix='udt-test')
 
-        self.mox.StubOutWithMock(ubuntutools.archive, 'Distribution')
-        self.mox.StubOutWithMock(ubuntutools.archive, 'rmadison')
-
-        self.real_http = httplib2.Http()
-        self.mox.StubOutWithMock(httplib2, 'Http')
-        self.mock_http = self.mox.CreateMock(httplib2.Http)
+        self._stubout('ubuntutools.archive.Distribution')
+        self._stubout('ubuntutools.archive.rmadison')
+
+        self.mock_http = self._stubout('httplib2.Http.request')
+        self.mock_http.side_effect = self.request_proxy
+
+        self.url_opener = mock.MagicMock(spec=urllib2.OpenerDirector)
+        self.url_opener.open.side_effect = self.urlopen_proxy
 
         # Silence the tests a little:
-        self.mox.stubs.Set(Logger, 'stdout', StringIO.StringIO())
-        self.mox.stubs.Set(Logger, 'stderr', StringIO.StringIO())
+        self._stubout('ubuntutools.logger.Logger.stdout')
+        self._stubout('ubuntutools.logger.Logger.stderr')        
+
+    def _stubout(self, stub):
+        patcher = mock.patch(stub)
+        self.addCleanup(patcher.stop)
+        return patcher.start()
 
     def tearDown(self):
-        super(LocalSourcePackageTestCase, self).tearDown()
         shutil.rmtree(self.workdir)
 
     def urlopen_proxy(self, url, destname=None):
@@ -141,6 +143,12 @@
         response = httplib2.Response({'status': 404})
         return response, "I'm a 404 Error"
 
+    def request_404_then_proxy(self, url, destname=None):
+        "mock side_effect callable to chain request 404 & proxy"
+        if self.mock_http.called:
+            return self.request_proxy(url, destname)
+        return self.request_404(url)
+
     def test_local_copy(self):
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  dscfile='test-data/example_1.0-1.dsc',
@@ -188,20 +196,11 @@
         dist = self.SourcePackage.distribution
         mirror = UDTConfig.defaults['%s_MIRROR' % dist.upper()]
         urlbase = '/pool/main/e/example/'
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request('https://launchpad.net/%s/+archive/primary/'
-                               '+files/example_1.0-1.dsc' % dist
-                              ).WithSideEffects(self.request_proxy)
-        url_opener = self.mox.CreateMock(urllib2.OpenerDirector)
-        url_opener.open(mirror + urlbase + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_proxy)
-        url_opener.open(mirror + urlbase + 'example_1.0-1.debian.tar.xz'
-                       ).WithSideEffects(self.urlopen_proxy)
-        self.mox.ReplayAll()
 
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  workdir=self.workdir)
-        pkg.url_opener = url_opener
+
+        pkg.url_opener = self.url_opener
         pkg.pull()
 
     def test_mirrors(self):
@@ -209,19 +208,12 @@
         mirror = 'http://mirror'
         lpbase = 'https://launchpad.net/ubuntu/+archive/primary/+files/'
         urlbase = '/pool/main/e/example/'
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(lpbase + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_proxy)
-        url_opener = self.mox.CreateMock(urllib2.OpenerDirector)
-        url_opener.open(mirror + urlbase + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_null)
-        url_opener.open(master + urlbase + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_404)
-        url_opener.open(lpbase + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_proxy)
-        url_opener.open(mirror + urlbase + 'example_1.0-1.debian.tar.xz'
-                       ).WithSideEffects(self.urlopen_proxy)
-        self.mox.ReplayAll()
+        sequence = [self.urlopen_null, self.urlopen_404, self.urlopen_proxy,
+                    self.urlopen_proxy]
+        def _callable_iter(*args, **kwargs):
+            return sequence.pop(0)(*args, **kwargs)
+        url_opener = mock.MagicMock(spec=urllib2.OpenerDirector)
+        url_opener.open.side_effect = _callable_iter
 
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  workdir=self.workdir, mirrors=[mirror])
@@ -229,12 +221,7 @@
         pkg.pull()
 
     def test_dsc_missing(self):
-        lpbase = 'https://launchpad.net/ubuntu/+archive/primary/+files/'
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(lpbase + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_404)
-        self.mox.ReplayAll()
-
+        self.mock_http.side_effect = self.request_404
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  workdir=self.workdir)
         self.assertRaises(ubuntutools.archive.DownloadError, pkg.pull)
@@ -251,31 +238,19 @@
         lpbase = 'https://launchpad.net/debian/+archive/primary/+files/'
         base = '/pool/main/e/example/'
 
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(lpbase + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_proxy)
-        url_opener = self.mox.CreateMock(urllib2.OpenerDirector)
-        url_opener.open(debian_mirror + base + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_null)
-        url_opener.open(debsec_mirror + base + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_404)
-        url_opener.open(debian_master + base + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_404)
-        url_opener.open(debsec_master + base + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_404)
-        url_opener.open(lpbase + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_404)
-        url_opener.open('http://snapshot.debian.org/mr/package/example/1.0-1/'
-                        'srcfiles?fileinfo=1'
-                       ).WithSideEffects(lambda x: StringIO.StringIO(
-            '{"fileinfo": {"hashabc": [{"name": "example_1.0.orig.tar.gz"}]}}'
-            ))
-        url_opener.open('http://snapshot.debian.org/file/hashabc'
-                       ).WithSideEffects(self.urlopen_file(
-                           'example_1.0.orig.tar.gz'))
-        url_opener.open(debian_mirror + base + 'example_1.0-1.debian.tar.xz'
-                       ).WithSideEffects(self.urlopen_proxy)
-        self.mox.ReplayAll()
+        sequence = [self.urlopen_null,
+                    self.urlopen_404,
+                    self.urlopen_404,
+                    self.urlopen_404,
+                    self.urlopen_404,
+                    lambda x: BytesIO(
+                        '{"fileinfo": {"hashabc": [{"name": "example_1.0.orig.tar.gz"}]}}'),
+                    self.urlopen_file('example_1.0.orig.tar.gz'),
+                    self.urlopen_proxy]
+        def _callable_iter(*args, **kwargs):
+            return sequence.pop(0)(*args, **kwargs)
+        url_opener = mock.MagicMock(spec=urllib2.OpenerDirector)
+        url_opener.open.side_effect = _callable_iter
 
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  workdir=self.workdir, mirrors=[debian_mirror,
@@ -288,61 +263,32 @@
         mirror = 'http://mirror'
         lpbase = 'https://launchpad.net/debian/+archive/primary/+files/'
         base = '/pool/main/e/example/'
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(lpbase + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_404)
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(mirror + base + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_proxy)
-        url_opener = self.mox.CreateMock(urllib2.OpenerDirector)
-        url_opener.open(mirror + base + 'example_1.0.orig.tar.gz'
-                       ).WithSideEffects(self.urlopen_proxy)
-        url_opener.open(mirror + base + 'example_1.0-1.debian.tar.xz'
-                       ).WithSideEffects(self.urlopen_proxy)
-
-        def fake_gpg_info(self, message, keyrings=None):
-            return debian.deb822.GpgInfo.from_output(
-                    '[GNUPG:] GOODSIG DEADBEEF Joe Developer '
-                    '<[e-mail]>')
-        # We have to stub this out without mox because there some versions of
-        # python-debian will pass keyrings=None, others won't.
-        # http://code.google.com/p/pymox/issues/detail?id=37
-        self.mox.stubs.Set(debian.deb822.GpgInfo, 'from_sequence',
-                           types.MethodType(fake_gpg_info,
-                                            debian.deb822.GpgInfo,
-                                            debian.deb822.GpgInfo))
-
-        self.mox.ReplayAll()
+        self.mock_http.side_effect = self.request_404_then_proxy
+
+        patcher = mock.patch.object(debian.deb822.GpgInfo, 'from_sequence')
+        self.addCleanup(patcher.stop)
+        mock_gpg_info = patcher.start()
+        mock_gpg_info.return_value = debian.deb822.GpgInfo.from_output(
+            '[GNUPG:] GOODSIG DEADBEEF Joe Developer '
+            '<[e-mail]>')
 
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  workdir=self.workdir, mirrors=[mirror])
-        pkg.url_opener = url_opener
+        pkg.url_opener = self.url_opener
         pkg.pull()
 
     def test_dsc_badsig(self):
         mirror = 'http://mirror'
         lpbase = 'https://launchpad.net/debian/+archive/primary/+files/'
         base = '/pool/main/e/example/'
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(lpbase + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_404)
-        httplib2.Http().AndReturn(self.mock_http)
-        self.mock_http.request(mirror + base + 'example_1.0-1.dsc'
-                              ).WithSideEffects(self.request_proxy)
-
-        def fake_gpg_info(self, message, keyrings=None):
-            return debian.deb822.GpgInfo.from_output(
-                    '[GNUPG:] ERRSIG DEADBEEF')
-        # We have to stub this out without mox because there some versions of
-        # python-debian will pass keyrings=None, others won't.
-        # http://code.google.com/p/pymox/issues/detail?id=37
-        self.mox.stubs.Set(debian.deb822.GpgInfo, 'from_sequence',
-                           types.MethodType(fake_gpg_info,
-                                            debian.deb822.GpgInfo,
-                                            debian.deb822.GpgInfo))
-
-        self.mox.ReplayAll()
-
+        self.mock_http.side_effect = self.request_404_then_proxy        
+
+        patcher = mock.patch.object(debian.deb822.GpgInfo, 'from_sequence')
+        self.addCleanup(patcher.stop)
+        mock_gpg_info = patcher.start()
+        mock_gpg_info.return_value = debian.deb822.GpgInfo.from_output(
+            '[GNUPG:] ERRSIG DEADBEEF')
+        
         pkg = self.SourcePackage('example', '1.0-1', 'main',
                                  workdir=self.workdir, mirrors=[mirror])
         self.assertRaises(ubuntutools.archive.DownloadError, pkg.pull)
 
=== modified file 'ubuntutools/test/test_config.py'
--- ubuntutools/test/test_config.py	2013-05-15 00:18:50 +0000
+++ ubuntutools/test/test_config.py	2014-12-16 09:17:30 +0000
@@ -19,15 +19,16 @@
 import os
 import sys
 import locale
+from io import BytesIO
 from StringIO import StringIO
 
-import mox
+import mock
 
 from ubuntutools.config import UDTConfig, ubu_email
 from ubuntutools.logger import Logger
 from ubuntutools.test import unittest
 
-class ConfigTestCase(mox.MoxTestBase, unittest.TestCase):
+class ConfigTestCase(unittest.TestCase):
     _config_files = {
         'system': '',
         'user': '',
@@ -42,11 +43,16 @@
         }
         if filename not in files:
             raise IOError("No such file or directory: '%s'" % filename)
-        return StringIO(files[filename])
+        return BytesIO(files[filename])
 
     def setUp(self):
         super(ConfigTestCase, self).setUp()
-        self.mox.stubs.Set(__builtin__, 'open', self._fake_open)
+        m = mock.mock_open()
+        m.side_effect = self._fake_open
+        patcher = mock.patch('__builtin__.open', m)
+        self.addCleanup(patcher.stop)
+        patcher.start()
+        
         Logger.stdout = StringIO()
         Logger.stderr = StringIO()
 
 
=== modified file 'ubuntutools/test/test_pylint.py'
--- ubuntutools/test/test_pylint.py	2011-06-24 14:32:07 +0000
+++ ubuntutools/test/test_pylint.py	2014-12-16 09:17:30 +0000
@@ -25,9 +25,6 @@
     r"No name '\w+Error' in module 'launchpadlib\.errors'",
     # http://www.logilab.org/ticket/51250:
     r"Module 'hashlib' has no '(md5|sha(1|224|256|384|512))' member",
-    # mox:
-    r"Instance of '.+' has no '(WithSideEffects|MultipleTimes|AndReturn)' "
-    r"member",
     # pylint doesn't like *args/**kwargs
     r"Instance of 'Popen' has no '.*' member",
 )]
 
=== modified file 'ubuntutools/test/test_update_maintainer.py'
--- ubuntutools/test/test_update_maintainer.py	2013-03-18 23:18:02 +0000
+++ ubuntutools/test/test_update_maintainer.py	2014-12-16 09:17:30 +0000
@@ -21,7 +21,7 @@
 import StringIO
 import sys
 
-import mox
+import mock
 
 from ubuntutools.logger import Logger
 from ubuntutools.test import unittest
@@ -186,7 +186,7 @@
 """
 
 #pylint: disable=R0904
-class UpdateMaintainerTestCase(mox.MoxTestBase, unittest.TestCase):
+class UpdateMaintainerTestCase(unittest.TestCase):
     """TestCase object for ubuntutools.update_maintainer"""
 
     _directory = "/"
@@ -216,9 +216,15 @@
 
     #pylint: disable=C0103
     def setUp(self):
-        super(UpdateMaintainerTestCase, self).setUp()
-        self.mox.stubs.Set(__builtin__, 'open', self._fake_open)
-        self.mox.stubs.Set(os.path, 'isfile', self._fake_isfile)
+        m = mock.mock_open()
+        m.side_effect = self._fake_open
+        patcher = mock.patch('__builtin__.open', m)
+        self.addCleanup(patcher.stop)
+        patcher.start()
+        m = mock.MagicMock(side_effect=self._fake_isfile)
+        patcher = mock.patch('os.path.isfile', m)
+        self.addCleanup(patcher.stop)
+        patcher.start()
         self._files["rules"] = StringIO.StringIO(_SIMPLE_RULES)
         Logger.stdout = StringIO.StringIO()
         Logger.stderr = StringIO.StringIO()