# -*- 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 # # ***************************************************************************** """test data types.""" # no fixtures needed import pytest from secop.datatypes import ArrayOf, BLOBType, BoolType, \ CommandType, ConfigError, DataType, Enum, EnumType, FloatRange, \ IntRange, ProgrammingError, ScaledInteger, StatusType, \ StringType, StructOf, TextType, TupleOf, get_datatype def copytest(dt): assert repr(dt) == repr(dt.copy()) assert dt.export_datatype() == dt.copy().export_datatype() assert dt != dt.copy() def test_DataType(): dt = DataType() with pytest.raises(NotImplementedError): dt.export_datatype() with pytest.raises(NotImplementedError): dt('') dt.export_value('') dt.import_value('') def test_FloatRange(): dt = FloatRange(-3.14, 3.14) copytest(dt) assert dt.export_datatype() == {'type': 'double', 'min':-3.14, 'max':3.14} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt(-9) with pytest.raises(ValueError): dt('XX') with pytest.raises(ValueError): dt([19, 'X']) dt(1) dt(0) dt(13.14 - 10) # raises an error, if resolution is not handled correctly assert dt.export_value(-2.718) == -2.718 assert dt.import_value(-2.718) == -2.718 with pytest.raises(ProgrammingError): FloatRange('x', 'Y') # check that unit can be changed dt.setProperty('unit', 'K') assert dt.export_datatype() == {'type': 'double', 'min':-3.14, 'max':3.14, 'unit': 'K'} with pytest.raises(KeyError): dt.setProperty('visibility', 0) dt.setProperty('absolute_resolution', 0) dt = FloatRange() copytest(dt) assert dt.export_datatype() == {'type': 'double'} dt = FloatRange(unit='X', fmtstr='%.2f', absolute_resolution=1, relative_resolution=0.1) copytest(dt) assert dt.export_datatype() == {'type': 'double', 'unit':'X', 'fmtstr':'%.2f', 'absolute_resolution':1.0, 'relative_resolution':0.1} assert dt(4) == 4 assert dt.format_value(3.14) == '3.14 X' assert dt.format_value(3.14, '') == '3.14' assert dt.format_value(3.14, '#') == '3.14 #' dt.setProperty('min', 1) dt.setProperty('max', 0) with pytest.raises(ConfigError): dt.checkProperties() with pytest.raises(ProgrammingError): FloatRange(resolution=1) def test_IntRange(): dt = IntRange(-3, 3) copytest(dt) assert dt.export_datatype() == {'type': 'int', 'min':-3, 'max':3} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt(-9) with pytest.raises(ValueError): dt('XX') with pytest.raises(ValueError): dt([19, 'X']) with pytest.raises(ValueError): dt(1.3) with pytest.raises(ValueError): dt('1.3') dt(1) dt(0) dt('1') with pytest.raises(ProgrammingError): IntRange('xc', 'Yx') dt = IntRange() copytest(dt) assert dt.export_datatype()['type'] == 'int' assert dt.export_datatype()['min'] < 0 < dt.export_datatype()['max'] assert dt.export_datatype() == {'type': 'int', 'max': 16777216,'min': -16777216} assert dt.format_value(42) == '42' dt.setProperty('min', 1) dt.setProperty('max', 0) with pytest.raises(ConfigError): dt.checkProperties() def test_ScaledInteger(): dt = ScaledInteger(0.01, -3, 3) copytest(dt) # serialisation of datatype contains limits on the 'integer' value assert dt.export_datatype() == {'type': 'scaled', 'scale':0.01, 'min':-300, 'max':300} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt(-9) with pytest.raises(ValueError): dt('XX') with pytest.raises(ValueError): dt([19, 'X']) dt(1) dt(0) with pytest.raises(ValueError): ScaledInteger('xc', 'Yx') with pytest.raises(ProgrammingError): ScaledInteger(scale=0, minval=1, maxval=2) with pytest.raises(ProgrammingError): ScaledInteger(scale=-10, minval=1, maxval=2) # check that unit can be changed dt.setProperty('unit', 'A') assert dt.export_datatype() == {'type': 'scaled', 'scale':0.01, 'min':-300, 'max':300, 'unit': 'A'} assert dt.export_value(0.0001) == int(0) assert dt.export_value(2.71819) == int(272) assert dt.import_value(272) == 2.72 dt.setProperty('scale', 0.1) assert dt.export_datatype() == {'type': 'scaled', 'scale':0.1, 'min':-30, 'max':30, 'unit':'A'} assert dt.absolute_resolution == dt.scale dt = ScaledInteger(0.003, 0, 1, unit='X', fmtstr='%.1f', absolute_resolution=0.001, relative_resolution=1e-5) copytest(dt) assert dt.export_datatype() == {'type': 'scaled', 'scale':0.003, 'min':0, 'max':333, 'unit':'X', 'fmtstr':'%.1f', 'absolute_resolution':0.001, 'relative_resolution':1e-5} assert dt(0.4) == 0.399 assert dt.format_value(0.4) == '0.4 X' assert dt.format_value(0.4, '') == '0.4' assert dt.format_value(0.4, 'Z') == '0.4 Z' assert dt(1.0029) == 0.999 with pytest.raises(ValueError): dt(1.004) dt.setProperty('min', 1) dt.setProperty('max', 0) with pytest.raises(ConfigError): dt.checkProperties() with pytest.raises(ValueError): dt.setProperty('scale', None) def test_EnumType(): # test constructor catching illegal arguments with pytest.raises(TypeError): EnumType(1) with pytest.raises(TypeError): EnumType(['b', 0]) dt = EnumType('dt', a=3, c=7, stuff=1) copytest(dt) assert dt.export_datatype() == {'type': 'enum', 'members': dict(a=3, c=7, stuff=1)} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt(-9) with pytest.raises(ValueError): dt('XX') with pytest.raises(ValueError): dt([19, 'X']) assert dt('a') == 3 assert dt('stuff') == 1 assert dt(1) == 1 with pytest.raises(ValueError): dt(2) assert dt.export_value('c') == 7 assert dt.export_value('stuff') == 1 assert dt.export_value(1) == 1 assert dt.import_value('c') == 7 assert dt.import_value('a') == 3 assert dt.import_value('stuff') == 1 with pytest.raises(ValueError): dt.export_value(2) with pytest.raises(ValueError): dt.import_value('A') assert dt.format_value(3) == 'a<3>' def test_BLOBType(): # test constructor catching illegal arguments dt = BLOBType() copytest(dt) assert dt.export_datatype() == {'type': 'blob', 'maxbytes':255} dt = BLOBType(10) copytest(dt) assert dt.export_datatype() == {'type': 'blob', 'minbytes':10, 'maxbytes':10} dt = BLOBType(3, 10) copytest(dt) assert dt.export_datatype() == {'type': 'blob', 'minbytes':3, 'maxbytes':10} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt(b'av') with pytest.raises(ValueError): dt(b'abcdefghijklmno') with pytest.raises(ValueError): dt('abcd') assert dt(b'abcd') == b'abcd' dt.setProperty('minbytes', 1) dt.setProperty('maxbytes', 0) with pytest.raises(ConfigError): dt.checkProperties() assert dt.export_value(b'abcd') == 'YWJjZA==' assert dt.export_value(b'abcd') == 'YWJjZA==' # assert dt.export_value('abcd') == 'YWJjZA==' assert dt.import_value('YWJjZA==') == b'abcd' # XXX: right? or different format? # to be added after migration to py3 # assert dt.format_value(b'ab\0cd') == "b'ab\\x00cd\'" def test_StringType(): # test constructor catching illegal arguments dt = StringType() copytest(dt) assert dt.export_datatype() == {'type': 'string'} dt = StringType(12) copytest(dt) assert dt.export_datatype() == {'type': 'string', 'minchars':12, 'maxchars':12} dt = StringType(4, 11) copytest(dt) assert dt.export_datatype() == {'type': 'string', 'minchars':4, 'maxchars':11} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt('av') with pytest.raises(ValueError): dt('abcdefghijklmno') with pytest.raises(ValueError): dt('abcdefg\0') assert dt('abcd') == 'abcd' # tests with bytes have to be added after migration to py3 #assert dt(b'abcd') == 'abcd' assert dt.export_value('abcd') == 'abcd' # assert dt.export_value(b'abcd') == 'abcd' assert dt.import_value('abcd') == 'abcd' assert dt.format_value('abcd') == "'abcd'" dt.setProperty('minchars', 1) dt.setProperty('maxchars', 0) with pytest.raises(ConfigError): dt.checkProperties() def test_TextType(): # test constructor catching illegal arguments dt = TextType(12) copytest(dt) assert dt.export_datatype() == {'type': 'string', 'maxchars':12} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt('abcdefghijklmno') with pytest.raises(ValueError): dt('abcdefg\0') assert dt('ab\n\ncd\n') == 'ab\n\ncd\n' # assert dt(b'ab\n\ncd\n') == 'ab\n\ncd\n' assert dt.export_value('abcd') == 'abcd' # assert dt.export_value(b'abcd') == b'abcd' assert dt.export_value('abcd') == 'abcd' assert dt.import_value('abcd') == 'abcd' def test_BoolType(): # test constructor catching illegal arguments dt = BoolType() copytest(dt) assert dt.export_datatype() == {'type': 'bool'} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt('av') assert dt('true') is True assert dt('off') is False assert dt(1) is True assert dt.export_value('false') is False assert dt.export_value(0) is False assert dt.export_value('on') is True assert dt.import_value(False) is False assert dt.import_value(True) is True with pytest.raises(ValueError): dt.import_value('av') assert dt.format_value(0) == "False" assert dt.format_value(True) == "True" with pytest.raises(TypeError): # pylint: disable=unexpected-keyword-arg BoolType(unit='K') 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) copytest(dt) assert dt.export_datatype() == {'type': 'array', 'minlen':5, 'maxlen':5, 'members': {'type': 'int', 'min':-10, 'max':10}} dt = ArrayOf(FloatRange(-10, 10, unit='Z'), 1, 3) copytest(dt) assert dt.export_datatype() == {'type': 'array', 'minlen':1, 'maxlen':3, 'members':{'type': 'double', 'min':-10, 'max':10, 'unit': 'Z'}} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt('av') assert dt([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]) == '[1, 2, 3] Z' assert dt.format_value([1,2,3], '') == '[1, 2, 3]' assert dt.format_value([1,2,3], 'Q') == '[1, 2, 3] Q' dt = ArrayOf(FloatRange(unit='K')) assert dt.members.unit == 'K' dt.setProperty('unit', 'mm') with pytest.raises(TypeError): # pylint: disable=unexpected-keyword-arg ArrayOf(BoolType(), unit='K') dt.setProperty('minlen', 1) dt.setProperty('maxlen', 0) with pytest.raises(ConfigError): dt.checkProperties() dt = ArrayOf(EnumType('myenum', single=0), 5) copytest(dt) def test_TupleOf(): # test constructor catching illegal arguments with pytest.raises(ValueError): TupleOf(2) dt = TupleOf(IntRange(-10, 10), BoolType()) copytest(dt) assert dt.export_datatype() == {'type': 'tuple', 'members':[{'type': 'int', 'min':-10, 'max':10}, {'type': 'bool'}]} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt([99, 'X']) assert dt([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]) == "(3, False)" dt = TupleOf(EnumType('myenum', single=0)) copytest(dt) 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=['an_int']) copytest(dt) assert dt.export_datatype() == {'type': 'struct', 'members':{'a_string': {'type': 'string', 'maxchars':55}, 'an_int': {'type': 'int', 'min':0, 'max':999}}, 'optional':['an_int']} with pytest.raises(ValueError): dt(9) with pytest.raises(ValueError): dt([99, 'X']) with pytest.raises(ValueError): dt(dict(a_string='XXX', an_int=1811)) assert dt(dict(a_string='XXX', an_int=8)) == {'a_string': 'XXX', 'an_int': 8} assert dt.export_value({'an_int': 13, 'a_string': 'WFEC'}) == { 'a_string': 'WFEC', 'an_int': 13} assert dt.import_value({'an_int': 13, 'a_string': 'WFEC'}) == { 'a_string': 'WFEC', 'an_int': 13} assert dt.format_value({'an_int':2, 'a_string':'Z'}) == "{a_string='Z', an_int=2}" dt = StructOf(['optionalmember'], optionalmember=EnumType('myenum', single=0)) copytest(dt) def test_Command(): dt = CommandType() assert dt.export_datatype() == {'type': 'command'} dt = CommandType(IntRange(-1,1)) assert dt.export_datatype() == {'type': 'command', 'argument':{'type': 'int', 'min':-1, 'max':1}} dt = CommandType(IntRange(-1,1), IntRange(-3,3)) assert dt.export_datatype() == {'type': 'command', 'argument':{'type': 'int', 'min':-1, 'max':1}, 'result':{'type': 'int', 'min':-3, 'max':3}} def test_StatusType(): status_codes = Enum('Status', IDLE=100, WARN=200, BUSY=300, ERROR=400) dt = StatusType(status_codes) assert dt.IDLE == status_codes.IDLE assert dt.ERROR == status_codes.ERROR assert dt._enum == status_codes 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({'undefined': {}}) assert isinstance(get_datatype({'type': 'bool'}), BoolType) with pytest.raises(ValueError): get_datatype(['bool']) with pytest.raises(ValueError): get_datatype({'type': 'int', 'min':-10}) # missing max with pytest.raises(ValueError): get_datatype({'type': 'int', 'max':10}) # missing min assert isinstance(get_datatype({'type': 'int', 'min':-10, 'max':10}), IntRange) with pytest.raises(ValueError): get_datatype({'type': 'int', 'min':10, 'max':-10}) # min > max with pytest.raises(ValueError): get_datatype({'type': 'int'}) # missing limits with pytest.raises(ValueError): get_datatype({'type': 'int', 'x': 2}) assert isinstance(get_datatype({'type': 'double'}), FloatRange) assert isinstance(get_datatype({'type': 'double', 'min':-2.718}), FloatRange) assert isinstance(get_datatype({'type': 'double', 'max':3.14}), FloatRange) assert isinstance(get_datatype({'type': 'double', 'min':-9.9, 'max':11.1}), FloatRange) with pytest.raises(ValueError): get_datatype(['double']) with pytest.raises(ValueError): get_datatype({'type': 'double', 'min':10, 'max':-10}) with pytest.raises(ValueError): get_datatype(['double', {}, 2]) with pytest.raises(ValueError): get_datatype({'type': 'scaled', 'scale':0.01, 'min':-2.718}) with pytest.raises(ValueError): get_datatype({'type': 'scaled', 'scale':0.02, 'max':3.14}) assert isinstance(get_datatype( {'type': 'scaled', 'scale':0.03, 'min':-99, 'max':111}), ScaledInteger) dt = ScaledInteger(scale=0.03, minval=0, maxval=9.9) assert dt.export_datatype() == {'type': 'scaled', 'max':330, 'min':0, 'scale':0.03} assert get_datatype(dt.export_datatype()).export_datatype() == dt.export_datatype() with pytest.raises(ValueError): get_datatype(['scaled']) # dict missing with pytest.raises(ValueError): get_datatype({'type': 'scaled', 'min':-10, 'max':10}) # no scale with pytest.raises(ValueError): get_datatype({'type': 'scaled', 'min':10, 'max':-10, 'scale': 1}) # limits reversed with pytest.raises(ValueError): get_datatype(['scaled', {'min':10, 'max':-10, 'scale': 1}, 2]) with pytest.raises(ValueError): get_datatype(['enum']) with pytest.raises(ValueError): get_datatype({'type': 'enum', 'a': -2}) assert isinstance(get_datatype({'type': 'enum', 'members':dict(a=-2)}), EnumType) assert isinstance(get_datatype({'type': 'blob', 'maxbytes':1}), BLOBType) assert isinstance(get_datatype({'type': 'blob', 'minbytes':1, 'maxbytes':10}), BLOBType) with pytest.raises(ValueError): get_datatype({'type': 'blob', 'minbytes':10, 'maxbytes':1}) with pytest.raises(ValueError): get_datatype({'type': 'blob', 'minbytes':10, 'maxbytes':-10}) with pytest.raises(ValueError): get_datatype(['blob', {'maxbytes':10}, 'x']) assert isinstance(get_datatype({'type': 'string', 'maxchars':1}), StringType) assert isinstance(get_datatype({'type': 'string', 'maxchars':1}), StringType) assert isinstance(get_datatype({'type': 'string', 'minchars':1, 'maxchars':10}), StringType) with pytest.raises(ValueError): get_datatype({'type': 'string', 'minchars':10, 'maxchars':1}) with pytest.raises(ValueError): get_datatype({'type': 'string', 'minchars':10, 'maxchars':-10}) with pytest.raises(ValueError): get_datatype(['string', {'maxchars':-0}, 'x']) with pytest.raises(ValueError): get_datatype(['array']) with pytest.raises(ValueError): get_datatype({'type': 'array', 'members': [1]}) assert isinstance(get_datatype({'type': 'array', 'minlen':1, 'maxlen':1, 'members':{'type': 'blob', 'maxbytes':1}} ), ArrayOf) assert isinstance(get_datatype({'type': 'array', 'minlen':1, 'maxlen':1, 'members':{'type': 'blob', 'maxbytes':1}} ).members, BLOBType) with pytest.raises(ValueError): get_datatype({'type': 'array', 'members':{'type': 'blob', 'maxbytes':1}, 'minbytes':-10}) with pytest.raises(ValueError): get_datatype({'type': 'array', 'members':{'type': 'blob', 'maxbytes':1}, 'min':10, 'max':1}) with pytest.raises(ValueError): get_datatype({'type': 'array', 'blob': dict(max=4), 'maxbytes': 10}) with pytest.raises(ValueError): get_datatype(['tuple']) with pytest.raises(ValueError): get_datatype(['tuple', [1], 2, 3]) assert isinstance(get_datatype( {'type': 'tuple', 'members':[{'type': 'blob', 'maxbytes':1}]}), TupleOf) assert isinstance(get_datatype( {'type': 'tuple', 'members':[{'type': 'blob', 'maxbytes':1}]}).members[0], BLOBType) with pytest.raises(ValueError): get_datatype({'type': 'tuple', 'members': {}}) with pytest.raises(ValueError): get_datatype(['tuple', 10, -10]) assert isinstance(get_datatype({'type': 'tuple', 'members':[{'type': 'blob', 'maxbytes':1}, {'type': 'bool'}]}), TupleOf) with pytest.raises(ValueError): get_datatype(['struct']) with pytest.raises(ValueError): get_datatype(['struct', [1], 2, 3]) assert isinstance(get_datatype({'type': 'struct', 'members': {'name': {'type': 'blob', 'maxbytes':1}}}), StructOf) assert isinstance(get_datatype({'type': 'struct', 'members': {'name': {'type': 'blob', 'maxbytes':1}}}).members['name'], BLOBType) with pytest.raises(ValueError): get_datatype({'type': 'struct', 'members': {}}) with pytest.raises(ValueError): get_datatype({'type': 'struct', 'members':[1,2,3]}) @pytest.mark.parametrize('dt, contained_in', [ (FloatRange(-10, 10), FloatRange()), (IntRange(-10, 10), FloatRange()), (IntRange(-10, 10), IntRange(-20, 10)), (StringType(), StringType(isUTF8=True)), (StringType(10, 10), StringType()), (ArrayOf(StringType(), 3, 5), ArrayOf(StringType(), 3, 6)), (TupleOf(StringType(), BoolType()), TupleOf(StringType(), IntRange())), (StructOf(a=FloatRange(-1,1)), StructOf(a=FloatRange(), b=BoolType(), optional=['b'])), ]) def test_oneway_compatible(dt, contained_in): dt.compatible(contained_in) with pytest.raises(ValueError): contained_in.compatible(dt) @pytest.mark.parametrize('dt1, dt2', [ (FloatRange(-5.5, 5.5), ScaledInteger(10, -5.5, 5.5)), (IntRange(0,1), BoolType()), (IntRange(-10, 10), IntRange(-10, 10)), ]) def test_twoway_compatible(dt1, dt2): dt1.compatible(dt1) dt2.compatible(dt2) @pytest.mark.parametrize('dt1, dt2', [ (StringType(), FloatRange()), (IntRange(-10, 10), StringType()), (StructOf(a=BoolType(), b=BoolType()), ArrayOf(StringType(), 2)), (ArrayOf(BoolType(), 2), TupleOf(BoolType(), StringType())), (TupleOf(BoolType(), BoolType()), StructOf(a=BoolType(), b=BoolType())), (ArrayOf(StringType(), 3), ArrayOf(BoolType(), 3)), (TupleOf(StringType(), BoolType()), TupleOf(BoolType(), BoolType())), (StructOf(a=FloatRange(-1, 1), b=StringType()), StructOf(a=FloatRange(), b=BoolType())), ]) def test_incompatible(dt1, dt2): with pytest.raises(ValueError): dt1.compatible(dt2) with pytest.raises(ValueError): dt2.compatible(dt1)