Add unittests for server.py

evennia/accounts/tests.py

@@ -8,7 +8,7 @@ from unittest import TestCase
 from django.test import override_settings
 from evennia.accounts.accounts import AccountSessionHandler
 from evennia.accounts.accounts import DefaultAccount, DefaultGuest
-from evennia.utils.test_resources import EvenniaTest, unload_module
+from evennia.utils.test_resources import EvenniaTest
 from evennia.utils import create
 
 from django.conf import settings
@@ -318,7 +318,7 @@ class TestAccountPuppetDeletion(EvenniaTest):
         # See what happens when we delete char1.
         self.char1.delete()
         # Playable char list should be empty.
-        self.assertFalse(self.account.db._playable_characters, 
+        self.assertFalse(self.account.db._playable_characters,
                          'Playable character list is not empty! %s' % self.account.db._playable_characters)
 
 
@@ -335,7 +335,6 @@ class TestDefaultAccountEv(EvenniaTest):
         self.assertEqual(self.account.db._playable_characters, [self.char1])
 
     def test_puppet_success(self):
-        unload_module(DefaultAccount)
         self.account.msg = MagicMock()
         with patch("evennia.accounts.accounts._MULTISESSION_MODE", 2):
             self.account.puppet_object(self.session, self.char1)
@@ -348,8 +347,7 @@ class TestDefaultAccountEv(EvenniaTest):
         self.assertEqual(idle, 10)
 
         # test no sessions
-        unload_module("evennia.accounts.accounts")
+        with patch("evennia.accounts.accounts._SESSIONS.sessions_from_account", return_value=[]) as mock_sessh:
-        with patch("evennia.accounts.accounts._SESSIONS.sessions_from_account", return_value=[]) as mock_sessh: 
             idle = self.account.idle_time
             self.assertEqual(idle, None)
 
@@ -360,7 +358,6 @@ class TestDefaultAccountEv(EvenniaTest):
         self.assertEqual(conn, 10)
 
         # test no sessions
-        unload_module("evennia.accounts.accounts")
         with patch("evennia.accounts.accounts._SESSIONS.sessions_from_account", return_value=[]) as mock_sessh: 
             idle = self.account.connection_time
             self.assertEqual(idle, None)

evennia/server/server.py

@@ -143,8 +143,6 @@ def _server_maintenance():
                     session.account.access(session.account, "noidletimeout", default=False):
                 SESSIONS.disconnect(session, reason=reason)
 
-maintenance_task = LoopingCall(_server_maintenance)
-maintenance_task.start(60, now=True)  # call every minute
 
 #------------------------------------------------------------
 # Evennia Main Server object
@@ -199,6 +197,7 @@ class Evennia(object):
             reactor.callLater(1, d.callback, None)
         reactor.sigInt = _wrap_sigint_handler
 
+
     # Server startup methods
 
     def sqlite3_prep(self):
@@ -303,6 +302,10 @@ class Evennia(object):
         """
         from evennia.objects.models import ObjectDB
 
+        # start server time and maintenance task
+        self.maintenance_task = LoopingCall(_server_maintenance)
+        self.maintenance_task.start(60, now=True)  # call every minute
+
         # update eventual changed defaults
         self.update_defaults()
 
@@ -322,6 +325,7 @@ class Evennia(object):
             # clear eventual lingering session storages
             ObjectDB.objects.clear_all_sessids()
             logger.log_msg("Evennia Server successfully started.")
+
         # always call this regardless of start type
         self.at_server_start()
 

evennia/server/tests/test_server.py

@@ -0,0 +1,144 @@
+"""
+Test the main server component
+
+"""
+
+from unittest import TestCase
+from mock import MagicMock, patch, DEFAULT, call
+from evennia.utils.test_resources import unload_module
+
+
+@patch("evennia.server.server.LoopingCall", new=MagicMock())
+class TestServer(TestCase):
+    """
+    Test server module.
+
+    """
+
+    def setUp(self):
+        from evennia.server import server
+        self.server = server
+
+    def test__server_maintenance_flush(self):
+        with patch.multiple("evennia.server.server",
+                            LoopingCall=DEFAULT,
+                            Evennia=DEFAULT,
+                            _FLUSH_CACHE=DEFAULT,
+                            connection=DEFAULT,
+                            _IDMAPPER_CACHE_MAXSIZE=1000,
+                            _MAINTENANCE_COUNT=600 - 1,
+                            ServerConfig=DEFAULT) as mocks:
+            mocks['connection'].close = MagicMock()
+            mocks['ServerConfig'].objects.conf = MagicMock(return_value=100)
+
+            # flush cache
+            self.server._server_maintenance()
+            mocks['_FLUSH_CACHE'].assert_called_with(1000)
+
+    def test__server_maintenance_validate_scripts(self):
+        with patch.multiple("evennia.server.server",
+                            LoopingCall=DEFAULT,
+                            Evennia=DEFAULT,
+                            _FLUSH_CACHE=DEFAULT,
+                            connection=DEFAULT,
+                            _IDMAPPER_CACHE_MAXSIZE=1000,
+                            _MAINTENANCE_COUNT=3600 - 1,
+                            ServerConfig=DEFAULT) as mocks:
+            mocks['connection'].close = MagicMock()
+            mocks['ServerConfig'].objects.conf = MagicMock(return_value=100)
+            with patch("evennia.server.server.evennia.ScriptDB.objects.validate") as mock:
+                self.server._server_maintenance()
+                mocks['_FLUSH_CACHE'].assert_called_with(1000)
+                mock.assert_called()
+
+    def test__server_maintenance_channel_handler_update(self):
+        with patch.multiple("evennia.server.server",
+                            LoopingCall=DEFAULT,
+                            Evennia=DEFAULT,
+                            _FLUSH_CACHE=DEFAULT,
+                            connection=DEFAULT,
+                            _IDMAPPER_CACHE_MAXSIZE=1000,
+                            _MAINTENANCE_COUNT=3700 - 1,
+                            ServerConfig=DEFAULT) as mocks:
+            mocks['connection'].close = MagicMock()
+            mocks['ServerConfig'].objects.conf = MagicMock(return_value=100)
+            with patch("evennia.server.server.evennia.CHANNEL_HANDLER.update") as mock:
+                self.server._server_maintenance()
+                mock.assert_called()
+
+    def test__server_maintenance_close_connection(self):
+        with patch.multiple("evennia.server.server",
+                            LoopingCall=DEFAULT,
+                            Evennia=DEFAULT,
+                            _FLUSH_CACHE=DEFAULT,
+                            connection=DEFAULT,
+                            _IDMAPPER_CACHE_MAXSIZE=1000,
+                            _MAINTENANCE_COUNT=(3600 * 7) - 1,
+                            ServerConfig=DEFAULT) as mocks:
+            mocks['connection'].close = MagicMock()
+            mocks['ServerConfig'].objects.conf = MagicMock(return_value=100)
+            self.server._server_maintenance()
+            mocks['connection'].close.assert_called()
+
+    def test__server_maintenance_idle_time(self):
+        with patch.multiple("evennia.server.server",
+                            LoopingCall=DEFAULT,
+                            Evennia=DEFAULT,
+                            _FLUSH_CACHE=DEFAULT,
+                            connection=DEFAULT,
+                            _IDMAPPER_CACHE_MAXSIZE=1000,
+                            _MAINTENANCE_COUNT=(3600 * 7) - 1,
+                            SESSIONS=DEFAULT,
+                            _IDLE_TIMEOUT=10,
+                            time=DEFAULT,
+                            ServerConfig=DEFAULT) as mocks:
+            sess1 = MagicMock()
+            sess2 = MagicMock()
+            sess3 = MagicMock()
+            sess4 = MagicMock()
+            sess1.cmd_last = 100  # should time out
+            sess2.cmd_last = 999  # should not time out
+            sess3.cmd_last = 100  # should not time (due to account)
+            sess4.cmd_last = 100  # should time out (due to access)
+            sess1.account = None
+            sess2.account = None
+            sess3.account = MagicMock()
+            sess3.account = MagicMock()
+            sess4.account.access = MagicMock(return_value=False)
+
+            mocks['time'].time = MagicMock(return_value=1000)
+
+            mocks['ServerConfig'].objects.conf = MagicMock(return_value=100)
+            mocks["SESSIONS"].values = MagicMock(return_value=[sess1, sess2, sess3, sess4])
+            mocks["SESSIONS"].disconnect = MagicMock()
+
+            self.server._server_maintenance()
+            reason = "idle timeout exceeded"
+            calls = [call(sess1, reason=reason), call(sess4, reason=reason)]
+            mocks["SESSIONS"].disconnect.assert_has_calls(calls, any_order=True)
+
+    def test_evennia_start(self):
+        with patch.multiple("evennia.server.server",
+                            time=DEFAULT,
+                            service=DEFAULT) as mocks:
+
+            mocks['time'].time = MagicMock(return_value=1000)
+            evennia = self.server.Evennia(MagicMock())
+            self.assertEqual(evennia.start_time, 1000)
+
+    def test_update_defaults(self):
+        evennia = self.server.Evennia(MagicMock())
+        evennia.update_defaults()
+
+    def test_initial_setup(self):
+        from evennia.utils.create import create_account
+
+        acct = create_account("TestSuperuser", "test@test.com", "testpassword",
+                              is_superuser=True)
+
+        with patch.multiple("evennia.server.initial_setup",
+                            reset_server=DEFAULT,
+                            AccountDB=DEFAULT) as mocks:
+            mocks['AccountDB'].objects.get = MagicMock(return_value=acct)
+            evennia = self.server.Evennia(MagicMock())
+            evennia.run_initial_setup()

evennia/utils/create.py

@@ -420,14 +420,14 @@ def create_account(key, email, password,
         locks (str): Lockstring.
         permission (list): List of permission strings.
         tags (list): List of Tags on form `(key, category[, data])`
-        attributes (list): List of Attributes on form 
+        attributes (list): List of Attributes on form
              `(key, value [, category, [,lockstring [, default_pass]]])`
         report_to (Object): An object with a msg() method to report
             errors to. If not given, errors will be logged.
 
     Raises:
         ValueError: If `key` already exists in database.
-        
+
 
     Notes:
         Usually only the server admin should need to be superuser, all

evennia/utils/test_resources.py

@@ -35,7 +35,7 @@ def unload_module(module):
         with mock.patch("foo.GLOBALTHING", "mockval"):
             import foo
             ... # test code using foo.GLOBALTHING, now set to 'mockval'
-            
+
 
     This allows for mocking constants global to the module, since
     otherwise those would not be mocked (since a module is only