[Tests] Transition tests to pure pytest

Convert all the twisted.trial tests to pytest_twisted. Also move off of unittest.TestCase as well. Seems there were several tests which weren't actually testing what they should, and also some code that wasn't doing what the broken test said it should.

Goals:

    Remove twisted.trial tests
    Move to pytest fixtures, rather than many classess and subclasses with setup and teardown functions
    Move away from self.assertX to assert style tests
    FIx broken tests

Going forward I think these should be the goals when adding/modifying tests:

* Don't use BaseTest or set_up tear_down methods any more. Fixtures should be used either in the test module/class, or make/improve the ones available in conftest.py
* For sure don't use unittest or twisted.trial, they mess up the pytest stuff.
* Prefer pytest_twisted.ensureDeferred with an async function over inlineCallbacks.
  - I think the async function syntax is nicer, and it helps catch silly mistakes, e.g. await None is invalid, but yield None isn't, so if some function returns an unexpected thing we try to await on, it will be caught earlier. (I struggled debugging a test for quite a while, then caught it immediately when switching to the new syntax)
  - Once the maybe_coroutine PR goes in, using the async syntax can also improve tracebacks when debugging tests.

Things that should probably be cleaned up going forward:

* Remove BaseTestCase
* Remove the subclasses like DaemonBase in favor of new fixtures.
  * I think there are some other utility subclasses that could be removed too
* Perhaps use parameterization in the ui_entry tests, rather that the weird combination of subclasses and the set_var fixture I mixed in.
* Convert some of the callback stuff to pytest_twisted.ensureDeferred tests, just for nicer readability

Details relating to pytest fixtures conftest.py in root dir:
 * https://github.com/pytest-dev/pytest/issues/5822#issuecomment-697331920
 * https://docs.pytest.org/en/latest/deprecations.html#pytest-plugins-in-non-top-level-conftest-files

Closes: https://github.com/deluge-torrent/deluge/pull/354

1 files changed, 26 insertions, 28 deletions

diff --git a/deluge/tests/test_torrent.py b/deluge/tests/test_torrent.py
index 99069f9c9..d84b9b46c 100644
--- a/deluge/tests/test_torrent.py
+++ b/deluge/tests/test_torrent.py
@@ -9,30 +9,28 @@ import time
 from base64 import b64encode
 from unittest import mock
 
+import pytest
 from twisted.internet import defer, reactor
 from twisted.internet.task import deferLater
-from twisted.trial import unittest
 
 import deluge.component as component
 import deluge.core.torrent
 import deluge.tests.common as common
 from deluge._libtorrent import lt
 from deluge.common import VersionSplit, utf8_encode_structure
+from deluge.conftest import BaseTestCase
 from deluge.core.core import Core
 from deluge.core.rpcserver import RPCServer
 from deluge.core.torrent import Torrent
 from deluge.core.torrentmanager import TorrentManager, TorrentState
 
-from .basetest import BaseTestCase
 
-
-class TorrentTestCase(BaseTestCase):
+class TestTorrent(BaseTestCase):
     def setup_config(self):
-        config_dir = common.set_tmp_config_dir()
         core_config = deluge.config.Config(
             'core.conf',
             defaults=deluge.core.preferencesmanager.DEFAULT_PREFS,
-            config_dir=config_dir,
+            config_dir=self.config_dir,
         )
         core_config.save()
 
@@ -64,7 +62,7 @@ class TorrentTestCase(BaseTestCase):
 
     def assert_state(self, torrent, state):
         torrent.update_state()
-        self.assertEqual(torrent.state, state)
+        assert torrent.state == state
 
     def get_torrent_atp(self, filename):
         filename = common.get_test_data_file(filename)
@@ -88,11 +86,11 @@ class TorrentTestCase(BaseTestCase):
         torrent = Torrent(handle, {})
 
         result = torrent.get_file_priorities()
-        self.assertTrue(all(x == 4 for x in result))
+        assert all(x == 4 for x in result)
 
         new_priorities = [3, 1, 2, 0, 5, 6, 7]
         torrent.set_file_priorities(new_priorities)
-        self.assertEqual(torrent.get_file_priorities(), new_priorities)
+        assert torrent.get_file_priorities() == new_priorities
 
         # Test with handle.piece_priorities as handle.file_priorities async
         # updates and will return old value. Also need to remove a priority
@@ -100,7 +98,7 @@ class TorrentTestCase(BaseTestCase):
         time.sleep(0.6)  # Delay to wait for alert from lt
         piece_prio = handle.piece_priorities()
         result = all(p in piece_prio for p in [3, 2, 0, 5, 6, 7])
-        self.assertTrue(result)
+        assert result
 
     def test_set_prioritize_first_last_pieces(self):
         piece_indexes = [
@@ -145,14 +143,14 @@ class TorrentTestCase(BaseTestCase):
         priorities = handle.piece_priorities()
 
         # The length of the list of new priorites is the same as the original
-        self.assertEqual(len(priorities_original), len(priorities))
+        assert len(priorities_original) == len(priorities)
 
         # Test the priority of all the pieces against the calculated indexes.
         for idx, priority in enumerate(priorities):
             if idx in prioritized_piece_indexes:
-                self.assertEqual(priorities[idx], 7)
+                assert priorities[idx] == 7
             else:
-                self.assertEqual(priorities[idx], 4)
+                assert priorities[idx] == 4
 
         # self.print_priority_list(priorities)
 
@@ -168,7 +166,7 @@ class TorrentTestCase(BaseTestCase):
 
         # Test the priority of the prioritized pieces
         for i in priorities:
-            self.assertEqual(priorities[i], 4)
+            assert priorities[i] == 4
 
         # self.print_priority_list(priorities)
 
@@ -209,7 +207,7 @@ class TorrentTestCase(BaseTestCase):
 
     def test_torrent_error_resume_data_unaltered(self):
         if VersionSplit(lt.__version__) >= VersionSplit('1.2.0.0'):
-            raise unittest.SkipTest('Test not working as expected on lt 1.2 or greater')
+            pytest.skip('Test not working as expected on lt 1.2 or greater')
 
         resume_data = {
             'active_time': 13399,
@@ -277,7 +275,7 @@ class TorrentTestCase(BaseTestCase):
             tm_resume_data = lt.bdecode(
                 self.core.torrentmanager.resume_data[torrent.torrent_id]
             )
-            self.assertEqual(tm_resume_data, resume_data)
+            assert tm_resume_data == resume_data
 
         return deferLater(reactor, 0.5, assert_resume_data)
 
@@ -285,7 +283,7 @@ class TorrentTestCase(BaseTestCase):
         atp = self.get_torrent_atp('test_torrent.file.torrent')
         handle = self.session.add_torrent(atp)
         self.torrent = Torrent(handle, {})
-        self.assertEqual(self.torrent.get_eta(), 0)
+        assert self.torrent.get_eta() == 0
         self.torrent.status = mock.MagicMock()
 
         self.torrent.status.upload_payload_rate = 5000
@@ -295,18 +293,18 @@ class TorrentTestCase(BaseTestCase):
         self.torrent.is_finished = True
         self.torrent.options = {'stop_at_ratio': False}
         # Test finished and uploading but no stop_at_ratio set.
-        self.assertEqual(self.torrent.get_eta(), 0)
+        assert self.torrent.get_eta() == 0
 
         self.torrent.options = {'stop_at_ratio': True, 'stop_ratio': 1.5}
         result = self.torrent.get_eta()
-        self.assertEqual(result, 2)
-        self.assertIsInstance(result, int)
+        assert result == 2
+        assert isinstance(result, int)
 
     def test_get_eta_downloading(self):
         atp = self.get_torrent_atp('test_torrent.file.torrent')
         handle = self.session.add_torrent(atp)
         self.torrent = Torrent(handle, {})
-        self.assertEqual(self.torrent.get_eta(), 0)
+        assert self.torrent.get_eta() == 0
 
         self.torrent.status = mock.MagicMock()
         self.torrent.status.download_payload_rate = 50
@@ -314,15 +312,15 @@ class TorrentTestCase(BaseTestCase):
         self.torrent.status.total_wanted_done = 5000
 
         result = self.torrent.get_eta()
-        self.assertEqual(result, 100)
-        self.assertIsInstance(result, int)
+        assert result == 100
+        assert isinstance(result, int)
 
     def test_get_name_unicode(self):
         """Test retrieving a unicode torrent name from libtorrent."""
         atp = self.get_torrent_atp('unicode_file.torrent')
         handle = self.session.add_torrent(atp)
         self.torrent = Torrent(handle, {})
-        self.assertEqual(self.torrent.get_name(), 'সুকুমার রায়.txt')
+        assert self.torrent.get_name() == 'সুকুমার রায়.txt'
 
     def test_rename_unicode(self):
         """Test renaming file/folders with unicode filenames."""
@@ -333,15 +331,15 @@ class TorrentTestCase(BaseTestCase):
         TorrentManager.save_resume_data = mock.MagicMock
 
         result = self.torrent.rename_folder('unicode_filenames', 'Горбачёв')
-        self.assertIsInstance(result, defer.DeferredList)
+        assert isinstance(result, defer.DeferredList)
 
         result = self.torrent.rename_files([[0, 'new_рбачёв']])
-        self.assertIsNone(result)
+        assert result is None
 
     def test_connect_peer_port(self):
         """Test to ensure port is int for libtorrent"""
         atp = self.get_torrent_atp('test_torrent.file.torrent')
         handle = self.session.add_torrent(atp)
         self.torrent = Torrent(handle, {})
-        self.assertFalse(self.torrent.connect_peer('127.0.0.1', 'text'))
-        self.assertTrue(self.torrent.connect_peer('127.0.0.1', '1234'))
+        assert not self.torrent.connect_peer('127.0.0.1', 'text')
+        assert self.torrent.connect_peer('127.0.0.1', '1234')