# Copyright (C) 2014 Nippon Telegraph and Telephone Corporation.
#
# 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 os
import time
import re
import sys
import nose
import collections
import docker_control as fab
from fabric.api import local
import json
import toml
from noseplugin import OptionParser
from noseplugin import parser_option
from constant import CONFIG_DIR, CLI_CMD

wait_per_retry = 2
retry_limit = 60 / wait_per_retry

gobgp_ip = "10.0.255.1"
gobgp_port = "8080"
gobgp_config_file = "/tmp/gobgp/gobgpd.conf"


def check_pattern():
    """
    if want to add test pattern, please write config name and notification message in this function.
    this tests is execute defined order.
    sample:
    pattern["<File to be used in test>"] = "<at that time the message>"
    """
    pattern = collections.OrderedDict()
    pattern["malformed1-exabgp-gobgp-v4-MP_REACH_NLRI.conf"] = "UPDATE message error / Attribute Flags Error / 0x600E0411223344"
    pattern["malformed1-exabgp-gobgp-v4-MP_UNREACH_NLRI.conf"] = "UPDATE message error / Attribute Flags Error / 0x600F0411223344"
    pattern["malformed1-exabgp-gobgp-v4-AS_PATH.conf"] = "UPDATE message error / Attribute Flags Error / 0x60020411223344"
    pattern["malformed1-exabgp-gobgp-v4-AS4_PATH.conf"] = "UPDATE message error / Attribute Flags Error / 0x60110411223344"
    pattern["malformed1-exabgp-gobgp-v4-NEXTHOP_INVALID.conf"] = "UPDATE message error / Attribute Flags Error / 0x600E08010110FFFFFF0000"
    pattern["malformed1-exabgp-gobgp-v4-ROUTE_FAMILY_INVALID.conf"] = "UPDATE message error / Attribute Flags Error / 0x600E150002011020010DB800000000000000000000000100"

    pattern["malformed1-exabgp-gobgp-v4-AS_PATH_SEGMENT_LENGTH_INVALID.conf"] = "UPDATE message error / Malformed AS_PATH / 0x4002040202FFDC"
    pattern["malformed1-exabgp-gobgp-v4-NEXTHOP_LOOPBACK_ADDR_INVALID.conf"] = "UPDATE message error / Invalid NEXT_HOP Attribute / 0x4003047F000001"
    pattern["malformed1-exabgp-gobgp-v4-ORIGIN_TYPE_INVALID.conf"] = "UPDATE message error / Invalid ORIGIN Attribute / 0x40010104"
    return pattern


def test_malformed_packet():
    pwd = os.getcwd()
    pattern = check_pattern()
    if fab.test_user_check() is False:
        print "you are not root"
        sys.exit(1)

    if fab.docker_pkg_check() is False:
        print "not install docker package."
        sys.exit(1)

    if len(pattern) <= 0:
        print "read test pattern is faild."
        print "pattern element is " + str(len(pattern))
        sys.exit(1)

    image = parser_option.gobgp_image
    log_debug = True if parser_option.gobgp_log_level == 'debug' else False
    go_path = parser_option.go_path
    exabgp_path = parser_option.exabgp_path

    fab.init_malformed_test_env_executor(image, go_path, exabgp_path, log_debug)

    for pkey in pattern:
        conf_file = pwd + "/exabgp_test_conf/" + pkey
        if os.path.isfile(conf_file) is True:
            fab.start_exabgp(pkey)
            yield check_func, pkey, pattern[pkey]
            fab.stop_exabgp()
        else:
            print "config file not exists."
            print conf_file
            sys.exit(1)


def check_func(exabgp_conf, result):
    in_prepare_quagga = True
    in_prepare_exabgp = True
    retry_count = 0
    # get neighbor addresses from gobgpd.conf
    addresses = get_neighbor_address()
    neighbors = None
    q_address = ""
    e_address = ""
    q_transitions = 0
    q_state = ""
    notification = ""

    while in_prepare_quagga or in_prepare_exabgp:
        if retry_count != 0:
            print "please wait more (" + str(wait_per_retry) + " second)"
            time.sleep(wait_per_retry)
        if retry_count >= retry_limit:
            print "retry limit"
            break
        retry_count += 1
        # check whether the service of gobgp is normally
        try:
            cmd = "%s -j neighbor" % CLI_CMD
            j = local(cmd, capture=True)
            neighbors = json.loads(j)
        except Exception:
            continue
        if neighbors is None:
            continue
        for neighbor in neighbors:
            remote_ip = neighbor['conf']['remote_ip']
            if remote_ip == "10.0.0.1":
                q_state = neighbor['info']['bgp_state']
                q_address = remote_ip
                if q_state == "BGP_FSM_ESTABLISHED":
                    q_transitions = neighbor['info']['fsm_established_transitions']
                    in_prepare_quagga = False
            else:
                e_address = remote_ip
        # get notification message from exabgp log
        err_msg = fab.get_notification_from_exabgp_log()
        parse_msg = re.search(r'error.*', err_msg)
        if parse_msg is not None:
            notification_src = parse_msg.group(0)[5:]
            notification = notification_src[1:-1]
            in_prepare_exabgp = False

    assert neighbors is not None, "neighbors is None"
    assert len(neighbors) == len(addresses), "neighbors = " + len(neighbors) + ", addresses = " + len(addresses)
    print "check of [ " + q_address + " ]"
    assert q_state == "BGP_FSM_ESTABLISHED", "q_state = " + q_state
    assert q_transitions == 1, "q_transitions = " + q_transitions
    print "check of [ " + e_address + " ]"
    print "notification message : "
    print " >>> " + str(notification)
    # check notification messege
    assert notification == result, "notification = " + notification


# get address of each neighbor from gobpg configration
def get_neighbor_address():
    address = []
    try:
        gobgp_config = toml.loads(open(gobgp_config_file).read())
        neighbors_config = gobgp_config['NeighborList']
        for neighbor_config in neighbors_config:
            neighbor_ip = neighbor_config['NeighborAddress']
            address.append(neighbor_ip)

    except IOError, (errno, strerror):
        print "I/O error(%s): %s" % (errno, strerror)

    return address

if __name__ == '__main__':
    if fab.test_user_check() is False:
        print "you are not root."
        sys.exit(1)
    if fab.docker_pkg_check() is False:
        print "not install docker package."
        sys.exit(1)
    nose.main(argv=sys.argv, addplugins=[OptionParser()], defaultTest=sys.argv[0])