path: root/tools/pkt_gen/dummy/dummy.py

# Copyright 2015-2017 Intel 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.

"""
Dummy traffic generator, designed for user intput.

Provides a model for the Dummy traffic generator - a psuedo "traffic
generator" that doesn't actually generate any traffic. Instead the
user is required to send traffic using their own choice of traffic
generator *outside of the framework*. The Dummy traffic generator
then returns the results - manually entered by the user - as its
own.
"""

import json

from collections import OrderedDict
from conf import settings
from conf import merge_spec
from tools.pkt_gen import trafficgen
from core.results.results_constants import ResultsConstants

def _get_user_traffic_stat(stat_type):
    """
    Request user input for traffic.

    :param stat_type: Name of statistic required from user

    :returns: Value of stat provided by user
    """
    true_vals = ('yes', 'y', 'ye', None)
    false_vals = ('no', 'n')

    while True:
        result = input('What was the result for \'%s\'? ' % stat_type)

        try:
            result = int(result)
        except ValueError:
            print('That was not a valid integer result. Try again.')
            continue

        while True:
            choice = input('Is \'%d\' correct? ' % result).lower()
            if not choice or choice in true_vals:
                return result
            elif choice and choice in false_vals:
                break
            else:
                print('Please respond with \'yes\' or \'no\' ', end='')

def get_user_traffic(traffic_type, traffic_conf, flow_conf, traffic_stats):
    """
    Request user input for traffic.

    :param traffic_type: Name of traffic type.
    :param traffic_conf: Configuration of traffic to be sent.
    :param traffic_conf: Configuration of flow to be sent.
    :param traffic_stats: Required output statistics (i.e. what's needed)

    :returns: List of stats corresponding to those in traffic_stats
    """
    results = []

    print('Please send \'%s\' traffic with the following stream config:\n%s\n'
          'and the following flow config:\n%s'
          % (traffic_type, traffic_conf, json.dumps(flow_conf, indent=4)))

    for stat in traffic_stats:
        if stat in settings.getValue('TRAFFICGEN_DUMMY_RESULTS'):
            results.append(settings.getValue('TRAFFICGEN_DUMMY_RESULTS')[stat])
        else:
            results.append(_get_user_traffic_stat(stat))

    return results


class Dummy(trafficgen.ITrafficGenerator):
    """
    A dummy traffic generator whose data is generated by the user.

    This traffic generator is useful when a user does not wish to write
    a wrapper for a given type of traffic generator. By using this
    "traffic generator", the user is asked to send traffic when
    required and enter the results manually. The user controls the
    real traffic generator and is responsible for ensuring the flows
    are setup correctly.
    """
    def connect(self):
        """
        Do nothing.
        """
        return self

    def disconnect(self):
        """
        Do nothing.
        """
        pass

    def send_burst_traffic(self, traffic=None, duration=20):
        """
        Send a burst of traffic.
        """
        traffic_ = self.traffic_defaults.copy()
        result = OrderedDict()

        if traffic:
            traffic_ = merge_spec(traffic_, traffic)

        results = get_user_traffic(
            'burst',
            '%dpkts, %dmS' % (traffic['burst_size'], duration),
            traffic_,
            ('frames rx', 'payload errors', 'sequence errors'))

        # builds results by using user-supplied values where possible
        # and guessing remainder using available info
        result[ResultsConstants.TX_FRAMES] = traffic['burst_size']
        result[ResultsConstants.RX_FRAMES] = results[0]
        result[ResultsConstants.TX_BYTES] = traffic_['l2']['framesize'] \
                                            * traffic['burst_size']
        result[ResultsConstants.RX_BYTES] = traffic_['l2']['framesize'] \
                                            * results[0]
        result[ResultsConstants.PAYLOAD_ERR] = results[1]
        result[ResultsConstants.SEQ_ERR] = results[2]

        return result

    def send_cont_traffic(self, traffic=None, duration=30):
        """
        Send a continuous flow of traffic.
        """
        traffic_ = self.traffic_defaults.copy()
        result = OrderedDict()

        if traffic:
            traffic_ = merge_spec(traffic_, traffic)

        results = get_user_traffic(
            'continuous',
            '%dmpps, multistream %s, duration %d' % (traffic['frame_rate'],
                                                     traffic['multistream'],
                                                     duration), traffic_,
            ('frames tx', 'frames rx', 'tx rate %', 'rx rate %', 'min latency',
             'max latency', 'avg latency', 'frameloss %'))

        framesize = traffic_['l2']['framesize']

        # builds results by using user-supplied values
        # and guessing remainder using available info
        result[ResultsConstants.TX_RATE_FPS] = float(results[0]) / duration
        result[ResultsConstants.THROUGHPUT_RX_FPS] = float(results[1]) / duration
        result[ResultsConstants.TX_RATE_MBPS] = (float(results[0]) / duration) \
                                                 * (framesize * 8 / 1000000)
        result[ResultsConstants.THROUGHPUT_RX_MBPS] = (float(results[1]) / duration) \
                                                 * (framesize * 8 / 1000000)
        result[ResultsConstants.TX_RATE_PERCENT] = float(results[2])
        result[ResultsConstants.THROUGHPUT_RX_PERCENT] = float(results[3])
        result[ResultsConstants.MIN_LATENCY_NS] = float(results[4])
        result[ResultsConstants.MAX_LATENCY_NS] = float(results[5])
        result[ResultsConstants.AVG_LATENCY_NS] = float(results[6])
        result[ResultsConstants.FRAME_LOSS_PERCENT] = float(results[7])
        return result

    def send_rfc2544_throughput(self, traffic=None, tests=1, duration=20,
                                lossrate=0.0):
        """
        Send traffic per RFC2544 throughput test specifications.
        """
        traffic_ = self.traffic_defaults.copy()
        result = OrderedDict()

        if traffic:
            traffic_ = merge_spec(traffic_, traffic)

        results = get_user_traffic(
            'throughput',
            '%d tests, %d seconds iterations, %f packet loss, multistream '
            '%s' % (tests, duration, lossrate, traffic['multistream']),
            traffic_,
            ('frames tx', 'frames rx', 'tx rate %', 'rx rate %', 'min latency',
             'max latency', 'avg latency', 'frameloss %'))

        framesize = traffic_['l2']['framesize']

        # builds results by using user-supplied values
        # and guessing remainder using available info
        result[ResultsConstants.TX_RATE_FPS] = float(results[0]) / duration
        result[ResultsConstants.THROUGHPUT_RX_FPS] = float(results[1]) / duration
        result[ResultsConstants.TX_RATE_MBPS] = (float(results[0]) / duration) \
                                                 * (framesize * 8 / 1000000)
        result[ResultsConstants.THROUGHPUT_RX_MBPS] = (float(results[1]) / duration) \
                                                 * (framesize * 8 / 1000000)
        result[ResultsConstants.TX_RATE_PERCENT] = float(results[2])
        result[ResultsConstants.THROUGHPUT_RX_PERCENT] = float(results[3])
        result[ResultsConstants.MIN_LATENCY_NS] = float(results[4])
        result[ResultsConstants.MAX_LATENCY_NS] = float(results[5])
        result[ResultsConstants.AVG_LATENCY_NS] = float(results[6])
        result[ResultsConstants.FRAME_LOSS_PERCENT] = float(results[7])
        return result

    def send_rfc2544_back2back(self, traffic=None, tests=1, duration=2,
                               lossrate=0.0):
        """
        Send traffic per RFC2544 back2back test specifications.
        """
        traffic_ = self.traffic_defaults.copy()
        result = OrderedDict()

        if traffic:
            traffic_ = merge_spec(traffic_, traffic)

        results = get_user_traffic(
            'back2back',
            '%d tests, %d seconds iterations, %f packet loss, multistream '
            '%s' % (tests, duration, lossrate, traffic['multistream']),
            traffic_,
            ('b2b frames', 'b2b frame loss %'))

        # builds results by using user-supplied values
        # and guessing remainder using available info
        result[ResultsConstants.B2B_FRAMES] = float(results[0])
        result[ResultsConstants.B2B_FRAME_LOSS_PERCENT] = float(results[1])
        return result

    def start_cont_traffic(self, traffic=None, duration=20):
        return NotImplementedError('Dummy does not implement start_cont_traffic')

    def stop_cont_traffic(self):
        return NotImplementedError(
            'Dummy does not implement stop_cont_traffic')

    def start_rfc2544_back2back(self, traffic=None, tests=1, duration=20,
                                lossrate=0.0):
        return NotImplementedError(
            'Dummy does not implement start_rfc2544_back2back')

    def wait_rfc2544_back2back(self):
        return NotImplementedError(
            'Dummy does not implement stop_cont_traffic')

    def start_rfc2544_throughput(self, traffic=None, tests=1, duration=20,
                                 lossrate=0.0):
        return NotImplementedError(
            'Dummy does not implement start_rfc2544_throughput')

    def wait_rfc2544_throughput(self):
        return NotImplementedError(
            'Dummy does not implement wait_rfc2544_throughput')

if __name__ == '__main__':
    TRAFFIC = {
        'l3': {
            'proto': 'tcp',
            'srcip': '1.1.1.1',
            'dstip': '90.90.90.90',
        },
    }

    with Dummy() as dev:
        print(dev.send_burst_traffic(traffic=TRAFFIC))
        print(dev.send_cont_traffic(traffic=TRAFFIC))
        print(dev.send_rfc2544_throughput(traffic=TRAFFIC))
        print(dev.send_rfc2544_back2back(traffic=TRAFFIC))
        # pylint: disable=no-member
        print(dev.send_rfc(traffic=TRAFFIC))