frappy/test/test_datatypes.py
Markus Zolliker bc33f263ec as_json on FloatRange and ScaledInteger must be a property
as the unit property may be set in the config file, the datatype
might change after creation.
This proposed implementation changes the internal name of *_precision
to its full name, as this is easier for the way it is done.

IntRange is not yet modified, as anyway 'unit' (and 'fmtstr') should
not be applied to it, this is not forseen in the standard.

Questions for further work:
- should we also allow to configure 'fmtstr'?
- should it be allowed to change min, max from configuration?
- if yes, what is the proper way to do it?

Change-Id: I1fda7e8274109fdcca3c792c0a6e3dc6664cc45e
Reviewed-on: https://forge.frm2.tum.de/review/20304
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2019-04-03 12:56:08 +02:00

504 lines
18 KiB
Python

# -*- coding: utf-8 -*-
# *****************************************************************************
#
# 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 2 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, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Module authors:
# Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
#
# *****************************************************************************
"""test data types."""
from __future__ import division, print_function
# no fixtures needed
import pytest
from secop.datatypes import ArrayOf, BLOBType, BoolType, \
DataType, EnumType, FloatRange, IntRange, ProgrammingError, \
ScaledInteger, StringType, StructOf, TupleOf, get_datatype
def test_DataType():
dt = DataType()
assert dt.as_json == [u'undefined']
with pytest.raises(NotImplementedError):
dt = DataType()
dt.validate('')
dt.export_value('')
dt.import_value('')
def test_FloatRange():
dt = FloatRange(-3.14, 3.14)
assert dt.as_json == [u'double', {u'min':-3.14, u'max':3.14}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(-9)
with pytest.raises(ValueError):
dt.validate(u'XX')
with pytest.raises(ValueError):
dt.validate([19, u'X'])
dt.validate(1)
dt.validate(0)
assert dt.export_value(-2.718) == -2.718
assert dt.import_value(-2.718) == -2.718
with pytest.raises(ValueError):
FloatRange(u'x', u'Y')
dt = FloatRange()
assert dt.as_json == [u'double', {}]
dt = FloatRange(unit=u'X', fmtstr=u'%r', absolute_precision=1,
relative_precision=0.1)
assert dt.as_json == [u'double', {u'unit':u'X', u'fmtstr':u'%r',
u'absolute_precision':1,
u'relative_precision':0.1}]
assert dt.validate(4) == 4
assert dt.format_value(3.14) == u'3.14 X'
assert dt.format_value(3.14, u'') == u'3.14'
assert dt.format_value(3.14, u'#') == u'3.14 #'
def test_IntRange():
dt = IntRange(-3, 3)
assert dt.as_json == [u'int', {u'min':-3, u'max':3}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(-9)
with pytest.raises(ValueError):
dt.validate(u'XX')
with pytest.raises(ValueError):
dt.validate([19, u'X'])
dt.validate(1)
dt.validate(0)
with pytest.raises(ValueError):
IntRange(u'xc', u'Yx')
dt = IntRange()
assert dt.as_json[0] == u'int'
assert dt.as_json[1][u'min'] < 0 < dt.as_json[1][u'max']
assert dt.as_json == [u'int', {u'max': 16777216, u'min': -16777216}]
assert dt.format_value(42) == u'42'
def test_ScaledInteger():
dt = ScaledInteger(0.01, -3, 3)
# serialisation of datatype contains limits on the 'integer' value
assert dt.as_json == [u'scaled', {u'scale':0.01, u'min':-300, u'max':300}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(-9)
with pytest.raises(ValueError):
dt.validate(u'XX')
with pytest.raises(ValueError):
dt.validate([19, u'X'])
dt.validate(1)
dt.validate(0)
with pytest.raises(ValueError):
ScaledInteger(u'xc', u'Yx')
with pytest.raises(ValueError):
ScaledInteger(scale=0, minval=1, maxval=2)
with pytest.raises(ValueError):
ScaledInteger(scale=-10, minval=1, maxval=2)
assert dt.export_value(0.0001) == int(0)
assert dt.export_value(2.71819) == int(272)
assert dt.import_value(272) == 2.72
dt = ScaledInteger(0.003, 0, 1, unit=u'X', fmtstr=u'%r',
absolute_precision=1, relative_precision=0.1)
assert dt.as_json == [u'scaled', {u'scale':0.003,u'min':0,u'max':333,
u'unit':u'X', u'fmtstr':u'%r',
u'absolute_precision':1,
u'relative_precision':0.1}]
assert dt.validate(0.4) == 0.399
assert dt.format_value(0.4) == u'0.4 X'
assert dt.format_value(0.4, u'') == u'0.4'
assert dt.format_value(0.4, u'Z') == u'0.4 Z'
def test_EnumType():
# test constructor catching illegal arguments
with pytest.raises(TypeError):
EnumType(1)
with pytest.raises(TypeError):
EnumType([u'b', 0])
dt = EnumType(u'dt', a=3, c=7, stuff=1)
assert dt.as_json == [u'enum', dict(members=dict(a=3, c=7, stuff=1))]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(-9)
with pytest.raises(ValueError):
dt.validate(u'XX')
with pytest.raises(TypeError):
dt.validate([19, u'X'])
assert dt.validate(u'a') == 3
assert dt.validate(u'stuff') == 1
assert dt.validate(1) == 1
with pytest.raises(ValueError):
dt.validate(2)
assert dt.export_value(u'c') == 7
assert dt.export_value(u'stuff') == 1
assert dt.export_value(1) == 1
assert dt.import_value(u'c') == 7
assert dt.import_value(u'a') == 3
assert dt.import_value(u'stuff') == 1
with pytest.raises(ValueError):
dt.export_value(2)
with pytest.raises(ValueError):
dt.import_value(u'A')
assert dt.format_value(3) == u'a<3>'
def test_BLOBType():
# test constructor catching illegal arguments
dt = BLOBType()
assert dt.as_json == [u'blob', {u'min':0, u'max':255}]
dt = BLOBType(10)
assert dt.as_json == [u'blob', {u'min':10, u'max':10}]
dt = BLOBType(3, 10)
assert dt.as_json == [u'blob', {u'min':3, u'max':10}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(u'av')
with pytest.raises(ValueError):
dt.validate(u'abcdefghijklmno')
assert dt.validate('abcd') == b'abcd'
assert dt.validate(b'abcd') == b'abcd'
assert dt.validate(u'abcd') == b'abcd'
assert dt.export_value('abcd') == u'YWJjZA=='
assert dt.export_value(b'abcd') == u'YWJjZA=='
assert dt.export_value(u'abcd') == u'YWJjZA=='
assert dt.import_value(u'YWJjZA==') == b'abcd'
# XXX: right? or different format?
assert dt.format_value(b'ab\0cd') == '\'ab\\x00cd\''
def test_StringType():
# test constructor catching illegal arguments
dt = StringType()
dt = StringType(12)
assert dt.as_json == [u'string', {u'min':12, u'max':12}]
dt = StringType(4, 11)
assert dt.as_json == [u'string', {u'min':4, u'max':11}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(u'av')
with pytest.raises(ValueError):
dt.validate(u'abcdefghijklmno')
with pytest.raises(ValueError):
dt.validate('abcdefg\0')
assert dt.validate('abcd') == b'abcd'
assert dt.validate(b'abcd') == b'abcd'
assert dt.validate(u'abcd') == b'abcd'
assert dt.export_value('abcd') == b'abcd'
assert dt.export_value(b'abcd') == b'abcd'
assert dt.export_value(u'abcd') == b'abcd'
assert dt.import_value(u'abcd') == u'abcd'
assert dt.format_value(u'abcd') == u"u'abcd'"
def test_BoolType():
# test constructor catching illegal arguments
dt = BoolType()
assert dt.as_json == [u'bool', {}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(u'av')
assert dt.validate(u'true') is True
assert dt.validate(u'off') is False
assert dt.validate(1) is True
assert dt.export_value(u'false') is False
assert dt.export_value(0) is False
assert dt.export_value(u'on') is True
assert dt.import_value(False) is False
assert dt.import_value(True) is True
with pytest.raises(ValueError):
dt.import_value(u'av')
assert dt.format_value(0) == u"False"
assert dt.format_value(True) == u"True"
def test_ArrayOf():
# test constructor catching illegal arguments
with pytest.raises(ValueError):
ArrayOf(int)
with pytest.raises(ValueError):
ArrayOf(-3, IntRange(-10,10))
dt = ArrayOf(IntRange(-10, 10), 5)
assert dt.as_json == [u'array', {u'min':5, u'max':5,
u'members':[u'int', {u'min':-10,
u'max':10}]}]
dt = ArrayOf(FloatRange(-10, 10, unit=u'Z'), 1, 3)
assert dt.as_json == [u'array', {u'min':1, u'max':3,
u'members':[u'double', {u'min':-10,
u'max':10,
u'unit':u'Z'}]}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate(u'av')
assert dt.validate([1, 2, 3]) == [1, 2, 3]
assert dt.export_value([1, 2, 3]) == [1, 2, 3]
assert dt.import_value([1, 2, 3]) == [1, 2, 3]
assert dt.format_value([1,2,3]) == u'[1, 2, 3] Z'
assert dt.format_value([1,2,3], u'') == u'[1, 2, 3]'
assert dt.format_value([1,2,3], u'Q') == u'[1, 2, 3] Q'
def test_TupleOf():
# test constructor catching illegal arguments
with pytest.raises(ValueError):
TupleOf(2)
dt = TupleOf(IntRange(-10, 10), BoolType())
assert dt.as_json == [u'tuple', {u'members':[[u'int', {u'min':-10,
u'max':10}],
[u'bool', {}]]}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate([99, 'X'])
assert dt.validate([1, True]) == [1, True]
assert dt.export_value([1, True]) == [1, True]
assert dt.import_value([1, True]) == [1, True]
assert dt.format_value([3,0]) == u"(3, False)"
def test_StructOf():
# test constructor catching illegal arguments
with pytest.raises(ValueError):
StructOf(IntRange) # pylint: disable=E1121
with pytest.raises(ProgrammingError):
StructOf(IntRange=1)
dt = StructOf(a_string=StringType(0, 55), an_int=IntRange(0, 999),
optional=[u'an_int'])
assert dt.as_json == [u'struct', {u'members':{u'a_string':
[u'string', {u'min':0, u'max':55}],
u'an_int':
[u'int', {u'min':0, u'max':999}],},
u'optional':[u'an_int'],
}]
with pytest.raises(ValueError):
dt.validate(9)
with pytest.raises(ValueError):
dt.validate([99, u'X'])
with pytest.raises(ValueError):
dt.validate(dict(a_string=u'XXX', an_int=1811))
assert dt.validate(dict(a_string=u'XXX', an_int=8)) == {u'a_string': u'XXX',
u'an_int': 8}
assert dt.export_value({u'an_int': 13, u'a_string': u'WFEC'}) == {
u'a_string': u'WFEC', u'an_int': 13}
assert dt.import_value({u'an_int': 13, u'a_string': u'WFEC'}) == {
u'a_string': u'WFEC', u'an_int': 13}
assert dt.format_value({u'an_int':2, u'a_string':u'Z'}) == u"{a_string=u'Z', an_int=2}"
def test_get_datatype():
with pytest.raises(ValueError):
get_datatype(1)
with pytest.raises(ValueError):
get_datatype(True)
with pytest.raises(ValueError):
get_datatype(str)
with pytest.raises(ValueError):
get_datatype([u'undefined'])
assert isinstance(get_datatype([u'bool', {}]), BoolType)
with pytest.raises(ValueError):
get_datatype([u'bool'])
with pytest.raises(ValueError):
get_datatype([u'bool', 3])
with pytest.raises(ValueError):
get_datatype([u'int', {u'min':-10}])
with pytest.raises(ValueError):
get_datatype([u'int', {u'max':10}])
assert isinstance(get_datatype([u'int', {u'min':-10, u'max':10}]), IntRange)
with pytest.raises(ValueError):
get_datatype([u'int', {u'min':10, u'max':-10}])
with pytest.raises(ValueError):
get_datatype([u'int'])
with pytest.raises(ValueError):
get_datatype([u'int', {}])
with pytest.raises(ValueError):
get_datatype([u'int', 1, 2])
assert isinstance(get_datatype([u'double', {}]), FloatRange)
assert isinstance(get_datatype([u'double', {u'min':-2.718}]), FloatRange)
assert isinstance(get_datatype([u'double', {u'max':3.14}]), FloatRange)
assert isinstance(get_datatype([u'double', {u'min':-9.9, u'max':11.1}]),
FloatRange)
with pytest.raises(ValueError):
get_datatype([u'double'])
with pytest.raises(ValueError):
get_datatype([u'double', {u'min':10, u'max':-10}])
with pytest.raises(ValueError):
get_datatype([u'double', 1, 2])
with pytest.raises(ValueError):
get_datatype([u'scaled', {u'scale':0.01,u'min':-2.718}])
with pytest.raises(ValueError):
get_datatype([u'scaled', {u'scale':0.02,u'max':3.14}])
assert isinstance(get_datatype([u'scaled', {u'scale':0.03,
u'min':-99,
u'max':111}]), ScaledInteger)
dt = ScaledInteger(scale=0.03, minval=0, maxval=9.9)
assert dt.as_json == [u'scaled', {u'max':330, u'min':0, u'scale':0.03}]
assert get_datatype(dt.as_json).as_json == dt.as_json
with pytest.raises(ValueError):
get_datatype([u'scaled']) # dict missing
with pytest.raises(ValueError):
get_datatype([u'scaled', {u'min':-10, u'max':10}]) # no scale
with pytest.raises(ValueError):
get_datatype([u'scaled', {u'min':10, u'max':-10}]) # limits reversed
with pytest.raises(ValueError):
get_datatype([u'scaled', {}, 1, 2]) # trailing data
with pytest.raises(ValueError):
get_datatype([u'enum'])
with pytest.raises(ValueError):
get_datatype([u'enum', dict(a=-2)])
assert isinstance(get_datatype([u'enum', {u'members':dict(a=-2)}]), EnumType)
with pytest.raises(ValueError):
get_datatype([u'enum', 10, -10])
with pytest.raises(ValueError):
get_datatype([u'enum', [1, 2, 3]])
assert isinstance(get_datatype([u'blob', {u'max':1}]), BLOBType)
assert isinstance(get_datatype([u'blob', {u'min':1, u'max':10}]), BLOBType)
with pytest.raises(ValueError):
get_datatype([u'blob', {u'min':10, u'max':1}])
with pytest.raises(ValueError):
get_datatype([u'blob', {u'min':10, u'max':-10}])
with pytest.raises(ValueError):
get_datatype([u'blob', 10, -10, 1])
with pytest.raises(ValueError):
get_datatype([u'string'])
assert isinstance(get_datatype([u'string', {u'min':1}]), StringType)
assert isinstance(get_datatype([u'string', {u'min':1, u'max':10}]), StringType)
with pytest.raises(ValueError):
get_datatype([u'string', {u'min':10, u'max':1}])
with pytest.raises(ValueError):
get_datatype([u'string', {u'min':10, u'max':-10}])
with pytest.raises(ValueError):
get_datatype([u'string', 10, -10, 1])
with pytest.raises(ValueError):
get_datatype([u'array'])
with pytest.raises(ValueError):
get_datatype([u'array', 1])
with pytest.raises(ValueError):
get_datatype([u'array', [1], 2, 3])
assert isinstance(get_datatype([u'array', {u'min':1, u'max':1,
u'members':[u'blob', {u'max':1}]}]
), ArrayOf)
assert isinstance(get_datatype([u'array', {u'min':1, u'max':1,
u'members':[u'blob', {u'max':1}]}]
).members, BLOBType)
with pytest.raises(ValueError):
get_datatype([u'array', {u'members':[u'blob', {u'max':1}], u'min':-10}])
with pytest.raises(ValueError):
get_datatype([u'array', {u'members':[u'blob', {u'max':1}],
u'min':10, 'max':1}])
with pytest.raises(ValueError):
get_datatype([u'array', [u'blob', 1], 10, -10])
with pytest.raises(ValueError):
get_datatype([u'tuple'])
with pytest.raises(ValueError):
get_datatype([u'tuple', 1])
with pytest.raises(ValueError):
get_datatype([u'tuple', [1], 2, 3])
assert isinstance(get_datatype([u'tuple', {u'members':[[u'blob',
{u'max':1}]]}]), TupleOf)
assert isinstance(get_datatype([u'tuple', {u'members':[[u'blob',
{u'max':1}]]}]).members[0], BLOBType)
with pytest.raises(ValueError):
get_datatype([u'tuple', {}])
with pytest.raises(ValueError):
get_datatype([u'tuple', 10, -10])
assert isinstance(get_datatype([u'tuple', {u'members':[[u'blob', {u'max':1}],
[u'bool',{}]]}]), TupleOf)
with pytest.raises(ValueError):
get_datatype([u'struct'])
with pytest.raises(ValueError):
get_datatype([u'struct', 1])
with pytest.raises(ValueError):
get_datatype([u'struct', [1], 2, 3])
assert isinstance(get_datatype([u'struct', {u'members':
{u'name': [u'blob', {u'max':1}]}}]), StructOf)
assert isinstance(get_datatype([u'struct', {u'members':
{u'name': [u'blob', {u'max':1}]}}]).members[u'name'], BLOBType)
with pytest.raises(ValueError):
get_datatype([u'struct', {}])
with pytest.raises(ValueError):
get_datatype([u'struct', {u'members':[1,2,3]}])