From: Laine Stump <laine@redhat.com>
Date: Mon, 15 Nov 2021 18:28:12 +0000 (-0500)
Subject: tests: document why virgdbus must be mocked in networkxml2firewalltest.c
X-Git-Tag: v8.0.0-rc1~223
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d37406626704b89c5f23ab8bc5adb8f59e58401;p=thirdparty%2Flibvirt.git

tests: document why virgdbus must be mocked in networkxml2firewalltest.c

It isn't intuitive (to me) that a test just converting xml text into
iptables commands should need to call dbus, so rather than forcing the
next person to look through the commit logs and/or run the test under
gdb to understand why this is needed, just add a short comment in the
source.

Signed-off-by: Laine Stump <laine@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
---

diff --git a/tests/networkxml2firewalltest.c b/tests/networkxml2firewalltest.c
index e4f86bc3fc..68a82e60d6 100644
--- a/tests/networkxml2firewalltest.c
+++ b/tests/networkxml2firewalltest.c
@@ -187,6 +187,12 @@ mymain(void)
     return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
 }
 
+/* NB: virgdbus must be mocked because this test calls
+ * networkAddFirewallRules(), which will always call
+ * virFirewallDIsRegistered(), which calls
+ * virGDBusIsServiceRegistered().
+ */
+
 VIR_TEST_MAIN_PRELOAD(mymain, VIR_TEST_MOCK("virgdbus"),
                       VIR_TEST_MOCK("virfirewall"))