Email (#3421)
* Added email component * added email sensor component * added doc string to test class * fixed lint error * fixed lint error * rename of email component * added another block as test fails on CI * added retry to multi email test * added delay to retry * added to .coveragerc * removed sleep from tests and fixed up stale comments
This commit is contained in:
1 parent
54248863b3
commit
de5bd26050
3 files changed
+478
No files matched your search
@@ -0,0 +1,227 @@
|
||||
"""The tests for the Command line sensor platform."""
|
||||
import unittest
|
||||
import email
|
||||
import datetime
|
||||
|
||||
from email.mime.multipart import MIMEMultipart
|
||||
from email.mime.text import MIMEText
|
||||
from threading import Event
|
||||
|
||||
from homeassistant.helpers.event import track_state_change
|
||||
from collections import deque
|
||||
|
||||
from homeassistant.components.sensor import imap_email_content
|
||||
from tests.common import get_test_home_assistant
|
||||
|
||||
|
||||
class FakeEMailReader:
|
||||
"""A test class for sending test emails"""
|
||||
|
||||
def __init__(self, messages):
|
||||
"""Setup the fake email reader"""
|
||||
self._messages = messages
|
||||
|
||||
def connect(self):
|
||||
"""Always connected."""
|
||||
return True
|
||||
|
||||
def read_next(self):
|
||||
"""Get the next email."""
|
||||
if len(self._messages) == 0:
|
||||
return None
|
||||
return self._messages.popleft()
|
||||
|
||||
|
||||
class EmailContentSensor(unittest.TestCase):
|
||||
"""Test the Command line sensor."""
|
||||
|
||||
def setUp(self):
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant()
|
||||
|
||||
def tearDown(self):
|
||||
"""Stop everything that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_allowed_sender(self):
|
||||
"""Test emails from allowed sender."""
|
||||
test_message = email.message.Message()
|
||||
test_message['From'] = "sender@test.com"
|
||||
test_message['Subject'] = "Test"
|
||||
test_message['Date'] = datetime.datetime(2016, 1, 1, 12, 44, 57)
|
||||
test_message.set_payload("Test Message")
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([test_message])),
|
||||
"test_emails_sensor",
|
||||
["sender@test.com"],
|
||||
None)
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
self.assertEqual("Test Message", sensor.state)
|
||||
self.assertEqual("sender@test.com", sensor.state_attributes["from"])
|
||||
self.assertEqual("Test", sensor.state_attributes["subject"])
|
||||
self.assertEqual(datetime.datetime(2016, 1, 1, 12, 44, 57),
|
||||
sensor.state_attributes["date"])
|
||||
|
||||
def test_multi_part_with_text(self):
|
||||
"""Test multi part emails."""
|
||||
msg = MIMEMultipart('alternative')
|
||||
msg['Subject'] = "Link"
|
||||
msg['From'] = "sender@test.com"
|
||||
|
||||
text = "Test Message"
|
||||
html = "<html><head></head><body>Test Message</body></html>"
|
||||
|
||||
textPart = MIMEText(text, 'plain')
|
||||
htmlPart = MIMEText(html, 'html')
|
||||
|
||||
msg.attach(textPart)
|
||||
msg.attach(htmlPart)
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([msg])),
|
||||
"test_emails_sensor",
|
||||
["sender@test.com"],
|
||||
None)
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
self.assertEqual("Test Message", sensor.state)
|
||||
|
||||
def test_multi_part_only_html(self):
|
||||
"""Test multi part emails with only html."""
|
||||
msg = MIMEMultipart('alternative')
|
||||
msg['Subject'] = "Link"
|
||||
msg['From'] = "sender@test.com"
|
||||
|
||||
html = "<html><head></head><body>Test Message</body></html>"
|
||||
|
||||
htmlPart = MIMEText(html, 'html')
|
||||
|
||||
msg.attach(htmlPart)
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([msg])),
|
||||
"test_emails_sensor",
|
||||
["sender@test.com"],
|
||||
None)
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
self.assertEqual(
|
||||
"<html><head></head><body>Test Message</body></html>",
|
||||
sensor.state)
|
||||
|
||||
def test_multi_part_only_other_text(self):
|
||||
"""Test multi part emails with only other text."""
|
||||
msg = MIMEMultipart('alternative')
|
||||
msg['Subject'] = "Link"
|
||||
msg['From'] = "sender@test.com"
|
||||
|
||||
other = "Test Message"
|
||||
|
||||
htmlPart = MIMEText(other, 'other')
|
||||
|
||||
msg.attach(htmlPart)
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([msg])),
|
||||
"test_emails_sensor",
|
||||
["sender@test.com"],
|
||||
None)
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
self.assertEqual("Test Message", sensor.state)
|
||||
|
||||
def test_multiple_emails(self):
|
||||
"""Test multiple emails."""
|
||||
states = []
|
||||
|
||||
test_message1 = email.message.Message()
|
||||
test_message1['From'] = "sender@test.com"
|
||||
test_message1['Subject'] = "Test"
|
||||
test_message1['Date'] = datetime.datetime(2016, 1, 1, 12, 44, 57)
|
||||
test_message1.set_payload("Test Message")
|
||||
|
||||
test_message2 = email.message.Message()
|
||||
test_message2['From'] = "sender@test.com"
|
||||
test_message2['Subject'] = "Test 2"
|
||||
test_message2['Date'] = datetime.datetime(2016, 1, 1, 12, 44, 57)
|
||||
test_message2.set_payload("Test Message 2")
|
||||
|
||||
states_received = Event()
|
||||
|
||||
def state_changed_listener(entity_id, from_s, to_s):
|
||||
states.append(to_s)
|
||||
if len(states) == 2:
|
||||
states_received.set()
|
||||
|
||||
track_state_change(
|
||||
self.hass,
|
||||
["sensor.emailtest"],
|
||||
state_changed_listener)
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([test_message1, test_message2])),
|
||||
"test_emails_sensor",
|
||||
["sender@test.com"],
|
||||
None)
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
|
||||
self.hass.pool.block_till_done()
|
||||
states_received.wait(5)
|
||||
|
||||
self.assertEqual("Test Message", states[0].state)
|
||||
self.assertEqual("Test Message 2", states[1].state)
|
||||
|
||||
self.assertEqual("Test Message 2", sensor.state)
|
||||
|
||||
def test_sender_not_allowed(self):
|
||||
"""Test not whitelisted emails."""
|
||||
test_message = email.message.Message()
|
||||
test_message['From'] = "sender@test.com"
|
||||
test_message['Subject'] = "Test"
|
||||
test_message['Date'] = datetime.datetime(2016, 1, 1, 12, 44, 57)
|
||||
test_message.set_payload("Test Message")
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([test_message])),
|
||||
"test_emails_sensor",
|
||||
["other@test.com"],
|
||||
None)
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
self.assertEqual(None, sensor.state)
|
||||
|
||||
def test_template(self):
|
||||
"""Test value template."""
|
||||
test_message = email.message.Message()
|
||||
test_message['From'] = "sender@test.com"
|
||||
test_message['Subject'] = "Test"
|
||||
test_message['Date'] = datetime.datetime(2016, 1, 1, 12, 44, 57)
|
||||
test_message.set_payload("Test Message")
|
||||
|
||||
sensor = imap_email_content.EmailContentSensor(
|
||||
self.hass,
|
||||
FakeEMailReader(deque([test_message])),
|
||||
"test_emails_sensor",
|
||||
["sender@test.com"],
|
||||
"{{ subject }} from {{ from }} with message {{ body }}")
|
||||
|
||||
sensor.entity_id = "sensor.emailtest"
|
||||
sensor.update()
|
||||
self.assertEqual(
|
||||
"Test from sender@test.com with message Test Message",
|
||||
sensor.state)
|
||||
Reference in new issue
Block a user