This commit is contained in:
Paulus Schoutsen 2019-07-31 12:25:30 -07:00
parent da05dfe708
commit 4de97abc3a
2676 changed files with 163166 additions and 140084 deletions

View file

@ -6,7 +6,10 @@ from mock_open import MockOpen
from homeassistant.setup import setup_component
from homeassistant.components.fail2ban.sensor import (
BanSensor, BanLogParser, STATE_CURRENT_BANS, STATE_ALL_BANS
BanSensor,
BanLogParser,
STATE_CURRENT_BANS,
STATE_ALL_BANS,
)
from tests.common import get_test_home_assistant, assert_setup_component
@ -15,44 +18,44 @@ from tests.common import get_test_home_assistant, assert_setup_component
def fake_log(log_key):
"""Return a fake fail2ban log."""
fake_log_dict = {
'single_ban': (
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 111.111.111.111'
"single_ban": (
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 111.111.111.111"
),
'ipv6_ban': (
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 2607:f0d0:1002:51::4'
),
'multi_ban': (
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 111.111.111.111\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 222.222.222.222'
"ipv6_ban": (
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 2607:f0d0:1002:51::4"
),
'multi_jail': (
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 111.111.111.111\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_two] Ban 222.222.222.222'
"multi_ban": (
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 111.111.111.111\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 222.222.222.222"
),
'unban_all': (
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 111.111.111.111\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Unban 111.111.111.111\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 222.222.222.222\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Unban 222.222.222.222'
"multi_jail": (
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 111.111.111.111\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_two] Ban 222.222.222.222"
),
"unban_all": (
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 111.111.111.111\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Unban 111.111.111.111\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 222.222.222.222\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Unban 222.222.222.222"
),
"unban_one": (
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 111.111.111.111\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Ban 222.222.222.222\n"
"2017-01-01 12:23:35 fail2ban.actions [111]: "
"NOTICE [jail_one] Unban 111.111.111.111"
),
'unban_one': (
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 111.111.111.111\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Ban 222.222.222.222\n'
'2017-01-01 12:23:35 fail2ban.actions [111]: '
'NOTICE [jail_one] Unban 111.111.111.111'
)
}
return fake_log_dict[log_key]
@ -68,152 +71,150 @@ class TestBanSensor(unittest.TestCase):
"""Stop everything that was started."""
self.hass.stop()
@patch('os.path.isfile', Mock(return_value=True))
@patch("os.path.isfile", Mock(return_value=True))
def test_setup(self):
"""Test that sensor can be setup."""
config = {
'sensor': {
'platform': 'fail2ban',
'jails': ['jail_one']
}
}
config = {"sensor": {"platform": "fail2ban", "jails": ["jail_one"]}}
mock_fh = MockOpen()
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
assert setup_component(self.hass, 'sensor', config)
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
assert setup_component(self.hass, "sensor", config)
self.hass.block_till_done()
assert_setup_component(1, 'sensor')
assert_setup_component(1, "sensor")
@patch('os.path.isfile', Mock(return_value=True))
@patch("os.path.isfile", Mock(return_value=True))
def test_multi_jails(self):
"""Test that multiple jails can be set up as sensors.."""
config = {
'sensor': {
'platform': 'fail2ban',
'jails': ['jail_one', 'jail_two']
}
}
config = {"sensor": {"platform": "fail2ban", "jails": ["jail_one", "jail_two"]}}
mock_fh = MockOpen()
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
assert setup_component(self.hass, 'sensor', config)
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
assert setup_component(self.hass, "sensor", config)
self.hass.block_till_done()
assert_setup_component(2, 'sensor')
assert_setup_component(2, "sensor")
def test_single_ban(self):
"""Test that log is parsed correctly for single ban."""
log_parser = BanLogParser('/tmp')
sensor = BanSensor('fail2ban', 'jail_one', log_parser)
assert sensor.name == 'fail2ban jail_one'
mock_fh = MockOpen(read_data=fake_log('single_ban'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor = BanSensor("fail2ban", "jail_one", log_parser)
assert sensor.name == "fail2ban jail_one"
mock_fh = MockOpen(read_data=fake_log("single_ban"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor.update()
assert sensor.state == '111.111.111.111'
assert \
sensor.state_attributes[STATE_CURRENT_BANS] == ['111.111.111.111']
assert \
sensor.state_attributes[STATE_ALL_BANS] == ['111.111.111.111']
assert sensor.state == "111.111.111.111"
assert sensor.state_attributes[STATE_CURRENT_BANS] == ["111.111.111.111"]
assert sensor.state_attributes[STATE_ALL_BANS] == ["111.111.111.111"]
def test_ipv6_ban(self):
"""Test that log is parsed correctly for IPV6 bans."""
log_parser = BanLogParser('/tmp')
sensor = BanSensor('fail2ban', 'jail_one', log_parser)
assert sensor.name == 'fail2ban jail_one'
mock_fh = MockOpen(read_data=fake_log('ipv6_ban'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor = BanSensor("fail2ban", "jail_one", log_parser)
assert sensor.name == "fail2ban jail_one"
mock_fh = MockOpen(read_data=fake_log("ipv6_ban"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor.update()
assert sensor.state == '2607:f0d0:1002:51::4'
assert \
sensor.state_attributes[STATE_CURRENT_BANS] == \
['2607:f0d0:1002:51::4']
assert \
sensor.state_attributes[STATE_ALL_BANS] == ['2607:f0d0:1002:51::4']
assert sensor.state == "2607:f0d0:1002:51::4"
assert sensor.state_attributes[STATE_CURRENT_BANS] == ["2607:f0d0:1002:51::4"]
assert sensor.state_attributes[STATE_ALL_BANS] == ["2607:f0d0:1002:51::4"]
def test_multiple_ban(self):
"""Test that log is parsed correctly for multiple ban."""
log_parser = BanLogParser('/tmp')
sensor = BanSensor('fail2ban', 'jail_one', log_parser)
assert sensor.name == 'fail2ban jail_one'
mock_fh = MockOpen(read_data=fake_log('multi_ban'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor = BanSensor("fail2ban", "jail_one", log_parser)
assert sensor.name == "fail2ban jail_one"
mock_fh = MockOpen(read_data=fake_log("multi_ban"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor.update()
assert sensor.state == '222.222.222.222'
assert sensor.state_attributes[STATE_CURRENT_BANS] == \
['111.111.111.111', '222.222.222.222']
assert sensor.state_attributes[STATE_ALL_BANS] == \
['111.111.111.111', '222.222.222.222']
assert sensor.state == "222.222.222.222"
assert sensor.state_attributes[STATE_CURRENT_BANS] == [
"111.111.111.111",
"222.222.222.222",
]
assert sensor.state_attributes[STATE_ALL_BANS] == [
"111.111.111.111",
"222.222.222.222",
]
def test_unban_all(self):
"""Test that log is parsed correctly when unbanning."""
log_parser = BanLogParser('/tmp')
sensor = BanSensor('fail2ban', 'jail_one', log_parser)
assert sensor.name == 'fail2ban jail_one'
mock_fh = MockOpen(read_data=fake_log('unban_all'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor = BanSensor("fail2ban", "jail_one", log_parser)
assert sensor.name == "fail2ban jail_one"
mock_fh = MockOpen(read_data=fake_log("unban_all"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor.update()
assert sensor.state == 'None'
assert sensor.state == "None"
assert sensor.state_attributes[STATE_CURRENT_BANS] == []
assert sensor.state_attributes[STATE_ALL_BANS] == \
['111.111.111.111', '222.222.222.222']
assert sensor.state_attributes[STATE_ALL_BANS] == [
"111.111.111.111",
"222.222.222.222",
]
def test_unban_one(self):
"""Test that log is parsed correctly when unbanning one ip."""
log_parser = BanLogParser('/tmp')
sensor = BanSensor('fail2ban', 'jail_one', log_parser)
assert sensor.name == 'fail2ban jail_one'
mock_fh = MockOpen(read_data=fake_log('unban_one'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor = BanSensor("fail2ban", "jail_one", log_parser)
assert sensor.name == "fail2ban jail_one"
mock_fh = MockOpen(read_data=fake_log("unban_one"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor.update()
assert sensor.state == '222.222.222.222'
assert sensor.state_attributes[STATE_CURRENT_BANS] == \
['222.222.222.222']
assert sensor.state_attributes[STATE_ALL_BANS] == \
['111.111.111.111', '222.222.222.222']
assert sensor.state == "222.222.222.222"
assert sensor.state_attributes[STATE_CURRENT_BANS] == ["222.222.222.222"]
assert sensor.state_attributes[STATE_ALL_BANS] == [
"111.111.111.111",
"222.222.222.222",
]
def test_multi_jail(self):
"""Test that log is parsed correctly when using multiple jails."""
log_parser = BanLogParser('/tmp')
sensor1 = BanSensor('fail2ban', 'jail_one', log_parser)
sensor2 = BanSensor('fail2ban', 'jail_two', log_parser)
assert sensor1.name == 'fail2ban jail_one'
assert sensor2.name == 'fail2ban jail_two'
mock_fh = MockOpen(read_data=fake_log('multi_jail'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor1 = BanSensor("fail2ban", "jail_one", log_parser)
sensor2 = BanSensor("fail2ban", "jail_two", log_parser)
assert sensor1.name == "fail2ban jail_one"
assert sensor2.name == "fail2ban jail_two"
mock_fh = MockOpen(read_data=fake_log("multi_jail"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor1.update()
sensor2.update()
assert sensor1.state == '111.111.111.111'
assert \
sensor1.state_attributes[STATE_CURRENT_BANS] == ['111.111.111.111']
assert sensor1.state_attributes[STATE_ALL_BANS] == ['111.111.111.111']
assert sensor2.state == '222.222.222.222'
assert \
sensor2.state_attributes[STATE_CURRENT_BANS] == ['222.222.222.222']
assert sensor2.state_attributes[STATE_ALL_BANS] == ['222.222.222.222']
assert sensor1.state == "111.111.111.111"
assert sensor1.state_attributes[STATE_CURRENT_BANS] == ["111.111.111.111"]
assert sensor1.state_attributes[STATE_ALL_BANS] == ["111.111.111.111"]
assert sensor2.state == "222.222.222.222"
assert sensor2.state_attributes[STATE_CURRENT_BANS] == ["222.222.222.222"]
assert sensor2.state_attributes[STATE_ALL_BANS] == ["222.222.222.222"]
def test_ban_active_after_update(self):
"""Test that ban persists after subsequent update."""
log_parser = BanLogParser('/tmp')
sensor = BanSensor('fail2ban', 'jail_one', log_parser)
assert sensor.name == 'fail2ban jail_one'
mock_fh = MockOpen(read_data=fake_log('single_ban'))
with patch('homeassistant.components.fail2ban.sensor.open', mock_fh,
create=True):
log_parser = BanLogParser("/tmp")
sensor = BanSensor("fail2ban", "jail_one", log_parser)
assert sensor.name == "fail2ban jail_one"
mock_fh = MockOpen(read_data=fake_log("single_ban"))
with patch(
"homeassistant.components.fail2ban.sensor.open", mock_fh, create=True
):
sensor.update()
assert sensor.state == '111.111.111.111'
assert sensor.state == "111.111.111.111"
sensor.update()
assert sensor.state == '111.111.111.111'
assert \
sensor.state_attributes[STATE_CURRENT_BANS] == ['111.111.111.111']
assert sensor.state_attributes[STATE_ALL_BANS] == ['111.111.111.111']
assert sensor.state == "111.111.111.111"
assert sensor.state_attributes[STATE_CURRENT_BANS] == ["111.111.111.111"]
assert sensor.state_attributes[STATE_ALL_BANS] == ["111.111.111.111"]