jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-19 03:07:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

API to fetch Error log is no longer cached.

Browse Source
This commit is contained in:
Paulus Schoutsen 2015-11-28 14:08:01 -08:00
parent 05978ad88d
commit e84ef2d2d7
3 changed files with 60 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
homeassistant/components/api.py
View File

@ -21,7 +21,7 @@ from homeassistant.const import (
URL_API_CONFIG, URL_API_BOOTSTRAP, URL_API_ERROR_LOG, URL_API_CONFIG, URL_API_BOOTSTRAP, URL_API_ERROR_LOG,
EVENT_TIME_CHANGED, EVENT_HOMEASSISTANT_STOP, MATCH_ALL, EVENT_TIME_CHANGED, EVENT_HOMEASSISTANT_STOP, MATCH_ALL,
HTTP_OK, HTTP_CREATED, HTTP_BAD_REQUEST, HTTP_NOT_FOUND, HTTP_OK, HTTP_CREATED, HTTP_BAD_REQUEST, HTTP_NOT_FOUND,
HTTP_UNPROCESSABLE_ENTITY, CONTENT_TYPE_TEXT_PLAIN) HTTP_UNPROCESSABLE_ENTITY)
DOMAIN = 'api' DOMAIN = 'api'
@ -36,10 +36,6 @@ _LOGGER = logging.getLogger(__name__)
def setup(hass, config): def setup(hass, config):
""" Register the API with the HTTP interface. """ """ Register the API with the HTTP interface. """
if 'http' not in hass.config.components:
_LOGGER.error('Dependency http is not loaded')
return False
# /api - for validation purposes # /api - for validation purposes
hass.http.register_path('GET', URL_API, _handle_get_api) hass.http.register_path('GET', URL_API, _handle_get_api)
@ -347,9 +343,8 @@ def _handle_get_api_components(handler, path_match, data):
def _handle_get_api_error_log(handler, path_match, data): def _handle_get_api_error_log(handler, path_match, data):
""" Returns the logged errors for this session. """ """ Returns the logged errors for this session. """
error_path = handler.server.hass.config.path(ERROR_LOG_FILENAME) handler.write_file(handler.server.hass.config.path(ERROR_LOG_FILENAME),
with open(error_path, 'rb') as error_log: False)
handler.write_file_pointer(CONTENT_TYPE_TEXT_PLAIN, error_log)
def _services_json(hass): def _services_json(hass):

10
homeassistant/components/http.py
View File

@ -307,18 +307,19 @@ class RequestHandler(SimpleHTTPRequestHandler):
json.dumps(data, indent=4, sort_keys=True, json.dumps(data, indent=4, sort_keys=True,
cls=rem.JSONEncoder).encode("UTF-8")) cls=rem.JSONEncoder).encode("UTF-8"))
def write_file(self, path): def write_file(self, path, cache_headers=True):
""" Returns a file to the user. """ """ Returns a file to the user. """
try: try:
with open(path, 'rb') as inp: with open(path, 'rb') as inp:
self.write_file_pointer(self.guess_type(path), inp) self.write_file_pointer(self.guess_type(path), inp,
cache_headers)
except IOError: except IOError:
self.send_response(HTTP_NOT_FOUND) self.send_response(HTTP_NOT_FOUND)
self.end_headers() self.end_headers()
_LOGGER.exception("Unable to serve %s", path) _LOGGER.exception("Unable to serve %s", path)
def write_file_pointer(self, content_type, inp): def write_file_pointer(self, content_type, inp, cache_headers=True):
""" """
Helper function to write a file pointer to the user. Helper function to write a file pointer to the user.
Does not do error handling. Does not do error handling.
@ -328,7 +329,8 @@ class RequestHandler(SimpleHTTPRequestHandler):
self.send_response(HTTP_OK) self.send_response(HTTP_OK)
self.send_header(HTTP_HEADER_CONTENT_TYPE, content_type) self.send_header(HTTP_HEADER_CONTENT_TYPE, content_type)
self.set_cache_header() if cache_headers:
self.set_cache_header()
self.set_session_cookie_header() self.set_session_cookie_header()
if do_gzip: if do_gzip:

81
tests/components/test_api.py
View File

@ -8,14 +8,13 @@ Tests Home Assistant HTTP component does what it should do.
import unittest import unittest
import json import json
from unittest.mock import patch from unittest.mock import patch
import tempfile
import requests import requests
from homeassistant import bootstrap, const
import homeassistant.core as ha import homeassistant.core as ha
import homeassistant.bootstrap as bootstrap
import homeassistant.remote as remote
import homeassistant.components.http as http import homeassistant.components.http as http
from homeassistant.const import HTTP_HEADER_HA_AUTH
API_PASSWORD = "test1234" API_PASSWORD = "test1234"
@ -26,7 +25,7 @@ SERVER_PORT = 8120
HTTP_BASE_URL = "http://127.0.0.1:{}".format(SERVER_PORT) HTTP_BASE_URL = "http://127.0.0.1:{}".format(SERVER_PORT)
HA_HEADERS = {HTTP_HEADER_HA_AUTH: API_PASSWORD} HA_HEADERS = {const.HTTP_HEADER_HA_AUTH: API_PASSWORD}
hass = None hass = None
@ -68,20 +67,20 @@ class TestAPI(unittest.TestCase):
# TODO move back to http component and test with use_auth. # TODO move back to http component and test with use_auth.
def test_access_denied_without_password(self): def test_access_denied_without_password(self):
req = requests.get( req = requests.get(
_url(remote.URL_API_STATES_ENTITY.format("test"))) _url(const.URL_API_STATES_ENTITY.format("test")))
self.assertEqual(401, req.status_code) self.assertEqual(401, req.status_code)
def test_access_denied_with_wrong_password(self): def test_access_denied_with_wrong_password(self):
req = requests.get( req = requests.get(
_url(remote.URL_API_STATES_ENTITY.format("test")), _url(const.URL_API_STATES_ENTITY.format("test")),
headers={HTTP_HEADER_HA_AUTH: 'wrongpassword'}) headers={const.HTTP_HEADER_HA_AUTH: 'wrongpassword'})
self.assertEqual(401, req.status_code) self.assertEqual(401, req.status_code)
def test_api_list_state_entities(self): def test_api_list_state_entities(self):
""" Test if the debug interface allows us to list state entities. """ """ Test if the debug interface allows us to list state entities. """
req = requests.get(_url(remote.URL_API_STATES), req = requests.get(_url(const.URL_API_STATES),
headers=HA_HEADERS) headers=HA_HEADERS)
remote_data = [ha.State.from_dict(item) for item in req.json()] remote_data = [ha.State.from_dict(item) for item in req.json()]
@ -91,7 +90,7 @@ class TestAPI(unittest.TestCase):
def test_api_get_state(self): def test_api_get_state(self):
""" Test if the debug interface allows us to get a state. """ """ Test if the debug interface allows us to get a state. """
req = requests.get( req = requests.get(
_url(remote.URL_API_STATES_ENTITY.format("test.test")), _url(const.URL_API_STATES_ENTITY.format("test.test")),
headers=HA_HEADERS) headers=HA_HEADERS)
data = ha.State.from_dict(req.json()) data = ha.State.from_dict(req.json())
@ -105,7 +104,7 @@ class TestAPI(unittest.TestCase):
def test_api_get_non_existing_state(self): def test_api_get_non_existing_state(self):
""" Test if the debug interface allows us to get a state. """ """ Test if the debug interface allows us to get a state. """
req = requests.get( req = requests.get(
_url(remote.URL_API_STATES_ENTITY.format("does_not_exist")), _url(const.URL_API_STATES_ENTITY.format("does_not_exist")),
headers=HA_HEADERS) headers=HA_HEADERS)
self.assertEqual(404, req.status_code) self.assertEqual(404, req.status_code)
@ -115,7 +114,7 @@ class TestAPI(unittest.TestCase):
hass.states.set("test.test", "not_to_be_set") hass.states.set("test.test", "not_to_be_set")
requests.post(_url(remote.URL_API_STATES_ENTITY.format("test.test")), requests.post(_url(const.URL_API_STATES_ENTITY.format("test.test")),
data=json.dumps({"state": "debug_state_change2"}), data=json.dumps({"state": "debug_state_change2"}),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -130,7 +129,7 @@ class TestAPI(unittest.TestCase):
new_state = "debug_state_change" new_state = "debug_state_change"
req = requests.post( req = requests.post(
_url(remote.URL_API_STATES_ENTITY.format( _url(const.URL_API_STATES_ENTITY.format(
"test_entity.that_does_not_exist")), "test_entity.that_does_not_exist")),
data=json.dumps({'state': new_state}), data=json.dumps({'state': new_state}),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -146,7 +145,7 @@ class TestAPI(unittest.TestCase):
""" Test if API sends appropriate error if we omit state. """ """ Test if API sends appropriate error if we omit state. """
req = requests.post( req = requests.post(
_url(remote.URL_API_STATES_ENTITY.format( _url(const.URL_API_STATES_ENTITY.format(
"test_entity.that_does_not_exist")), "test_entity.that_does_not_exist")),
data=json.dumps({}), data=json.dumps({}),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -165,7 +164,7 @@ class TestAPI(unittest.TestCase):
hass.bus.listen_once("test.event_no_data", listener) hass.bus.listen_once("test.event_no_data", listener)
requests.post( requests.post(
_url(remote.URL_API_EVENTS_EVENT.format("test.event_no_data")), _url(const.URL_API_EVENTS_EVENT.format("test.event_no_data")),
headers=HA_HEADERS) headers=HA_HEADERS)
hass.pool.block_till_done() hass.pool.block_till_done()
@ -186,7 +185,7 @@ class TestAPI(unittest.TestCase):
hass.bus.listen_once("test_event_with_data", listener) hass.bus.listen_once("test_event_with_data", listener)
requests.post( requests.post(
_url(remote.URL_API_EVENTS_EVENT.format("test_event_with_data")), _url(const.URL_API_EVENTS_EVENT.format("test_event_with_data")),
data=json.dumps({"test": 1}), data=json.dumps({"test": 1}),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -206,7 +205,7 @@ class TestAPI(unittest.TestCase):
hass.bus.listen_once("test_event_bad_data", listener) hass.bus.listen_once("test_event_bad_data", listener)
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENTS_EVENT.format("test_event_bad_data")), _url(const.URL_API_EVENTS_EVENT.format("test_event_bad_data")),
data=json.dumps('not an object'), data=json.dumps('not an object'),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -217,7 +216,7 @@ class TestAPI(unittest.TestCase):
# Try now with valid but unusable JSON # Try now with valid but unusable JSON
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENTS_EVENT.format("test_event_bad_data")), _url(const.URL_API_EVENTS_EVENT.format("test_event_bad_data")),
data=json.dumps([1, 2, 3]), data=json.dumps([1, 2, 3]),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -226,9 +225,31 @@ class TestAPI(unittest.TestCase):
self.assertEqual(422, req.status_code) self.assertEqual(422, req.status_code)
self.assertEqual(0, len(test_value)) self.assertEqual(0, len(test_value))
def test_api_get_config(self):
req = requests.get(_url(const.URL_API_CONFIG),
headers=HA_HEADERS)
self.assertEqual(hass.config.as_dict(), req.json())
def test_api_get_components(self):
req = requests.get(_url(const.URL_API_COMPONENTS),
headers=HA_HEADERS)
self.assertEqual(hass.config.components, req.json())
def test_api_get_error_log(self):
test_content = 'Test String'
with tempfile.NamedTemporaryFile() as log:
log.write(test_content.encode('utf-8'))
log.flush()
with patch.object(hass.config, 'path', return_value=log.name):
req = requests.get(_url(const.URL_API_ERROR_LOG),
headers=HA_HEADERS)
self.assertEqual(test_content, req.text)
self.assertIsNone(req.headers.get('expires'))
def test_api_get_event_listeners(self): def test_api_get_event_listeners(self):
""" Test if we can get the list of events being listened for. """ """ Test if we can get the list of events being listened for. """
req = requests.get(_url(remote.URL_API_EVENTS), req = requests.get(_url(const.URL_API_EVENTS),
headers=HA_HEADERS) headers=HA_HEADERS)
local = hass.bus.listeners local = hass.bus.listeners
@ -241,7 +262,7 @@ class TestAPI(unittest.TestCase):
def test_api_get_services(self): def test_api_get_services(self):
""" Test if we can get a dict describing current services. """ """ Test if we can get a dict describing current services. """
req = requests.get(_url(remote.URL_API_SERVICES), req = requests.get(_url(const.URL_API_SERVICES),
headers=HA_HEADERS) headers=HA_HEADERS)
local_services = hass.services.services local_services = hass.services.services
@ -262,7 +283,7 @@ class TestAPI(unittest.TestCase):
hass.services.register("test_domain", "test_service", listener) hass.services.register("test_domain", "test_service", listener)
requests.post( requests.post(
_url(remote.URL_API_SERVICES_SERVICE.format( _url(const.URL_API_SERVICES_SERVICE.format(
"test_domain", "test_service")), "test_domain", "test_service")),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -283,7 +304,7 @@ class TestAPI(unittest.TestCase):
hass.services.register("test_domain", "test_service", listener) hass.services.register("test_domain", "test_service", listener)
requests.post( requests.post(
_url(remote.URL_API_SERVICES_SERVICE.format( _url(const.URL_API_SERVICES_SERVICE.format(
"test_domain", "test_service")), "test_domain", "test_service")),
data=json.dumps({"test": 1}), data=json.dumps({"test": 1}),
headers=HA_HEADERS) headers=HA_HEADERS)
@ -296,24 +317,24 @@ class TestAPI(unittest.TestCase):
""" Test setting up event forwarding. """ """ Test setting up event forwarding. """
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
headers=HA_HEADERS) headers=HA_HEADERS)
self.assertEqual(400, req.status_code) self.assertEqual(400, req.status_code)
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({'host': '127.0.0.1'}), data=json.dumps({'host': '127.0.0.1'}),
headers=HA_HEADERS) headers=HA_HEADERS)
self.assertEqual(400, req.status_code) self.assertEqual(400, req.status_code)
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({'api_password': 'bla-di-bla'}), data=json.dumps({'api_password': 'bla-di-bla'}),
headers=HA_HEADERS) headers=HA_HEADERS)
self.assertEqual(400, req.status_code) self.assertEqual(400, req.status_code)
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({ data=json.dumps({
'api_password': 'bla-di-bla', 'api_password': 'bla-di-bla',
'host': '127.0.0.1', 'host': '127.0.0.1',
@ -323,7 +344,7 @@ class TestAPI(unittest.TestCase):
self.assertEqual(422, req.status_code) self.assertEqual(422, req.status_code)
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({ data=json.dumps({
'api_password': 'bla-di-bla', 'api_password': 'bla-di-bla',
'host': '127.0.0.1', 'host': '127.0.0.1',
@ -334,7 +355,7 @@ class TestAPI(unittest.TestCase):
# Setup a real one # Setup a real one
req = requests.post( req = requests.post(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({ data=json.dumps({
'api_password': API_PASSWORD, 'api_password': API_PASSWORD,
'host': '127.0.0.1', 'host': '127.0.0.1',
@ -345,13 +366,13 @@ class TestAPI(unittest.TestCase):
# Delete it again.. # Delete it again..
req = requests.delete( req = requests.delete(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({}), data=json.dumps({}),
headers=HA_HEADERS) headers=HA_HEADERS)
self.assertEqual(400, req.status_code) self.assertEqual(400, req.status_code)
req = requests.delete( req = requests.delete(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({ data=json.dumps({
'host': '127.0.0.1', 'host': '127.0.0.1',
'port': 'abcd' 'port': 'abcd'
@ -360,7 +381,7 @@ class TestAPI(unittest.TestCase):
self.assertEqual(422, req.status_code) self.assertEqual(422, req.status_code)
req = requests.delete( req = requests.delete(
_url(remote.URL_API_EVENT_FORWARD), _url(const.URL_API_EVENT_FORWARD),
data=json.dumps({ data=json.dumps({
'host': '127.0.0.1', 'host': '127.0.0.1',
'port': SERVER_PORT 'port': SERVER_PORT