#!/usr/bin/env python

#############################################################################
##
# This file is part of Taurus
##
# http://taurus-scada.org
##
# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
# Taurus is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
##
# Taurus 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 Lesser General Public License for more details.
##
# You should have received a copy of the GNU Lesser General Public License
# along with Taurus.  If not, see <http://www.gnu.org/licenses/>.
##
#############################################################################

"""Test for taurus.core.tango.test.test_tangovalidator..."""

#__all__ = []

__docformat__ = 'restructuredtext'


from taurus.external import unittest
from taurus.core.test import (valid, invalid, names,
                              AbstractNameValidatorTestCase)
from taurus.core.tango.tangovalidator import (TangoAuthorityNameValidator,
                                              TangoDeviceNameValidator,
                                              TangoAttributeNameValidator)

import PyTango
__GETENV = PyTango.ApiUtil.get_env_var


#=========================================================================
# Tests for Tango Authority  name validation
#=========================================================================
@valid(name='tango://foo:10000')
@invalid(name='tango:foo')
@invalid(name='tango:foo:10000')
@invalid(name='tango://foo:10000/')
@invalid(name='tango://foo:10000/?')
@invalid(name='tango://foo:bar')
@invalid(name='tango://foo:10000/foo')
@names(name='tango://foo:123',
       out=('tango://foo:123', '//foo:123', 'foo:123'))
@names(name='//foo:123',  # using implicit scheme!
       out=('tango://foo:123', '//foo:123', 'foo:123'))
class TangoAuthValidatorTestCase(AbstractNameValidatorTestCase,
                                 unittest.TestCase):
    validator = TangoAuthorityNameValidator


#=========================================================================
# Tests for Tango Device name validation
#=========================================================================
@valid(name='tango:foo', groups={'devname': 'foo',
                                 '_devalias': 'foo',
                                 '_devslashname': None})
@valid(name='tango:a/b/c', groups={'devname': 'a/b/c',
                                   '_devalias': None,
                                   '_devslashname': 'a/b/c'})
@valid(name='tango://foo:123/a/b/c', groups={'devname': 'a/b/c',
                                             '_devalias': None,
                                             '_devslashname': 'a/b/c'})
@valid(name='tango:a/b/ c', groups={'devname': 'a/b/ c'})
@invalid(name='tango:/a/b/c?')
@valid(name='tango://a/b/c', strict=False)
@invalid(name='tango://a/b/c', strict=True)
@invalid(name='tango://devalias')
@names(name='tango://foo:123/a/b/c',
       out=('tango://foo:123/a/b/c', '//foo:123/a/b/c', 'a/b/c'))
@names(name='tango:sys/tg_test/1',
       out=('tango://%s/sys/tg_test/1' % __GETENV("TANGO_HOST"),
            'sys/tg_test/1', 'sys/tg_test/1'))
@names(name='tango:alias', out=(None, None, 'alias'))
# @names(name = 'tango:mot49', # commented out because it assumes mot49 exists
#        out=('tango://%s/motor/motctrl13/1'% __GETENV("TANGO_HOST"),
#             'motor/motctrl13/1', 'mot49'))
class TangoDevValidatorTestCase(AbstractNameValidatorTestCase,
                                unittest.TestCase):
    validator = TangoDeviceNameValidator


#=========================================================================
# Tests for Tango Attribute name validation (without fragment)
#=========================================================================
@valid(name='tango:a/b/c/d', groups={'devname': 'a/b/c',
                                     'attrname': 'a/b/c/d',
                                     '_shortattrname': 'd'})
@valid(name='tango:alias/attr', groups={'devname': 'alias',
                                        '_devalias': 'alias',
                                        'attrname': 'alias/attr',
                                        '_shortattrname': 'attr'})
@valid(name='tango://a/b/c/d', strict=False)
@valid(name='tango://alias/attr', strict=False)
@invalid(name='tango://a/b/c/d')
@invalid(name='tango://a/b/c/')
@invalid(name='tango://alias/attr')
@invalid(name='tango://a/b/c/d?')
@invalid(name='tango:a/b/c')
@invalid(name='tango:sys/tg_test/1')
@names(name='tango://foo:123/a/b/c/d',
       out=('tango://foo:123/a/b/c/d', '//foo:123/a/b/c/d', 'd'))
@names(name='tango:sys/tg_test/1/float_scalar',
       out=('tango://%s/sys/tg_test/1/float_scalar' % __GETENV("TANGO_HOST"),
            'sys/tg_test/1/float_scalar', 'float_scalar'))
# @names(name = 'tango:mot49/position', # commented out because it assumes mot49
#        out=('tango://%s/motor/motctrl13/1/position'% __GETENV("TANGO_HOST"),
#             'motor/motctrl13/1/position', 'position'))
#=========================================================================
# Tests for validation of Attribute name with fragment
#=========================================================================
@valid(name='tango:a/b/c/d#',
       groups={'devname': 'a/b/c', 'attrname': 'a/b/c/d', '_shortattrname': 'd',
               'cfgkey': ''})
@valid(name='tango:a/b/c/d#label',
       groups={'devname': 'a/b/c', 'attrname': 'a/b/c/d', '_shortattrname': 'd',
               'cfgkey': 'label'})
@valid(name='tango:alias/attr#')
@valid(name='tango:alias/attr#label')
@valid(name='tango://a/b/c/d?configuration', strict=False)
@valid(name='tango://a/b/c/d?configuration=label', strict=False,
       groups={'devname': 'a/b/c',
               'attrname': 'a/b/c/d',
               '_shortattrname': 'd',
               'cfgkey': 'label',
               'fragment': 'label'})  # fragment=cfgkey (in non-strict mode)
@invalid(name='tango://a/b/c/d#')
@invalid(name='tango://a/b/c/d?foo', strict=False)
@invalid(name='tango://a/b/c/d?foo=label', strict=False)
@valid(name='tango:a/b/c/d#?foo=label')  # "?" is allowed in cfgkeys!
@valid(name='tango:a/b/c/d#label?foo=bar')
@names(name='tango://foo:123/a/b/c/d#',
       out=('tango://foo:123/a/b/c/d',
            '//foo:123/a/b/c/d', 'd', ''))
@names(name='tango://foo:123/a/b/c/d#label',
       out=('tango://foo:123/a/b/c/d',
            '//foo:123/a/b/c/d', 'd', 'label'))
@names(name='tango:sys/tg_test/1/float_scalar#',
       out=('tango://%s/sys/tg_test/1/float_scalar' %
            __GETENV("TANGO_HOST"),
            'sys/tg_test/1/float_scalar', 'float_scalar', ''))
@names(name='tango://foo:123/a/b/c/d?configuration=label',
       out=('tango://foo:123/a/b/c/d',
            '//foo:123/a/b/c/d', 'd', 'label'))
class TangoAttrValidatorTestCase(AbstractNameValidatorTestCase,
                                 unittest.TestCase):
    validator = TangoAttributeNameValidator


if __name__ == '__main__':
    pass
