Functional/integration testing

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

PDB runcall (IO-capturing turned off) >>>>>>>>>>>>>>>>>>>>>

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(19)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(21)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(22)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(23)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(24)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(25)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(26)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(21)test_btmgmt_info()

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(28)test_btmgmt_info()

Using pci-serial to forward eg. btvirt sockets is unreliable, as qemu or kernel seems to be sometimes dropping part of the sent data or insert spurious \0 bytes, leading to sporadic errors like:

    kernel: Bluetooth: hci0: command 0x0c52 tx timeout
    kernel: Bluetooth: hci0: Opcode 0x0c52 failed: -110
    btvirt: packet error, unknown type: 0

This appears to occur most often when host system is under load, e.g. due to multiple test-runners running at the same time. The problem is not specific to btvirt, but seems to be in the qemu serial device layer vs. kernel interaction.

Change test-runner to use virtserialport to forward the btvirt connection inside the VM, as virtio-serial doesn't appear to have these problems.

---
 tools/test-runner.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

tools/test-runner.c +8 -3

index b3e0b0cfe..0e3bfb8b7 100644
@@ -306,7 +306,7 @@ static void start_qemu(void)
                                testargs);
 
        argv = alloca(sizeof(qemu_argv) +
-                       (sizeof(char *) * (6 + (num_devs * 4))) +
+                       (sizeof(char *) * (8 + (num_devs * 4))) +
                        (sizeof(char *) * (usb_dev ? 4 : 0)) +
                        (sizeof(char *) * num_extra_opts));
        memcpy(argv, qemu_argv, sizeof(qemu_argv));

@@ -330,14 +330,19 @@ static void start_qemu(void)
        argv[pos++] = "-append";
        argv[pos++] = (char *) cmdline;
 
+       if (num_devs) {
+               argv[pos++] = "-device";
+               argv[pos++] = "virtio-serial";
+       }
+
        for (i = 0; i < num_devs; i++) {
                char *chrdev, *serdev;
 
                chrdev = alloca(48 + strlen(device_path));
                sprintf(chrdev, "socket,path=%s,id=bt%d", device_path, i);
 
-               serdev = alloca(48);
-               sprintf(serdev, "pci-serial,chardev=bt%d", i);
+               serdev = alloca(64);
+               sprintf(serdev, "virtconsole,chardev=bt%d,name=bt.%d", i, i);
 
                argv[pos++] = "-chardev";
                argv[pos++] = chrdev;

tools/test-runner.c +0 -1

                unsigned int basic_flags, extra_flags;
 
                printf("Attaching BR/EDR controller to %s\n", node);
--

2.54.0

Hi Pauli,

Quoted 65 lines · Pauli Virtanen

Using pci-serial to forward eg. btvirt sockets is unreliable, as qemu or
kernel seems to be sometimes dropping part of the sent data or insert
spurious \0 bytes, leading to sporadic errors like:

    kernel: Bluetooth: hci0: command 0x0c52 tx timeout
    kernel: Bluetooth: hci0: Opcode 0x0c52 failed: -110
    btvirt: packet error, unknown type: 0

This appears to occur most often when host system is under load, e.g.
due to multiple test-runners running at the same time.  The problem is
not specific to btvirt, but seems to be in the qemu serial device layer
vs. kernel interaction.

Change test-runner to use virtserialport to forward the btvirt connection inside the VM, as virtio-serial doesn't appear to have these
problems.
---
 tools/test-runner.c | 13 +++++++++----

 1 file changed, 9 insertions(+), 4 deletions(-)

tools/test-runner.c +0 -0

index b3e0b0cfe..0e3bfb8b7 100644
@@ -306,7 +306,7 @@ static void start_qemu(void)
                                 testargs);
 

        argv = alloca(sizeof(qemu_argv) +
-                       (sizeof(char *) * (6 + (num_devs * 4))) + +                       (sizeof(char *) * (8 + (num_devs * 4))) + (sizeof(char *) * (usb_dev ? 4 : 0)) + (sizeof(char *) * num_extra_opts)); memcpy(argv, qemu_argv, sizeof(qemu_argv));

tools/test-runner.c +7 -2

@@ -330,14 +330,19 @@ static void start_qemu(void)
         argv[pos++] = "-append";
         argv[pos++] = (char *) cmdline;
 
+       if (num_devs) {
+               argv[pos++] = "-device";
+               argv[pos++] = "virtio-serial";
+       }
+
         for (i = 0; i < num_devs; i++) {
                 char *chrdev, *serdev;
 
                 chrdev = alloca(48 + strlen(device_path));
                 sprintf(chrdev, "socket,path=%s,id=bt%d",
 device_path, i);
 
-               serdev = alloca(48);
-               sprintf(serdev, "pci-serial,chardev=bt%d", i);
+               serdev = alloca(64);
+               sprintf(serdev,
 "virtconsole,chardev=bt%d,name=bt.%d", i, i);
 

                argv[pos++] = "-chardev";
                argv[pos++] = chrdev;

tools/test-runner.c static void run_command(char *cmdname, char · line 919

Quoted 6 lines

tools/test-runner.c +1 -1

@@ -910,7 +915,7 @@ static void run_command(char *cmdname, char
 *home)
         }
 
         if (num_devs) {
-               const char *node = "/dev/ttyS1";
+               const char *node = "/dev/hvc0";

Im getting and error with these changes:

Attaching BR/EDR controller to /dev/hvc0 Failed to open serial port: No such file or directory

I tried adding the kernel config options but it didn't make any difference.

Quoted 9 lines

tools/test-runner.c +0 -0

                 unsigned int basic_flags, extra_flags;
 

                printf("Attaching BR/EDR controller to %s\n", node);
--
2.54.0

Hi Luiz,

ti, 2026-06-02 kello 15:35 -0400, Luiz Augusto von Dentz kirjoitti:

Quoted 78 lines

Hi Pauli,

Quoted 66 lines · Pauli Virtanen

Using pci-serial to forward eg. btvirt sockets is unreliable, as qemu or
kernel seems to be sometimes dropping part of the sent data or insert
spurious \0 bytes, leading to sporadic errors like:

    kernel: Bluetooth: hci0: command 0x0c52 tx timeout
    kernel: Bluetooth: hci0: Opcode 0x0c52 failed: -110
    btvirt: packet error, unknown type: 0

This appears to occur most often when host system is under load, e.g.
due to multiple test-runners running at the same time.  The problem
is
not specific to btvirt, but seems to be in the qemu serial device layer
vs. kernel interaction.

Change test-runner to use virtserialport to forward the btvirt connection inside the VM, as virtio-serial doesn't appear to have these
problems.
---
 tools/test-runner.c | 13 +++++++++----

 1 file changed, 9 insertions(+), 4 deletions(-)

tools/test-runner.c +0 -0

index b3e0b0cfe..0e3bfb8b7 100644
@@ -306,7 +306,7 @@ static void start_qemu(void)
                                 testargs);
 

        argv = alloca(sizeof(qemu_argv) +
-                       (sizeof(char *) * (6 + (num_devs * 4))) + +                       (sizeof(char *) * (8 + (num_devs * 4))) + (sizeof(char *) * (usb_dev ? 4 : 0)) + (sizeof(char *) * num_extra_opts)); memcpy(argv, qemu_argv, sizeof(qemu_argv));

tools/test-runner.c +7 -2

@@ -330,14 +330,19 @@ static void start_qemu(void)
         argv[pos++] = "-append";
         argv[pos++] = (char *) cmdline;
 
+       if (num_devs) {
+               argv[pos++] = "-device";
+               argv[pos++] = "virtio-serial";
+       }
+
         for (i = 0; i < num_devs; i++) {
                 char *chrdev, *serdev;
 
                 chrdev = alloca(48 + strlen(device_path));
                 sprintf(chrdev, "socket,path=%s,id=bt%d",
 device_path, i);
 
-               serdev = alloca(48);
-               sprintf(serdev, "pci-serial,chardev=bt%d", i);
+               serdev = alloca(64);
+               sprintf(serdev,
 "virtconsole,chardev=bt%d,name=bt.%d", i, i);
 

                argv[pos++] = "-chardev";
                argv[pos++] = chrdev;

tools/test-runner.c static void run_command(char *cmdname, char · line 919

Quoted 6 lines

tools/test-runner.c +1 -1

@@ -910,7 +915,7 @@ static void run_command(char *cmdname, char
 *home)
         }
 
         if (num_devs) {
-               const char *node = "/dev/ttyS1";
+               const char *node = "/dev/hvc0";

Im getting and error with these changes:

Quoted 5 lines

Attaching BR/EDR controller to /dev/hvc0 Failed to open serial port: No such file or directory

I tried adding the kernel config options but it didn't make any difference.

We have test-runner with this patch in Pipewire CI, and it is working

https://gitlab.freedesktop.org/pipewire/pipewire/-/jobs/101256448

on Fedora 44 + Qemu 10.2.2. Kernel configuration is here:

https://github.com/pv/bluez-test-functional-kernel/blob/main/tester.config

I've also used with this for USB redirection.

Not sure what is different for you, do you get any virtio serial devices from the virtconsole?

Quoted 10 lines

Quoted 9 lines

tools/test-runner.c +0 -0

                 unsigned int basic_flags, extra_flags;
 

                printf("Attaching BR/EDR controller to %s\n", node);
--
2.54.0

ti, 2026-06-02 kello 19:51 +0000, Pauli Virtanen kirjoitti:

Quoted 89 lines

Hi Luiz,

ti, 2026-06-02 kello 15:35 -0400, Luiz Augusto von Dentz kirjoitti:

Quoted 78 lines

Hi Pauli,

Quoted 66 lines · Pauli Virtanen

Using pci-serial to forward eg. btvirt sockets is unreliable, as qemu or
kernel seems to be sometimes dropping part of the sent data or insert
spurious \0 bytes, leading to sporadic errors like:

    kernel: Bluetooth: hci0: command 0x0c52 tx timeout
    kernel: Bluetooth: hci0: Opcode 0x0c52 failed: -110
    btvirt: packet error, unknown type: 0

This appears to occur most often when host system is under load, e.g.
due to multiple test-runners running at the same time. The problem
is
not specific to btvirt, but seems to be in the qemu serial device layer
vs. kernel interaction.

Change test-runner to use virtserialport to forward the btvirt connection inside the VM, as virtio-serial doesn't appear to have these
problems.

---
 tools/test-runner.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

tools/test-runner.c +8 -3

index b3e0b0cfe..0e3bfb8b7 100644
@@ -306,7 +306,7 @@ static void start_qemu(void)
                                testargs);
 
        argv = alloca(sizeof(qemu_argv) +
-                       (sizeof(char *) * (6 + (num_devs * 4))) +
+                       (sizeof(char *) * (8 + (num_devs * 4))) +
                        (sizeof(char *) * (usb_dev ? 4 : 0)) +
                        (sizeof(char *) * num_extra_opts));
        memcpy(argv, qemu_argv, sizeof(qemu_argv));

@@ -330,14 +330,19 @@ static void start_qemu(void)
        argv[pos++] = "-append";
        argv[pos++] = (char *) cmdline;
 
+       if (num_devs) {
+               argv[pos++] = "-device";
+               argv[pos++] = "virtio-serial";
+       }
+
        for (i = 0; i < num_devs; i++) {
                char *chrdev, *serdev;
 
                chrdev = alloca(48 + strlen(device_path));
                sprintf(chrdev, "socket,path=%s,id=bt%d",
 device_path, i);
 
-               serdev = alloca(48);
-               sprintf(serdev, "pci-serial,chardev=bt%d", i);
+               serdev = alloca(64);
+               sprintf(serdev,
 "virtconsole,chardev=bt%d,name=bt.%d", i, i);
 

                argv[pos++] = "-chardev";
                argv[pos++] = chrdev;

tools/test-runner.c static void run_command(char *cmdname, char · line 919

Quoted 6 lines

tools/test-runner.c +1 -1

@@ -910,7 +915,7 @@ static void run_command(char *cmdname, char
 *home)
        }
 
        if (num_devs) {
-               const char *node = "/dev/ttyS1";
+               const char *node = "/dev/hvc0";

Im getting and error with these changes:

Quoted 5 lines

Attaching BR/EDR controller to /dev/hvc0 Failed to open serial port: No such file or directory

I tried adding the kernel config options but it didn't make any difference.

We have test-runner with this patch in Pipewire CI, and it is working

Quoted 7 lines

https://gitlab.freedesktop.org/pipewire/pipewire/-/jobs/101256448

on Fedora 44 + Qemu 10.2.2. Kernel configuration is here:

https://github.com/pv/bluez-test-functional-kernel/blob/main/tester.config

I've also used with this for USB redirection.

Also, the exact kernel image we are using built from that config is here:

https://github.com/pv/bluez-test-functional-kernel/releases/tag/2026-05-08.1

at bluez 07b6fc156348bb515ac0a876d49644312c9476d6 I can then do

$ ./emulator/btvirt -s &
$ ./tools/test-runner -u/tmp/bt-server-bredrle -k bzImage -- bash
...
Attachment of devices requested
Attaching BR/EDR controller to /dev/hvc0
Switched line discipline from 0 to 15
Device index 0 attached
Running command bash

Quoted 7 lines

Not sure what is different for you, do you get any virtio serial devices from the virtconsole?

Quoted 3 lines

Quoted 3 lines

tools/test-runner.c +0 -0

                unsigned int basic_flags, extra_flags;
 

Quoted 7 lines

Quoted 7 lines

Quoted 6 lines

printf("Attaching BR/EDR controller to %s\n",
node);
--
2.54.0

Hello:

This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <[email protected]>:

Quoted 9 lines · On Wed, 13 May 2026 19:17:17 +0300 you wrote:

Add framework for writing tests simulating "real" environments where BlueZ and other parts of the stack run on different virtual machine hosts that communicate with each other.

*** v5 ***

https://github.com/pv/bluez/compare/func-test-v4-r..func-test-v5

[...]

Here is the summary with links:
- [BlueZ,v5,01/16] emulator: btvirt: check pkt lengths, don't get stuck on malformed

    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=e19c771841e9
  - [BlueZ,v5,02/16] emulator: btvirt: allow specifying where server unix sockets are made
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=5ee43f9993dd
  - [BlueZ,v5,03/16] emulator: btvirt: support SCO data packets
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=cc077e4a12dd
  - [BlueZ,v5,04/16] emulator: btdev: clear more state on Reset
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=f1a303e1d07a
  - [BlueZ,v5,05/16] test-runner: enable path argument for --unix
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=ff2ecb82e4c3
  - [BlueZ,v5,06/16] test-runner: Add -o/--option option
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=82c635c879bf

- [BlueZ,v5,07/16] test-runner: allow source tree root for -k

    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=1929b3a99d2f
  - [BlueZ,v5,08/16] test-runner: use virtio-serial for implementing -u device forwarding
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=908c14fc3abb
  - [BlueZ,v5,09/16] doc: enable CONFIG_VIRTIO_CONSOLE in tester config
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=7856de4d69d6
  - [BlueZ,v5,10/16] doc: enable KVM paravirtualization & clock support in tester kernel config
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=48cb22a572c7

- [BlueZ,v5,11/16] doc: add functional/integration testing documentation (no matching commit)
- [BlueZ,v5,12/16] test: add functional/integration testing framework (no matching commit)
- [BlueZ,v5,13/16] build: add functional testing target
(no matching commit)
- [BlueZ,v5,14/16] test: functional: impose Python code formatting (no matching commit)
- [BlueZ,v5,15/16] test: functional: add some Agent1 interface tests (no matching commit)
- [BlueZ,v5,16/16] test: functional: add basic obex file transfer tests (no matching commit)

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Quoted 30 lines

Hello:

This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <[email protected]>:

Quoted 9 lines · On Wed, 13 May 2026 19:17:17 +0300 you wrote:

Add framework for writing tests simulating "real" environments where BlueZ and other parts of the stack run on different virtual machine hosts that communicate with each other.

*** v5 ***

https://github.com/pv/bluez/compare/func-test-v4-r..func-test-v5

[...]

Here is the summary with links:
- [BlueZ,v5,01/16] emulator: btvirt: check pkt lengths, don't get stuck on malformed

    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=e19c771841e9
  - [BlueZ,v5,02/16] emulator: btvirt: allow specifying where server unix sockets are made
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=5ee43f9993dd
  - [BlueZ,v5,03/16] emulator: btvirt: support SCO data packets
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=cc077e4a12dd
  - [BlueZ,v5,04/16] emulator: btdev: clear more state on Reset
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=f1a303e1d07a
  - [BlueZ,v5,05/16] test-runner: enable path argument for --unix
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=ff2ecb82e4c3
  - [BlueZ,v5,06/16] test-runner: Add -o/--option option
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=82c635c879bf

Quoted 8 lines

- [BlueZ,v5,07/16] test-runner: allow source tree root for -k

    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=1929b3a99d2f
  - [BlueZ,v5,08/16] test-runner: use virtio-serial for implementing -u device forwarding
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=908c14fc3abb
  - [BlueZ,v5,09/16] doc: enable CONFIG_VIRTIO_CONSOLE in tester config
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=7856de4d69d6
  - [BlueZ,v5,10/16] doc: enable KVM paravirtualization & clock support in tester kernel config
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=48cb22a572c7

Push the ones that didn't introduce new functionality, there were some complaints from the likes of checkpatch regarding scripts with execute permission,

and Id like to go more in detail about how to write tests
and what is the RPC message protocol since we could in teory use the same protocol used for autopts for example.

Quoted 21 lines

- [BlueZ,v5,11/16] doc: add functional/integration testing documentation (no matching commit)
- [BlueZ,v5,12/16] test: add functional/integration testing framework (no matching commit)
- [BlueZ,v5,13/16] build: add functional testing target
(no matching commit)
- [BlueZ,v5,14/16] test: functional: impose Python code formatting (no matching commit)
- [BlueZ,v5,15/16] test: functional: add some Agent1 interface tests (no matching commit)
- [BlueZ,v5,16/16] test: functional: add basic obex file transfer tests (no matching commit)

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html

Add framework for writing tests simulating "real" environments where BlueZ and other parts of the stack run on different virtual machine hosts that communicate with each other.

*** v5 ***

https://github.com/pv/bluez/compare/func-test-v4-r..func-test-v5

* Factor out the pytest-bluezenv plugin, to be maintained separately.
https://pypi.org/project/pytest-bluezenv/

It could in principle be moved under the BlueZ organization, but there's no particular reason why it should be in bluez repository.

Generally, it's better to have the pytest plugin separate so it's easier to reuse and can have its own version cycle.

* Pipewire tests are moved to pipewire repository where they probably belong to.

They can be run easily vs. given BlueZ build dir.

We are currently running them in Pipewire CI, but at frozen kernel/BlueZ version, so it is not testing BlueZ/kernel upstream development.

* No changes in the emulator/test-runner patches since v4

They are stand-alone bug fixes / improvements, and make sense also separately from the rest.

*** v4 ***

https://github.com/pv/bluez/compare/func-test-v3-r..func-test-v4

* Use virtconsole for simpler HCI forwarding to the vm

* Fix typoed vm_module -> vm_once

* Skip tests for some pipewire versions

*** v3 ***

https://github.com/pv/bluez/compare/func-test-v2-r..func-test-v3

* fix configure.ac openpty() detection to match TOOLS conditional, to fix make distcheck

* properly retry virtio RPC connection if it fails initially

* properly restart VM if previous test hangs

* allow custom parent host side proxy objects, use them for pexpect

* improve --list with out-of-tree test files

* fix missing bus.set_exit_on_disconnect(False) for obex tests

* have --vm-timeout etc. change values also on VM host side

* use larger-memory VM instances for Pipewire, in case ASAN enabled

* set reasonable inside-VM ASAN_OPTION default values

* don't run btvirt under stdbuf, since not compatible with ASAN

*** v2 ***

https://github.com/pv/bluez/compare/func-test-v1-r..func-test-v2

* move unit/func_test -> test/functional & test/pytest_bluez

The pytest_bluez plugin is in principle reusable for other projects, so we can eg. have more complete Pipewire integration tests that can live in Pipewire repository.

* openpty() is in -lutil on some platforms, detect this in autoconf

* more emulator adjustments:

- fix SCO data packet support in btvirt
- more complete Reset command

* improve logging: get timestamps from kernel, and reorder logs to timestamp order, so that lines from different hosts, btmon, and parent tester appear in right order regardless of whether VM console / btmon is lagging

- this requires accurate clock sync in the VM, so enable KVM PTP in config and run chronyd inside the VMs
- use virtio port instead of qemu console to export logs, since the console has fixed baud rate and is too slow

* add --btmon & export btsnoop dumps from VM hosts

* fix compatibility with older Python versions

* add parametrized_host_config()

* split Pipewire test to A2DP/BAP/HFP and really stream audio. These catch the 5.86 regression fixed in 066a164a524e498 and the 5.84 one in 6b0a08776a

* add support for tests that reuse tester environment, so they can run faster without needing Bluetoothd teardown/setup in between

* add HostPlugin.presetup (mainly for test skipping)

* deal with RPC virtio port buffer possibly containing unflushed commands from previous failed test

* add some Agent1 interface tests

* add basic Obex file transfer tests

* add support for logging in to a running test instance (for gdb etc)

* export any core dumps out from test environ

Some bells & whistles:

* add --kernel-build for kernel image build

* test suite Python code formatting checks

***

Implements:

- RPC communication with tester instances running each of the VM hosts. Tests run on parent host, which instructs VM hosts what to do.

- Extensible way to add stateful test-specific code inside the VM instances

- Logging control: output from different processes running inside the VM are separated and can be filtered.

- Test runner framework with Pytest (more convenient than Python/unittest)

- Automatic grouping of tests to minimize VM reboots

- Redirecting USB controllers to use for testing in addition to btvirt

- Fairly straightforward, ~1600 sloc for the framework

There is no requirement that the tests spawn VM instances, the test runner can be used for any tests written in Python.

See doc/test-functional.rst for various examples.

Also test/functional/test_bluetoothctl_vm.py has some simple cases, and test/functional/test_pipewire.py for a more complicated setup

    host0(qemu): Pipewire <-> BlueZ <-> kernel
    <-> btvirt
    host1(qemu): kernel <-> BlueZ <-> Pipewire

The framework allows easily passing any data and code between the parent and VM hosts, so writing tests is straightforward.

***

Some examples:

$ test/test-functional --list -q

test/functional/lib/tests/test_rpc.py::test_basic test/functional/test_bluetoothctl_vm.py::test_bluetoothctl_pair[hosts0-vm2] test/functional/test_bluetoothctl_vm.py::test_bluetoothctl_script_show[hosts1-vm1] test/functional/test_btmgmt_vm.py::test_btmgmt_info[hosts2-vm1] test/functional/test_pipewire.py::test_pipewire[hosts3-vm2]

$ test/test-functional -v --no-header
======================================= test session starts ========================================
collected 5 items

test/functional/lib/tests/test_rpc.py::test_basic PASSED                                      [ 20%]
test/functional/test_bluetoothctl_vm.py::test_bluetoothctl_script_show[hosts1-vm1] SKIPPED    [ 40%]
test/functional/test_btmgmt_vm.py::test_btmgmt_info[hosts2-vm1] SKIPPED (No kernel image)     [ 60%]

test/functional/test_bluetoothctl_vm.py::test_bluetoothctl_pair[hosts0-vm2] SKIPPED (No k...) [ 80%]
test/functional/test_pipewire.py::test_pipewire[hosts3-vm2] SKIPPED (No kernel image) [100%]

=================================== 1 passed, 4 skipped in 0.19s ===================================

$ test/test-functional --kernel=../linux
============================= test session starts ==============================
platform linux -- Python 3.14.3, pytest-8.3.5, pluggy-1.6.0
rootdir: /home/pauli/prj/external/bluez/unit
configfile: pytest.ini
plugins: cov-5.0.0, forked-1.6.0, rerunfailures-15.0, timeout-2.4.0, xdist-3.7.0, hypothesis-6.123.0, flaky-3.8.1, anyio-4.12.1
collected 5 items

test/functional/lib/tests/test_rpc.py .                                   [ 20%]
test/functional/test_bluetoothctl_vm.py .                                 [ 40%]
test/functional/test_btmgmt_vm.py .                                       [ 60%]
test/functional/test_bluetoothctl_vm.py .                                 [ 80%]
test/functional/test_pipewire.py .                                        [100%]

============================== 5 passed in 41.92s ==============================

$ test/test-functional --kernel=../linux -k test_btmgmt
============================= test session starts ==============================
platform linux -- Python 3.14.3, pytest-8.3.5, pluggy-1.6.0
rootdir: /home/pauli/prj/external/bluez/unit
configfile: pytest.ini
plugins: cov-5.0.0, forked-1.6.0, rerunfailures-15.0, timeout-2.4.0, xdist-3.7.0, hypothesis-6.123.0, flaky-3.8.1, anyio-4.12.1
collected 5 items / 4 deselected / 1 selected

test/functional/test_btmgmt_vm.py . [100%]

======================= 1 passed, 4 deselected in 9.15s ========================

$ grep btmgmt test-functional.log
13:15:42 INFO   rpc.host.0.0        :  client: call_plugin ('call', '__call__', <function run at 0x7f27b81ce140>, ['/home/pauli/prj/external/bluez/build/tools/btmgmt', '--index', '0', 'info']) {'stdout': -1, 'stdin': -3, 'encoding': 'utf-8'}
13:15:42 INFO   host.0.0.rpc        :  server: call_plugin ('call', '__call__', <function run at 0x7fd5e35a1010>, ['/home/pauli/prj/external/bluez/build/tools/btmgmt', '--index', '0', 'info']) {'stdout': -1, 'stdin': -3, 'encoding': 'utf-8'}
13:15:42 INFO   host.0.0.run        :      $ /home/pauli/prj/external/bluez/build/tools/btmgmt --index 0 info

$ test/test-functional --kernel=../linux -k test_btmgmt --log-cli-level=0
============================= test session starts ==============================
platform linux -- Python 3.14.3, pytest-8.3.5, pluggy-1.6.0
rootdir: /home/pauli/prj/external/bluez/unit
configfile: pytest.ini
plugins: cov-5.0.0, forked-1.6.0, rerunfailures-15.0, timeout-2.4.0, xdist-3.7.0, hypothesis-6.123.0, flaky-3.8.1, anyio-4.12.1
collected 5 items / 4 deselected / 1 selected

test/functional/test_btmgmt_vm.py::test_btmgmt_info[hosts2-vm1] -------------------------------- live log setup --------------------------------

13:00:31 INFO   func_test.lib.env   :  Starting btvirt: /usr/bin/stdbuf -o L -e L /home/pauli/prj/external/bluez/build/emulator/btvirt --server=/tmp/bluez-func-test-8t6ychy8
13:00:31 OUT    btvirt              :  Bluetooth emulator ver 5.86
13:00:31 INFO   func_test.lib.env   :  Starting host: /home/pauli/prj/external/bluez/build/tools/test-runner --kernel=../linux/arch/x86/boot/bzImage -u/tmp/bluez-func-test-8t6ychy8/bt-server-bredrle -o -chardev -o socket,id=ser0,path=/tmp/bluez-func-test-8t6ychy8/bluez-func-test-rpc-0,server=on,wait=off -o -device -o virtio-serial -o -device -o virtserialport,chardev=ser0,name=bluez-func-test-rpc -H -- /usr/bin/python3 -P /home/pauli/prj/external/bluez/test/functional/lib/runner.py /dev/ttyS2
13:00:31 OUT    btvirt              :  Request for /tmp/bluez-func-test-8t6ychy8/bt-server-bredrle
13:00:32 OUT    host.0.0            :  early console in extract_kernel
13:00:32 OUT    host.0.0            :  input_data: 0x000000000425c2c4
...
13:00:39 INFO   rpc.host.0.0        :  client: call_plugin ('call', '__call__', <function run at 0x7f7547472140>, ['/home/pauli/prj/external/bluez/build/tools/btmgmt', '--index', '0', 'info']) {'stdout': -1, 'stdin': -3, 'encoding': 'utf-8'}
13:00:39 DEBUG  host.0.0.rpc        :  server: done
13:00:39 INFO   host.0.0.rpc        :  server: call_plugin ('call', '__call__', <function run at 0x7f77dcc81010>, ['/home/pauli/prj/external/bluez/build/tools/btmgmt', '--index', '0', 'info']) {'stdout': -1, 'stdin': -3, 'encoding': 'utf-8'}
13:00:39 INFO   host.0.0.run        :      $ /home/pauli/prj/external/bluez/build/tools/btmgmt --index 0 info
13:00:40 OUT    host.0.0.run.out    :  hci0:    Primary controller
13:00:40 OUT    host.0.0.run.out    :   addr 00:AA:01:00:00:42 version 11 manufacturer 1521 class 0x000000
13:00:40 OUT    host.0.0.run.out    :   supported settings: powered connectable fast-connectable discoverable bondable link-security ssp br/edr le advertising secure-conn debug-keys privacy static-addr phy-configuration cis-central cis-peripheral iso-broadcaster sync-receiver ll-privacy past-sender past-receiver
13:00:40 OUT    host.0.0.run.out    :   current settings: br/edr
13:00:40 OUT    host.0.0.run.out    :   name
13:00:40 OUT    host.0.0.run.out    :   short name
13:00:40 INFO   host.0.0.run        :  (return code 0)
13:00:40 DEBUG  rpc.host.0.0        :  client-reply

PASSED [100%]
13:00:40 OUT host.0.0 : qemu-system-x86_64: terminating on signal 15 from pid 149047 (python3)
======================= 1 passed, 4 deselected in 8.84s ========================

$ test/test-functional --kernel=../linux -k test_bluetoothctl_pair --log-cli-level=0 --log-filter=*.bluetoothctl,rpc.* --force-usb
============================= test session starts ==============================
platform linux -- Python 3.14.3, pytest-8.3.5, pluggy-1.6.0
rootdir: /home/pauli/prj/external/bluez/unit
configfile: pytest.ini
plugins: cov-5.0.0, forked-1.6.0, rerunfailures-15.0, timeout-2.4.0, xdist-3.7.0, hypothesis-6.123.0, flaky-3.8.1, anyio-4.12.1
collected 5 items / 4 deselected / 1 selected

test/functional/test_bluetoothctl_vm.py::test_bluetoothctl_pair[hosts0-vm2] -------------------------------- live log setup --------------------------------

13:03:20 INFO   rpc.host.0.0        :  client: start_load (<func_test.lib.host_plugins.Bdaddr object at 0x7f268712d160>,) {}
13:03:20 INFO   rpc.host.0.0        :  client: start_load (<func_test.lib.host_plugins.Call object at 0x7f268712d2b0>,) {}
13:03:20 INFO   rpc.host.0.0        :  client: start_load (<func_test.lib.host_plugins.DbusSystem object at 0x7f2687aa30e0>,) {}
13:03:20 INFO   rpc.host.0.0        :  client: start_load (<func_test.lib.host_plugins.Bluetoothd object at 0x7f2687aa3230>,) {}
13:03:20 INFO   rpc.host.0.0        :  client: start_load (<func_test.lib.host_plugins.Bluetoothctl object at 0x7f268712d010>,) {}
13:03:20 INFO   rpc.host.0.1        :  client: start_load (<func_test.lib.host_plugins.Bdaddr object at 0x7f26871542d0>,) {}
13:03:20 INFO   rpc.host.0.1        :  client: start_load (<func_test.lib.host_plugins.Call object at 0x7f2687154410>,) {}
13:03:20 INFO   rpc.host.0.1        :  client: start_load (<func_test.lib.host_plugins.DbusSystem object at 0x7f2687aa30e0>,) {}
13:03:20 INFO   rpc.host.0.1        :  client: start_load (<func_test.lib.host_plugins.Bluetoothd object at 0x7f2687aa3230>,) {}
13:03:20 INFO   rpc.host.0.1        :  client: start_load (<func_test.lib.host_plugins.Bluetoothctl object at 0x7f2687154190>,) {}
13:03:20 INFO   rpc.host.0.0        :  client: wait_load () {}
13:03:21 DEBUG  rpc.host.0.0        :  client-reply
13:03:21 INFO   rpc.host.0.1        :  client: wait_load () {}
13:03:21 DEBUG  rpc.host.0.1        :  client-reply
-------------------------------- live log call ---------------------------------
13:03:21 INFO   rpc.host.0.0        :  client: call_plugin ('bluetoothctl', 'send', 'show\n') {}
13:03:21 DEBUG  rpc.host.0.0        :  client-reply
13:03:21 INFO   rpc.host.0.0        :  client: call_plugin ('bluetoothctl', 'expect', 'Powered: yes') {}
...
13:03:23 INFO   rpc.host.0.0        :  client: call_plugin ('bluetoothctl', 'send', 'pair 70:1a:b8:73:99:bb\n') {}
13:03:23 OUT    host.0.0.bluetoothctl:  pair 70:1a:b8:73:99:bb
13:03:23 DEBUG  rpc.host.0.0        :  client-reply
13:03:23 INFO   rpc.host.0.0        :  client: call_plugin ('bluetoothctl', 'expect', 'Confirm passkey (\\d+).*:') {}
13:03:23 OUT    host.0.0.bluetoothctl:  [bluetoothctl]> pair 70:1a:b8:73:99:bb
13:03:23 OUT    host.0.0.bluetoothctl:  Attempting to pair with 70:1A:B8:73:99:BB
13:03:23 OUT    host.0.0.bluetoothctl:  [bluetoothctl]> hci0 device_flags_changed: 70:1A:B8:73:99:BB (BR/EDR)
13:03:23 OUT    host.0.0.bluetoothctl:  [bluetoothctl]>      supp: 0x00000007  curr: 0x00000000
13:03:23 OUT    host.0.0.bluetoothctl:  [bluetoothctl]> hci0 type 7 discovering off
13:03:25 OUT    host.0.0.bluetoothctl:  [bluetoothctl]> hci0 70:1A:B8:73:99:BB type BR/EDR connected eir_len 12
13:03:25 OUT    host.0.0.bluetoothctl:  [bluetoothctl]> [BlueZ 5.86]> [CHG] Device 70:1A:B8:73:99:BB Connected: yes
13:03:25 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> Request confirmation
13:03:25 DEBUG  rpc.host.0.0        :  client-reply
13:03:25 INFO   rpc.host.0.1        :  client: call_plugin ('bluetoothctl', 'expect', 'Confirm passkey 237345') {}
13:03:25 OUT    host.0.1.bluetoothctl:  [bluetoothctl]> hci0 84:5C:F3:77:31:19 type BR/EDR connected eir_len 12
13:03:25 OUT    host.0.1.bluetoothctl:  [bluetoothctl]> [NEW] Device 84:5C:F3:77:31:19 BlueZ 5.86
13:03:25 DEBUG  rpc.host.0.1        :  client-reply
13:03:25 INFO   rpc.host.0.0        :  client: call_plugin ('bluetoothctl', 'send', 'yes\n') {}
13:03:25 OUT    host.0.1.bluetoothctl:  [bluetoothctl]> [BlueZ 5.86]> Request confirmation
13:03:25 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> [agent] Confirm passkey 237345 (yes/no): yes
13:03:25 DEBUG  rpc.host.0.0        :  client-reply
13:03:25 INFO   rpc.host.0.1        :  client: call_plugin ('bluetoothctl', 'send', 'yes\n') {}
13:03:25 OUT    host.0.1.bluetoothctl:  [BlueZ 5.86]> [agent] Confirm passkey 237345 (yes/no): yes
13:03:25 DEBUG  rpc.host.0.1        :  client-reply
13:03:25 INFO   rpc.host.0.0        :  client: call_plugin ('bluetoothctl', 'expect', 'Pairing successful') {}
13:03:25 OUT    host.0.0.bluetoothctl:  yes
13:03:25 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> hci0 new_link_key 70:1A:B8:73:99:BB type 0x08 pin_len 0 store_hint 1
13:03:25 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> [CHG] Device 70:1A:B8:73:99:BB Bonded: yes
13:03:26 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> [CHG] Device 70:1A:B8:73:99:BB AddressType: public
13:03:26 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> [CHG] Device 70:1A:B8:73:99:BB UUIDs: 0000110c-0000-1000-8000-00805f9b34fb
13:03:26 OUT    host.0.0.bluetoothctl:  [BlueZ 5.86]> [CHG] Device 70:1A:B8:73:99:BB UUIDs: 0000110e-0000-1000-8000-00805f9b34fb
13:03:26 DEBUG  rpc.host.0.0        :  client-reply

PASSED [100%]
------------------------------ live log teardown -------------------------------
13:03:26 OUT host.0.0.bluetoothctl: [BlueZ 5.86]> [CHG] Device 70:1A:B8:98:FF:qemu-system-x86_64: terminating on signal 15 from pid 149357 (python3)

======================= 1 passed, 4 deselected in 13.22s =======================

$ test/test-functional -k test_btmgmt --kernel=../linux --trace
============================= test session starts ==============================
platform linux -- Python 3.14.3, pytest-8.3.5, pluggy-1.6.0
rootdir: /home/pauli/prj/external/bluez/unit
configfile: pytest.ini
plugins: cov-5.0.0, forked-1.6.0, rerunfailures-15.0, timeout-2.4.0, xdist-3.7.0, hypothesis-6.123.0, flaky-3.8.1, anyio-4.12.1
collected 5 items / 4 deselected / 1 selected

test/functional/test_btmgmt_vm.py

Quoted 2 lines

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

Quoted 1 line

PDB runcall (IO-capturing turned off) >>>>>>>>>>>>>>>>>>>>>

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(19)test_btmgmt_info()

-> (host,) = hosts
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(21)test_btmgmt_info()

-> result = host.call(
(Pdb) p host.bdaddr
'00:aa:01:00:00:42'
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(22)test_btmgmt_info()

-> run,
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(23)test_btmgmt_info()

-> [btmgmt, "--index", "0", "info"],
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(24)test_btmgmt_info()

-> stdout=subprocess.PIPE,
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(25)test_btmgmt_info()

-> stdin=subprocess.DEVNULL,
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(26)test_btmgmt_info()

-> encoding="utf-8",
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(21)test_btmgmt_info()

-> result = host.call(
(Pdb) n

Quoted 1 line

/home/pauli/prj/external/bluez/test/functional/test_btmgmt_vm.py(28)test_btmgmt_info()

-> assert result.returncode == 0
(Pdb) p result
CompletedProcess(args=['/home/pauli/prj/external/bluez/build/tools/btmgmt', '--index', '0', 'info'], returncode=0, stdout='hci0:\tPrimary controller\n\taddr 00:AA:01:00:00:42 version 11 manufacturer 1521 class 0x000000\n\tsupported settings: powered connectable fast-connectable discoverable bondable link-security ssp br/edr le advertising secure-conn debug-keys privacy static-addr phy-configuration cis-central cis-peripheral iso-broadcaster sync-receiver ll-privacy past-sender past-receiver \n\tcurrent settings: br/edr \n\tname \n\tshort name \n') (Pdb) print(result.stdout)
hci0: Primary controller
addr 00:AA:01:00:00:42 version 11 manufacturer 1521 class 0x000000
supported settings: powered connectable fast-connectable discoverable bondable link-security ssp br/edr le advertising secure-conn debug-keys privacy static-addr phy-configuration cis-central cis-peripheral iso-broadcaster sync-receiver ll-privacy past-sender past-receiver
current settings: br/edr
name
short name
(Pdb) q

!!!!!!!!!!!!!!!!!!! _pytest.outcomes.Exit: Quitting debugger !!!!!!!!!!!!!!!!!!! ======================= 4 deselected in 75.91s (0:01:15) =======================

Pauli Virtanen (16):
emulator: btvirt: check pkt lengths, don't get stuck on malformed
emulator: btvirt: allow specifying where server unix sockets are made
emulator: btvirt: support SCO data packets
emulator: btdev: clear more state on Reset
test-runner: enable path argument for --unix
test-runner: Add -o/--option option
test-runner: allow source tree root for -k
test-runner: use virtio-serial for implementing -u device forwarding
doc: enable CONFIG_VIRTIO_CONSOLE in tester config
doc: enable KVM paravirtualization & clock support in tester kernel
config
doc: add functional/integration testing documentation
test: add functional/integration testing framework
build: add functional testing target
test: functional: impose Python code formatting
test: functional: add some Agent1 interface tests
test: functional: add basic obex file transfer tests

 Makefile.am                             |  10 +
 configure.ac                            |  22 ++
 doc/ci.config                           |   9 +
 doc/test-functional.rst                 | 299 ++++++++++++++++++++++++
 doc/test-runner.rst                     |  17 ++
 doc/tester.config                       |   9 +
 emulator/btdev.c                        | 117 ++++++----
 emulator/main.c                         |  37 +--
 emulator/server.c                       |  21 ++
 test/functional/__init__.py             |   2 +
 test/functional/conftest.py             |  48 ++++
 test/functional/requirements.txt        |   2 +
 test/functional/test_agent.py           |  46 ++++
 test/functional/test_bluetoothctl_vm.py | 152 ++++++++++++
 test/functional/test_btmgmt_vm.py       |  30 +++
 test/functional/test_obex.py            | 285 ++++++++++++++++++++++
 test/functional/test_tests.py           |  23 ++
 test/pytest.ini                         |  17 ++
 test/test-functional                    |  21 ++
 test/test-functional-attach             |   7 +
 tools/test-runner.c                     |  89 ++++---
 21 files changed, 1177 insertions(+), 86 deletions(-)
 create mode 100644 doc/test-functional.rst
 create mode 100644 test/functional/__init__.py
 create mode 100644 test/functional/conftest.py
 create mode 100644 test/functional/requirements.txt
 create mode 100644 test/functional/test_agent.py
 create mode 100644 test/functional/test_bluetoothctl_vm.py
 create mode 100644 test/functional/test_btmgmt_vm.py
 create mode 100644 test/functional/test_obex.py
 create mode 100644 test/functional/test_tests.py
 create mode 100644 test/pytest.ini
 create mode 100755 test/test-functional
 create mode 100755 test/test-functional-attach

--
2.54.0

Hi Pauli,

Quoted 4 lines · Pauli Virtanen

Add framework for writing tests simulating "real" environments where BlueZ and other parts of the stack run on different virtual machine hosts that communicate with each other.

Quoted 15 lines

 21 files changed, 1177 insertions(+), 86 deletions(-)
 create mode 100644 doc/test-functional.rst
 create mode 100644 test/functional/__init__.py
 create mode 100644 test/functional/conftest.py
 create mode 100644 test/functional/requirements.txt
 create mode 100644 test/functional/test_agent.py
 create mode 100644 test/functional/test_bluetoothctl_vm.py
 create mode 100644 test/functional/test_btmgmt_vm.py
 create mode 100644 test/functional/test_obex.py
 create mode 100644 test/functional/test_tests.py
 create mode 100644 test/pytest.ini
 create mode 100755 test/test-functional
 create mode 100755 test/test-functional-attach

Quoted 2 lines

--
2.54.0

Do you mind resending the remaining changes? I'd like to see how it works; it seems you've already integrated with things like make check, right?