Adding upstream version 4.2.2.upstream/4.2.2

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 270 insertions, 0 deletions

diff --git a/test/suite_mergecap.py b/test/suite_mergecap.py
new file mode 100644
index 00000000..95e657b5
--- /dev/null
+++ b/test/suite_mergecap.py
@@ -0,0 +1,270 @@
+#
+# Wireshark tests
+# By Gerald Combs <gerald@wireshark.org>
+#
+# Ported from a set of Bash scripts which were copyright 2005 Ulf Lamping
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+'''Mergecap tests'''
+
+import re
+import subprocess
+from subprocesstest import grep_output
+
+testout_pcap = 'testout.pcap'
+testout_pcapng = 'testout.pcapng'
+
+file_type_to_descr = {
+    'pcap': 'Wireshark/tcpdump/... - pcap',
+    'pcapng': 'Wireshark/... - pcapng',
+}
+
+# common checking code:
+# arg 1 = return value from mergecap command
+# arg 2 = file type string
+# arg 3 = file encap
+# arg 4 = number of IDBs generated
+# arg 5 = number of file packets merged
+# arg 6 = number of some IDB packets merged
+def check_mergecap(mergecap_proc, file_type, encapsulation, tot_packets, generated_idbs, idb_packets, cmd_capinfos, testout_file, env=None):
+
+    assert mergecap_proc.returncode == 0
+    assert grep_output(mergecap_proc.stderr, 'merging complete')
+    assert file_type in file_type_to_descr, 'Invalid file type'
+
+    capinfos_stdout = subprocess.check_output([cmd_capinfos, '-t', '-E', '-I', '-c', testout_file], encoding='utf-8', env=env)
+
+    file_descr = file_type_to_descr[file_type]
+    type_pat = r'File type:\s+{}'.format(file_descr)
+    assert re.search(type_pat, capinfos_stdout), \
+        'Failed to generate a {} file'.format(file_type)
+
+    encap_pat = r'File encapsulation:\s+{}'.format(encapsulation)
+    assert re.search(encap_pat, capinfos_stdout), \
+        'Failed to generate an {} encapsulation'.format(encapsulation)
+
+    pkt_pat = r'Number of packets:\s+{}'.format(tot_packets)
+    assert re.search(pkt_pat, capinfos_stdout), \
+        'Failed to generate {} packets'.format(tot_packets)
+
+    gidb_pat = r'Number of interfaces in file:\s+{}'.format(generated_idbs)
+    assert re.search(gidb_pat, capinfos_stdout), \
+        'Failed to generate {} IDBs'.format(generated_idbs)
+
+    midb_pat = r'\s+Number of packets\s+=\s+{}'.format(idb_packets)
+    assert re.search(midb_pat, capinfos_stdout), \
+        'Failed to merge {} IDB packets'.format(idb_packets)
+
+
+class TestMergecapPcap:
+    def test_mergecap_basic_1_pcap_pcap(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge a single pcap file to pcap'''
+        # $MERGECAP -vF pcap -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcap)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-F', 'pcap',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcap', 'Ethernet', 4, 1, 4, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_2_pcap_pcap(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge two pcap files to pcap'''
+        # $MERGECAP -vF pcap -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcap)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-F', 'pcap',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'), capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcap', 'Ethernet', 8, 1, 8, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_3_empty_pcap_pcap(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge three pcap files to pcap, two empty'''
+        # $MERGECAP -vF pcap -w testout.pcap "${CAPTURE_DIR}empty.pcap" "${CAPTURE_DIR}dhcp.pcap" "${CAPTURE_DIR}empty.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcap)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-F', 'pcap',
+            '-w', testout_file,
+            capture_file('empty.pcap'), capture_file('dhcp.pcap'), capture_file('empty.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcap', 'Ethernet', 4, 1, 4, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_2_nano_pcap_pcap(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge two pcap files to pcap, one with nanosecond timestamps'''
+        # $MERGECAP -vF pcap -w testout.pcap "${CAPTURE_DIR}dhcp-nanosecond.pcap" "${CAPTURE_DIR}rsasnakeoil2.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcap)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-F', 'pcap',
+            '-w', testout_file,
+            capture_file('dhcp-nanosecond.pcap'), capture_file('rsasnakeoil2.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcap', 'Ethernet', 62, 1, 62, cmd_capinfos, testout_file, test_env)
+
+
+class TestMergecapPcapng:
+    def test_mergecap_basic_1_pcap_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge a single pcap file to pcapng'''
+        # $MERGECAP -v -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Ethernet', 4, 1, 4, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_2_pcap_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge two pcap files to pcapng'''
+        # $MERGECAP -v -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'), capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Ethernet', 8, 1, 8, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_2_pcap_none_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge two pcap files to pcapng, "none" merge mode'''
+        # $MERGECAP -vI 'none' -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-I', 'none',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'), capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Ethernet', 8, 2, 4, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_2_pcap_all_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge two pcap files to pcapng, "all" merge mode'''
+        # $MERGECAP -vI 'all' -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-I', 'all',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'), capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Ethernet', 8, 1, 8, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_2_pcap_any_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge two pcap files to pcapng, "any" merge mode'''
+        # $MERGECAP -vI 'any' -w testout.pcap "${CAPTURE_DIR}dhcp.pcap" "${CAPTURE_DIR}dhcp.pcap" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-I', 'any',
+            '-w', testout_file,
+            capture_file('dhcp.pcap'), capture_file('dhcp.pcap'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Ethernet', 8, 1, 8, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_basic_1_pcapng_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge a single pcapng file to pcapng'''
+        # $MERGECAP -v -w testout.pcap "${CAPTURE_DIR}dhcp.pcapng" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-w', testout_file,
+            capture_file('dhcp.pcapng'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Ethernet', 4, 1, 4, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_1_pcapng_many_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge one pcapng file with many interfaces to pcapng'''
+        # $MERGECAP -v -w testout.pcap "${CAPTURE_DIR}many_interfaces.pcapng.1" > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-w', testout_file,
+            capture_file('many_interfaces.pcapng.1'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Per packet', 64, 11, 62, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_3_pcapng_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge multiple pcapng files with many interfaces to pcapng'''
+        # $MERGECAP -v -w testout.pcap "${CAPTURE_DIR}"many_interfaces.pcapng* > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-w', testout_file,
+            capture_file('many_interfaces.pcapng.1'),
+            capture_file('many_interfaces.pcapng.2'),
+            capture_file('many_interfaces.pcapng.3'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap( mergecap_proc, 'pcapng', 'Per packet', 88, 11, 86, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_3_pcapng_none_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge multiple pcapng files with many interfaces to pcapng, "none" merge mode'''
+        # $MERGECAP -vI 'none' -w testout.pcap "${CAPTURE_DIR}"many_interfaces.pcapng* > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-I', 'none',
+            '-w', testout_file,
+            capture_file('many_interfaces.pcapng.1'),
+            capture_file('many_interfaces.pcapng.2'),
+            capture_file('many_interfaces.pcapng.3'),
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        check_mergecap(mergecap_proc, 'pcapng', 'Per packet', 88, 33, 62, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_3_pcapng_all_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge multiple pcapng files to pcapng in "none" mode, then merge that to "all" mode.'''
+        # build a pcapng of all the interfaces repeated by using mode 'none'
+        # $MERGECAP -vI 'none' -w testin.pcap "${CAPTURE_DIR}"many_interfaces.pcapng* > testout.txt 2>&1
+        testin_file = result_file('testin.pcapng')
+        subprocess.check_call((cmd_mergecap,
+            '-V',
+            '-I', 'none',
+            '-w', testin_file,
+            capture_file('many_interfaces.pcapng.1'),
+            capture_file('many_interfaces.pcapng.2'),
+            capture_file('many_interfaces.pcapng.3'),
+        ))
+        # the above generated 33 IDBs, 88 total pkts, 62 in first IDB
+
+        # and use that generated pcap for our test
+        # $MERGECAP -vI 'all' -w testout.pcap ./testin.pcap ./testin.pcap ./testin.pcap > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-I', 'all',
+            '-w', testout_file,
+            testin_file, testin_file, testin_file,
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        # check for 33 IDBs, 88*3=264 total pkts, 62*3=186 in first IDB
+        check_mergecap(mergecap_proc, 'pcapng', 'Per packet', 264, 33, 186, cmd_capinfos, testout_file, test_env)
+
+    def test_mergecap_3_pcapng_any_pcapng(self, cmd_mergecap, capture_file, result_file, cmd_capinfos, test_env):
+        '''Merge multiple pcapng files to pcapng in "none" mode, then merge that to "all" mode.'''
+        # build a pcapng of all the interfaces repeated by using mode 'none'
+        # $MERGECAP -vI 'none' -w testin.pcap "${CAPTURE_DIR}"many_interfaces.pcapng* > testout.txt 2>&1
+        testin_file = result_file('testin.pcapng')
+        subprocess.check_call((cmd_mergecap,
+            '-V',
+            '-I', 'none',
+            '-w', testin_file,
+            capture_file('many_interfaces.pcapng.1'),
+            capture_file('many_interfaces.pcapng.2'),
+            capture_file('many_interfaces.pcapng.3'),
+        ), env=test_env)
+        # the above generated 33 IDBs, 88 total pkts, 62 in first IDB
+
+        # and use that generated pcap for our test
+        # $MERGECAP -vI 'any' -w testout.pcap ./testin.pcap ./testin.pcap ./testin.pcap > testout.txt 2>&1
+        testout_file = result_file(testout_pcapng)
+        mergecap_proc = subprocess.run((cmd_mergecap,
+            '-V',
+            '-I', 'any',
+            '-w', testout_file,
+            testin_file, testin_file, testin_file,
+        ), capture_output=True, encoding='utf-8', env=test_env)
+        # check for 11 IDBs, 88*3=264 total pkts, 86*3=258 in first IDB
+        check_mergecap(mergecap_proc, 'pcapng', 'Per packet', 264, 11, 258, cmd_capinfos, testout_file, test_env)