ece31cf3cf
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
161 lines
5.5 KiB
Python
161 lines
5.5 KiB
Python
#
|
|
# Copyright (C) 2016 bendikro <bro.devel+deluge@gmail.com>
|
|
#
|
|
# This file is part of Deluge and is licensed under GNU General Public License 3.0, or later, with
|
|
# the additional special exception to link portions of this program with the OpenSSL library.
|
|
# See LICENSE for more details.
|
|
#
|
|
import pytest_twisted
|
|
from twisted.internet.defer import maybeDeferred, succeed
|
|
from twisted.internet.task import Clock
|
|
|
|
import deluge.component as component
|
|
import deluge.ui.sessionproxy
|
|
from deluge.conftest import BaseTestCase
|
|
|
|
|
|
class Core:
|
|
def __init__(self):
|
|
self.reset()
|
|
|
|
def reset(self):
|
|
self.torrents = {}
|
|
self.torrents['a'] = {'key1': 1, 'key2': 2, 'key3': 3}
|
|
self.torrents['b'] = {'key1': 1, 'key2': 2, 'key3': 3}
|
|
self.torrents['c'] = {'key1': 1, 'key2': 2, 'key3': 3}
|
|
self.prev_status = {}
|
|
|
|
def get_session_state(self):
|
|
return maybeDeferred(self.torrents.keys)
|
|
|
|
def get_torrent_status(self, torrent_id, keys, diff=False):
|
|
if not keys:
|
|
keys = list(self.torrents[torrent_id])
|
|
|
|
if not diff:
|
|
ret = {}
|
|
for key in keys:
|
|
ret[key] = self.torrents[torrent_id][key]
|
|
|
|
return succeed(ret)
|
|
|
|
else:
|
|
ret = {}
|
|
if torrent_id in self.prev_status:
|
|
for key in keys:
|
|
if (
|
|
self.prev_status[torrent_id][key]
|
|
!= self.torrents[torrent_id][key]
|
|
):
|
|
ret[key] = self.torrents[torrent_id][key]
|
|
else:
|
|
ret = self.torrents[torrent_id]
|
|
self.prev_status[torrent_id] = dict(self.torrents[torrent_id])
|
|
return succeed(ret)
|
|
|
|
def get_torrents_status(self, filter_dict, keys, diff=False):
|
|
if not filter_dict:
|
|
filter_dict['id'] = list(self.torrents)
|
|
if not keys:
|
|
keys = list(self.torrents['a'])
|
|
if not diff:
|
|
if 'id' in filter_dict:
|
|
torrents = filter_dict['id']
|
|
ret = {}
|
|
for torrent in torrents:
|
|
ret[torrent] = {}
|
|
for key in keys:
|
|
ret[torrent][key] = self.torrents[torrent][key]
|
|
return succeed(ret)
|
|
else:
|
|
if 'id' in filter_dict:
|
|
torrents = filter_dict['id']
|
|
ret = {}
|
|
for torrent in torrents:
|
|
ret[torrent] = {}
|
|
if torrent in self.prev_status:
|
|
for key in self.prev_status[torrent]:
|
|
if (
|
|
self.prev_status[torrent][key]
|
|
!= self.torrents[torrent][key]
|
|
):
|
|
ret[torrent][key] = self.torrents[torrent][key]
|
|
else:
|
|
ret[torrent] = dict(self.torrents[torrent])
|
|
|
|
self.prev_status[torrent] = dict(self.torrents[torrent])
|
|
return succeed(ret)
|
|
|
|
|
|
class Client:
|
|
def __init__(self):
|
|
self.core = Core()
|
|
|
|
def __noop__(self, *args, **kwargs):
|
|
return None
|
|
|
|
def __getattr__(self, *args, **kwargs):
|
|
return self.__noop__
|
|
|
|
|
|
client = Client()
|
|
|
|
|
|
class TestSessionProxy(BaseTestCase):
|
|
def set_up(self):
|
|
self.clock = Clock()
|
|
self.patch(deluge.ui.sessionproxy, 'time', self.clock.seconds)
|
|
self.patch(deluge.ui.sessionproxy, 'client', client)
|
|
self.sp = deluge.ui.sessionproxy.SessionProxy()
|
|
client.core.reset()
|
|
d = self.sp.start()
|
|
|
|
def do_get_torrents_status(torrent_ids):
|
|
inital_keys = ['key1']
|
|
# Advance clock to expire the cache times
|
|
self.clock.advance(2)
|
|
return self.sp.get_torrents_status({'id': torrent_ids}, inital_keys)
|
|
|
|
d.addCallback(do_get_torrents_status)
|
|
return d
|
|
|
|
def tear_down(self):
|
|
return component.deregister(self.sp)
|
|
|
|
def test_startup(self):
|
|
assert client.core.torrents['a'] == self.sp.torrents['a'][1]
|
|
|
|
@pytest_twisted.ensureDeferred
|
|
async def test_get_torrent_status_no_change(self):
|
|
result = await self.sp.get_torrent_status('a', [])
|
|
assert result == client.core.torrents['a']
|
|
|
|
@pytest_twisted.ensureDeferred
|
|
async def test_get_torrent_status_change_with_cache(self):
|
|
client.core.torrents['a']['key1'] = 2
|
|
result = await self.sp.get_torrent_status('a', ['key1'])
|
|
assert result == {'key1': 1}
|
|
|
|
@pytest_twisted.ensureDeferred
|
|
async def test_get_torrent_status_change_without_cache(self):
|
|
client.core.torrents['a']['key1'] = 2
|
|
self.clock.advance(self.sp.cache_time + 0.1)
|
|
result = await self.sp.get_torrent_status('a', [])
|
|
assert result == client.core.torrents['a']
|
|
|
|
@pytest_twisted.ensureDeferred
|
|
async def test_get_torrent_status_key_not_updated(self):
|
|
self.clock.advance(self.sp.cache_time + 0.1)
|
|
self.sp.get_torrent_status('a', ['key1'])
|
|
client.core.torrents['a']['key2'] = 99
|
|
result = await self.sp.get_torrent_status('a', ['key2'])
|
|
assert result == {'key2': 99}
|
|
|
|
@pytest_twisted.ensureDeferred
|
|
async def test_get_torrents_status_key_not_updated(self):
|
|
self.clock.advance(self.sp.cache_time + 0.1)
|
|
self.sp.get_torrents_status({'id': ['a']}, ['key1'])
|
|
client.core.torrents['a']['key2'] = 99
|
|
result = await self.sp.get_torrents_status({'id': ['a']}, ['key2'])
|
|
assert result == {'a': {'key2': 99}}
|