Merge pull request #124 from kwirk/servertestcase

Rewrite and enable server testcases + fixed few bugs along the way (logging, missing assignment)

common/protocol.py

@@ -90,6 +90,7 @@ protocol = [
 ["get <JAIL> actioncheck <ACT>", "gets the check command for the action <ACT> for <JAIL>"],
 ["get <JAIL> actionban <ACT>", "gets the ban command for the action <ACT> for <JAIL>"],
 ["get <JAIL> actionunban <ACT>", "gets the unban command for the action <ACT> for <JAIL>"],
+["get <JAIL> cinfo <ACT> <KEY>", "gets the value for <KEY> for the action <ACT> for <JAIL>"],
 ]
 
 ##

fail2ban-testcases

@@ -124,7 +124,7 @@ else:
 
 # Server
 #tests.addTest(unittest.makeSuite(servertestcase.StartStop))
-#tests.addTest(unittest.makeSuite(servertestcase.Transmitter))
+tests.addTest(unittest.makeSuite(servertestcase.Transmitter))
 tests.addTest(unittest.makeSuite(actiontestcase.ExecuteAction))
 # FailManager
 tests.addTest(unittest.makeSuite(failmanagertestcase.AddFailure))

server/server.py

@@ -97,12 +97,6 @@ class Server:
 		except OSError, e:
 			logSys.error("Unable to remove PID file: %s" % e)
 		logSys.info("Exiting Fail2ban")
-		# Shutdowns the logging.
-		try:
-			self.__loggingLock.acquire()
-			logging.shutdown()
-		finally:
-			self.__loggingLock.release()
 	
 	def quit(self):
 		# Stop communication first because if jail's unban action
@@ -112,8 +106,17 @@ class Server:
 		# are exiting)
 		# See https://github.com/fail2ban/fail2ban/issues/7
 		self.__asyncServer.stop()
+
 		# Now stop all the jails
 		self.stopAllJail()
+
+		# Only now shutdown the logging.
+		try:
+			self.__loggingLock.acquire()
+			logging.shutdown()
+		finally:
+			self.__loggingLock.release()
+
 	
 	def addJail(self, name, backend):
 		self.__jails.add(name, backend)
@@ -367,11 +370,20 @@ class Server:
 					logSys.error("Unable to log to " + target)
 					logSys.info("Logging to previous target " + self.__logTarget)
 					return False
-			# Removes previous handlers
+			# Removes previous handlers -- in reverse order since removeHandler
-			for handler in logging.getLogger("fail2ban").handlers:
+			# alter the list in-place and that can confuses the iterable
-				# Closes the handler.
+			for handler in logging.getLogger("fail2ban").handlers[::-1]:
+				# Remove the handler.
 				logging.getLogger("fail2ban").removeHandler(handler)
-				handler.close()
+				# And try to close -- it might be closed already
+				try:
+					handler.flush()
+					handler.close()
+				except ValueError:
+					if sys.version_info >= (2,6):
+						raise
+					# is known to be thrown after logging was shutdown once
+					# with older Pythons -- seems to be safe to ignore there
 			# tell the handler to use this format
 			hdlr.setFormatter(formatter)
 			logging.getLogger("fail2ban").addHandler(hdlr)

server/transmitter.py

@@ -183,6 +183,7 @@ class Transmitter:
 			self.__server.addAction(name, value)
 			return self.__server.getLastAction(name).getName()
 		elif command[1] == "delaction":
+			value = command[2]
 			self.__server.delAction(name, value)
 			return None
 		elif command[1] == "setcinfo":
@@ -265,6 +266,10 @@ class Transmitter:
 		elif command[1] == "actionunban":
 			act = command[2]
 			return self.__server.getActionUnban(name, act)
+		elif command[1] == "cinfo":
+			act = command[2]
+			key = command[3]
+			return self.__server.getCInfo(name, act, key)
 		raise Exception("Invalid command (no get action or not yet implemented)")
 	
 	def status(self, command):

testcases/servertestcase.py

@@ -27,7 +27,7 @@ __date__ = "$Date$"
 __copyright__ = "Copyright (c) 2004 Cyril Jaquier"
 __license__ = "GPL"
 
-import unittest, socket, time
+import unittest, socket, time, tempfile, os
 from server.server import Server
 
 class StartStop(unittest.TestCase):
@@ -55,76 +55,389 @@ class Transmitter(unittest.TestCase):
 	def setUp(self):
 		"""Call before every test case."""
 		self.__server = Server()
+		self.__transm = self.__server._Server__transm
+		self.__server.setLogTarget("/dev/null")
 		self.__server.setLogLevel(0)
-		self.__server.start(False)
+		sock_fd, sock_name = tempfile.mkstemp('fail2ban.sock', 'transmitter')
+		os.close(sock_fd)
+		pidfile_fd, pidfile_name = tempfile.mkstemp(
+			'fail2ban.pid', 'transmitter')
+		os.close(pidfile_fd)
+		self.__server.start(sock_name, pidfile_name, force=False)
+		self.jailName = "TestJail1"
+		self.__server.addJail(self.jailName, "auto")
 
 	def tearDown(self):
 		"""Call after every test case."""
 		self.__server.quit()
-	
+
-	def testSetActionOK(self):
+	def setGetTest(self, cmd, inValue, outValue=None, jail=None):
-		name = "TestCase"
+		setCmd = ["set", cmd, inValue]
-		cmdList = [["add", name],
+		getCmd = ["get", cmd]
-				   ["set", name, "actionstart", "Action Start"],
+		if jail is not None:
-				   ["set", name, "actionstop", "Action Stop"],
+			setCmd.insert(1, jail)
-				   ["set", name, "actioncheck", "Action Check"],
+			getCmd.insert(1, jail)
-				   ["set", name, "actionban", "Action Ban"],
+		if outValue is None:
-				   ["set", name, "actionunban", "Action Unban"],
+			outValue = inValue
-				   ["quit"]]
+
-		
+		self.assertEqual(self.__transm.proceed(setCmd), (0, outValue))
-		outList = [(0, name),
+		self.assertEqual(self.__transm.proceed(getCmd), (0, outValue))
-				   (0, 'Action Start'),
+
-				   (0, 'Action Stop'),
+	def setGetTestNOK(self, cmd, inValue, jail=None):
-				   (0, 'Action Check'),
+		setCmd = ["set", cmd, inValue]
-				   (0, 'Action Ban'),
+		getCmd = ["get", cmd]
-				   (0, 'Action Unban'),
+		if jail is not None:
-				   (0, None)]
+			setCmd.insert(1, jail)
-		
+			getCmd.insert(1, jail)
-		cnt = 0
+
-		for cmd in cmdList:
+		# Get initial value before trying invalid value
-			self.assertEqual(self.__server.transm.proceed(cmd), outList[cnt])
+		initValue = self.__transm.proceed(getCmd)[1]
-			cnt += 1
+		self.assertEqual(self.__transm.proceed(setCmd)[0], 1)
-	
+		# Check after failed set that value is same as previous
-	def testSetActionNOK(self):
+		self.assertEqual(self.__transm.proceed(getCmd), (0, initValue))
-		name = "TestCase"
+
-		cmdList = [["addd", name],
+	def jailAddDelTest(self, cmd, values, jail):
-				   ["set", name, "test"],
+		cmdAdd = "add" + cmd
-				   ["prout prout", "Stop"],
+		cmdDel = "del" + cmd
-				   ["fail2ban", "sucks"],
+
-				   ["set"],
+		self.assertEqual(
-				   ["_/&%", "@*+%&"],
+			self.__transm.proceed(["get", jail, cmd]), (0, []))
-				   [" quit"]]
+		for n, value in enumerate(values):
-		
+			self.assertEqual(
-		outList = [1,
+				self.__transm.proceed(["set", jail, cmdAdd, value]),
-				   1,
+				(0, values[:n+1]))
-				   1,
+			self.assertEqual(
-				   1,
+				self.__transm.proceed(["get", jail, cmd]),
-				   1,
+				(0, values[:n+1]))
-				   1,
+		for n, value in enumerate(values):
-				   1]
+			self.assertEqual(
-		
+				self.__transm.proceed(["set", jail, cmdDel, value]),
-		cnt = 0
+				(0, values[n+1:]))
-		for cmd in cmdList:
+			self.assertEqual(
-			msg = self.__server.transm.proceed(cmd)
+				self.__transm.proceed(["get", jail, cmd]),
-			self.assertEqual(msg[0], outList[cnt])
+				(0, values[n+1:]))
-			cnt += 1
+
-	
+	def jailAddDelRegexTest(self, cmd, inValues, outValues, jail):
-	def testJail(self):
+		cmdAdd = "add" + cmd
-		name = "TestCase"
+		cmdDel = "del" + cmd
-		cmdList = [["add", name],
+
-				   ["set", name, "logpath", "testcases/files/testcase01.log"],
+		if outValues is None:
-				   ["set", name, "timeregex", "\S{3}\s{1,2}\d{1,2} \d{2}:\d{2}:\d{2}"],
+			outValues = inValues
-				   ["set", name, "timepattern", "%b %d %H:%M:%S"],
+
-				   ["set", name, "failregex", "Authentication failure"],
+		self.assertEqual(
-				   ["start", name],
+			self.__transm.proceed(["get", jail, cmd]), (0, []))
-				   ["stop", name],
+		for n, value in enumerate(inValues):
-				   ["quit"]]
+			self.assertEqual(
-				  
+				self.__transm.proceed(["set", jail, cmdAdd, value]),
-		for cmd in cmdList:
+				(0, outValues[:n+1]))
-			self.__server.transm.proceed(cmd)
+			self.assertEqual(
-			if cmd == ["start", name]:
+				self.__transm.proceed(["get", jail, cmd]),
-				time.sleep(2)
+				(0, outValues[:n+1]))
-				jail = self.__server.jails[name]
+		for n, value in enumerate(inValues):
-				self.assertEqual(jail.getFilter().failManager.size(), 0)
+			self.assertEqual(
-				self.assertEqual(jail.getAction().banManager.size(), 2)
+				self.__transm.proceed(["set", jail, cmdDel, 0]), # First item
-		
+				(0, outValues[n+1:]))
+			self.assertEqual(
+				self.__transm.proceed(["get", jail, cmd]),
+				(0, outValues[n+1:]))
+
+	def testPing(self):
+		self.assertEqual(self.__transm.proceed(["ping"]), (0, "pong"))
+
+	def testSleep(self):
+		t0 = time.time()
+		self.assertEqual(self.__transm.proceed(["sleep", "1"]), (0, None))
+		t1 = time.time()
+		# Approx 1 second delay
+		self.assertAlmostEqual(t1 - t0, 1, places=2)
+
+	def testLogTarget(self):
+		logTargets = []
+		for _ in xrange(3):
+			tmpFile = tempfile.mkstemp("fail2ban", "transmitter")
+			logTargets.append(tmpFile[1])
+			os.close(tmpFile[0])
+		for logTarget in logTargets:
+			self.setGetTest("logtarget", logTarget)
+
+		# If path is invalid, do not change logtarget
+		value = "/this/path/should/not/exist"
+		self.assertEqual(
+			self.__transm.proceed(["set", "logtarget", value]),
+			(0, logTarget)) #NOTE: Shouldn't this return 1
+		self.assertEqual(
+			self.__transm.proceed(["get", "logtarget"]), (0, logTargets[-1]))
+
+		self.__transm.proceed(["set", "/dev/null"])
+		for logTarget in logTargets:
+			os.remove(logTarget)
+
+	def testLogLevel(self):
+		self.setGetTest("loglevel", "4", 4)
+		self.setGetTest("loglevel", "2", 2)
+		self.setGetTest("loglevel", "-1", -1)
+		self.setGetTestNOK("loglevel", "Bird")
+
+	def testAddJail(self):
+		jail2 = "TestJail2"
+		jail3 = "TestJail3"
+		jail4 = "TestJail4"
+		self.assertEqual(
+			self.__transm.proceed(["add", jail2, "polling"]), (0, jail2))
+		self.assertEqual(self.__transm.proceed(["add", jail3]), (0, jail3))
+		self.assertEqual(
+			self.__transm.proceed(["add", jail4, "invalid backend"])[0], 1)
+		self.assertEqual(
+			self.__transm.proceed(["add", jail4, "auto"]), (0, jail4))
+		# Duplicate Jail
+		self.assertEqual(
+			self.__transm.proceed(["add", self.jailName, "polling"])[0], 1)
+		# All name is reserved
+		self.assertEqual(
+			self.__transm.proceed(["add", "all", "polling"])[0], 1)
+
+	def testJailIdle(self):
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "idle", "on"]),
+			(0, True))
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "idle", "off"]),
+			(0, False))
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "idle", "CAT"])[0],
+			0) #NOTE: Should this return 1
+
+	def testJailFindTime(self):
+		self.setGetTest("findtime", "120", 120, jail=self.jailName)
+		self.setGetTest("findtime", "60", 60, jail=self.jailName)
+		self.setGetTest("findtime", "-60", -60, jail=self.jailName)
+		self.setGetTestNOK("findtime", "Dog", jail=self.jailName)
+
+	def testJailBanTime(self):
+		self.setGetTest("bantime", "600", 600, jail=self.jailName)
+		self.setGetTest("bantime", "50", 50, jail=self.jailName)
+		self.setGetTest("bantime", "-50", -50, jail=self.jailName)
+		self.setGetTestNOK("bantime", "Cat", jail=self.jailName)
+
+	def testJailUseDNS(self):
+		self.setGetTest("usedns", "yes", jail=self.jailName)
+		self.setGetTest("usedns", "warn", jail=self.jailName)
+		self.setGetTest("usedns", "no", jail=self.jailName)
+
+		# Safe default should be "no"
+		value = "Fish"
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "usedns", value]),
+			(0, "no"))
+
+	def testJailBanIP(self):
+		self.__server.startJail(self.jailName) # Jail must be started
+
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "banip", "127.0.0.1"]),
+			(0, "127.0.0.1"))
+		time.sleep(1) # Give chance to ban
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "banip", "Badger"]),
+			(0, "Badger")) #NOTE: Is IP address validated? Is DNS Lookup done?
+		time.sleep(1) # Give chance to ban
+		# Unban IP
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "unbanip", "127.0.0.1"]),
+			(0, "127.0.0.1"))
+		# Unban IP which isn't banned
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "unbanip", "192.168.1.1"]),
+			(0, "None")) #NOTE: Should this return 1?
+
+	def testJailMaxRetry(self):
+		self.setGetTest("maxretry", "5", 5, jail=self.jailName)
+		self.setGetTest("maxretry", "2", 2, jail=self.jailName)
+		self.setGetTest("maxretry", "-2", -2, jail=self.jailName)
+		self.setGetTestNOK("maxretry", "Duck", jail=self.jailName)
+
+	def testJailLogPath(self):
+		self.jailAddDelTest(
+			"logpath",
+			[
+				"testcases/files/testcase01.log",
+				"testcases/files/testcase02.log",
+				"testcases/files/testcase03.log",
+			],
+			self.jailName
+		)
+		# Try duplicates
+		value = "testcases/files/testcase04.log"
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "addlogpath", value]),
+			(0, [value]))
+		# Will silently ignore duplicate
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "addlogpath", value]),
+			(0, [value]))
+		self.assertEqual(
+			self.__transm.proceed(["get", self.jailName, "logpath"]),
+			(0, [value]))
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "dellogpath", value]),
+			(0, []))
+
+		# Invalid file
+		value = "this_file_shouldn't_exist"
+		result = self.__transm.proceed(
+			["set", self.jailName, "addlogpath", value])
+		self.assertTrue(isinstance(result[1], IOError))
+
+	def testJailIgnoreIP(self):
+		self.jailAddDelTest(
+			"ignoreip",
+			[
+				"127.0.0.1",
+				"192.168.1.1",
+				"8.8.8.8",
+			],
+			self.jailName
+		)
+
+		# Try duplicates
+		value = "127.0.0.1"
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "addignoreip", value]),
+			(0, [value]))
+		# Will allow duplicate
+		#NOTE: Should duplicates be allowed, or silent ignore like logpath?
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "addignoreip", value]),
+			(0, [value, value]))
+		self.assertEqual(
+			self.__transm.proceed(["get", self.jailName, "ignoreip"]),
+			(0, [value, value]))
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "delignoreip", value]),
+			(0, [value]))
+
+	def testJailRegex(self):
+		self.jailAddDelRegexTest("failregex",
+			[
+				"user john at <HOST>",
+				"Admin user login from <HOST>",
+				"failed attempt from <HOST> again",
+			],
+			[
+				"user john at (?:::f{4,6}:)?(?P<host>[\w\-.^_]+)",
+				"Admin user login from (?:::f{4,6}:)?(?P<host>[\w\-.^_]+)",
+				"failed attempt from (?:::f{4,6}:)?(?P<host>[\w\-.^_]+) again",
+			],
+			self.jailName
+		)
+
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "addfailregex", "No host regex"]),
+			(0, [])) #NOTE: Shouldn't this return 1?
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "addfailregex", 654])[0],
+			1)
+
+	def testJailIgnoreRegex(self):
+		self.jailAddDelRegexTest("ignoreregex",
+			[
+				"user john",
+				"Admin user login from <HOST>",
+				"Dont match me!",
+			],
+			[
+				"user john",
+				"Admin user login from (?:::f{4,6}:)?(?P<host>[\w\-.^_]+)",
+				"Dont match me!",
+			],
+			self.jailName
+		)
+
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "addignoreregex", 50])[0],
+			1)
+
+	def testStatus(self):
+		jails = [self.jailName]
+		self.assertEqual(self.__transm.proceed(["status"]),
+			(0, [('Number of jail', len(jails)), ('Jail list', ", ".join(jails))]))
+		self.__server.addJail("TestJail2", "auto")
+		jails.append("TestJail2")
+		self.assertEqual(self.__transm.proceed(["status"]),
+			(0, [('Number of jail', len(jails)), ('Jail list', ", ".join(jails))]))
+
+	def testJailStatus(self):
+		self.assertEqual(self.__transm.proceed(["status", self.jailName]),
+			(0,
+				[
+					('filter', [
+						('Currently failed', 0),
+						('Total failed', 0),
+						('File list', [])]
+					),
+					('action', [
+						('Currently banned', 0),
+						('Total banned', 0),
+						('IP list', [])]
+					)
+				]
+			)
+		)
+
+	def testAction(self):
+		action = "TestCaseAction"
+		cmdList = [
+			"actionstart",
+			"actionstop",
+			"actioncheck",
+			"actionban",
+			"actionunban",
+		]
+		cmdValueList = [
+			"Action Start",
+			"Action Stop",
+			"Action Check",
+			"Action Ban",
+			"Action Unban",
+		]
+
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "addaction", action]),
+			(0, action))
+		for cmd, value in zip(cmdList, cmdValueList):
+			self.assertEqual(
+				self.__transm.proceed(
+					["set", self.jailName, cmd, action, value]),
+				(0, value))
+		for cmd, value in zip(cmdList, cmdValueList):
+			self.assertEqual(
+				self.__transm.proceed(["get", self.jailName, cmd, action]),
+				(0, value))
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "setcinfo", action, "KEY", "VALUE"]),
+			(0, "VALUE"))
+		self.assertEqual(
+			self.__transm.proceed(
+				["get", self.jailName, "cinfo", action, "KEY"]),
+			(0, "VALUE"))
+		self.assertEqual(
+			self.__transm.proceed(
+				["get", self.jailName, "cinfo", action, "InvalidKey"])[0],
+			1)
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "delcinfo", action, "KEY"]),
+			(0, None))
+		self.assertEqual(
+			self.__transm.proceed(["set", self.jailName, "delaction", action]),
+			(0, None))
+		self.assertEqual(
+			self.__transm.proceed(
+				["set", self.jailName, "delaction", "Doesn't exist"]),
+			(0, None)) #NOTE: Should this return 1?