Merge ~jslarraz/qa-regression-testing:add_test_iperf3 into qa-regression-testing:master

[Jorge Sancho Larraz]

Add test-iperf3.py

Create new tests for iperf3 package

[Alex Murray (alexmurray)]

LGTM but it would be good to add this to .launchpad.yaml so that it gets run by lpci automatically as well against each of the stable releases.

review: Approve

[Steve Beattie (sbeattie)]

This is great, thanks fo rgetting the infrastrucutre in place to make this test workable and preparing these test. It's fine to merge as is, but a couple of minor comments inline.

And adding it to the .launchpad.yaml would be appreciated, peek at the history for the file for examples, and https://git.launchpad.net/qa-regression-testing/tree/scripts/README.md#n144 also covers a bit of documentation as well as how to handle cases that can't be run in lpci. (That said, please help clarify the documentation.)

THanks!

review: Approve

diff --git a/.launchpad.yaml b/.launchpad.yaml
index 7b32321..bd3e3a3 100644
--- a/.launchpad.yaml
+++ b/.launchpad.yaml
@@ -10,6 +10,7 @@ pipeline:
     - busybox
     - coreutils
     - util-linux
+    - iperf3
 
 jobs:
   imagemagick:
@@ -141,3 +142,16 @@ jobs:
       - sudo
     run: |
       ./lpcraft-runner util-linux
+
+  iperf3:
+    matrix:
+      - series: jammy
+        architectures: amd64
+      - series: focal
+        architectures: amd64
+      - series: bionic
+        architectures: amd64
+    packages:
+      - sudo
+    run: |
+      ./lpcraft-runner iperf3
diff --git a/scripts/test-iperf3.py b/scripts/test-iperf3.py
 new file mode 100755
index 0000000..a70c169
--- /dev/null
+++ b/scripts/test-iperf3.py
@@ -0,0 +1,97 @@
+#!/usr/bin/python3
+#
+#    test-iperf3.py quality assurance test script for iperf3
+#    Copyright (C) 2008-2023 Canonical Ltd.
+#    Author: Jorge Sancho <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 3,
+#    as published by the Free Software Foundation.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# QRT-Packages: iperf3
+# QRT-Privilege: none
+# QRT-Conflicts: none
+
+'''
+    In general, this test should be run in a virtual machine (VM) or possibly
+    a chroot and not on a production machine. While efforts are made to make
+    these tests non-destructive, there is no guarantee this script will not
+    alter the machine. You have been warned.
+
+    How to run in a clean VM:
+    $ sudo apt-get -y install <QRT-Packages> && sudo ./test-iperf3.py -v'
+'''
+
+import unittest
+import time
+import subprocess
+import socket
+import testlib
+
+class iperfTest(testlib.TestlibCase):
+    '''Test iperf.'''
+
+    def setUp(self):
+        '''Set up prior to each test_* function'''
+        self.server = subprocess.Popen(["iperf3", "-s"])
+        time.sleep(1)
+
+    def tearDown(self):
+        '''Clean up after each test_* function'''
+        self.server.terminate()
+        self.server.wait()
+
+    def test_client(self):
+        # Check server can handle several consecutive requests
+        for i in range(5):
+            self.assertShellExitSuccess(["iperf3", "-c", "localhost"], timeout=90,
+                                        msg="The client process returned something other than 0. It may indicate "
+                                            "that something is not working properly..")
+
+    def test_CVE_2023_38403(self):
+        '''Test CVE-2023-38403'''
+
+        # Run PoC
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        sock.connect(("localhost", 5201))
+        sock.sendall(bytearray.fromhex('41'*37+'ff'*4+'41'*50))
+        sock.close()
+        time.sleep(1)
+
+        # Check server is alive
+        self.assertEqual(self.server.poll(), None, "Server is not running anymore. This behaviour is typically "
+                       " observed after exploting CVE-2023-38403")
+
+        # Check client returned sucessfully
+        self.assertShellExitSuccess(["iperf3", "-c", "localhost"], timeout=90,
+                                    msg="The client process returned something other than 0. It may indicate "
+                                        "that something is not working properly..")
+
+    def test_LP_2038654(self):
+        '''Test LP-2038654'''
+
+        # Run PoC
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        sock.connect(("localhost", 5201))
+        sock.sendall(bytearray.fromhex('41'))
+        # We need to keep the connection alive, so that we don't want to call sock.close() yet
+        # sock.close()
+
+        # Wait for timeout to happen (timeout included in the patch)
+        time.sleep(11)
+
+        # Check client returned sucessfully
+        self.assertShellExitSuccess(["iperf3", "-c", "localhost"], timeout=90,
+                                    msg="The client process returned something other than 0. It may indicate "
+                                        "that something is not working properly..")
+
+if __name__ == '__main__':
+    unittest.main()
 \ No newline at end of file