net Package

basic_machine Module

common Module

net_tc Module

Convenience methods for use to manipulate traffic control settings.

see http://linux.die.net/man/8/tc for details about traffic controls in linux.

Example

try:

import autotest.common as common # pylint: disable=W0611

except ImportError:

import common # pylint: disable=W0611

from autotest.client.net.net_tc import * from autotest.client.net.net_utils import *

class mock_netif(object):

def __init__(self, name):

self._name = name

def get_name(self):

return self._name

netem_qdisc = netem() netem_qdisc.add_param(‘loss 100%’)

ack_filter = u32filter() ack_filter.add_rule(‘match ip protocol 6 0xff’) ack_filter.add_rule(‘match u8 0x10 0x10 at nexthdr+13’) ack_filter.set_dest_qdisc(netem_qdisc)

root_qdisc = prio() root_qdisc.get_class(2).set_leaf_qdisc(netem_qdisc) root_qdisc.add_filter(ack_filter)

lo_if = mock_netif(‘lo’)

root_qdisc.setup(lo_if)

# run test here … root_qdisc.restore(lo_if)

class autotest.client.net.net_tc.classful_qdisc(handle)

Bases: autotest.client.net.net_tc.qdisc

add_class(child_class)

add_filter(filter)

classful = True

restore(netif)

setup(netif)

class autotest.client.net.net_tc.classless_qdisc(handle)

Bases: autotest.client.net.net_tc.qdisc

classful = False

class autotest.client.net.net_tc.netem(handle=300)

Bases: autotest.client.net.net_tc.classless_qdisc

add_param(param)

name = 'netem'

setup(netif)

autotest.client.net.net_tc.new_handle()

class autotest.client.net.net_tc.pfifo(handle=200)

Bases: autotest.client.net.net_tc.classless_qdisc

name = 'pfifo'

setup(netif)

class autotest.client.net.net_tc.prio(handle=100, bands=3)

Bases: autotest.client.net.net_tc.classful_qdisc

get_class(band)

name = 'prio'

setup(netif)

class autotest.client.net.net_tc.qdisc(handle)

Bases: object

get_handle()

get_parent_class()

id()

restore(netif)

set_parent_class(parent_class)

setup(netif)

tc_cmd(tc_conf)

class autotest.client.net.net_tc.tcclass(handle, minor, leaf_qdisc=None)

Bases: object

add_child(child_class)

get_leaf_qdisc()

get_minor()

get_parent_class()

id()

restore(netif)

set_leaf_qdisc(leaf_qdisc)

set_parent_class(parent_class)

setup(netif)

class autotest.client.net.net_tc.tcfilter

Bases: object

conf_command = 'cmd'

conf_device = 'dev'

conf_flowid = 'flowid'

conf_name = 'name'

conf_params = 'params'

conf_parent = 'parent'

conf_priority = 'priority'

conf_protocol = 'protocol'

conf_qdiscid = 'qdiscid'

conf_rules = 'cmd'

conf_type = 'filtertype'

get_dest_qdisc()

get_handle()

get_parent_qdisc()

get_priority()

get_protocol()

restore(netif)

set_dest_qdisc(dest_qdisc)

set_handle(handle)

set_parent_qdisc(parent_qdisc)

set_priority(priority)

set_protocol(protocol)

setup(netif)

tc_cmd(tc_conf)

class autotest.client.net.net_tc.u32filter

Bases: autotest.client.net.net_tc.tcfilter

add_rule(rule)

filtertype = 'u32'

restore(netif)

setup(netif)

net_utils Module

Convenience functions for use by network tests or whomever.

This library is to release in the public repository.

autotest.client.net.net_utils.bond()

class autotest.client.net.net_utils.bonding

Bases: object

This class implements bonding interface abstraction.

AB_MODE = 1

AD_MODE = 2

NO_MODE = 0

disable()

enable()

get_active_interfaces()

get_mii_status()

get_mode()

get_slave_interfaces()

is_bondable()

is_enabled()

wait_for_state_change()

Wait for bonding state change.

Wait up to 90 seconds to successfully ping the gateway. This is to know when LACP state change has converged. (0 seconds is 3x lacp timeout, use by protocol)

class autotest.client.net.net_utils.ethernet

Bases: object

Provide ethernet packet manipulation methods.

CHECKSUM_LEN = 4

ETH_LLDP_DST_MAC = '01:80:C2:00:00:0E'

ETH_PACKET_MAX_SIZE = 1518

ETH_PACKET_MIN_SIZE = 64

ETH_TYPE_8021Q = 33024

ETH_TYPE_ARP = 2054

ETH_TYPE_CDP = 8192

ETH_TYPE_IP = 2048

ETH_TYPE_IP6 = 34525

ETH_TYPE_LLDP = 35020

ETH_TYPE_LOOPBACK = 36864

FRAME_KEY_DST_MAC = 'dst'

FRAME_KEY_PAYLOAD = 'payload'

FRAME_KEY_PROTO = 'proto'

FRAME_KEY_SRC_MAC = 'src'

HDR_LEN = 14

static mac_binary_to_string(hwaddr)

Converts a MAC address byte string to text string.

Converts a MAC byte string ‘xxxxxxxxxxxx’ to a text string ‘aa:aa:aa:aa:aa:aa’

Args:

hwaddr: a byte string containing the MAC address to convert.

Returns:

A text string.

static mac_string_to_binary(hwaddr)

Converts a MAC address text string to byte string.

Converts a MAC text string from a text string ‘aa:aa:aa:aa:aa:aa’ to a byte string ‘xxxxxxxxxxxx’

Args:

hwaddr: a text string containing the MAC address to convert.

Returns:

A byte string.

static pack(dst, src, protocol, payload)

Pack a frame in a byte string.

Args:

dst: destination mac in byte string format src: src mac address in byte string format protocol: short in network byte order payload: byte string payload data

Returns:

An ethernet frame with header and payload in a byte string.

static unpack(raw_frame)

Unpack a raw ethernet frame.

Returns:

None on error

{ ‘dst’ : byte string,

‘src’ : byte string, ‘proto’ : short in host byte order, ‘payload’ : byte string

}

autotest.client.net.net_utils.ethernet_packet()

autotest.client.net.net_utils.netif(name)

autotest.client.net.net_utils.network()

class autotest.client.net.net_utils.network_interface(name)

Bases: object

DISABLE = False

ENABLE = True

add_maddr(maddr)

del_maddr(maddr)

disable_loopback()

disable_promisc()

down()

enable_loopback()

enable_promisc()

exists()

flush()

get_advertised_link_modes()

get_carrier()

get_driver()

get_hwaddr()

get_ipaddr()

get_name()

get_speed()

get_stats()

get_stats_diff(orig_stats)

get_supported_link_modes()

get_wakeon()

is_autoneg_advertised()

is_autoneg_on()

is_down()

is_full_duplex()

is_loopback_enabled()

is_pause_autoneg_on()

is_rx_pause_on()

is_rx_summing_on()

is_scatter_gather_on()

is_tso_on()

is_tx_pause_on()

is_tx_summing_on()

parse_ethtool(field, match, option='', next_field='')

recv(len)

restore()

send(buf)

set_hwaddr(hwaddr)

set_ipaddr(ipaddr)

up()

wait_for_carrier(timeout=60)

class autotest.client.net.net_utils.network_utils

Bases: object

disable_ip_local_loopback(ignore_status=False)

enable_ip_local_loopback(ignore_status=False)

get_ip_local(query_ip, netmask='24')

Get ip address in local system which can communicate with query_ip.

Parameters:query_ip – IP of client which wants to communicate with autotest machine. Returns:IP address which can communicate with query_ip

list()

process_mpstat(mpstat_out, sample_count, loud=True)

Parses mpstat output of the following two forms: 02:10:17 0 0.00 0.00 0.00 0.00 0.00 0.00 0.00 100.00 1012.87 02:10:13 PM 0 0.00 0.00 0.00 0.00 0.00 0.00 0.00 100.00 1019.00

reset(ignore_status=False)

start(ignore_status=False)

stop(ignore_status=False)

class autotest.client.net.net_utils.raw_socket(iface_name)

Bases: object

This class implements an raw socket abstraction.

ETH_P_ALL = 3

SOCKET_TIMEOUT = 1

close()

Close the raw socket

open(protocol=None)

Opens the raw socket to send and receive.

Args:

protocol : short in host byte order. None if ALL

recv(timeout)

Synchroneous receive.

Receives one packet from the interface and returns its content in a string. Wait up to timeout for the packet if timeout is not 0. This function filters out all the packets that are less than the minimum ethernet packet size (60+crc).

Args:

timeout: max time in seconds to wait for the read to complete.

‘0’, wait for ever until a valid packet is received

Returns:

packet: None no packet was received

a binary string containing the received packet.

time_left: amount of time left in timeout

recv_from(dst_mac, src_mac, protocol)

Receive an ethernet frame that matches the dst, src and proto.

Filters all received packet to find a matching one, then unpack it and present it to the caller as a frame.

Waits up to self._socket_timeout for a matching frame before returning.

Args:

dst_mac: ‘byte string’. None do not use in filter. src_mac: ‘byte string’. None do not use in filter. protocol: short in host byte order. None do not use in filter.

Returns:

ethernet frame: { ‘dst’ : byte string,

‘src’ : byte string, ‘proto’ : short in host byte order, ‘payload’ : byte string

}

send(packet)

Send an ethernet packet.

send_to(dst_mac, src_mac, protocol, payload)

Send an ethernet frame.

Send an ethernet frame, formating the header.

Args:

dst_mac: ‘byte string’ src_mac: ‘byte string’ protocol: short in host byte order payload: ‘byte string’

set_socket_timeout(timeout)

Set the timeout use by recv_from.

Args:

timeout: time in seconds

socket()

socket_timeout()

Get the timeout use by recv_from

net_utils_mock Module

Set of Mocks and stubs for network utilities unit tests.

Implement a set of mocks and stubs use to implement unit tests for the network libraries.

class autotest.client.net.net_utils_mock.netif_stub(iface, cls, name, *args, **kwargs)

Bases: autotest.client.shared.test_utils.mock.mock_class

wait_for_carrier(timeout)

autotest.client.net.net_utils_mock.netutils_netif(iface)

class autotest.client.net.net_utils_mock.network_interface_mock(iface='some_name', test_init=False)

Bases: autotest.client.net.net_utils.network_interface

get_driver()

get_ipaddr()

is_down()

is_loopback_enabled()

wait_for_carrier(timeout=1)

autotest.client.net.net_utils_mock.os_open(*args, **kwarg)

class autotest.client.net.net_utils_mock.os_stub(symbol, **kwargs)

Bases: autotest.client.shared.test_utils.mock.mock_function

open(*args, **kwargs)

read(*args, **kwargs)

readval = ''

class autotest.client.net.net_utils_mock.socket_stub(iface, cls, name, *args, **kwargs)

Bases: autotest.client.shared.test_utils.mock.mock_class

Class use to mock sockets.

bind(arg)

close()

recv(size)

send(buf)

settimeout(timeout)

socket(family, type)