Page MenuHomeFreeBSD
Differential D38053 Diff 117620 sbin/ping/tests/test_ping.py

Changeset View

Standalone View

View Options

sbin/ping/tests/test_ping.py

  • This file was added.
import pytest
import logging
import os
import re
import subprocess
from atf_python.sys.net.vnet import IfaceFactory
from atf_python.sys.net.vnet import SingleVnetTestTemplate
from atf_python.sys.net.tools import ToolsHelper
from typing import List
from typing import Optional
logging.getLogger("scapy").setLevel(logging.CRITICAL)
import scapy.all as sc
def build_response_packet(echo, ip, icmp, oip_ihl, special):
icmp_id_seq_types = [0, 8, 13, 14, 15, 16, 17, 18, 37, 38]
oip = echo[sc.IP]
oicmp = echo[sc.ICMP]
load = echo[sc.ICMP].payload
oip[sc.IP].remove_payload()
oicmp[sc.ICMP].remove_payload()
oicmp.type = 8
# As if the original IP packet had these set
oip.ihl = None
oip.len = None
oip.id = 1
oip.flags = ip.flags
oip.chksum = None
oip.options = ip.options
# Inner packet (oip) options
if oip_ihl:
oip.ihl = oip_ihl
# Special options
if special == "no-payload":
load = ""
if special == "tcp":
oip.proto = "tcp"
tcp = sc.TCP(sport=1234, dport=5678)
return ip / icmp / oip / tcp
if special == "udp":
oip.proto = "udp"
udp = sc.UDP(sport=1234, dport=5678)
return ip / icmp / oip / udp
if special == "warp":
# Build a package with a timestamp of INT_MAX
# (time-warped package)
payload_no_timestamp = sc.bytes_hex(load)[16:]
load = (b"\xff" * 8) + sc.hex_bytes(payload_no_timestamp)
if special == "wrong":
# Build a package with a wrong last byte
payload_no_last_byte = sc.bytes_hex(load)[:-2]
load = (sc.hex_bytes(payload_no_last_byte)) + b"\x00"
if icmp.type in icmp_id_seq_types:
pkt = ip / icmp / load
else:
ip.options = ""
pkt = ip / icmp / oip / oicmp / load
return pkt
melifaroUnsubmitted
Done
Inline Actions

I’ve some plans on checking inet/inet6 support and skip tests that require something that’s not supported.
This works iff the test requests only the required families. For some tests one can tweak the PREFIXES lis based on the test name, like here: https://github.com/freebsd/freebsd-src/blob/main/tests/sys/net/routing/test_rtsock_multipath.py#L10

Happy to discuss any approaches here

melifaro: I’ve some plans on checking inet/inet6 support and skip tests that require something that’s not…
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

Great! Yes, the idea is that it should be transparent to the consumer, and gracefully skip the test.

jlduran_gmail.com: Great! Yes, the idea is that it should be transparent to the consumer, and gracefully skip the…
def generate_ip_options(opts):
if not opts:
return ""
routers = [
"192.0.2.10",
"192.0.2.20",
"192.0.2.30",
"192.0.2.40",
"192.0.2.50",
"192.0.2.60",
"192.0.2.70",
"192.0.2.80",
"192.0.2.90",
]
routers_zero = [0, 0, 0, 0, 0, 0, 0, 0, 0]
if opts == "EOL":
options = sc.IPOption(b"\x00")
elif opts == "NOP":
options = sc.IPOption(b"\x01")
elif opts == "NOP-40":
options = sc.IPOption(b"\x01" * 40)
melifaroUnsubmitted
Done
Inline Actions

Nit: I'd wrap this in a function somewhere inside tests/atf_python/sys/net/tools.py or similar.
Setting sysctls is a common thing and we should abstract the implementation

melifaro: Nit: I'd wrap this in a function somewhere inside `tests/atf_python/sys/net/tools.py` or…
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

Will do!

jlduran_gmail.com: Will do!
elif opts == "RR":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_RR(pointer=40, routers=routers)
elif opts == "RR-same":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_RR(pointer=3, routers=routers_zero)
elif opts == "RR-trunc":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_RR(length=7, routers=routers_zero)
elif opts == "LSRR":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_LSRR(routers=routers)
elif opts == "LSRR-trunc":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_LSRR(length=3, routers=routers_zero)
elif opts == "SSRR":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_SSRR(routers=routers)
elif opts == "SSRR-trunc":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption_SSRR(length=3, routers=routers_zero)
elif opts == "unk":
ngieUnsubmitted
Done
Inline Actions

I recommend using type hints instead of encoding the types for parameters and return values in functions/method docstrings: it eliminates useless metadata and allows other tools like mypy or pylint to analyze the type hints and help evaluate correctness.

ngie: I recommend using type hints instead of encoding the types for parameters and return values in…
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

Good idea! I'll try that.

jlduran_gmail.com: Good idea! I'll try that.
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption(b"\x9f")
elif opts == "unk-40":
ToolsHelper.set_sysctl("net.inet.ip.process_options", 0)
options = sc.IPOption(b"\x9f" * 40)
else:
options = ""
return options
def pinger(
# Required arguments
# Avoid setting defaults on these arguments,
# as we want to set them explicitly in the tests
iface: str,
/,
src: sc.scapy.fields.SourceIPField,
dst: sc.scapy.layers.inet.DestIPField,
icmp_type: sc.scapy.fields.ByteEnumField,
icmp_code: sc.scapy.fields.MultiEnumField,
# IP arguments
ihl: Optional[sc.scapy.fields.BitField] = None,
flags: Optional[sc.scapy.fields.FlagsField] = None,
opts: Optional[str] = None,
oip_ihl: Optional[sc.scapy.fields.BitField] = None,
special: Optional[str] = None,
# ICMP arguments
# Match names with <netinet/ip_icmp.h>
icmp_pptr: sc.scapy.fields.ByteField = 0,
icmp_gwaddr: sc.scapy.fields.IPField = "0.0.0.0",
icmp_nextmtu: sc.scapy.fields.ShortField = 0,
icmp_otime: sc.scapy.layers.inet.ICMPTimeStampField = 0,
icmp_rtime: sc.scapy.layers.inet.ICMPTimeStampField = 0,
icmp_ttime: sc.scapy.layers.inet.ICMPTimeStampField = 0,
icmp_mask: sc.scapy.fields.IPField = "0.0.0.0",
request: Optional[str] = None,
# Miscellaneous arguments
count: int = 1,
dup: bool = False,
) -> subprocess.CompletedProcess:
"""P I N G E R
Echo reply faker
:param str iface: Interface to send packet to
:keyword src: Source packet IP
:type src: class:`scapy.fields.SourceIPField`
:keyword dst: Destination packet IP
:type dst: class:`scapy.layers.inet.DestIPField`
:keyword icmp_type: ICMP type
:type icmp_type: class:`scapy.fields.ByteEnumField`
:keyword icmp_code: ICMP code
:type icmp_code: class:`scapy.fields.MultiEnumField`
:keyword ihl: Internet Header Length, defaults to None
:type ihl: class:`scapy.fields.BitField`, optional
:keyword flags: IP flags - one of `DF`, `MF` or `evil`, defaults to None
:type flags: class:`scapy.fields.FlagsField`, optional
:keyword opts: Include IP options - one of `EOL`, `NOP`, `NOP-40`, `unk`,
`unk-40`, `RR`, `RR-same`, `RR-trunc`, `LSRR`, `LSRR-trunc`, `SSRR` or
`SSRR-trunc`, defaults to None
:type opts: str, optional
:keyword oip_ihl: Inner packet's Internet Header Length, defaults to None
:type oip_ihl: class:`scapy.fields.BitField`, optional
:keyword special: Send a special packet - one of `no-payload`, `tcp`,
`udp`, `wrong` or `warp`, defaults to None
:type special: str, optional
:keyword icmp_pptr: ICMP pointer, defaults to 0
:type icmp_pptr: class:`scapy.fields.ByteField`
:keyword icmp_gwaddr: ICMP gateway IP address, defaults to "0.0.0.0"
:type icmp_gwaddr: class:`scapy.fields.IPField`
:keyword icmp_nextmtu: ICMP next MTU, defaults to 0
:type icmp_nextmtu: class:`scapy.fields.ShortField`
:keyword icmp_otime: ICMP originate timestamp, defaults to 0
:type icmp_otime: class:`scapy.layers.inet.ICMPTimeStampField`
:keyword icmp_rtime: ICMP receive timestamp, defaults to 0
:type icmp_rtime: class:`scapy.layers.inet.ICMPTimeStampField`
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

This can be abstracted as well, but I'll have to teach VnetInterface.setup_addr to understand tun(4) interfaces...

jlduran_gmail.com: This can be abstracted as well, but I'll have to teach `VnetInterface.setup_addr` to understand…
:keyword icmp_ttime: ICMP transmit timestamp, defaults to 0
:type icmp_ttime: class:`scapy.layers.inet.ICMPTimeStampField`
:keyword icmp_mask: ICMP address mask, defaults to "0.0.0.0"
:type icmp_mask: class:`scapy.fields.IPField`
:keyword request: Request type - one of `mask` or `timestamp`,
defaults to None
:type request: str, optional
:keyword count: Number of packets to send, defaults to 1
:type count: int
:keyword dup: Duplicate packets, defaults to `False`
:type dup: bool
:return: A class:`subprocess.CompletedProcess` with the output from the
ping utility
:rtype: class:`subprocess.CompletedProcess`
"""
tun = sc.TunTapInterface(iface)
subprocess.run(["ifconfig", tun.iface, "up"], check=True)
subprocess.run(["ifconfig", tun.iface, src, dst], check=True)
ip_opts = generate_ip_options(opts)
ip = sc.IP(ihl=ihl, flags=flags, src=dst, dst=src, options=ip_opts)
command = [
"/sbin/ping",
"-c",
str(count),
"-t",
str(count),
"-v",
]
if request == "mask":
command += ["-Mm"]
if request == "timestamp":
command += ["-Mt"]
if special:
command += ["-p1"]
if opts in [
"RR",
"RR-same",
"RR-trunc",
"LSRR",
"LSRR-trunc",
"SSRR",
"SSRR-trunc",
]:
command += ["-R"]
command += [dst]
with subprocess.Popen(
args=command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True
) as ping:
for dummy in range(count):
echo = tun.recv()
icmp = sc.ICMP(
type=icmp_type,
code=icmp_code,
id=echo[sc.ICMP].id,
seq=echo[sc.ICMP].seq,
ts_ori=icmp_otime,
ts_rx=icmp_rtime,
ts_tx=icmp_ttime,
gw=icmp_gwaddr,
ptr=icmp_pptr,
addr_mask=icmp_mask,
nexthopmtu=icmp_nextmtu,
)
pkt = build_response_packet(echo, ip, icmp, oip_ihl, special)
tun.send(pkt)
if dup is True:
tun.send(pkt)
stdout, stderr = ping.communicate()
return subprocess.CompletedProcess(
ping.args, ping.returncode, stdout, stderr
)
def redact(output):
"""Redact some elements of ping's output"""
pattern_replacements = [
("localhost \([0-9]{1,3}(\.[0-9]{1,3}){3}\)", "localhost"),
("from [0-9]{1,3}(\.[0-9]{1,3}){3}", "from"),
("hlim=[0-9]*", "hlim="),
("ttl=[0-9]*", "ttl="),
("time=[0-9.-]*", "time="),
("[0-9\.]+/[0-9.]+", "/"),
]
for pattern, repl in pattern_replacements:
output = re.sub(pattern, repl, output)
return output
ngieUnsubmitted
Not Done
Inline Actions

A lot of output metadata is being baked into the tests. I would consider abbreviating the responses somehow, or maybe make the parameters into a higher-level global dictionary, so some of the indentation can be reduced.
Also, some of these test cases rely on IPv4 and/or IPv6 support being enabled in the kernel: I would consider adding decorators and/or fixtures to check for this address family support before running a series of tests which will fail.

ngie: A lot of output metadata is being baked into the tests. I would consider abbreviating the…
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

A lot of output metadata is being baked into the tests. I would consider abbreviating the responses somehow, or maybe make the parameters into a higher-level global dictionary, so some of the indentation can be reduced.

Unfortunately we'll need almost all that info. This file will harbor a lot more tests and every single thing in the response needs to be scrutinized, the abstraction you are proposing would imply nearly re-implementing ping's printf routines here? I would prefer if we can avoid that! There are may more tests coming, e.g., we have opted to not remove the negative sign of the time, as there was a PR (now closed #192417), that we can artificially trigger, and we need the sign to identify when the statistics have been tampered, and void them, for instance.

Also, some of these test cases rely on IPv4 and/or IPv6 support being enabled in the kernel: I would consider adding decorators and/or fixtures to check for this address family support before running a series of tests which will fail.

The IPv4/IPv6 support should automagically be handled by ATF-Python, if not fully at the moment, eventually in the future it will. The plan is to polish this testing framework as we go along. Ideally, let the framework work for us, so we don't need to worry about implementing those details on every test. This was also one of the reasons why we decided to try ATF-Python; with ATF-sh a lot of this repetition is needed, bloating even more the tests.

jlduran_gmail.com: > A lot of output metadata is being baked into the tests. I would consider abbreviating the…
class TestPing(SingleVnetTestTemplate):
IPV6_PREFIXES: List[str] = ["2001:db8::1/64"]
IPV4_PREFIXES: List[str] = ["192.0.2.1/24"]
# Each param in testdata contains a dictionary with the command,
# and the expected outcome (returncode, redacted stdout, and stderr)
testdata = [
pytest.param(
{
"args": "ping -4 -c1 -s56 -t1 localhost",
"returncode": 0,
"stdout": """\
PING localhost: 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
--- localhost ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_4_c1_s56_t1_localhost",
),
pytest.param(
{
"args": "ping -6 -c1 -s8 -t1 localhost",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) ::1 --> ::1
16 bytes from ::1, icmp_seq=0 hlim= time= ms
--- localhost ping6 statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_6_c1_s8_t1_localhost",
),
pytest.param(
{
"args": "ping -A -c1 192.0.2.1",
"returncode": 0,
"stdout": """\
PING 192.0.2.1 (192.0.2.1): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
--- 192.0.2.1 ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_A_c1_192_0_2_1",
),
pytest.param(
{
"args": "ping -A -c1 192.0.2.2",
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_A_c1_192_0_2_2",
),
pytest.param(
{
"args": "ping -A -c1 2001:db8::1",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::1
16 bytes from 2001:db8::1, icmp_seq=0 hlim= time= ms
--- 2001:db8::1 ping6 statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_A_c1_2001_db8__1",
),
pytest.param(
{
"args": "ping -A -c1 2001:db8::2",
"returncode": 2,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::2
--- 2001:db8::2 ping6 statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_A_c1_2001_db8__2",
),
pytest.param(
{
"args": "ping -A -c3 192.0.2.1",
"returncode": 0,
"stdout": """\
PING 192.0.2.1 (192.0.2.1): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
64 bytes from: icmp_seq=1 ttl= time= ms
64 bytes from: icmp_seq=2 ttl= time= ms
--- 192.0.2.1 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_A_3_192_0.2.1",
),
pytest.param(
{
"args": "ping -A -c3 192.0.2.2",
"returncode": 2,
"stdout": """\
\x07\x07PING 192.0.2.2 (192.0.2.2): 56 data bytes
--- 192.0.2.2 ping statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_A_c3_192_0_2_2",
),
pytest.param(
{
ngieUnsubmitted
Not Done
Inline Actions

Coming up with human-readable descriptions of this would probably be better, e.g., "audible_bell_three_count_ipv4".

ngie: Coming up with human-readable descriptions of this would probably be better, e.g.
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

Originally I had these names programmatically created, because a lot more of them would be added. We'll be testing nearly every command option. But, yes, whenever possible, I'll try adding a descriptive, human name to the test.
With ATF-sh, this was the "descr", I wonder if we could adapt something similar here?

jlduran_gmail.com: Originally I had these names programmatically created, because a lot more of them would be…
"args": "ping -A -c3 2001:db8::1",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::1
16 bytes from 2001:db8::1, icmp_seq=0 hlim= time= ms
16 bytes from 2001:db8::1, icmp_seq=1 hlim= time= ms
16 bytes from 2001:db8::1, icmp_seq=2 hlim= time= ms
--- 2001:db8::1 ping6 statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_A_c3_2001_db8__1",
),
pytest.param(
{
"args": "ping -A -c3 2001:db8::2",
"returncode": 2,
"stdout": """\
\x07\x07PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::2
--- 2001:db8::2 ping6 statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_A_c3_2001_db8__2",
),
pytest.param(
{
"args": "ping -c1 192.0.2.1",
"returncode": 0,
"stdout": """\
PING 192.0.2.1 (192.0.2.1): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
--- 192.0.2.1 ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_c1_192_0_2_1",
),
pytest.param(
{
"args": "ping -c1 192.0.2.2",
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_c1_192_0_2_2",
),
pytest.param(
{
"args": "ping -c1 2001:db8::1",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::1
16 bytes from 2001:db8::1, icmp_seq=0 hlim= time= ms
--- 2001:db8::1 ping6 statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_c1_2001_db8__1",
),
pytest.param(
{
"args": "ping -c1 2001:db8::2",
"returncode": 2,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::2
--- 2001:db8::2 ping6 statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_c1_2001_db8__2",
),
pytest.param(
{
"args": "ping -c1 -S127.0.0.1 -s56 -t1 localhost",
"returncode": 0,
"stdout": """\
PING localhost from: 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
melifaroUnsubmitted
Done
Inline Actions

Each test consists of params, stdout and returncode.
Maybe it's worth encoding them directly as the test parameters?

e.g.

    @pytest.mark.parametrize(
        "params",
        [
            pytest.param(
                {
                    "args": "-4 -c1 -s56 -t1 localhost",
                    "returncode": 2,
                    "stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes

--- 192.0.2.2 ping statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
"""
                },
                id="ipandif",
            ),
        ],
    )
melifaro: Each test consists of `params`, `stdout` and `returncode`. Maybe it's worth encoding them…
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

Yes, that's how they started, it looked bulky, but let me update it the way you are suggesting.
May I also add stderr (see the`_Wx_localhost`), to keep it inline with atf-check(1).
I also do not like that things are in "two places".

jlduran_gmail.com: Yes, that's how they started, it looked bulky, but let me update it the way you are suggesting.
--- localhost ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_c1_S127_0_0_1_s56_t1_localhost",
),
pytest.param(
{
"args": "ping -c1 -S::1 -s8 -t1 localhost",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) ::1 --> ::1
16 bytes from ::1, icmp_seq=0 hlim= time= ms
--- localhost ping6 statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_c1_S__1_s8_t1_localhost",
),
pytest.param(
{
"args": "ping -c3 192.0.2.1",
"returncode": 0,
"stdout": """\
PING 192.0.2.1 (192.0.2.1): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
64 bytes from: icmp_seq=1 ttl= time= ms
64 bytes from: icmp_seq=2 ttl= time= ms
asomersUnsubmitted
Done
Inline Actions

What does ids do?

asomers: What does `ids` do?
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

The ids is the text inside the brackets when parameterized, (as in kyua list).
From https://docs.pytest.org/en/7.2.x/how-to/fixtures.html:

Numbers, strings, booleans and None will have their usual string representation used in the test ID. For other objects, pytest will make a string based on the argument name. It is possible to customize the string used in a test ID for a certain fixture value by using the ids keyword argument.

jlduran_gmail.com: The `ids` is the text inside the brackets when parameterized, (as in `kyua list`). From https…
--- 192.0.2.1 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
melifaroUnsubmitted
Done
Inline Actions
@pytest.mark.timeout(10)
melifaro: ``` @pytest.mark.timeout(10) ```
jlduran_gmail.comAuthorUnsubmitted
Done
Inline Actions

OK, will do. atf-check(1) uses 50 ms by default, subprocess.run() uses None.

jlduran_gmail.com: OK, will do. `atf-check(1)` uses 50 ms by default, `subprocess.run()` uses `None`.
"stderr": "",
},
id="_c3_192_0_2_1",
),
pytest.param(
{
"args": "ping -c3 192.0.2.2",
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
--- 192.0.2.2 ping statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_c3_192_0_2_2",
),
pytest.param(
{
"args": "ping -c3 2001:db8::1",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::1
16 bytes from 2001:db8::1, icmp_seq=0 hlim= time= ms
16 bytes from 2001:db8::1, icmp_seq=1 hlim= time= ms
16 bytes from 2001:db8::1, icmp_seq=2 hlim= time= ms
--- 2001:db8::1 ping6 statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_c3_2001_db8__1",
),
pytest.param(
{
"args": "ping -c3 2001:db8::2",
"returncode": 2,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::2
--- 2001:db8::2 ping6 statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_c3_2001_db8__2",
),
pytest.param(
{
"args": "ping -q -c1 192.0.2.1",
"returncode": 0,
"stdout": """\
PING 192.0.2.1 (192.0.2.1): 56 data bytes
--- 192.0.2.1 ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_q_c1_192_0_2_1",
),
pytest.param(
{
"args": "ping -q -c1 192.0.2.2",
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_q_c1_192_0_2_2",
),
pytest.param(
{
"args": "ping -q -c1 2001:db8::1",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::1
--- 2001:db8::1 ping6 statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_q_c1_2001_db8__1",
),
pytest.param(
{
"args": "ping -q -c1 2001:db8::2",
"returncode": 2,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::2
--- 2001:db8::2 ping6 statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_q_c1_2001_db8__2",
),
pytest.param(
{
"args": "ping -q -c3 192.0.2.1",
"returncode": 0,
"stdout": """\
PING 192.0.2.1 (192.0.2.1): 56 data bytes
--- 192.0.2.1 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
},
id="_q_c3_192_0_2_1",
),
pytest.param(
{
"args": "ping -q -c3 192.0.2.2",
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
--- 192.0.2.2 ping statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_q_c3_192_0_2_2",
),
pytest.param(
{
"args": "ping -q -c3 2001:db8::1",
"returncode": 0,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::1
--- 2001:db8::1 ping6 statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/std-dev = /// ms
""",
"stderr": "",
},
id="_q_c3_2001_db8__1",
),
pytest.param(
{
"args": "ping -q -c3 2001:db8::2",
"returncode": 2,
"stdout": """\
PING6(56=40+8+8 bytes) 2001:db8::1 --> 2001:db8::2
--- 2001:db8::2 ping6 statistics ---
3 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
},
id="_q_c3_2001_db8__2",
),
]
@pytest.mark.parametrize("expected", testdata)
def test_ping(self, expected):
"""Test ping"""
ping = subprocess.run(
expected["args"].split(),
capture_output=True,
timeout=15,
text=True,
)
assert ping.returncode == expected["returncode"]
assert redact(ping.stdout) == expected["stdout"]
assert ping.stderr == expected["stderr"]
# Each param in ping46_testdata contains a dictionary with the arguments
# and the expected outcome (returncode, redacted stdout, and stderr)
# common to `ping -4` and `ping -6`
ping46_testdata = [
pytest.param(
{
"args": "-Wx localhost",
"returncode": os.EX_USAGE,
"stdout": "",
"stderr": "ping: invalid timing interval: `x'\n",
},
marks=pytest.mark.skip("XXX currently failing"),
id="_Wx_localhost",
),
]
@pytest.mark.parametrize("expected", ping46_testdata)
def test_ping_46(self, expected):
"""Test ping -4/ping -6"""
for version in [4, 6]:
ping = subprocess.run(
["ping", f"-{version}"] + expected["args"].split(),
capture_output=True,
timeout=15,
text=True,
)
assert ping.returncode == expected["returncode"]
assert redact(ping.stdout) == expected["stdout"]
assert ping.stderr == expected["stderr"]
# Each param in pinger_testdata contains a dictionary with the keywords to
# `pinger()` and a dictionary with the expected outcome (returncode,
# stdout, stderr, and if ping's output is redacted)
pinger_testdata = [
pytest.param(
{
"src": "192.0.2.1",
"dst": "192.0.2.2",
"icmp_type": 0,
"icmp_code": 0,
},
{
"returncode": 0,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
"redacted": True,
},
id="_0_0",
),
pytest.param(
{
"src": "192.0.2.1",
"dst": "192.0.2.2",
"icmp_type": 0,
"icmp_code": 0,
"opts": "NOP-40",
},
{
"returncode": 0,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
wrong total length 124 instead of 84
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
NOP
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
"redacted": True,
},
id="_0_0_opts_NOP_40",
),
pytest.param(
{
"src": "192.0.2.1",
"dst": "192.0.2.2",
"icmp_type": 0,
"icmp_code": 0,
"opts": "unk",
},
{
"returncode": 0,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
64 bytes from: icmp_seq=0 ttl= time= ms
wrong total length 88 instead of 84
unknown option 9f
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 1 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = /// ms
""",
"stderr": "",
"redacted": True,
},
marks=pytest.mark.skip("XXX currently failing"),
id="_0_0_opts_unk",
),
pytest.param(
{
"src": "192.0.2.1",
"dst": "192.0.2.2",
"icmp_type": 3,
"icmp_code": 1,
"opts": "NOP-40",
},
{
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
132 bytes from 192.0.2.2: Destination Host Unreachable
Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
4 f 00 007c 0001 0 0000 40 01 d868 192.0.2.1 192.0.2.2 01010101010101010101010101010101010101010101010101010101010101010101010101010101
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
"redacted": False,
},
marks=pytest.mark.skip("XXX currently failing"),
id="_3_1_opts_NOP_40",
),
pytest.param(
{
"src": "192.0.2.1",
"dst": "192.0.2.2",
"icmp_type": 3,
"icmp_code": 1,
"flags": "DF",
},
{
"returncode": 2,
"stdout": """\
PING 192.0.2.2 (192.0.2.2): 56 data bytes
92 bytes from 192.0.2.2: Destination Host Unreachable
Vr HL TOS Len ID Flg off TTL Pro cks Src Dst
4 5 00 0054 0001 2 0000 40 01 b6a4 192.0.2.1 192.0.2.2
--- 192.0.2.2 ping statistics ---
1 packets transmitted, 0 packets received, 100.0% packet loss
""",
"stderr": "",
"redacted": False,
},
marks=pytest.mark.skip("XXX currently failing"),
id="_3_1_flags_DF",
),
]
@pytest.mark.parametrize("pinger_kargs, expected", pinger_testdata)
@pytest.mark.require_progs(["scapy"])
@pytest.mark.require_user("root")
def test_pinger(self, pinger_kargs, expected):
"""Test ping using pinger(), a reply faker"""
iface = IfaceFactory().create_iface("", "tun")[0].name
ping = pinger(iface, **pinger_kargs)
assert ping.returncode == expected["returncode"]
if expected["redacted"]:
assert redact(ping.stdout) == expected["stdout"]
else:
assert ping.stdout == expected["stdout"]
assert ping.stderr == expected["stderr"]