Skip to content

Commit 182428e

Browse files
committed
Fix formatting.
1 parent 0b3d418 commit 182428e

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

tests/unit/linux/wpa-controller/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
Some of the tests that exercise wpa daemon (hostapd, wpa_supplicant) functionality require a wlan device driver and a running instance of the daemon. To satisfy these requirements, the mac80211_hwsim driver is used to create a virtualized wlan device that the wpa daemon can then control. Helpers are provided for managing the virtualized wlan device(s) with [WifiVirtualDeviceManager](./detail/WifiVirtualDeviceManager.hxx) and for managing the wpa daemons with [WpaDaemonManager](./detail/WpaDaemonManager.hxx) and [WpaDaemonInstance](./detail/WpaDaemonInstance.hxx).
77

8-
Presently, the tests use [event listeners](https://github.com/catchorg/Catch2/blob/devel/docs/event-listeners.md) from the [Catch2](https://github.com/catchorg/Catch2) unit test framework instead of traditional, class-based setup/teardown fixtures. The event listeners have access to test case information such as the test case name and their tags. The [WpaDaemonCatch2EventListener](./detail/WpaDaemonCatch2EventListener.hxx) was developed to detect when a test case requires either of the daemons, and automatically creates a wlan driver and starts the required daemon . Similarly, it handles removing the driver instances and stopping the daemons on test case completion.
8+
Presently, the tests use [event listeners](https://github.com/catchorg/Catch2/blob/devel/docs/event-listeners.md) from the [Catch2](https://github.com/catchorg/Catch2) unit test framework instead of traditional, class-based setup/teardown fixtures. The event listeners have access to test case information such as the test case name and their tags. The [WpaDaemonCatch2EventListener](./detail/WpaDaemonCatch2EventListener.hxx) was developed to detect when a test case requires either of the daemons, and automatically creates a wlan driver and starts the required daemon. Similarly, it handles removing the driver instances and stopping the daemons on test case completion.
99

10-
To trigger this behavior, the test case must include a tag that corresponds to the name of a [WpaType](../../../../linux/wpa-controller/include/Wpa/WpaCore.hxx) enumeration value (a case insensitive comparison is done). For example, if the hostapd daemon is needed for the test, then a tag corresponding to WpaType::Hosapd is needed in the test case definition, for example '**hostapd**' as shown below:
10+
To trigger this behavior, the test case must include a tag that corresponds to the name of a [WpaType](../../../../linux/wpa-controller/include/Wpa/WpaCore.hxx) enumeration value (a case insensitive comparison is done). For example, if the hostapd daemon is needed for the test, then a tag corresponding to `WpaType::Hostapd` is needed in the test case definition, for example '**hostapd**' as shown below:
1111

1212
```C++
1313
TEST_CASE("Send command: GetStatus()", "[wpa][hostapd][client][remote]")
@@ -17,9 +17,8 @@ Only the first `WpaType` will be used. Failure to add the appropriate tag will c
1717
1818
### Future Work
1919
20-
This method will be improved in the future, with some possible improvements including:
20+
This method will be updated in the future, with some possible improvements including:
2121
2222
1. Allow multiple wpa daemon types.
2323
2. Allow a more generic daemon specification (eg. `[wpaDaemon=hostapd]`)
2424
3. Replacement of event-based fixtures to class-based fixtures.
25-

0 commit comments

Comments
 (0)