# Copyright (c) 2016 Cisco and/or its affiliates.
# 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.

"""Test variables for Honeycomb L2 FIB test suite."""

from resources.libraries.python.topology import Topology


def get_variables(node, interface, interface2):
    """Creates and returns dictionary of test variables.

    :param node: A Honeycomb node.
    :param interface: Name of an interface on the specified node.
    :param interface: Name of another interface on the specified node.
    :type node: dict
    :type interface: str
    :type interface2: str
    :return: Dictionary of test variables.
    :rtype: dict
    """
    # Interface sw_if_index
    sw_if_index = Topology.get_interface_sw_index_by_name(node, interface)
    sw_if_index2 = Topology.get_interface_sw_index_by_name(node, interface2)

    # Bridge domain name.
    bd_name = 'test-l2-bd'

    # L2 FIB MACs used in configuration.
    notstatic = "aa:bb:cc:dd:ee:ff"
    static = "22:22:33:44:55:66"
    filtered = "00:01:02:03:04:05"

    variables = {
        'bd_name': bd_name,
        # Bridge domain settings used while creating a test bridge domain.
        'bd_settings': {
            'flood': True,
            'forward': True,
            'learn': False,
            'unknown-unicast-flood': True,
            'arp-termination': True
        },

        # Index of created bridge domain.
        'bd_index': 1,

        # Bridge domain configuration used while adding the bridge domain to an
        # interface.
        'if_bd_settings': {
            'bridge-domain': bd_name,
            'split-horizon-group': 1,
            'bridged-virtual-interface': False
        },

        # Add L2 FIB entry (forward).
        # Configuration data:
        'l2_fib_forward_cfg': {
            "phys-address": notstatic,
            "outgoing-interface": interface,
            "action": "l2-fib-forward"
        },

        # Expected operational data:
        'l2_fib_forward_oper': {
            "phys-address": notstatic,
            "outgoing-interface": interface,
            "bridged-virtual-interface": False,
            "action": "v3po:l2-fib-forward",
            "static-config": False
        },

        # Expected VAT data:
        'l2_fib_forward_vat': {
            "mac": notstatic,
            "sw_if_index": sw_if_index,
            "static_mac": 0,
            "filter_mac": 0,
            "bvi_mac": 0
          },

        # Add L2 FIB entry (static, forward).
        # Configuration data:
        'l2_fib_static_forward_cfg': {
            "phys-address": static,
            "outgoing-interface": interface,
            "static-config": True,
            "action": "l2-fib-forward"
        },

        # Expected operational data:
        'l2_fib_static_forward_oper': {
            "phys-address": static,
            "outgoing-interface": interface,
            "bridged-virtual-interface": False,
            "action": "v3po:l2-fib-forward",
            "static-config": True
        },

        # Expected VAT data:
        'l2_fib_static_forward_vat': {
            "mac": static,
            "sw_if_index": sw_if_index,
            "static_mac": 1,
            "filter_mac": 0,
            "bvi_mac": 0
        },

        # Add L2 FIB entry (filter).
        # Configuration data:
        'l2_fib_filter_cfg': {
            "phys-address": filtered,
            "static-config": True,
            "action": "l2-fib-filter"
        },

        # Expected operational data:
        'l2_fib_filter_oper': {
            "phys-address": filtered,
            "bridged-virtual-interface": False,
            "action": "v3po:l2-fib-filter",
            "static-config": True
        },

        # Expected VAT data:
        'l2_fib_filter_vat': {
            "mac": filtered,
            "static_mac": 1,
            "filter_mac": 1,
            "bvi_mac": 0
        },

        # WRONG configuration data - Add L2 FIB entry.
        'l2_fib_forward_cfg_wrong_mac': {
            "phys-address": "WRONG-MAC",
            "outgoing-interface": interface,
            "action": "l2-fib-forward"
        },

        'l2_fib_forward_cfg_wrong_if': {
            "phys-address": notstatic,
            "outgoing-interface": "WRONG-INTERFACE",
            "action": "l2-fib-forward"
        },

        'l2_fib_forward_cfg_wrong_action': {
            "phys-address": notstatic,
            "outgoing-interface": interface,
            "action": "WRONG-ACTION"
        },

        # Modify L2 FIB entry (forward).
        # Configuration data:
        'l2_fib_forward_modified_cfg': {
            "phys-address": notstatic,
            "outgoing-interface": sw_if_index2,
            "action": "l2-fib-forward"
        }
    }
    return variables