libvirt/tests/virnetdevopenvswitchtest.c
Michal Privoznik 51d9af4c0c virnetdevopenvswitch: Try to unescape ovs-vsctl reply in one specific case
During testing of my patch v6.10.0-rc1~221 it was found that

  'ovs-vsctl get Interface $name name' or
  'ovs-vsctl find Interface options:vhost-server-path=$path'

may return a string in double quotes, e.g. "vhost-user1". Later
investigation of openvswitch code showed, that early versions
(like 1.3.0) have somewhat restrictive set of safe characters
(isalpha() || '_' || '-' || '.'), which is then refined with
increasing version. For instance, version 2.11.4 has: isalnum()
|| '_' || '-' || '.'. If the string that ovs-vsctl wants to
output contains any other character it is escaped. You want to be
looking at ovsdb_atom_to_string() which handles outputting of a
single string and calls string_needs_quotes() and possibly
json_serialize_string() in openvswitch code base.

Since the interfaces are usually named "vhost-userN" we are
facing a problem where with one version we get the name in double
quotes and with another we get plain name without funny business.

Because of json involved I thought, let's make ovs-vsctl output
into JSON format and then use our JSON parser, but guess what -
ovs-vsctl ignores --format=json. But with a little help of
g_strdup_printf() it can be turned into JSON.

Fixes: e4c29e2904
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1767013
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Laine Stump <laine@redhat.com>
2020-12-17 09:27:51 +01:00

153 lines
4.5 KiB
C

/*
* Copyright (C) 2019 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include "testutils.h"
#include "virnetdevopenvswitch.h"
#define VIR_FROM_THIS VIR_FROM_NONE
typedef struct _InterfaceParseStatsData InterfaceParseStatsData;
struct _InterfaceParseStatsData {
const char *filename;
const virDomainInterfaceStatsStruct stats;
};
static int
testInterfaceParseStats(const void *opaque)
{
const InterfaceParseStatsData *data = opaque;
g_autofree char *filename = NULL;
g_autofree char *buf = NULL;
virDomainInterfaceStatsStruct actual;
filename = g_strdup_printf("%s/virnetdevopenvswitchdata/%s", abs_srcdir,
data->filename);
if (virFileReadAll(filename, 1024, &buf) < 0)
return -1;
if (virNetDevOpenvswitchInterfaceParseStats(buf, &actual) < 0)
return -1;
if (memcmp(&actual, &data->stats, sizeof(actual)) != 0) {
fprintf(stderr,
"Expected stats: %lld %lld %lld %lld %lld %lld %lld %lld\n"
"Actual stats: %lld %lld %lld %lld %lld %lld %lld %lld",
data->stats.rx_bytes,
data->stats.rx_packets,
data->stats.rx_errs,
data->stats.rx_drop,
data->stats.tx_bytes,
data->stats.tx_packets,
data->stats.tx_errs,
data->stats.tx_drop,
actual.rx_bytes,
actual.rx_packets,
actual.rx_errs,
actual.rx_drop,
actual.tx_bytes,
actual.tx_packets,
actual.tx_errs,
actual.tx_drop);
return -1;
}
return 0;
}
typedef struct _escapeData escapeData;
struct _escapeData {
const char *input;
const char *expect;
};
static int
testNameEscape(const void *opaque)
{
const escapeData *data = opaque;
g_autofree char *reply = g_strdup(data->input);
int rv;
rv = virNetDevOpenvswitchMaybeUnescapeReply(reply);
if (data->expect) {
if (rv < 0 || STRNEQ(reply, data->expect)) {
fprintf(stderr,
"Unexpected failure, expected: %s for input %s got %s\n",
data->expect, data->input, reply);
return -1;
}
} else {
if (rv >= 0) {
fprintf(stderr,
"Unexpected success, input %s got %s\n",
data->input, reply);
return -1;
}
}
return 0;
}
static int
mymain(void)
{
int ret = 0;
#define TEST_INTERFACE_STATS(file, \
rxBytes, rxPackets, rxErrs, rxDrop, \
txBytes, txPackets, txErrs, txDrop) \
do { \
const InterfaceParseStatsData data = {.filename = file, .stats = { \
rxBytes, rxPackets, rxErrs, rxDrop, \
txBytes, txPackets, txErrs, txDrop}}; \
if (virTestRun("Interface stats " file, testInterfaceParseStats, &data) < 0) \
ret = -1; \
} while (0)
TEST_INTERFACE_STATS("stats1.json", 9, 12, 11, 10, 2, 8, 5, 4);
TEST_INTERFACE_STATS("stats2.json", 12406, 173, 0, 0, 0, 0, 0, 0);
#define TEST_NAME_ESCAPE(str, fail) \
do { \
const escapeData data = {str, fail};\
if (virTestRun("Name escape " str, testNameEscape, &data) < 0) \
ret = -1; \
} while (0)
TEST_NAME_ESCAPE("", "");
TEST_NAME_ESCAPE("\"\"", "");
TEST_NAME_ESCAPE("vhost-user1", "vhost-user1");
TEST_NAME_ESCAPE("\"vhost-user1\"", "vhost-user1");
TEST_NAME_ESCAPE("\"vhost_user-name.to.escape1", NULL);
TEST_NAME_ESCAPE("\"vhost_user-name.to\\\"escape1\"", "vhost_user-name.to\"escape1");
TEST_NAME_ESCAPE("\"vhost\"user1\"", NULL);
TEST_NAME_ESCAPE("\"\\\\", NULL);
return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
}
VIR_TEST_MAIN(mymain);