From 28fe98a570e3395531798d27c1ff36297f979986 Mon Sep 17 00:00:00 2001 From: Susant Sahani Date: Wed, 23 May 2018 17:48:08 +0530 Subject: [PATCH] Adds tests according to the CI Justification Adds tests according to the CI wiki specifically the standard test interface in the spec. The playbook includes Tier1 level test cases that have been tested in the following contexts and is passing reliably: Classic. Test logs are stored in the artifacts directory. The following steps are used to execute the tests using the standard test interface: Test enveronment Make sure you have installed packages from the spec ``` ansible-2.4.1.0-2.fc28.noarch python2-dnf-2.7.5-1.fc28.noarch libselinux-python-2.7-2.fc28.x86_64 standard-test-roles-2.5-1.fc28.noarch Run tests for Classic Snip of the example test run for Classic tests: ``` :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Setup :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: lldpd-1.0.1-1.fc28.x86_64 :: [ 17:45:16 ] :: [ PASS ] :: Checking for the presence of lldpd rpm :: [ 17:45:16 ] :: [ LOG ] :: Package versions: :: [ 17:45:16 ] :: [ LOG ] :: lldpd-1.0.1-1.fc28.x86_64 :: [ 17:45:16 ] :: [ BEGIN ] :: Running 'cp lldpd-tests.py /usr/bin/' :: [ 17:45:16 ] :: [ PASS ] :: Command 'cp lldpd-tests.py /usr/bin/' (Expected 0, got 0) :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 0s :: Assertions: 2 good, 0 bad :: RESULT: PASS :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Test :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: [ 17:45:16 ] :: [ LOG ] :: lladpd tests :: [ 17:45:16 ] :: [ BEGIN ] :: Running '/usr/bin/python3 /usr/bin/lldpd-tests.py' test_lldpd_trasmitted_lldp_attributes (__main__.lldpdTests) verify at the other end of veth received LLDP packets that contains attibutes (link address, hostname, TTL, system desc). tcpdump ... reading from file /tmp/lldpd-tcp-dump.pcap, link-type EN10MB (Ethernet) ok test_lldpd_trasmitted_lldp_packets (__main__.lldpdTests) verify at the other end of veth ifname lldpd has received LLDP packets. tcpdump ... reading from file /tmp/lldpd-tcp-dump.pcap, link-type EN10MB (Ethernet) ok test_lldpd_received_lldp_packets_sent_by_systemd_networkd (__main__.lldpdTestsViaNetworkd) ... ok test_systemd_networkd_received_lldp_packets (__main__.lldpdTestsViaNetworkd) ... ok ---------------------------------------------------------------------- Ran 4 tests in 64.222s OK :: [ 17:46:21 ] :: [ PASS ] :: Command '/usr/bin/python3 /usr/bin/lldpd-tests.py' (Expected 0, got 0) :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 65s :: Assertions: 1 good, 0 bad :: RESULT: PASS :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Cleanup :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: [ 17:46:21 ] :: [ BEGIN ] :: Running 'rm /usr/bin/lldpd-tests.py' :: [ 17:46:21 ] :: [ PASS ] :: Command 'rm /usr/bin/lldpd-tests.py' (Expected 0, got 0) :: [ 17:46:21 ] :: [ LOG ] :: lladpd tests done :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 0s :: Assertions: 1 good, 0 bad :: RESULT: PASS :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: TEST PROTOCOL :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: Package : lldpd Installed : lldpd-1.0.1-1.fc28.x86_64 beakerlib RPM : beakerlib-1.17-13.fc28.noarch Test started : 2018-05-23 17:45:15 IST Test finished : 2018-05-23 17:46:21 IST (still running) Test duration : 66 seconds Test name : unknown Distro : Fedora release 28 (Twenty Eight) Hostname : Zeus Architecture : x86_64 CPUs : 8 x Intel(R) Core(TM) i7-4700MQ CPU @ 2.40GHz RAM size : 15731 MB HDD size : 226.83 GB :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Setup :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: [ 17:45:16 ] :: [ PASS ] :: Checking for the presence of lldpd rpm :: [ 17:45:16 ] :: [ LOG ] :: Package versions: :: [ 17:45:16 ] :: [ LOG ] :: lldpd-1.0.1-1.fc28.x86_64 :: [ 17:45:16 ] :: [ PASS ] :: Command 'cp lldpd-tests.py /usr/bin/' (Expected 0, got 0) :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 0s :: Assertions: 2 good, 0 bad :: RESULT: PASS :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Test :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: [ 17:45:16 ] :: [ LOG ] :: lladpd tests :: [ 17:46:21 ] :: [ PASS ] :: Command '/usr/bin/python3 /usr/bin/lldpd-tests.py' (Expected 0, got 0) :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 65s :: Assertions: 1 good, 0 bad :: RESULT: PASS :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Cleanup :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: [ 17:46:21 ] :: [ PASS ] :: Command 'rm /usr/bin/lldpd-tests.py' (Expected 0, got 0) :: [ 17:46:21 ] :: [ LOG ] :: lladpd tests done :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 0s :: Assertions: 1 good, 0 bad :: RESULT: PASS :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: unknown :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: [ 17:46:21 ] :: [ LOG ] :: JOURNAL XML: /var/tmp/beakerlib-msOLBiM/journal.xml :: [ 17:46:21 ] :: [ LOG ] :: JOURNAL TXT: /var/tmp/beakerlib-msOLBiM/journal.txt :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: :: Duration: 66s :: Phases: 3 good, 0 bad :: OVERALL RESULT: PASS --- tests/miscellaneous-tests/lldpd-tests.py | 220 +++++++++++++++++++++++ tests/miscellaneous-tests/runtest.sh | 35 ++++ tests/tests.yml | 13 ++ 3 files changed, 268 insertions(+) create mode 100755 tests/miscellaneous-tests/lldpd-tests.py create mode 100755 tests/miscellaneous-tests/runtest.sh create mode 100644 tests/tests.yml diff --git a/tests/miscellaneous-tests/lldpd-tests.py b/tests/miscellaneous-tests/lldpd-tests.py new file mode 100755 index 0000000..3b78954 --- /dev/null +++ b/tests/miscellaneous-tests/lldpd-tests.py @@ -0,0 +1,220 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: LGPL-2.1+ +# ~~~ +# lldpd-test.py integration test +# Description: Test for lldpd: implementation of IEEE 802.1ab (LLDP) +# +# Author: Susant Sahani +# Copyright (c) 2018 Red Hat, Inc. +#~~~ + +import errno +import os +import sys +import time +import unittest +import subprocess +import signal +import shutil +import re +import psutil +import socket + +LLDPD_TCP_DUMP_FILE='/tmp/lldpd-tcp-dump.pcap' +LLDPD_PID_FILE='/var/run/lldpd.pid' + +SERVICE_UNITDIR = '/run/systemd/system' +NETWORK_UNITDIR = '/run/systemd/network' + +def setUpModule(): + """Initialize the environment, and perform sanity checks on it.""" + + if shutil.which('lldpd') is None: + raise OSError(errno.ENOENT, 'lldpd not found') + + # Ensure the unit directory exists so tests can dump files into it. + os.makedirs(NETWORK_UNITDIR, exist_ok=True) + +class lldpdUtilities(): + """Provide a set of utility functions start stop lldpd .""" + + def Startlldpd(self): + """Start lldpd interface lldpd-peer """ + subprocess.check_output(['/usr/sbin/lldpd', '-cfse', '-D', '-C', 'lldpd-peer', '-I', 'lldpd-peer', '-S', 'lldpd-system-name','-m', '192.168.50.6']) + + def Stoplldpd(self): + try: + with open(LLDPD_PID_FILE, 'r') as f: + pid = f.read().rstrip(' \t\r\n\0') + os.kill(int(pid), signal.SIGTERM) + os.remove(LLDPD_PID_FILE) + except IOError: + pass + + def StartCaptureLLDPPackets(self): + """Start tcpdump to capture packets""" + self.WriteServiceFile('tcpdump.service', '''\ +[Unit] +Description=TCPDumpd +After=multi-user.target network.target + +[Service] +Type=simple + +ExecStart=/usr/sbin/tcpdump -pnnli lldpd ether proto 0x88cc -vvv -w "/tmp/lldpd-tcp-dump.pcap" +[Install] +WantedBy=multi-user.target +''') + subprocess.check_output(['systemctl','daemon-reload']) + subprocess.check_output(['systemctl','restart', 'tcpdump.service']) + + def StopCapturingPackets(self): + subprocess.check_output(['systemctl', 'stop', 'tcpdump.service']) + time.sleep(3); + + def SetupVethInterface(self): + """Setup veth interface""" + subprocess.check_output(['ip', 'link', 'add', 'lldpd', 'type', 'veth', 'peer', 'name', 'lldpd-peer']) + subprocess.check_output(['ip', 'link', 'set', 'lldpd', 'address', '02:01:02:03:04:08']) + subprocess.check_output(['ip', 'link', 'set', 'lldpd-peer', 'address', '02:01:02:03:04:09']) + subprocess.check_output(['ip', 'link', 'set', 'lldpd', 'up']) + subprocess.check_output(['ip', 'link', 'set', 'lldpd-peer', 'up']) + + time.sleep(3); + + self.addCleanup(subprocess.call, ['ip', 'link', 'del', 'dev', 'lldpd']) + + def WriteServiceFile(self, unit_name, contents): + """Write a tcpdump unit file, and queue it to be removed.""" + unit_path = os.path.join(SERVICE_UNITDIR, unit_name) + + with open(unit_path, 'w') as unit: + unit.write(contents) + self.addCleanup(os.remove, unit_path) + + def WriteNetworkFile(self, unit_name, contents): + """Write a networkd unit file, and queue it to be removed.""" + unit_path = os.path.join(NETWORK_UNITDIR, unit_name) + + with open(unit_path, 'w') as unit: + unit.write(contents) + self.addCleanup(os.remove, unit_path) + + def FindProtocolFieldsinTCPDump(self, **kwargs): + """Look attributes in lldpd logs.""" + + contents = subprocess.check_output(['tcpdump', '-v', '-r', LLDPD_TCP_DUMP_FILE]).rstrip().decode('utf-8') + if kwargs is not None: + for key in kwargs: + self.assertRegex(contents, kwargs[key]) + +class lldpdTestsViaNetworkd(unittest.TestCase, lldpdUtilities): + + def setUp(self): + + """ Setup veth interface """ + self.WriteNetworkFile('lldpd-veth.netdev', '''\ +[NetDev] +Name=lldpd +Kind=veth +MACAddress=12:34:56:78:9a:bc + +[Peer] +Name=lldpd-peer +MACAddress=12:34:56:78:9a:bd +''') + + """ Receive LLDP packets via networkd """ + self.WriteNetworkFile('lldp.network', '''\ +[Match] +Name=lldpd + +[Network] +DHCP=no +IPv6AcceptRA=false +LLDP=yes +EmitLLDP=yes +''') + """ Receive LLDP packets via networkd """ + self.WriteNetworkFile('lldp-peer.network', '''\ +[Match] +Name=lldpd-peer +''') + subprocess.check_output(['systemctl', 'restart', 'systemd-networkd']) + time.sleep(5) + + def tearDown(self): + self.Stoplldpd() + subprocess.check_output(['ip', 'link', 'del', 'lldpd']) + + def test_lldpd_received_lldp_packets_sent_by_systemd_networkd(self): + self.Startlldpd() + + time.sleep(10) + + ''' Test whether lldpd receved LLDP packets from networkd ''' + output=subprocess.check_output(['lldpctl']).rstrip().decode('utf-8') + self.assertRegex(output, "ifname lldpd") + self.assertRegex(output, socket.gethostname()) + + def test_systemd_networkd_received_lldp_packets(self): + self.Startlldpd() + + time.sleep(10) + + # lldpd 02:01:02:03:04:09 [hostname] 02:01:02:03:04:09 lldpd-peer + output=subprocess.check_output(['networkctl', 'lldp', '--no-legend', '--no-pager']).rstrip().decode('utf-8') + self.assertRegex(output, "lldpd") + self.assertRegex(output, "lldpd-peer") + self.assertRegex(output, "12:34:56:78:9a:bd") + self.assertRegex(output, socket.gethostname()) + + # Port ID and Chasiss id count should be 2 + self.assertEqual(2, output.count("12:34:56:78:9a:bd")) + +class lldpdTests(unittest.TestCase, lldpdUtilities): + + def setUp(self): + """ Setup """ + self.SetupVethInterface() + + def tearDown(self): + self.Stoplldpd() + os.remove(LLDPD_TCP_DUMP_FILE) + + def test_lldpd_trasmitted_lldp_attributes(self): + """ verify at the other end of veth received LLDP packets that contains attibutes (link address, hostname, TTL, system desc). tcpdump """ + + self.StartCaptureLLDPPackets() + self.Startlldpd() + + """ capture for 10 seconds """ + time.sleep(10) + + self.StopCapturingPackets() + + self.FindProtocolFieldsinTCPDump(Chassis='Subtype MAC address \(4\): 02:01:02:03:04:09', + Port='Subtype MAC address \(3\): 02:01:02:03:04:09', + PortDesc='lldpd-peer', + TTL='TTL.*120s', + HostName=socket.gethostname() , + System_Description='lldpd-system-name', + ManagementAddress='192.168.50.6') + + def test_lldpd_trasmitted_lldp_packets(self): + """ verify at the other end of veth ifname lldpd has received LLDP packets. tcpdump """ + + self.StartCaptureLLDPPackets() + self.Startlldpd() + + """ capture for 10 seconds """ + time.sleep(10) + + self.StopCapturingPackets() + self.FindProtocolFieldsinTCPDump(MAC='02:01:02:03:04:09', + TTL='TTL 120s') + + +if __name__ == '__main__': + unittest.main(testRunner=unittest.TextTestRunner(stream=sys.stdout, + verbosity=2)) diff --git a/tests/miscellaneous-tests/runtest.sh b/tests/miscellaneous-tests/runtest.sh new file mode 100755 index 0000000..acf5d5c --- /dev/null +++ b/tests/miscellaneous-tests/runtest.sh @@ -0,0 +1,35 @@ +#!/bin/bash +# SPDX-License-Identifier: LGPL-2.1+ +# ~~~ +# LLDPD integration test +# Description: Test for ladpd:implementation of IEEE 802.1ab (LLDP) +# +# Author: Susant Sahani +# Copyright (c) 2018 Red Hat, Inc. +#~~~ + +# Include Beaker environment +. /usr/share/beakerlib/beakerlib.sh || exit 1 + +PACKAGE="lldpd" +LadpdPidFile="/var/run/lldpd.pid" + +rlJournalStart + rlPhaseStartSetup + rlAssertRpm $PACKAGE + rlRun "cp lldpd-tests.py /usr/bin/" + rlPhaseEnd + + rlPhaseStartTest + rlLog "lladpd tests" + rlRun "/usr/bin/python3 /usr/bin/lldpd-tests.py" + rlPhaseEnd + + rlPhaseStartCleanup + rlRun "rm /usr/bin/lldpd-tests.py" + rlLog "lladpd tests done" + rlPhaseEnd +rlJournalPrintText +rlJournalEnd + +rlGetTestState diff --git a/tests/tests.yml b/tests/tests.yml new file mode 100644 index 0000000..6df9154 --- /dev/null +++ b/tests/tests.yml @@ -0,0 +1,13 @@ +- hosts: localhost + roles: + - role: standard-test-beakerlib + tags: + - classic + tests: + - miscellaneous-tests + required_packages: + - ladpd + - python3 + - tcpdump + - systemd + - iproute