Issue 395 - Filter hits statistics backend

sitescripts/filterhits/test/test_helpers.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2015 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 import tempfile
 import shutil
+import unittest
 
+import MySQLdb
+
+from sitescripts.filterhits import db
 from sitescripts.utils import get_config
 
-config = get_config()
-live_config = {
-  "database": config.get("filterhitstats", "database"),
-  "log_dir": config.get("filterhitstats", "log_dir")
-}
-test_config = {
-  "database": config.get("filterhitstats", "test_database"),
-  "log_dir": tempfile.mkdtemp()

[Wladimir Palant, 2015/03/30 19:07:04]

This will create the directory exactly once rather than do it for each test run.
This means that if this module is loaded yet no tests run then the directory
will already be created but nothing will remove it. Also, the test results might
depend on the order in which the tests run because only the first test will have
the directory already - it will be removed after that test and not recreated.

So I'd suggest removing this setting from test_config and rather calling
mkdtemp() in setup_config() directly.

[kzar, 2015/03/30 19:29:03]

Ugh sorry, good point. (I didn't notice this as I've been running each test
individually so the log directory was always created properly as I expected.)

Done.

-}
+class FilterhitsTestCase(unittest.TestCase):
+  config = get_config()
+  _db = None
+  _live_config = {
+    "dbuser": config.get("filterhitstats", "dbuser"),
+    "dbpassword": config.get("filterhitstats", "dbpassword"),
+    "database": config.get("filterhitstats", "database"),
+    "log_dir": config.get("filterhitstats", "log_dir")
+  }
+  _test_config = {
+    "dbuser": config.get("filterhitstats", "test_dbuser"),
+    "dbpassword": config.get("filterhitstats", "test_dbpassword"),
+    "database": config.get("filterhitstats", "test_database")
+  }
 
-def setup_config():
-  config.set("filterhitstats", "database", test_config["database"])
-  config.set("filterhitstats", "log_dir", test_config["log_dir"])
-  return config
+  def _clear_database(self):
+    db.write(self._db, (("DELETE FROM frequencies",), ("DELETE FROM filters",)))
 
-def restore_config():
-  config.set("filterhitstats", "database", live_config["database"])
-  config.set("filterhitstats", "log_dir", live_config["log_dir"])
-  shutil.rmtree(test_config["log_dir"], ignore_errors=True)
+  @property
+  def db(self):
+    if (not self._db):
+      self._db = db.connect()
+      self._clear_database()
+    return self._db
+
+  def setUp(self):
+    # Set up a temporary log directory for testing
+    self.test_dir = tempfile.mkdtemp()
+    # Set up test config
+    for k, v in self._test_config.items():
+      self.config.set("filterhitstats", k, v)
+    self.config.set("filterhitstats", "log_dir", self.test_dir)
+
+  def tearDown(self):
+    # Clean the database and close our connection
+    if self._db:
+      self._clear_database()
+      self._db.close()
+      self._db = None
+    # Clean any generated logs
+    shutil.rmtree(self.test_dir, ignore_errors=True)
+    # Restore the configuration
+    for k, v in self._live_config.items():
+      self.config.set("filterhitstats", k, v)