Source code for tests.bot_tests

#!/usr/bin/env python3
"""Bot tests."""
# (C) Pywikibot team, 2015-2022
# Distributed under the terms of the MIT license.
import sys
from contextlib import suppress

import pywikibot
from pywikibot import i18n
from tests.aspects import (

[docs] class TWNBotTestCase(TestCase): """Verify that i18n is available."""
[docs] @classmethod def setUpClass(cls): """Verify that the translations are available.""" if not i18n.messages_available(): raise unittest.SkipTest("i18n messages package '{}' not available." .format(i18n._messages_package_name)) super().setUpClass()
[docs] class TestBotTreatExit: """Mixin to provide handling for treat and exit.""" def _treat(self, pages, post_treat=None): """ Get tests which are executed on each treat. It uses pages as an iterator and compares the page given to the page returned by pages iterator. It checks that the bot's _site and site attributes are set to the page's site. If _treat_site is set with a Site it compares it to that one too. Afterwards it calls post_treat so it's possible to do additional checks. Site attributes are only present on Bot and SingleSitesBot, not MultipleSitesBot. """ def treat(page): self.assertEqual(page, next(self._page_iter)) if self._treat_site is None: self.assertFalse(hasattr(, 'site')) self.assertFalse(hasattr(, '_site')) elif not isinstance(, self.assertIsNotNone( self.assertEqual(, if self._treat_site: self.assertEqual(, self._treat_site) self.assertEqual(, if post_treat: post_treat(page) self._page_iter = iter(pages) return treat def _treat_page(self, pages=True, post_treat=None): """ Adjust to CurrentPageBot signature. It uses almost the same logic as _treat but returns a wrapper function which itself calls the function returned by _treat. The pages may be set to True which sill use _treat_generator as the source for the pages. """ def treat_page(): treat( if pages is True: pages = self._treat_generator() treat = self._treat(pages, post_treat) return treat_page def _exit(self, treated, written=0, exception=None): """Get tests which are executed on exit.""" def exit(): exc = sys.exc_info()[0] if exc is AssertionError: # When an AssertionError happened we shouldn't do these # assertions as they are invalid anyway and hide the actual # failed assertion return # pragma: no cover self.assertEqual(['read'], treated) self.assertEqual(['write'], written) if exception: self.assertIs(exc, exception) else: self.assertIsNone(exc) with self.assertRaisesRegex(StopIteration, '^$'): next(self._page_iter) return exit
[docs] class TestDrySiteBot(TestBotTreatExit, SiteAttributeTestCase): """Tests for the BaseBot subclasses.""" CANT_SET_ATTRIBUTE_RE = "can't set attribute" NOT_IN_TREAT_RE = 'Requesting the site not while in treat is not allowed.' dry = True sites = { 'de': { 'family': 'wikipedia', 'code': 'de' }, 'en': { 'family': 'wikipedia', 'code': 'en' } } def _generator(self): """Generic generator.""" yield pywikibot.Page(, 'Page 1') yield pywikibot.Page(self.en, 'Page 2') yield pywikibot.Page(, 'Page 3') yield pywikibot.Page(self.en, 'Page 4')
[docs] def test_SingleSiteBot_automatic(self): """Test SingleSiteBot class with no predefined site.""" self._treat_site = =, generator=self._generator()) = self._treat([pywikibot.Page(, 'Page 1'), pywikibot.Page(, 'Page 3')]) = self._exit(2) self.assertEqual(, self._treat_site)
[docs] def test_SingleSiteBot_specific(self): """Test SingleSiteBot class with predefined site.""" self._treat_site = self.en =, generator=self._generator()) = self._treat([pywikibot.Page(self.en, 'Page 2'), pywikibot.Page(self.en, 'Page 4')]) = self._exit(2) self.assertEqual(, self._treat_site)
[docs] def test_MultipleSitesBot(self): """Test MultipleSitesBot class.""" # Assert no specific site self._treat_site = False = = self._treat(self._generator()) = self._exit(4)
[docs] def test_Bot(self): """Test normal Bot class.""" # Assert no specific site self._treat_site = False = = self._treat(self._generator()) = self._exit(4)
[docs] def test_CurrentPageBot(self): """Test normal Bot class.""" def post_treat(page): self.assertIs(, page) # Assert no specific site self._treat_site = None = = self._treat_page(self._generator(), post_treat) = self._exit(4)
[docs] def test_Bot_ValueError(self): """Test normal Bot class with a ValueError in treat.""" def post_treat(page): if page.title() == 'Page 3': raise ValueError('Whatever') self._treat_site = False = = self._treat([pywikibot.Page(, 'Page 1'), pywikibot.Page(self.en, 'Page 2'), pywikibot.Page(, 'Page 3')], post_treat) = self._exit(3, exception=ValueError) with self.assertRaisesRegex(ValueError, 'Whatever'):
[docs] def test_Bot_KeyboardInterrupt(self): """Test normal Bot class with a KeyboardInterrupt in treat.""" def post_treat(page): if page.title() == 'Page 3': raise KeyboardInterrupt('Whatever') self._treat_site = False = = self._treat([pywikibot.Page(, 'Page 1'), pywikibot.Page(self.en, 'Page 2'), pywikibot.Page(, 'Page 3')], post_treat) = self._exit(3, exception=None)
# TODO: This could be written as dry tests probably by faking the important # properties
[docs] class LiveBotTestCase(TestBotTreatExit, DefaultSiteTestCase): """Test bot classes which need to check the Page object live.""" def _treat_generator(self): """Yield the current page until it's None.""" while self._current_page: yield self._current_page def _missing_generator(self): """Yield pages and the last one does not exist.""" self._count = 0 # skip_page skips one page self._current_page = list([0] yield self._current_page while self._current_page.exists(): self._count += 1 self._current_page = pywikibot.Page(, self._current_page.title() + 'X') yield self._current_page self._current_page = None def _exit(self, treated=None, written=0, exception=None): """Set the number of treated pages to _count.""" def exit(): t = self._count if treated is None else treated # Due to PEP 3135 super()._exit(...)() would raise # RuntimeError: super(): no arguments super(LiveBotTestCase, self)._exit(t, written, exception)() return exit
[docs] def test_ExistingPageBot(self): """Test ExistingPageBot class.""" def post_treat(page): """Verify the page exists.""" self.assertTrue(page.exists()) self._treat_site = None = generator=self._missing_generator()) = self._treat_page(post_treat=post_treat) = self._exit()
[docs] def test_CreatingPageBot(self): """Test CreatingPageBot class.""" # This doesn't verify much (e.g. it could yield the first existing # page) but the assertion in post_treat should verify that the page # is valid def treat_generator(): """Yield just one current page (the last one).""" yield self._current_page def post_treat(page): """Verify the page is missing.""" self.assertFalse(page.exists()) self._treat_site = None = generator=self._missing_generator()) = self._treat_page(treat_generator(), post_treat) = self._exit()
[docs] class Options( """A derived OptionHandler class.""" available_options = { 'foo': 'bar', 'bar': 42, 'baz': False }
[docs] class TestOptionHandler(TestCase): """OptionHandler test class.""" dry = True
[docs] def setUp(self): """Setup tests.""" self.option_handler = Options(baz=True) super().setUp()
[docs] def test_opt_values(self): """Test OptionHandler.""" oh = self.option_handler self.assertEqual(, 'bar') self.assertEqual(, 42) self.assertTrue(oh.opt.baz) self.assertEqual(, oh.opt['foo']) oh.opt.baz = 'Hey' self.assertEqual(oh.opt.baz, 'Hey') self.assertEqual(oh.opt['baz'], 'Hey') self.assertNotIn('baz', oh.opt.__dict__)
if __name__ == '__main__': # pragma: no cover with suppress(SystemExit): unittest.main()