Bug 1441287 - [mozcrash] Refactor unit tests. draft
authorHenrik Skupin <mail@hskupin.info>
Tue, 13 Mar 2018 15:14:49 +0100
changeset 769938 f608125657882cb750a66a9dfe332a38bc986e57
parent 766824 8f1b2f872f0ea358a0412eb8b8687f08d47f6621
child 769939 834e75201494f50166cc3809624a64bebe2b2a93
push id103264
push userbmo:hskupin@gmail.com
push dateTue, 20 Mar 2018 13:40:52 +0000
bugs1441287
milestone61.0a1
Bug 1441287 - [mozcrash] Refactor unit tests. Split single unit test module into different modules separated by area of test coverage. MozReview-Commit-ID: Blh8V46kDq1
testing/mozbase/mozcrash/tests/manifest.ini
testing/mozbase/mozcrash/tests/test.py
testing/mozbase/mozcrash/tests/test_basic.py
testing/mozbase/mozcrash/tests/test_java_exception.py
testing/mozbase/mozcrash/tests/test_save_path.py
testing/mozbase/mozcrash/tests/test_stackwalk.py
testing/mozbase/mozcrash/tests/test_symbols_path.py
testing/mozbase/mozcrash/tests/testcase.py
--- a/testing/mozbase/mozcrash/tests/manifest.ini
+++ b/testing/mozbase/mozcrash/tests/manifest.ini
@@ -1,3 +1,8 @@
 [DEFAULT]
 subsuite = mozbase, os == "linux"
-[test.py]
+
+[test_basic.py]
+[test_java_exception.py]
+[test_save_path.py]
+[test_stackwalk.py]
+[test_symbols_path.py]
deleted file mode 100644
--- a/testing/mozbase/mozcrash/tests/test.py
+++ /dev/null
@@ -1,250 +0,0 @@
-#!/usr/bin/env python
-#
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this file,
-# You can obtain one at http://mozilla.org/MPL/2.0/.
-
-from __future__ import absolute_import
-
-import os
-import unittest
-import subprocess
-import tempfile
-import shutil
-import urlparse
-import zipfile
-import StringIO
-
-import mozunit
-
-import mozcrash
-import mozhttpd
-import mozlog.unstructured as mozlog
-
-# Make logs go away
-try:
-    log = mozlog.getLogger("mozcrash", handler=mozlog.FileHandler(os.devnull))
-except ValueError:
-    pass
-
-
-def popen_factory(stdouts):
-    """
-    Generate a class that can mock subprocess.Popen. |stdouts| is an iterable that
-    should return an iterable for the stdout of each process in turn.
-    """
-    class mock_popen(object):
-
-        def __init__(self, args, *args_rest, **kwargs):
-            self.stdout = stdouts.next()
-            self.returncode = 0
-
-        def wait(self):
-            return 0
-
-        def communicate(self):
-            return (self.stdout.next(), "")
-
-    return mock_popen
-
-
-class TestCrash(unittest.TestCase):
-
-    def setUp(self):
-        self.tempdir = tempfile.mkdtemp()
-        # a fake file to use as a stackwalk binary
-        self.stackwalk = os.path.join(self.tempdir, "stackwalk")
-        open(self.stackwalk, "w").write("fake binary")
-        self._subprocess_popen = subprocess.Popen
-        subprocess.Popen = popen_factory(self.next_mock_stdout())
-        self.stdouts = []
-
-    def tearDown(self):
-        subprocess.Popen = self._subprocess_popen
-        shutil.rmtree(self.tempdir)
-
-    def next_mock_stdout(self):
-        if not self.stdouts:
-            yield iter([])
-        for s in self.stdouts:
-            yield iter(s)
-
-    def test_nodumps(self):
-        """
-        Test that check_for_crashes returns False if no dumps are present.
-        """
-        self.stdouts.append(["this is some output"])
-        self.assertFalse(mozcrash.check_for_crashes(self.tempdir,
-                                                    symbols_path='symbols_path',
-                                                    stackwalk_binary=self.stackwalk,
-                                                    quiet=True))
-
-    def test_simple(self):
-        """
-        Test that check_for_crashes returns True if a dump is present.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        self.stdouts.append(["this is some output"])
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path='symbols_path',
-                                                stackwalk_binary=self.stackwalk,
-                                                quiet=True))
-
-    def test_stackwalk_envvar(self):
-        """
-        Test that check_for_crashes uses the MINIDUMP_STACKWALK environment var.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        self.stdouts.append(["this is some output"])
-        os.environ['MINIDUMP_STACKWALK'] = self.stackwalk
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path='symbols_path',
-                                                quiet=True))
-        del os.environ['MINIDUMP_STACKWALK']
-
-    def test_save_path(self):
-        """
-        Test that dump_save_path works.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        open(os.path.join(self.tempdir, "test.extra"), "w").write("bar")
-        save_path = os.path.join(self.tempdir, "saved")
-        os.mkdir(save_path)
-        self.stdouts.append(["this is some output"])
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path='symbols_path',
-                                                stackwalk_binary=self.stackwalk,
-                                                dump_save_path=save_path,
-                                                quiet=True))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.dmp")))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.extra")))
-
-    def test_save_path_not_present(self):
-        """
-        Test that dump_save_path works when the directory doesn't exist.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        open(os.path.join(self.tempdir, "test.extra"), "w").write("bar")
-        save_path = os.path.join(self.tempdir, "saved")
-        self.stdouts.append(["this is some output"])
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path='symbols_path',
-                                                stackwalk_binary=self.stackwalk,
-                                                dump_save_path=save_path,
-                                                quiet=True))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.dmp")))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.extra")))
-
-    def test_save_path_isfile(self):
-        """
-        Test that dump_save_path works when the directory doesn't exist,
-        but a file with the same name exists.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        open(os.path.join(self.tempdir, "test.extra"), "w").write("bar")
-        save_path = os.path.join(self.tempdir, "saved")
-        open(save_path, "w").write("junk")
-        self.stdouts.append(["this is some output"])
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path='symbols_path',
-                                                stackwalk_binary=self.stackwalk,
-                                                dump_save_path=save_path,
-                                                quiet=True))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.dmp")))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.extra")))
-
-    def test_save_path_envvar(self):
-        """
-        Test that the MINDUMP_SAVE_PATH environment variable works.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        open(os.path.join(self.tempdir, "test.extra"), "w").write("bar")
-        save_path = os.path.join(self.tempdir, "saved")
-        os.mkdir(save_path)
-        self.stdouts.append(["this is some output"])
-        os.environ['MINIDUMP_SAVE_PATH'] = save_path
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path='symbols_path',
-                                                stackwalk_binary=self.stackwalk,
-                                                quiet=True))
-        del os.environ['MINIDUMP_SAVE_PATH']
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.dmp")))
-        self.assert_(os.path.isfile(os.path.join(save_path, "test.extra")))
-
-    def test_symbol_path_not_present(self):
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        self.stdouts.append(["this is some output"])
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbols_path=None,
-                                                stackwalk_binary=self.stackwalk,
-                                                quiet=True))
-
-    def test_symbol_path_url(self):
-        """
-        Test that passing a URL as symbols_path correctly fetches the URL.
-        """
-        open(os.path.join(self.tempdir, "test.dmp"), "w").write("foo")
-        self.stdouts.append(["this is some output"])
-
-        def make_zipfile():
-            data = StringIO.StringIO()
-            z = zipfile.ZipFile(data, 'w')
-            z.writestr("symbols.txt", "abc/xyz")
-            z.close()
-            return data.getvalue()
-
-        def get_symbols(req):
-            headers = {}
-            return (200, headers, make_zipfile())
-        httpd = mozhttpd.MozHttpd(port=0,
-                                  urlhandlers=[{'method': 'GET',
-                                                'path': '/symbols',
-                                                'function': get_symbols}])
-        httpd.start()
-        symbol_url = urlparse.urlunsplit(('http', '%s:%d' % httpd.httpd.server_address,
-                                          '/symbols', '', ''))
-        self.assert_(mozcrash.check_for_crashes(self.tempdir,
-                                                symbol_url,
-                                                stackwalk_binary=self.stackwalk,
-                                                quiet=True))
-
-
-class TestJavaException(unittest.TestCase):
-
-    def setUp(self):
-        self.test_log = [
-            "01-30 20:15:41.937 E/GeckoAppShell( 1703): >>> "
-            "REPORTING UNCAUGHT EXCEPTION FROM THREAD 9 (\"GeckoBackgroundThread\")",
-            "01-30 20:15:41.937 E/GeckoAppShell( 1703): java.lang.NullPointerException",
-            "01-30 20:15:41.937 E/GeckoAppShell( 1703):"
-            "    at org.mozilla.gecko.GeckoApp$21.run(GeckoApp.java:1833)",
-            "01-30 20:15:41.937 E/GeckoAppShell( 1703):"
-            "    at android.os.Handler.handleCallback(Handler.java:587)"]
-
-    def test_uncaught_exception(self):
-        """
-        Test for an exception which should be caught
-        """
-        self.assert_(mozcrash.check_for_java_exception(self.test_log, quiet=True))
-
-    def test_truncated_exception(self):
-        """
-        Test for an exception which should be caught which
-        was truncated
-        """
-        truncated_log = list(self.test_log)
-        truncated_log[0], truncated_log[1] = truncated_log[1], truncated_log[0]
-        self.assert_(mozcrash.check_for_java_exception(truncated_log, quiet=True))
-
-    def test_unchecked_exception(self):
-        """
-        Test for an exception which should not be caught
-        """
-        passable_log = list(self.test_log)
-        passable_log[0] = "01-30 20:15:41.937 E/GeckoAppShell( 1703):" \
-                          " >>> NOT-SO-BAD EXCEPTION FROM THREAD 9 (\"GeckoBackgroundThread\")"
-        self.assert_(not mozcrash.check_for_java_exception(passable_log, quiet=True))
-
-
-if __name__ == '__main__':
-    mozunit.main()
new file mode 100644
--- /dev/null
+++ b/testing/mozbase/mozcrash/tests/test_basic.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+
+from __future__ import absolute_import
+
+import mozunit
+
+import mozcrash
+from testcase import CrashTestCase
+
+
+class TestBasic(CrashTestCase):
+
+    def test_nodumps(self):
+        """Test that check_for_crashes returns False if no dumps are present."""
+        self.stdouts.append(["this is some output"])
+        self.assertFalse(mozcrash.check_for_crashes(self.tempdir,
+                                                    symbols_path='symbols_path',
+                                                    stackwalk_binary=self.stackwalk,
+                                                    quiet=True))
+
+    def test_simple(self):
+        """Test that check_for_crashes returns True if a dump is present."""
+        self.create_minidump("test")
+
+        self.assert_(mozcrash.check_for_crashes(self.tempdir,
+                                                symbols_path='symbols_path',
+                                                stackwalk_binary=self.stackwalk,
+                                                quiet=True))
+
+
+if __name__ == '__main__':
+    mozunit.main()
new file mode 100644
--- /dev/null
+++ b/testing/mozbase/mozcrash/tests/test_java_exception.py
@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from __future__ import absolute_import
+
+import os
+import unittest
+
+import mozlog.unstructured as mozlog
+import mozunit
+
+import mozcrash
+
+
+# Make logs go away
+try:
+    log = mozlog.getLogger("mozcrash", handler=mozlog.FileHandler(os.devnull))
+except ValueError:
+    pass
+
+
+class TestJavaException(unittest.TestCase):
+
+    def setUp(self):
+        self.test_log = [
+            "01-30 20:15:41.937 E/GeckoAppShell( 1703): >>> "
+            "REPORTING UNCAUGHT EXCEPTION FROM THREAD 9 (\"GeckoBackgroundThread\")",
+            "01-30 20:15:41.937 E/GeckoAppShell( 1703): java.lang.NullPointerException",
+            "01-30 20:15:41.937 E/GeckoAppShell( 1703):"
+            "    at org.mozilla.gecko.GeckoApp$21.run(GeckoApp.java:1833)",
+            "01-30 20:15:41.937 E/GeckoAppShell( 1703):"
+            "    at android.os.Handler.handleCallback(Handler.java:587)"]
+
+    def test_uncaught_exception(self):
+        """
+        Test for an exception which should be caught
+        """
+        self.assert_(mozcrash.check_for_java_exception(self.test_log, quiet=True))
+
+    def test_truncated_exception(self):
+        """
+        Test for an exception which should be caught which
+        was truncated
+        """
+        truncated_log = list(self.test_log)
+        truncated_log[0], truncated_log[1] = truncated_log[1], truncated_log[0]
+        self.assert_(mozcrash.check_for_java_exception(truncated_log, quiet=True))
+
+    def test_unchecked_exception(self):
+        """
+        Test for an exception which should not be caught
+        """
+        passable_log = list(self.test_log)
+        passable_log[0] = "01-30 20:15:41.937 E/GeckoAppShell( 1703):" \
+                          " >>> NOT-SO-BAD EXCEPTION FROM THREAD 9 (\"GeckoBackgroundThread\")"
+        self.assert_(not mozcrash.check_for_java_exception(passable_log, quiet=True))
+
+
+if __name__ == '__main__':
+    mozunit.main()
new file mode 100644
--- /dev/null
+++ b/testing/mozbase/mozcrash/tests/test_save_path.py
@@ -0,0 +1,65 @@
+#!/usr/bin/env python
+
+from __future__ import absolute_import
+
+import os
+
+import mozunit
+
+import mozcrash
+from testcase import CrashTestCase
+
+
+class TestSavePath(CrashTestCase):
+
+    def setUp(self):
+        super(TestSavePath, self).setUp()
+
+        self.create_minidump("test")
+
+    def check_for_saved_minidump_files(self, save_path=None):
+        self.assert_(mozcrash.check_for_crashes(self.tempdir,
+                                                symbols_path='symbols_path',
+                                                stackwalk_binary=self.stackwalk,
+                                                dump_save_path=save_path,
+                                                quiet=True))
+        if save_path is None:
+            save_path = os.environ.get('MINIDUMP_SAVE_PATH', None)
+
+        self.assert_(os.path.isfile(os.path.join(save_path, "test.dmp")))
+        self.assert_(os.path.isfile(os.path.join(save_path, "test.extra")))
+
+    def test_save_path_not_present(self):
+        """Test that dump_save_path works when the directory doesn't exist."""
+        save_path = os.path.join(self.tempdir, "saved")
+
+        self.check_for_saved_minidump_files(save_path)
+
+    def test_save_path(self):
+        """Test that dump_save_path works."""
+        save_path = os.path.join(self.tempdir, "saved")
+        os.mkdir(save_path)
+
+        self.check_for_saved_minidump_files(save_path)
+
+    def test_save_path_isfile(self):
+        """Test that dump_save_path works when the path is a file and not a directory."""
+        save_path = os.path.join(self.tempdir, "saved")
+        open(save_path, "w").write("junk")
+
+        self.check_for_saved_minidump_files(save_path)
+
+    def test_save_path_envvar(self):
+        """Test that the MINDUMP_SAVE_PATH environment variable works."""
+        save_path = os.path.join(self.tempdir, "saved")
+        os.mkdir(save_path)
+
+        os.environ['MINIDUMP_SAVE_PATH'] = save_path
+        try:
+            self.check_for_saved_minidump_files()
+        finally:
+            del os.environ['MINIDUMP_SAVE_PATH']
+
+
+if __name__ == '__main__':
+    mozunit.main()
new file mode 100644
--- /dev/null
+++ b/testing/mozbase/mozcrash/tests/test_stackwalk.py
@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+
+from __future__ import absolute_import
+
+import os
+
+import mozunit
+
+import mozcrash
+from testcase import CrashTestCase
+
+
+class TestStackwalk(CrashTestCase):
+
+    def test_stackwalk_envvar(self):
+        """Test that check_for_crashes uses the MINIDUMP_STACKWALK environment var."""
+        self.create_minidump("test.")
+
+        os.environ['MINIDUMP_STACKWALK'] = self.stackwalk
+        self.assert_(mozcrash.check_for_crashes(self.tempdir,
+                                                symbols_path='symbols_path',
+                                                quiet=True))
+        del os.environ['MINIDUMP_STACKWALK']
+
+
+if __name__ == '__main__':
+    mozunit.main()
new file mode 100644
--- /dev/null
+++ b/testing/mozbase/mozcrash/tests/test_symbols_path.py
@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+from __future__ import absolute_import
+
+import urlparse
+import zipfile
+import StringIO
+
+import mozunit
+
+import mozcrash
+import mozhttpd
+
+from testcase import CrashTestCase
+
+
+class TestCrash(CrashTestCase):
+
+    def test_symbol_path_not_present(self):
+        """Test that no symbols path doesn't process the minidump."""
+        self.create_minidump("test")
+
+        self.assert_(mozcrash.check_for_crashes(self.tempdir,
+                                                symbols_path=None,
+                                                stackwalk_binary=self.stackwalk,
+                                                quiet=True))
+
+    def test_symbol_path_url(self):
+        """Test that passing a URL as symbols_path correctly fetches the URL."""
+        self.create_minidump("test")
+
+        data = {"retrieved": False}
+
+        def make_zipfile():
+            data = StringIO.StringIO()
+            z = zipfile.ZipFile(data, 'w')
+            z.writestr("symbols.txt", "abc/xyz")
+            z.close()
+            return data.getvalue()
+
+        def get_symbols(req):
+            data["retrieved"] = True
+
+            headers = {}
+            return (200, headers, make_zipfile())
+
+        httpd = mozhttpd.MozHttpd(port=0,
+                                  urlhandlers=[{'method': 'GET',
+                                                'path': '/symbols',
+                                                'function': get_symbols}])
+        httpd.start()
+        symbol_url = urlparse.urlunsplit(('http', '%s:%d' % httpd.httpd.server_address,
+                                          '/symbols', '', ''))
+
+        self.assert_(mozcrash.check_for_crashes(self.tempdir,
+                                                symbols_path=symbol_url,
+                                                stackwalk_binary=self.stackwalk,
+                                                quiet=True))
+        self.assertTrue(data["retrieved"])
+
+
+if __name__ == '__main__':
+    mozunit.main()
new file mode 100644
--- /dev/null
+++ b/testing/mozbase/mozcrash/tests/testcase.py
@@ -0,0 +1,69 @@
+from __future__ import absolute_import
+
+import os
+import unittest
+import subprocess
+import tempfile
+import shutil
+
+import mozlog.unstructured as mozlog
+
+
+# Make logs go away
+try:
+    log = mozlog.getLogger("mozcrash", handler=mozlog.FileHandler(os.devnull))
+except ValueError:
+    pass
+
+
+def popen_factory(stdouts):
+    """Generate a class that can mock subprocess.Popen.
+
+    :param stdouts: Iterable that should return an iterable for the
+                    stdout of each process in turn.
+    """
+    class mock_popen(object):
+
+        def __init__(self, args, *args_rest, **kwargs):
+            self.stdout = stdouts.next()
+            self.returncode = 0
+
+        def wait(self):
+            return 0
+
+        def communicate(self):
+            return (self.stdout.next(), "")
+
+    return mock_popen
+
+
+class CrashTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.tempdir = tempfile.mkdtemp()
+
+        # a fake file to use as a stackwalk binary
+        self.stackwalk = os.path.join(self.tempdir, "stackwalk")
+        open(self.stackwalk, "w").write("fake binary")
+
+        # set mock for subprocess.Popen
+        self._subprocess_popen = subprocess.Popen
+        subprocess.Popen = popen_factory(self.next_mock_stdout())
+        self.stdouts = []
+
+    def tearDown(self):
+        subprocess.Popen = self._subprocess_popen
+        shutil.rmtree(self.tempdir)
+
+    def create_minidump(self, name):
+        open(os.path.join(self.tempdir, "{}.dmp".format(name)), "w").write("foo")
+        open(os.path.join(self.tempdir, "{}.extra".format(name)), "w").write("bar")
+
+        self.stdouts.append(["This is some output for {}".format(name)])
+
+    def next_mock_stdout(self):
+        if not self.stdouts:
+            yield iter([])
+
+        for s in self.stdouts:
+            yield iter(s)