# -*- coding: utf-8 -*- ########################################################################## # OpenLP - Open Source Lyrics Projection # # ---------------------------------------------------------------------- # # Copyright (c) 2008-2022 OpenLP Developers # # ---------------------------------------------------------------------- # # This program is free software: you can redistribute it and/or modify # # it under the terms of the GNU General Public License as published by # # the Free Software Foundation, either version 3 of the License, or # # (at your option) any later version. # # # # This program 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 this program. If not, see . # ########################################################################## from unittest.mock import MagicMock from openlp.core.common.registry import Registry from openlp.core.api.poll import Poller from openlp.core.state import State from openlp.core.lib.plugin import PluginStatus, StringContent def test_plugins_returns_list(flask_client): State().load_settings() res = flask_client.get('/api/v2/core/plugins').get_json() assert len(res) == 0 class FakeMediaItem: has_search = True class FakePlugin: name = 'Faked' is_plugin = True status = PluginStatus.Active media_item = FakeMediaItem() text_strings = {StringContent.Name: {'plural': 'just a text'}} plugin = FakePlugin() State().modules['testplug'] = plugin Registry.create().register('testplug_plugin', plugin) res = flask_client.get('/api/v2/core/plugins').get_json() assert len(res) == 1 assert res[0]['key'] == plugin.name assert res[0]['name'] == plugin.text_strings[StringContent.Name]['plural'] def test_system_information(flask_client, settings): Registry().get('settings_thread').setValue('api/authentication enabled', False) res = flask_client.get('/api/v2/core/system').get_json() assert res['websocket_port'] > 0 assert not res['login_required'] def test_poll_backend(settings): """ Test the raw poll function returns the correct JSON """ # GIVEN: the system is configured with a set of data poller = Poller() mocked_service_manager = MagicMock() mocked_service_manager.service_id = 21 mocked_live_controller = MagicMock() mocked_live_controller.selected_row = 5 mocked_live_controller.service_item = MagicMock() mocked_live_controller.service_item.unique_identifier = '23-34-45' mocked_live_controller.blank_screen.isChecked.return_value = True mocked_live_controller.theme_screen.isChecked.return_value = False mocked_live_controller.desktop_screen.isChecked.return_value = False Registry().register('live_controller', mocked_live_controller) Registry().register('service_manager', mocked_service_manager) # WHEN: The poller polls poll_json = poller.poll() # THEN: the live json should be generated and match expected results assert poll_json['results']['blank'] is True, 'The blank return value should be True' assert poll_json['results']['theme'] is False, 'The theme return value should be False' assert poll_json['results']['display'] is False, 'The display return value should be False' assert poll_json['results']['isSecure'] is False, 'The isSecure return value should be False' assert poll_json['results']['twelve'] is True, 'The twelve return value should be True' assert poll_json['results']['version'] == 3, 'The version return value should be 3' assert poll_json['results']['slide'] == 5, 'The slide return value should be 5' assert poll_json['results']['service'] == 21, 'The version return value should be 21' assert poll_json['results']['item'] == '23-34-45', 'The item return value should match 23-34-45' def test_login_get_is_refused(flask_client): res = flask_client.get('/api/v2/core/login') assert res.status_code == 405 def test_login_without_data_returns_400(flask_client): res = flask_client.post('/api/v2/core/login') assert res.status_code == 400 def test_login_with_invalid_credetials_returns_401(flask_client, settings): res = flask_client.post('/api/v2/core/login', json=dict(username='openlp', password='invalid')) assert res.status_code == 401 def test_login_with_valid_credetials_returns_token(flask_client, settings): Registry().register('authentication_token', 'foobar') res = flask_client.post('/api/v2/core/login', json=dict(username='openlp', password='password')) assert res.status_code == 200 assert res.get_json()['token'] == 'foobar' def test_retrieving_image(flask_client): class FakeController: def grab_maindisplay(self): class FakeImage: def save(self, first, second): pass return FakeImage() Registry.create().register('live_controller', FakeController()) res = flask_client.get('/api/v2/core/live-image').get_json() assert res['binary_image'] != '' def test_toggle_display_requires_login(flask_client, settings): settings.setValue('api/authentication enabled', True) res = flask_client.post('/api/v2/core/display') settings.setValue('api/authentication enabled', False) assert res.status_code == 401 def test_toggle_display_does_not_allow_get(flask_client): res = flask_client.get('/api/v2/core/display') assert res.status_code == 405 def test_toggle_display_invalid_action(flask_client, settings): res = flask_client.post('/api/v2/core/display', json={'display': 'foo'}) assert res.status_code == 400 def test_toggle_display_no_data(flask_client, settings): res = flask_client.post('/api/v2/core/display', json={}) assert res.status_code == 400 def test_toggle_display_valid_action_updates_controller(flask_client, settings): class FakeController: class Emitter: def emit(self, value): self.set = value slidecontroller_toggle_display = Emitter() controller = FakeController() Registry().register('live_controller', controller) res = flask_client.post('/api/v2/core/display', json={'display': 'show'}) assert res.status_code == 204 assert controller.slidecontroller_toggle_display.set == 'show' def test_cors_headers_are_present(flask_client, settings): res = flask_client.get('/api/v2/core/system') assert 'Access-Control-Allow-Origin' in res.headers assert res.headers['Access-Control-Allow-Origin'] == '*'