Merge lp:~allenap/maas/remove-unused-testing-things into lp:~maas-committers/maas/trunk

[Gavin Panella]

Remove SeleniumTestCase and other miscellaneous unused or little-used testing bits.

[Lee Trager (ltrager)]

LGTM!

review: Approve

[Gavin Panella (allenap)]

I'm holding on this for a few days because I may end up using run_isolated elsewhere.

[Gavin Panella (allenap)]

I didn't end up using run_isolated where I thought I might.

=== modified file 'src/maasserver/testing/testcase.py'
--- src/maasserver/testing/testcase.py	2017-01-05 16:18:56 +0000
+++ src/maasserver/testing/testcase.py	2017-01-06 10:04:40 +0000
@@ -1,4 +1,4 @@
-# Copyright 2012-2016 Canonical Ltd.  This software is licensed under the
+# Copyright 2012-2017 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Custom test-case classes."""
@@ -8,24 +8,15 @@
     'MAASLegacyTransactionServerTestCase',
     'MAASServerTestCase',
     'MAASTransactionServerTestCase',
-    'SeleniumTestCase',
     'SerializationFailureTestCase',
-    'TestWithoutCrochetMixin',
     'UniqueViolationTestCase',
 ]
 
 from itertools import count
-import socketserver
 import sys
 import threading
-from unittest import SkipTest
-from unittest.mock import Mock
 import warnings
-import wsgiref
 
-import crochet
-import django
-from django.core.urlresolvers import reverse
 from django.db import (
     close_old_connections,
     connection,
@@ -36,7 +27,6 @@
     IntegrityError,
     OperationalError,
 )
-from fixtures import Fixture
 from maasserver.fields import register_mac_type
 from maasserver.testing.factory import factory
 from maasserver.testing.fixtures import (
@@ -54,9 +44,7 @@
     DjangoTestCase,
     DjangoTransactionTestCase,
 )
-from maastesting.fixtures import DisplayFixture
 from maastesting.testcase import MAASTestCase
-from maastesting.utils import run_isolated
 
 
 class MAASRegionTestCaseBase(PostCommitHooksTestMixin):
@@ -215,133 +203,6 @@
         self.setUpFixtures()
 
 
-# Django supports Selenium tests only since version 1.4.
-django_supports_selenium = (django.VERSION >= (1, 4))
-
-if django_supports_selenium:
-    from django.test import LiveServerTestCase
-    from selenium.webdriver.firefox.webdriver import WebDriver
-else:
-    LiveServerTestCase = object  # noqa
-
-
-class LogSilencerFixture(Fixture):
-
-    old_handle_error = wsgiref.handlers.BaseHandler.handle_error
-    old_log_exception = wsgiref.handlers.BaseHandler.log_exception
-
-    def setUp(self):
-        super(LogSilencerFixture, self).setUp()
-        self.silence_loggers()
-        self.addCleanup(self.unsilence_loggers)
-
-    def silence_loggers(self):
-        # Silence logging of errors to avoid the
-        # "IOError: [Errno 32] Broken pipe" error.
-        socketserver.BaseServer.handle_error = Mock()
-        wsgiref.handlers.BaseHandler.log_exception = Mock()
-
-    def unsilence_loggers(self):
-        """Restore original handle_error/log_exception methods."""
-        socketserver.BaseServer.handle_error = self.old_handle_error
-        wsgiref.handlers.BaseHandler.log_exception = self.old_log_exception
-
-
-class SeleniumTestCase(
-        DjangoTransactionTestCase, LiveServerTestCase,
-        PostCommitHooksTestMixin):
-    """Selenium-enabled test case.
-
-    Two users are pre-created: "user" for a regular user account, or "admin"
-    for an administrator account.  Both have the password "test".  You can log
-    in as either using `log_in`.
-    """
-
-    # Load the selenium test fixture.
-    fixtures = ['src/maastesting/protractor/fixture.yaml']
-
-    @classmethod
-    def setUpClass(cls):
-        if not django_supports_selenium:
-            return
-        cls.display = DisplayFixture()
-        cls.display.__enter__()
-
-        cls.silencer = LogSilencerFixture()
-        cls.silencer.__enter__()
-
-        cls.selenium = WebDriver()
-        super(SeleniumTestCase, cls).setUpClass()
-
-    def setUp(self):
-        if not django_supports_selenium:
-            raise SkipTest(
-                "Live tests only enabled if Django.version >=1.4.")
-        super(SeleniumTestCase, self).setUp()
-
-    @classmethod
-    def tearDownClass(cls):
-        if not django_supports_selenium:
-            return
-        cls.selenium.quit()
-        cls.display.__exit__(None, None, None)
-        cls.silencer.__exit__(None, None, None)
-        super(SeleniumTestCase, cls).tearDownClass()
-
-    def log_in(self, user='user', password='test'):
-        """Log in as the given user.  Defaults to non-admin user."""
-        self.get_page('login')
-        username_input = self.selenium.find_element_by_id("id_username")
-        username_input.send_keys(user)
-        password_input = self.selenium.find_element_by_id("id_password")
-        password_input.send_keys(password)
-        self.selenium.find_element_by_xpath('//input[@value="Login"]').click()
-
-    def get_page(self, *reverse_args, **reverse_kwargs):
-        """GET a page.  Arguments are passed on to `reverse`."""
-        path = reverse(*reverse_args, **reverse_kwargs)
-        return self.selenium.get("%s%s" % (self.live_server_url, path))
-
-
-class TestWithoutCrochetMixin:
-    """Ensure that Crochet's event-loop is not running.
-
-    Crochet's event-loop cannot easily be resurrected, so this runs each
-    test in a new subprocess. There we can stop Crochet without worrying
-    about how to get it going again.
-
-    Use this where tests must, for example, patch out global state
-    during testing, where those patches coincide with things that
-    Crochet expects to use too, ``time.sleep`` for example.
-    """
-
-    _dead_thread = threading.Thread()
-    _dead_thread.start()
-    _dead_thread.join()
-
-    def __call__(self, result=None):
-        if result is None:
-            result = self.defaultTestResult()
-        # nose.proxy.ResultProxy.assertMyTest() is weird, and makes
-        # things break, so we neutralise it here.
-        result.assertMyTest = lambda test: None
-        # Finally, run the test in a subprocess.
-        up = super(TestWithoutCrochetMixin, self.__class__)
-        run_isolated(up, self, result)
-
-    run = __call__
-
-    def setUp(self):
-        super(TestWithoutCrochetMixin, self).setUp()
-        # Ensure that Crochet's event-loop has shutdown. The following
-        # runs in the child process started by run_isolated() so we
-        # don't need to repair the damage we do.
-        if crochet._watchdog.is_alive():
-            crochet._watchdog._canary = self._dead_thread
-            crochet._watchdog.join()  # Wait for the watchdog to stop.
-            self.assertFalse(crochet.reactor.running)
-
-
 class SerializationFailureTestCase(
         MAASTransactionServerTestCase, PostCommitHooksTestMixin):
 

=== modified file 'src/maastesting/tests/test_factory.py'
--- src/maastesting/tests/test_factory.py	2016-08-09 15:56:46 +0000
+++ src/maastesting/tests/test_factory.py	2017-01-06 10:04:40 +0000
@@ -1,4 +1,4 @@
-# Copyright 2012-2016 Canonical Ltd.  This software is licensed under the
+# Copyright 2012-2017 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Test the factory where appropriate.  Don't overdo this."""
@@ -8,11 +8,11 @@
 from datetime import datetime
 from itertools import count
 import os.path
-import random
 from random import randint
 import subprocess
 from unittest.mock import sentinel
 
+from maastesting import factory as factory_module
 from maastesting.factory import (
     factory,
     TooManyRandomRetries,
@@ -23,7 +23,6 @@
     MockCalledOnceWith,
 )
 from maastesting.testcase import MAASTestCase
-from maastesting.utils import FakeRandInt
 from netaddr import (
     IPAddress,
     IPNetwork,
@@ -59,17 +58,21 @@
         # Artificially limit randint to a very narrow range, to guarantee
         # some repetition in its output, and virtually guarantee that we test
         # both outcomes of the flip-a-coin call in make_vlan_tag.
-        self.patch(random, 'randint', FakeRandInt(random.randint, 0, 1))
-        outcomes = {factory.make_vlan_tag() for _ in range(1000)}
-        self.assertEqual({1}, outcomes)
+        random = self.patch(factory_module, "random")
+        random.randint.side_effect = [1, 2]
+        outcomes = {factory.make_vlan_tag(), factory.make_vlan_tag()}
+        self.assertEqual({1, 2}, outcomes)
 
     def test_make_vlan_tag_includes_None_if_allow_none(self):
-        self.patch(random, 'randint', FakeRandInt(random.randint, 0, 1))
+        random = self.patch(factory_module, "random")
+        random.choice.side_effect = [True, False, False]
+        random.randint.side_effect = [1, 2]
         self.assertEqual(
-            {None, 1},
+            {None, 1, 2},
             {
-                factory.make_vlan_tag(allow_none=True)
-                for _ in range(1000)
+                factory.make_vlan_tag(allow_none=True),
+                factory.make_vlan_tag(allow_none=True),
+                factory.make_vlan_tag(allow_none=True),
             })
 
     def test_make_ipv4_address(self):

=== modified file 'src/maastesting/utils.py'
--- src/maastesting/utils.py	2015-12-01 18:12:59 +0000
+++ src/maastesting/utils.py	2017-01-06 10:04:40 +0000
@@ -1,32 +1,17 @@
-# Copyright 2012-2015 Canonical Ltd.  This software is licensed under the
+# Copyright 2012-2017 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Testing utilities."""
 
 __all__ = [
     "age_file",
-    "content_from_file",
     "extract_word_list",
-    "get_write_time",
-    "FakeRandInt",
-    "preexec_fn",
-    "run_isolated",
     "sample_binary_data",
-    ]
+]
 
 import codecs
 import os
 import re
-import signal
-from sys import (
-    stderr,
-    stdout,
-)
-from traceback import print_exc
-
-import subunit
-from testtools.content import Content
-from testtools.content_type import UTF8_TEXT
 
 
 def age_file(path, seconds):
@@ -37,26 +22,6 @@
     os.utime(path, (atime, mtime - seconds))
 
 
-def get_write_time(path):
-    """Return last modification time of file at `path`."""
-    return os.stat(path).st_mtime
-
-
-def content_from_file(path):
-    """Alternative to testtools' version.
-
-    This keeps an open file-handle, so it can obtain the log even when the
-    file has been unlinked.
-    """
-    fd = open(path, "rb")
-
-    def iterate():
-        fd.seek(0)
-        return iter(fd)
-
-    return Content(UTF8_TEXT, iterate)
-
-
 def extract_word_list(string):
     """Return a list of words from a string.
 
@@ -66,75 +31,6 @@
     return re.findall("[^,;\s]+", string)
 
 
-def preexec_fn():
-    # Revert Python's handling of SIGPIPE. See
-    # http://bugs.python.org/issue1652 for more info.
-    signal.signal(signal.SIGPIPE, signal.SIG_DFL)
-
-
-class BytesToStdout:
-    """File-like object to forward bytes to a text-mode `stdout`.
-
-    Bytes are decoded as ASCII and unrecognised characters are replaced.
-    """
-
-    def write(self, data):
-        string = data.decode("ascii", "replace")
-        stdout.write(string)
-
-
-def run_isolated(cls, self, result):
-    """Run a test suite or case in a subprocess.
-
-    This is derived from ``subunit.run_isolated``. Subunit's version
-    clobbers stdout by dup'ing the subunit's stream over the top, which
-    prevents effective debugging at the terminal. This variant does not
-    suffer from the same issue.
-    """
-    c2pread, c2pwrite = os.pipe()
-    pid = os.fork()
-    if pid == 0:
-        # Child: runs test and writes subunit to c2pwrite.
-        try:
-            os.close(c2pread)
-            stream = os.fdopen(c2pwrite, 'wb')
-            sender = subunit.TestProtocolClient(stream)
-            cls.run(self, sender)
-            stream.flush()
-            stdout.flush()
-            stderr.flush()
-        except:
-            # Print error and exit hard.
-            try:
-                print_exc(file=stderr)
-                stderr.flush()
-            finally:
-                os._exit(2)
-        finally:
-            # Exit hard.
-            os._exit(0)
-    else:
-        # TestProtocolServer, by default, will write non-subunit content to
-        # stdout as *bytes*. In Python 3 it assumes that stdout has a `buffer`
-        # attribute which can accept bytes. However, nose buffers test output,
-        # and replaces sys.stdout with only a StringIO instance.
-        try:
-            stdout.write(b"")
-        except TypeError:
-            try:
-                output = stdout.buffer
-            except AttributeError:
-                output = BytesToStdout()
-        else:
-            output = stdout
-        # Parent: receives subunit from c2pread.
-        os.close(c2pwrite)
-        stream = os.fdopen(c2pread, 'rb')
-        receiver = subunit.TestProtocolServer(result, output)
-        receiver.readFrom(stream)
-        os.waitpid(pid, 0)
-
-
 # Some horrible binary data that could never, ever, under any encoding
 # known to man(1) survive mis-interpretation as text.
 #
@@ -146,25 +42,3 @@
 # (1) Provided, of course, that man know only about ASCII and
 # UTF.
 sample_binary_data = codecs.BOM64_LE + codecs.BOM64_BE + b'\x00\xff\x00'
-
-
-class FakeRandInt:
-    """Fake `randint` with forced limitations on its range.
-
-    This lets you set a forced minimum, and/or a forced maximum, on the range
-    of any call.  For example, if you pass `forced_maximum=3`, then a call
-    will never return more than 3.  If you don't set a maximum, or if the
-    call's maximum argument is less than the forced maximum, then the call's
-    maximum will be respected.
-    """
-    def __init__(self, real_randint, forced_minimum=None, forced_maximum=None):
-        self.real_randint = real_randint
-        self.minimum = forced_minimum
-        self.maximum = forced_maximum
-
-    def __call__(self, minimum, maximum):
-        if self.minimum is not None:
-            minimum = max(minimum, self.minimum)
-        if self.maximum is not None:
-            maximum = min(maximum, self.maximum)
-        return self.real_randint(minimum, maximum)

=== modified file 'src/provisioningserver/utils/tests/test_fs.py'
--- src/provisioningserver/utils/tests/test_fs.py	2016-12-14 08:43:09 +0000
+++ src/provisioningserver/utils/tests/test_fs.py	2017-01-06 10:04:40 +0000
@@ -1,4 +1,4 @@
-# Copyright 2014-2016 Canonical Ltd.  This software is licensed under the
+# Copyright 2014-2017 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Tests for filesystem-related utilities."""
@@ -31,10 +31,7 @@
     MockNotCalled,
 )
 from maastesting.testcase import MAASTestCase
-from maastesting.utils import (
-    age_file,
-    get_write_time,
-)
+from maastesting.utils import age_file
 import provisioningserver.config
 from provisioningserver.utils.fs import (
     atomic_copy,
@@ -217,11 +214,11 @@
         contents = factory.make_bytes()
         dest = self.make_file(contents=contents)
         age_file(dest, 100)
-        original_write_time = get_write_time(dest)
+        original_write_time = os.stat(dest).st_mtime
         loader = self.make_file(contents=contents)
         atomic_copy(loader, dest)
         self.assertThat(dest, FileContains(contents))
-        self.assertEqual(original_write_time, get_write_time(dest))
+        self.assertEqual(original_write_time, os.stat(dest).st_mtime)
 
     def test__sweeps_aside_dot_new_if_any(self):
         contents = factory.make_bytes()