# 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 SPAN port mirroring test suite."""


def get_variables(interface1, interface2, interface3):
    """Create and return a dictionary of test variables.

    :param interface1: Name of an interface.
    :param interface2: Name of an interface.
    :param interface3: Name of an interface.
    :type interface1: string
    :type interface2: string
    :type interface3: string

    :returns: Dictionary of test variables - settings for Honeycomb's
    SPAN port mirroring suite.
    :rtype: dict
    """
    variables = {
        "interface1": interface1,
        "interface2": interface2,
        "interface3": interface3,

        # Interface 2 - ingress
        "settings_receive": {
            "state": "receive",
            "iface-ref": interface2,
        },

        # Interface 2 - egress
        "settings_transmit": {
            "state": "transmit",
            "iface-ref": interface2,
        },

        # Interface 2 - ingress/egress
        "settings_both": {
            "state": "both",
            "iface-ref": interface2,
        },

        # Interface 3 - ingress/egress
        "settings_if2": {
            "state": "both",
            "iface-ref": interface3,
        },

        # IP addresses for traffic test
        "tg_to_dut_if1_ip": "192.168.1.1",
        "dut_to_tg_if1_ip": "192.168.1.2",
        "tg_to_dut_if2_ip": "192.168.2.1",
        "dut_to_tg_if2_ip": "192.168.2.2",
        "prefix": 24,
    }
    return variables