"""
Definitions of common variables for the system test robot suites of the
OpenDaylight project.

Authors: Baohua Yang@IBM, Denghui Huang@IBM
Edited: Many times by many people
"""

# VM Environment defaults
DEFAULT_LINUX_PROMPT = ">"
DEFAULT_LINUX_PROMPT_STRICT = "]>"
DEFAULT_USER = "jenkins"
DEFAULT_TIMEOUT = "30s"

# ODL system variables
ODL_SYSTEM_IP = "127.0.0.1"  # Override if ODL is not running locally to pybot
ODL_SYSTEM_IP_LIST = ["ODL_SYSTEM_1_IP", "ODL_SYSTEM_2_IP", "ODL_SYSTEM_3_IP"]
ODL_SYSTEM_USER = DEFAULT_USER
ODL_SYSTEM_PASSWORD = ""  # empty means use public key authentication
ODL_SYSTEM_PROMPT = DEFAULT_LINUX_PROMPT

# "Tools" system variables (mininet etc).
TOOLS_SYSTEM_IP = "127.0.0.1"  # Override if tools are not run locally to pybot
TOOLS_SYSTEM_USER = DEFAULT_USER
TOOLS_SYSTEM_PASSWORD = ""  # empty means use public key authentication
TOOLS_SYSTEM_PROMPT = DEFAULT_LINUX_PROMPT

# KARAF Variables
KARAF_SHELL_PORT = "8101"
ESCAPE_CHARACTER = "\x1B"
KARAF_PROMPT_LOGIN = "opendaylight-user"
KARAF_USER = "karaf"
KARAF_PASSWORD = "karaf"
KARAF_PROMPT = "opendaylight-user.*root.*>"

# Logging levels
DEFAULT_ODL_LOG_LEVEL = "INFO"
DEFAULT_BGPCEP_LOG_LEVEL = DEFAULT_ODL_LOG_LEVEL
DEFAULT_PROTOCOL_LOG_LEVEL = DEFAULT_BGPCEP_LOG_LEVEL
BGPCEP_LOG_LEVEL = DEFAULT_BGPCEP_LOG_LEVEL
PROTOCOL_LOG_LEVEL = BGPCEP_LOG_LEVEL

# BGP variables
ODL_BGP_PORT = "1790"
BGP_TOOL_PORT = "17900"

# Restconf variables
ODL_RESTCONF_USER = "admin"
ODL_RESTCONF_PASSWORD = "admin"

# Netconf variables
ODL_NETCONF_CONFIG_PORT = "1830"
ODL_NETCONF_MDSAL_PORT = "2830"
ODL_NETCONF_USER = "admin"
ODL_NETCONF_PASSWORD = "admin"
ODL_NETCONF_PROMPT = "]]>]]>"
ODL_NETCONF_NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0"

# OpenFlow variables
ODL_OF_PORT = "6633"
ODL_OF_PLUGIN = "lithium"

# VTN Coordinator Variables
VTNC = "127.0.0.1"
VTNCPORT = "8083"
VTNC_PREFIX = "http://" + VTNC + ":" + VTNCPORT
VTNC_HEADERS = {
    "Content-Type": "application/json",
    "username": "admin",
    "password": "adminpass",
}

VTNWEBAPI = "/vtn-webapi"
# controllers URL
CTRLS_CREATE = "controllers.json"
CTRLS = "controllers"
SW = "switches"

# vtn URL
VTNS_CREATE = "vtns.json"
VTNS = "vtns"

# vbridge URL
VBRS_CREATE = "vbridges.json"
VBRS = "vbridges"

# interfaces URL
VBRIFS_CREATE = "interfaces.json"
VBRIFS = "interfaces"

# portmap URL
PORTMAP_CREATE = "portmap.json"

# vlanmap URL
VLANMAP_CREATE = "vlanmaps.json"

# ports URL
PORTS = "ports/detail.json"

# flowlist URL
FLOWLISTS_CREATE = "flowlists.json"

# flowlistentry_URL
FLOWLISTENTRIES_CREATE = "flowlistentries.json"
FLOWLISTS = "flowlists"

# flowfilter_URL
FLOWFILTERS_CREATE = "flowfilters.json"
FLOWFILTERENTRIES_CREATE = "flowfilterentries.json"
FLOWFILTERS = "flowfilters/in"
FLOWFILTERS_UPDATE = "flowfilterentries"


# Common APIs
CONFIG_NODES_API = "/restconf/config/opendaylight-inventory:nodes"
OPERATIONAL_NODES_API = "/restconf/operational/opendaylight-inventory:nodes"
OPERATIONAL_TOPO_API = "/restconf/operational/network-topology:" "network-topology"
CONFIG_TOPO_API = "/restconf/config/network-topology:network-topology"
CONTROLLER_CONFIG_MOUNT = (
    "/restconf/config/network-topology:"
    "network-topology/topology"
    "/topology-netconf/node/"
    "controller-config/yang-ext:mount"
)
CONFIG_API = "/restconf/config"
OPERATIONAL_API = "/restconf/operational"
MODULES_API = "/rests/data/ietf-yang-library:modules-state?content=nonconfig"
VTN_INVENTORY_NODE_API = "/restconf/operational/vtn-inventory:vtn-nodes"

# NEMO Variables
PREDEFINE_ROLE_URI = "/restconf/config/nemo-user:user-roles"
PREDEFINE_NODE_URI = "/restconf/config/nemo-object:node-definitions"
PREDEFINE_CONNECTION_URI = "/restconf/config/nemo-object:connection-definitions"
REGISTER_TENANT_URI = "/restconf/operations/nemo-intent:register-user"
STRUCTURE_INTENT_URI = "/restconf/operations/nemo-intent:structure-style-nemo-update"
GET_INTENTS_URI = "/retconf/config/intent:intents"

# TOKEN
AUTH_TOKEN_API = "/oauth2/token"
REVOKE_TOKEN_API = "/oauth2/revoke"

# Vlan Custom Topology Path and File
CREATE_VLAN_TOPOLOGY_FILE = "vlan_vtn_test.py"
CREATE_VLAN_TOPOLOGY_FILE_PATH = "MininetTopo/" + CREATE_VLAN_TOPOLOGY_FILE

# Mininet Custom Topology Path and File for Path Policy
CREATE_PATHPOLICY_TOPOLOGY_FILE = "topo-3sw-2host_multipath.py"
CREATE_PATHPOLICY_TOPOLOGY_FILE_PATH = "MininetTopo/" + CREATE_PATHPOLICY_TOPOLOGY_FILE

# LISP Flow Mapping variables
LFM_RPC_API = "/restconf/operations/odl-mappingservice"
LFM_RPC_API_LI = "/restconf/operations/lfm-mapping-database"
LFM_SB_RPC_API = "/restconf/operations/odl-lisp-sb"

# Neutron
NEUTRON_NB_API = "/controller/nb/v2/neutron"
NEUTRON_NETWORKS_API = NEUTRON_NB_API + "/" + "networks"
NEUTRON_SUBNETS_API = NEUTRON_NB_API + "/" + "subnets"
NEUTRON_PORTS_API = NEUTRON_NB_API + "/" + "ports"
NEUTRON_ROUTERS_API = NEUTRON_NB_API + "/" + "routers"
OSREST = "/v2.0/networks"

# Other global variables
# TODO: Move these to more apropriate sections.
PORT = "8080"
RESTPORT = "8282"
RESTCONFPORT = "8181"
OVSDBPORT = "6640"
CONTAINER = "default"
PREFIX = (  # TODO: determine where this is used; create a better named variable
    "http://" + ODL_SYSTEM_IP + ":" + PORT
)
USER = (  # TODO: who is using this?  Can we make it more specific? (e.g.  RESTCONF_USER)
    "admin"
)
PWD = "admin"
PASSWORD = "EMPTY"
AUTH = ["admin", "admin"]
SCOPE = "sdn"
HEADERS = {"Content-Type": "application/json"}
# FIXME: keep it as 'application/json' to make it work for both Bierman02
#  and RFC8040 URLs. Change it to RFC8040 media type once RFC8040 migration
#  is completed.
HEADERS_YANG_JSON = {"Content-Type": "application/json"}
HEADERS_XML = {"Content-Type": "application/xml"}
ACCEPT_XML = {"Accept": "application/xml"}
ACCEPT_JSON = {"Accept": "application/json"}
ACCEPT_EMPTY = (
    {}
)  # Json should be default, but no-output RPC cannot have Accept header.
ODL_CONTROLLER_SESSION = None
TOPO_TREE_LEVEL = 2
TOPO_TREE_DEPTH = 3
TOPO_TREE_FANOUT = 2
KEYFILE_PASS = "any"
SSH_KEY = "id_rsa"
CONTROLLER_STOP_TIMEOUT = (
    120  # Max number of seconds test will wait for a controller to stop
)
TOPOLOGY_URL = "network-topology:network-topology/topology"
SEND_ACCEPT_XML_HEADERS = {
    "Content-Type": "application/xml",
    "Accept": "application/xml",
}

# Test deadlines global control
ENABLE_GLOBAL_TEST_DEADLINES = True

# Deprecated old variables, to be removed once all tests that need them are
# updated to use the new names.
CONTROLLER = ODL_SYSTEM_IP
CONTROLLERS = ["ODL_SYSTEM_1_IP", "ODL_SYSTEM_2_IP", "ODL_SYSTEM_3_IP"]
CONTROLLER_PASSWORD = ODL_SYSTEM_PASSWORD
CONTROLLER_PROMPT = ODL_SYSTEM_PROMPT

# Centinel Variables
SET_CONFIGURATION_URI = "/restconf/operations/configuration:set-centinel-configurations"
GET_CONFIGURATION_URI = "/restconf/operational/configuration:configurationRecord/"
STREAMRECORD_CONFIG = "/restconf/config/stream:streamRecord"
SET_STREAMRECORD = "/restconf/operations/stream:set-stream"
ALERTFIELDCONTENTRULERECORD = "/restconf/config/alertrule:alertFieldContentRuleRecord/"
SET_ALERTFIELDCONTENTRULERECORD = (
    "/restconf/operations/alertrule:set-alert-field-content-rule"
)
ALERTFIELDVALUERULERECORD = "/restconf/config/alertrule:alertFieldValueRuleRecord"
SET_ALERTFIELDVALUERULERECORD = (
    "/restconf/operations/alertrule:set-alert-field-value-rule"
)
ALERTMESSAGECOUNTRULERECORD = "/restconf/config/alertrule:alertMessageCountRuleRecord/"
SET_ALERTMESSAGECOUNTRULERECORD = (
    "/restconf/operations/alertrule:set-alert-message-count-rule"
)
GET_DASHBOARDRECORD = "/restconf/operational/dashboardrule:dashboardRecord/"
SET_DASHBOARDRECORD = "/restconf/operations/dashboardrule:set-dashboard"
DELETE_DASHBOARDRECORD = "/restconf/operations/dashboardrule:delete-dashboard"
SET_SUBSCRIBEUSER = "/restconf/operations/subscribe:subscribe-user"
SUBSCRIPTION = "/restconf/config/subscribe:subscription/"

# Elasticsearch Variables
ELASTICPORT = 9200