Support enumeration and filtering of flows #230

[dipendughosh]

Fixes https://github.com/open-traffic-generator/models/issues/230

View proposed changes in documentation

What has changed (and why) ?

• How to distinguish between egress and ingress flows-

  • Previously flow.packet were used to configure shape of ingress packets only
  • There was no clear distinction between ingress and egress packet shapes, and no way to configure latter
  • Going forward the distinction between ingress and egress flows will be done with flow.ingress_packet and flow.egress_packet.
  • flow.packet shall be deprecated.

• How to track the egress and ingress flows-

  • Under packet header configuration for each field,
    • metric_groups has been replaced with metric_tags containing a list of metric_tag consisting of properties name, offset and length.
  • Under flow metrics request,
    • metric_groups has been replaced with metric_tags containing a list of filter consisting of tag name and list of corresponding values associated with that tag name

What's pending ?

• Description needs to be updated properly. Need feedback from reviewers.

Backwards Compatibility

• No breakage in existing tests - flow.packet is deprecated and metric_groups was never implemented.
• snappi UTs needs update to replace usage of metric_groups with metric_tags and use ingress packet configuration

Examples

• Before

  
  # create a new config object
  test_const = {
      "mac1": ["00:00:01:01:01:01", "00:00:01:01:01:02"],
      "mac2": ["00:00:01:01:01:03", "00:00:01:01:01:04"],
      "ip1": ["1.1.1.1", "1.1.1.2"],
      "ip2": ["1.1.1.3", "1.1.1.4"],
      "tcpPortValue": 80,
  }
  
  config = grpc_api.config()
  
  tx_port, rx_port = config.ports.port(
      name="Tx Port", location="10.36.74.26;02;13"
  ).port(name="Rx Port", location="10.36.74.26;02;14")
  
  flow = config.flows.flow(name="Tx -> Rx Flow")[0]
  flow.tx_rx.port.tx_name = tx_port.name
  flow.tx_rx.port.rx_name = rx_port.name
  flow.size.fixed = 128
  flow.rate.pps = 1000
  flow.duration.fixed_packets.packets = 10000
  
  eth, vlan, ip, tcp = (
      flow.packet.ethernet().vlan().ipv4().tcp()
  )
  
  eth.src.values = test_const["mac1"]
  eth.dst.values = test_const["mac2"]
  ip.src.values = test_const["ip1"]
  ip.dst.values = test_const["ip2"]
  tcp.src_port.value = test_const["tcpPortValue"]
  tcp.dst_port.value = test_const["tcpPortValue"]
  eth.dst.metric_groups.add(name="eth_dst")
  ip.dst.metric_groups.add(name="ip_dst")
  
  response = grpc_api.set_config(config)
  assert len(response.warnings) == 1
  assert response.warnings[0] == "no"
  
  response = grpc_api.get_config()
  assert config.serialize() == response.serialize()

• After

  
  # create a new config object
  test_const = {
      "mac1": ["00:00:01:01:01:01", "00:00:01:01:01:02"],
      "mac2": ["00:00:01:01:01:03", "00:00:01:01:01:04"],
      "mac3": ["00:00:01:01:01:05", "00:00:01:01:01:06"],
      "ip1": ["1.1.1.1", "1.1.1.2"],
      "ip2": ["1.1.1.3", "1.1.1.4"],
      "ip3": ["1.1.1.5", "1.1.1.6"],
      "tcpPortValue": 80,
  }
  
  config = grpc_api.config()
  
  tx_port, rx_port = config.ports.port(
      name="Tx Port", location="10.36.74.26;02;13"
  ).port(name="Rx Port", location="10.36.74.26;02;14")
  
  flow = config.flows.flow(name="Tx -> Rx Flow")[0]
  flow.tx_rx.port.tx_name = tx_port.name
  flow.tx_rx.port.rx_name = rx_port.name
  flow.size.fixed = 128
  flow.rate.pps = 1000
  flow.duration.fixed_packets.packets = 10000
  
  ethIngress, vlanIngress, ipIngress, tcpIngress = (
      flow.ingress_packet.ethernet().vlan().ipv4().tcp()
  )
  
  ethIngress.src.values = test_const["mac1"]
  ethIngress.dst.values = test_const["mac2"]
  ipIngress.src.values = test_const["ip1"]
  ipIngress.dst.values = test_const["ip2"]
  tcpIngress.src_port.value = test_const["tcpPortValue"]
  tcpIngress.dst_port.value = test_const["tcpPortValue"]
  ethIngress.dst.metric_tags.add(name="eth_dst_ingress", offset=40, length=8)
  ipIngress.dst.metric_tags.add(name="ip_dst_ingress", offset=24, length=8)
  
  ethEgress, ipEgress, tcpEgress = (
      flow.egress_packet.ethernet().ipv4().tcp()
  )
  
  ethEgress.src.values = test_const["mac2"]
  ethEgress.dst.values = test_const["mac3"]
  ipEgress.src.values = test_const["ip2"]
  ipEgress.dst.values = test_const["ip3"]
  tcpEgress.src_port.value = test_const["tcpPortValue"]
  tcpEgress.dst_port.value = test_const["tcpPortValue"]
  ethEgress.dst.metric_tags.add(name="eth_dst_egress", offset=40, length=8)
  ipEgress.dst.metric_tags.add(name="ip_dst_egress", offset=24, length=8)
  
  response = grpc_api.set_config(config)
  assert len(response.warnings) == 1
  assert response.warnings[0] == "no"
  
  response = grpc_api.get_config()
  assert config.serialize() == response.serialize()
  grpc_api.get_metrics()

Flow	IPDstIngress	MacDstIngress	MacDstEgress	FramesRx
Tx -> Rx Flow	1.1.1.1	00:00:01:01:01:01	01:03	5000
Tx -> Rx Flow	1.1.1.3	00:00:01:01:01:03	01:05	5000
Tx -> Rx Flow				10000