# Copyright (c) 2015 Potential Ventures Ltd
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of Potential Ventures Ltd
#       names of its contributors may be used to endorse or promote products
#       derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import logging

import cocotb
from cocotb.handle import HierarchyObject, ModifiableObject, IntegerObject, ConstantObject, EnumObject
from cocotb.result import TestFailure


@cocotb.test()
async def check_enum_object(dut):
    """
    Enumerations currently behave as normal signals

    TODO: Implement an EnumObject class and detect valid string mappings
    """
    if not isinstance(dut.inst_ram_ctrl.write_ram_fsm, EnumObject):
        raise TestFailure("Expected the FSM enum to be an EnumObject")


@cocotb.test()
async def check_objects(dut):
    """
    Check the types of objects that are returned
    """
    tlog = logging.getLogger("cocotb.test")
    fails = 0

    def check_instance(obj, objtype):
        if not isinstance(obj, objtype):
            tlog.error("Expected %s to be of type %s but got %s" % (
                obj._fullname, objtype.__name__, type(obj).__name__))
            return 1
        tlog.info("%s is %s" % (obj._fullname, type(obj).__name__))
        return 0

    # Hierarchy checks
    fails += check_instance(dut.inst_axi4s_buffer, HierarchyObject)
    fails += check_instance(dut.gen_branch_distance[0], HierarchyObject)
    fails += check_instance(dut.gen_branch_distance[0].inst_branch_distance, HierarchyObject)
    fails += check_instance(dut.gen_acs[0].inbranch_tdata_low, ModifiableObject)
    fails += check_instance(dut.gen_acs[0].inbranch_tdata_low[0], ModifiableObject)
    fails += check_instance(dut.aclk, ModifiableObject)
    fails += check_instance(dut.s_axis_input_tdata, ModifiableObject)
    fails += check_instance(dut.current_active, IntegerObject)
    fails += check_instance(dut.inst_axi4s_buffer.DATA_WIDTH, ConstantObject)
    fails += check_instance(dut.inst_ram_ctrl, HierarchyObject)

    if dut.inst_axi4s_buffer.DATA_WIDTH != 32:
        tlog.error("Expected dut.inst_axi4s_buffer.DATA_WIDTH to be 32 but got %d",
                   dut.inst_axi4s_buffer.DATA_WIDTH)
        fails += 1

    try:
        dut.inst_axi4s_buffer.DATA_WIDTH = 42
        tlog.error("Shouldn't be allowed to set a value on constant object")
        fails += 1
    except TypeError as e:
        pass

    try:
        dut.inst_axi4s_buffer.DATA_WIDTH <= 42
        tlog.error("Shouldn't be allowed to set a value on constant object using __le__")
        fails += 1
    except TypeError as e:
        pass

    if fails:
        raise TestFailure("%d Failures during the test" % fails)


@cocotb.test()
async def port_not_hierarchy(dut):
    """
    Test for issue raised by Luke - iteration causes a toplevel port type to
    change from ModifiableObject to HierarchyObject
    """
    tlog = logging.getLogger("cocotb.test")
    if not isinstance(dut.aclk, ModifiableObject):
        tlog.error("dut.aclk should be ModifiableObject but got %s", type(dut.aclk).__name__)
    else:
        tlog.info("dut.aclk is ModifiableObject")
    for _ in dut:
        pass
    if not isinstance(dut.aclk, ModifiableObject):
        tlog.error("dut.aclk should be ModifiableObject but got %s", type(dut.aclk).__name__)
    else:
        tlog.info("dut.aclk is ModifiableObject")
