1
0
mirror of https://github.com/gsi-upm/senpy synced 2024-12-22 21:18:12 +00:00
senpy/tests/test_extensions.py

248 lines
8.8 KiB
Python
Raw Normal View History

2019-07-17 14:29:30 +00:00
#
# Copyright 2014 Grupo de Sistemas Inteligentes (GSI) DIT, UPM
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
2015-12-17 18:47:11 +00:00
from __future__ import print_function
2014-11-07 18:12:21 +00:00
import os
2017-02-28 03:01:05 +00:00
from copy import deepcopy
2014-11-07 18:12:21 +00:00
import logging
2014-11-20 18:29:49 +00:00
2017-01-10 09:16:45 +00:00
from functools import partial
2014-11-07 18:12:21 +00:00
from senpy.extensions import Senpy
2023-09-26 17:47:23 +00:00
from senpy import plugins, config, api
from senpy.models import Results, Entry, EmotionSet, Emotion, Plugin
from senpy.errors import Error
2014-11-07 18:12:21 +00:00
from flask import Flask
from unittest import TestCase
2014-11-07 18:12:21 +00:00
2017-06-21 17:58:18 +00:00
def analyse(instance, **kwargs):
basic = api.parse_params(kwargs, api.API_PARAMS)
request = api.parse_call(basic)
2017-06-21 17:58:18 +00:00
return instance.analyse(request)
2014-11-20 18:29:49 +00:00
class ExtensionsTest(TestCase):
def setUp(self):
self.app = Flask('test_extensions')
self.examples_dir = os.path.join(os.path.dirname(__file__), '..', 'example-plugins')
self.senpy = Senpy(plugin_folder=self.examples_dir,
app=self.app,
default_plugins=False)
self.senpy.default_plugin = "Dummy"
self.app.config['TESTING'] = True # Tell Flask not to catch Exceptions
2014-11-07 18:12:21 +00:00
def test_init(self):
""" Initialising the app with the extension. """
assert hasattr(self.app, "senpy")
tapp = Flask("temp app")
2014-11-20 18:29:49 +00:00
self.senpy.init_app(tapp)
2014-11-07 18:12:21 +00:00
assert hasattr(tapp, "senpy")
def test_discovery(self):
""" Discovery of plugins in given folders. """
2014-11-20 18:29:49 +00:00
# noinspection PyProtectedMember
print(self.senpy.plugins())
assert self.senpy.get_plugin("dummy")
def test_add_delete(self):
'''Should be able to add and delete new plugins. '''
new = plugins.Analyser(name='new', description='new', version=0)
self.senpy.add_plugin(new)
assert new in self.senpy.plugins()
self.senpy.delete_plugin(new)
assert new not in self.senpy.plugins()
def test_adding_folder(self):
""" It should be possible for senpy to look for plugins in more folders. """
app = Flask('test_adding_folder')
senpy = Senpy(plugin_folder=None,
app=app,
default_plugins=False)
assert not senpy.analysis_plugins()
senpy.add_folder(self.examples_dir)
assert senpy.plugins(plugin_type=plugins.Analyser)
self.assertRaises(AttributeError, senpy.add_folder, 'DOES NOT EXIST')
2014-11-07 18:12:21 +00:00
def test_installing(self):
""" Installing a plugin """
info = {
'name': 'TestPip',
'module': 'mynoop',
'description': None,
'requirements': ['noop'],
'version': 0
2017-01-10 09:16:45 +00:00
}
module = plugins.from_info(info, root=self.examples_dir, install=True)
assert module.name == 'TestPip'
assert module
import noop
dir(noop)
def test_enabling(self):
2014-11-07 18:12:21 +00:00
""" Enabling a plugin """
assert len(self.senpy.plugins()) >= 3
assert self.senpy.get_plugin("Sleep")
2014-11-07 18:12:21 +00:00
2017-03-30 15:38:17 +00:00
def test_installing_nonexistent(self):
""" Fail if the dependencies cannot be met """
info = {
'name': 'TestPipFail',
'module': 'dummy',
'description': None,
'requirements': ['IAmMakingThisPackageNameUpToFail'],
'version': 0
}
with self.assertRaises(Error):
plugins.install_deps(info)
2017-03-30 15:38:17 +00:00
2014-11-07 18:12:21 +00:00
def test_default(self):
""" Default plugin should be set """
assert self.senpy.default_plugin
assert self.senpy.default_plugin.name == "dummy"
def test_noplugin(self):
""" Don't analyse if there isn't any plugin installed """
nosenpy = Senpy(default_plugins=False, plugin_folders=[])
2017-06-21 17:58:18 +00:00
self.assertRaises(Error, partial(analyse, self.senpy, input="tupni"))
2014-11-07 18:12:21 +00:00
def test_analyse(self):
""" Using a plugin """
# I was using mock until plugin started inheriting
# Leaf (defaultdict with __setattr__ and __getattr__.
2017-06-21 17:58:18 +00:00
r1 = analyse(self.senpy, algorithm="Dummy", input="tupni", output="tuptuo")
r2 = analyse(self.senpy, input="tupni", output="tuptuo")
assert r1.activities[0].algorithm == "endpoint:plugins/dummy_0.1"
assert r2.activities[0].algorithm == "endpoint:plugins/dummy_0.1"
assert r1.entries[0]['nif:isString'] == 'input'
def test_analyse_empty(self):
""" Trying to analyse when no plugins are installed should raise an error."""
app = Flask('test_adding_folder')
senpy = Senpy(plugin_folder=None,
app=app,
default_plugins=False)
self.assertRaises(Error, senpy.analyse, Results(), [])
def test_analyse_wrong(self):
""" Trying to analyse with a non-existent plugin should raise an error."""
self.assertRaises(Error, analyse, self.senpy, algorithm='DOES NOT EXIST', input='test')
def test_analyse_jsonld(self):
""" Using a plugin with JSON-LD input"""
js_input = '''{
"@id": "prueba",
"@type": "results",
"entries": [
{"@id": "entry1",
2017-06-21 17:58:18 +00:00
"nif:isString": "tupni",
"@type": "entry"
}
]
}'''
2017-06-21 17:58:18 +00:00
r1 = analyse(self.senpy,
algorithm="Dummy",
input=js_input,
informat="json-ld",
output="tuptuo")
r2 = analyse(self.senpy,
input="tupni",
output="tuptuo")
assert r1.activities[0].algorithm == "endpoint:plugins/dummy_0.1"
assert r2.activities[0].algorithm == "endpoint:plugins/dummy_0.1"
assert r1.entries[0]['nif:isString'] == 'input'
2014-11-07 18:12:21 +00:00
def test_analyse_error(self):
class ErrorPlugin(plugins.Analyser):
author: str = 'nobody'
version = 0
ex = Error()
def process(self, *args, **kwargs):
raise self.ex
m = ErrorPlugin(ex=Error('error in analysis', status=500))
self.senpy.add_plugin(m)
2017-03-13 20:06:19 +00:00
try:
analyse(self.senpy, input='nothing', algorithm='ErrorPlugin')
2017-03-13 20:06:19 +00:00
assert False
except Error as ex:
2017-06-21 17:58:18 +00:00
assert 'error in analysis' in ex['message']
2017-03-13 20:06:19 +00:00
assert ex['status'] == 500
m.ex = Exception('generic exception on analysis')
2017-03-13 20:06:19 +00:00
try:
analyse(self.senpy, input='nothing', algorithm='ErrorPlugin')
2017-03-13 20:06:19 +00:00
assert False
except Exception as ex:
2018-01-18 12:25:20 +00:00
assert 'generic exception on analysis' in str(ex)
2014-11-07 18:12:21 +00:00
def test_filtering(self):
""" Filtering plugins """
assert len(self.senpy.plugins(name="Dummy")) > 0
assert not len(self.senpy.plugins(name="NotDummy"))
def test_load_default_plugins(self):
senpy = Senpy(plugin_folder=self.examples_dir, default_plugins=True)
assert len(senpy.plugins()) > 1
2017-02-28 03:01:05 +00:00
def test_convert_emotions(self):
2017-03-13 20:06:19 +00:00
plugin = Plugin({
2017-02-28 03:01:05 +00:00
'id': 'imaginary',
'onyx:usesEmotionModel': 'emoml:fsre-dimensions'
2017-03-13 20:06:19 +00:00
})
2017-02-28 03:01:05 +00:00
eSet1 = EmotionSet()
activity = plugin.activity()
eSet1.prov(activity)
2017-02-28 03:01:05 +00:00
eSet1['onyx:hasEmotion'].append(Emotion({
'emoml:arousal': 1,
'emoml:potency': 0,
'emoml:valence': 0
}))
response = Results({
'activities': [activity],
2017-02-28 03:01:05 +00:00
'entries': [Entry({
'nif:isString': 'much ado about nothing',
'onyx:hasEmotionSet': [eSet1]
2017-02-28 03:01:05 +00:00
})]
})
params = {'emotion-model': 'emoml:big6',
'algorithm': ['conversion'],
2017-02-28 03:01:05 +00:00
'conversion': 'full'}
r1 = deepcopy(response)
2017-06-21 17:58:18 +00:00
r1.parameters = params
self.senpy.analyse(r1)
2017-02-28 03:01:05 +00:00
assert len(r1.entries[0].emotions) == 2
params['conversion'] = 'nested'
r2 = deepcopy(response)
2017-06-21 17:58:18 +00:00
r2.parameters = params
self.senpy.analyse(r2)
2017-02-28 03:01:05 +00:00
assert len(r2.entries[0].emotions) == 1
assert r2.entries[0].emotions[0]['prov:wasDerivedFrom'] == eSet1
params['conversion'] = 'filtered'
r3 = deepcopy(response)
2017-06-21 17:58:18 +00:00
r3.parameters = params
self.senpy.analyse(r3)
2017-02-28 03:01:05 +00:00
assert len(r3.entries[0].emotions) == 1
r3.jsonld()
def testDefaultPlugins(self):
'''The default set of plugins should all load'''
self.app = Flask('test_extensions')
self.examples_dir = os.path.join(os.path.dirname(__file__), '..', 'example-plugins')
2023-09-26 17:47:23 +00:00
self.senpy = Senpy(app=self.app, default_plugins=False)