# Copyright (c) 2011 OpenStack Foundation
# All Rights Reserved.
#
#    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.

#import testtools
from lxml import etree
from troveclient.compat import xml


# Killing this until xml support is brought back.
#class XmlTest(testtools.TestCase):
class XmlTest(object):
    ELEMENT = '''
        <instances>
            <instance>
                <flavor>
                    <links>
                    </links>
                    <value value="5"/>
                </flavor>
            </instance>
        </instances>
    '''
    ROOT = etree.fromstring(ELEMENT)

    JSON = {'instances': {
        'instances': ['1', '2', '3']}, 'dummy': {'dict': True}
    }

    def test_element_ancestors_match_list(self):
        # Test normal operation:
        self.assertTrue(xml.element_ancestors_match_list(self.ROOT[0][0],
                                                         ['instance',
                                                          'instances']))

        # Test itr_elem is None:
        self.assertTrue(xml.element_ancestors_match_list(self.ROOT,
                                                         ['instances']))

        # Test that the first parent element does not match the first list
        # element:
        self.assertFalse(xml.element_ancestors_match_list(self.ROOT[0][0],
                                                          ['instances',
                                                           'instance']))

    def test_populate_element_from_dict(self):
        # Test populate_element_from_dict with a None in the data
        ele = '''
        <instance>
            <volume>
                <value size="5"/>
            </volume>
        </instance>
            '''
        rt = etree.fromstring(ele)

        self.assertIsNone(xml.populate_element_from_dict(rt, {'size': None}))

    def test_element_must_be_list(self):
        # Test for when name isn't in the dictionary
        self.assertFalse(xml.element_must_be_list(self.ROOT, "not_in_list"))

        # Test when name is in the dictionary but list is empty
        self.assertTrue(xml.element_must_be_list(self.ROOT, "accounts"))

        # Test when name is in the dictionary but list is not empty
        self.assertTrue(xml.element_must_be_list(self.ROOT[0][0][0], "links"))

    def test_element_to_json(self):
        # Test when element must be list:
        self.assertEqual([{'flavor': {'links': [], 'value': {'value': '5'}}}],
                         xml.element_to_json("accounts", self.ROOT))

        # Test when element must not be list:
        exp = {'instance': {'flavor': {'links': [], 'value': {'value': '5'}}}}
        self.assertEqual(exp, xml.element_to_json("not_in_list", self.ROOT))

    def test_root_element_to_json(self):
        # Test when element must be list:
        exp = ([{'flavor': {'links': [], 'value': {'value': '5'}}}], None)
        self.assertEqual(exp, xml.root_element_to_json("accounts", self.ROOT))

        # Test when element must not be list:
        exp = {'instance': {'flavor': {'links': [], 'value': {'value': '5'}}}}
        self.assertEqual((exp, None),
                         xml.root_element_to_json("not_in_list", self.ROOT))

        # Test rootEnabled True:
        t_element = etree.fromstring('''<rootEnabled> True </rootEnabled>''')
        self.assertEqual((True, None),
                         xml.root_element_to_json("rootEnabled", t_element))

        # Test rootEnabled False:
        f_element = etree.fromstring('''<rootEnabled> False </rootEnabled>''')
        self.assertEqual((False, None),
                         xml.root_element_to_json("rootEnabled", f_element))

    def test_element_to_list(self):
        # Test w/ no child elements
        self.assertEqual([], xml.element_to_list(self.ROOT[0][0][0]))

        # Test w/ no child elements and check_for_links = True
        self.assertEqual(([], None),
                         xml.element_to_list(self.ROOT[0][0][0],
                                             check_for_links=True))

        # Test w/ child elements
        self.assertEqual([{}, {'value': '5'}],
                         xml.element_to_list(self.ROOT[0][0]))

        # Test w/ child elements and check_for_links = True
        self.assertEqual(([{'value': '5'}], []),
                         xml.element_to_list(self.ROOT[0][0],
                                             check_for_links=True))

    def test_element_to_dict(self):
        # Test when there is not a None
        exp = {'instance': {'flavor': {'links': [], 'value': {'value': '5'}}}}
        self.assertEqual(exp, xml.element_to_dict(self.ROOT))

        # Test when there is a None
        element = '''
                <server>
                    None
                </server>
            '''
        rt = etree.fromstring(element)
        self.assertIsNone(xml.element_to_dict(rt))

    def test_standarize_json(self):
        xml.standardize_json_lists(self.JSON)
        self.assertEqual({'instances': ['1', '2', '3'],
                          'dummy': {'dict': True}}, self.JSON)

    def test_normalize_tag(self):
        ELEMENT_NS = '''
            <instances xmlns="http://www.w3.org/1999/xhtml">
                <instance>
                    <flavor>
                        <links>
                        </links>
                        <value value="5"/>
                    </flavor>
                </instance>
            </instances>
        '''
        ROOT_NS = etree.fromstring(ELEMENT_NS)

        # Test normalizing without namespace info
        self.assertEqual('instances', xml.normalize_tag(self.ROOT))

        # Test normalizing with namespace info
        self.assertEqual('instances', xml.normalize_tag(ROOT_NS))

    def test_create_root_xml_element(self):
        # Test creating when name is not in REQUEST_AS_LIST
        element = xml.create_root_xml_element("root", {"root": "value"})
        exp = '<root xmlns="http://docs.openstack.org/database/api/v1.0" ' \
              'root="value"/>'
        self.assertEqual(exp, etree.tostring(element))

        # Test creating when name is in REQUEST_AS_LIST
        element = xml.create_root_xml_element("users", [])
        exp = '<users xmlns="http://docs.openstack.org/database/api/v1.0"/>'
        self.assertEqual(exp, etree.tostring(element))

    def test_creating_subelements(self):
        # Test creating a subelement as a dictionary
        element = xml.create_root_xml_element("root", {"root": 5})
        xml.create_subelement(element, "subelement", {"subelement": "value"})
        exp = '<root xmlns="http://docs.openstack.org/database/api/v1.0" ' \
              'root="5"><subelement subelement="value"/></root>'
        self.assertEqual(exp, etree.tostring(element))

        # Test creating a subelement as a list
        element = xml.create_root_xml_element("root",
                                              {"root": {"value": "nested"}})
        xml.create_subelement(element, "subelement", [{"subelement": "value"}])
        exp = '<root xmlns="http://docs.openstack.org/database/api/v1.0">' \
              '<root value="nested"/><subelement><subelement subelement=' \
              '"value"/></subelement></root>'
        self.assertEqual(exp, etree.tostring(element))

        # Test creating a subelement as a string (should raise TypeError)
        element = xml.create_root_xml_element("root", {"root": "value"})
        try:
            xml.create_subelement(element, "subelement", ["value"])
            self.fail("TypeError exception expected")
        except TypeError:
            pass

    def test_modify_response_types(self):
        TYPE_MAP = {
            "Int": int,
            "Bool": bool
        }
        #Is a string True
        self.assertEqual(True, xml.modify_response_types('True', TYPE_MAP))

        #Is a string False
        self.assertEqual(False, xml.modify_response_types('False', TYPE_MAP))

        #Is a dict
        test_dict = {"Int": "5"}
        test_dict = xml.modify_response_types(test_dict, TYPE_MAP)
        self.assertEqual(int, test_dict["Int"].__class__)

        #Is a list
        test_list = {"a_list": [{"Int": "5"}, {"Str": "A"}]}
        test_list = xml.modify_response_types(test_list["a_list"], TYPE_MAP)
        self.assertEqual([{'Int': 5}, {'Str': 'A'}], test_list)

    def test_trovexmlclient(self):
        from troveclient import exceptions

        client = xml.TroveXmlClient("user", "password", "tenant",
                                    "auth_url", "service_name",
                                    auth_strategy="fake")
        request = {'headers': {}}

        # Test morph_request, no body
        client.morph_request(request)
        self.assertEqual('application/xml', request['headers']['Accept'])
        self.assertEqual('application/xml', request['headers']['Content-Type'])

        # Test morph_request, with body
        request['body'] = {'root': {'test': 'test'}}
        client.morph_request(request)
        body = '<root xmlns="http://docs.openstack.org/database/api/v1.0" ' \
               'test="test"/>\n'
        exp = {'body': body,
               'headers': {'Content-Type': 'application/xml',
                           'Accept': 'application/xml'}}
        self.assertEqual(exp, request)

        # Test morph_response_body
        request = "<users><links><user href='value'/></links></users>"
        result = client.morph_response_body(request)
        self.assertEqual({'users': [], 'links': [{'href': 'value'}]}, result)

        # Test morph_response_body with improper input
        try:
            client.morph_response_body("value")
            self.fail("ResponseFormatError exception expected")
        except exceptions.ResponseFormatError:
            pass