qemu-ga: add guest-get-osinfo command
v6 cover qemu-ga: add guest-get-osinfo command
v6:
- fixed the documentation comment in schema
- disguising os-release as key-value file (thanks Marc-André)
- dropped dependency on gio
- improved error handling
- added test
v5:
- fixed build failure with older glib
- fixed coding style issues
- fixed one log string
This is a continuation of the work started by Vinzenz Feenstra in the threads:
https://lists.nongnu.org/archive/html/qemu-devel/2017-03/msg04154.html
https://lists.nongnu.org/archive/html/qemu-devel/2017-03/msg04302.html
https://lists.nongnu.org/archive/html/qemu-devel/2017-03/msg06262.html
The idea is to report some basic information from uname and from os-release file, if it is present. On MS Windows, where neither uname nor os-release exist we fill the values based on the information we can get from the OS.
The example output on Fedora is:
{
"return": {
"kernel-version": "#1 SMP Mon May 8 18:46:06 UTC 2017",
"kernel-release": "4.10.15-200.fc25.x86_64",
"machine-hardware": "x86_64",
"id": "fedora",
"name": "Fedora",
"pretty-name": "Fedora 25 (Server Edition)",
"version": "25 (Server Edition)",
"variant": "Server Edition",
"version-id": "25",
"variant-id": "server" }
}
The example output on MS Windows 10 is:
{
"return": {
"kernel-version": "10.0",
"kernel-release": "10240",
"machine-hardware": "x86_64",
"id": "mswindows",
"name": "Microsoft Windows",
"pretty-name": "Windows 10 Enterprise",
"version": "Microsoft Windows 10",
"version-id": "10",
"variant": "client",
"variant-id": "client" }
}
Tomas Golembiovsky
Tomáš Golembiovský (3):
qemu-ga: add guest-get-osinfo command
test-qga: pass environemnt to qemu-ga
test-qga: add test for guest-get-osinfo
qga/commands-posix.c | 143 +++++++++++++++++++++++++++++++++++++++ qga/commands-win32.c | 185 +++++++++++++++++++++++++++++++++++++++++++++++++++ qga/qapi-schema.json | 65 ++++++++++++++++++ tests/test-qga.c | 61 +++++++++++++++-- 4 files changed, 450 insertions(+), 4 deletions(-)
Signature · 1 line
2.13.1
PATCH v6 1/3 qemu-ga: add guest-get-osinfo command
Add a new 'guest-get-osinfo' command for reporting basic information of the guest operating system. This includes machine architecture, version and release of the kernel and several fields from os-release file if it is present (as defined in [1]).
[1] https://www.freedesktop.org/software/systemd/man/os-release.html
--- qga/commands-posix.c | 136 +++++++++++++++++++++++++++++++++++++ qga/commands-win32.c | 185 +++++++++++++++++++++++++++++++++++++++++++++++++++ qga/qapi-schema.json | 65 ++++++++++++++++++ 3 files changed, 386 insertions(+)
qga/commands-posix.c +136 -0
@@ -13,6 +13,7 @@#include "qemu/osdep.h" #include <sys/ioctl.h> +#include <sys/utsname.h> #include <sys/wait.h> #include <dirent.h> #include <utmpx.h>
@@ -2577,3 +2578,138 @@ GuestUserList *qmp_guest_get_users(Error **err)g_hash_table_destroy (cache);return head; } + +/* Replace escaped special characters with theire real values. The replacement +* is done in place -- returned value is in the original string. +*/ +static void ga_osrelease_replace_special (gchar *value) +{ +gchar *p, *p2, quote; + +/* Trim the string at first space or semicolon if it is not enclosed in +* single or double quotes. */ +if ((value[0 ] !='"' ) || (value[0 ] =='\'' )) { + p =strchr (value,' ' ); +if (p !=NULL ) { + *p =0 ; + } + p =strchr (value,';' ); +if (p !=NULL ) { + *p =0 ; + } +return ; + } + + quote = value[0 ]; + p2 = value; + p = value+1 ; +while (*p !=0 ) { +if (*p =='\\' ) { + p++; +switch (*p) { +case '$' : +case '\'' : +case '"' : +case '\\' : +case '`' : +break ; +default : +/* Keep literal backslash followed by whatever is there */ + p--; +break ; + } + }else if (*p == quote) { + *p2 =0 ; +break ; + } + *(p2++) = *(p++); + } +} + +static GKeyFile *ga_parse_osrelease (const char *fname) +{ +gboolean ret; +gchar *content =NULL ; +gchar *content2 =NULL ; +gsize len; +GError *err =NULL ; +GKeyFile *keys =g_key_file_new (); +const char *group ="[os-release]\n" ; + + ret =g_file_get_contents (fname, &content, &len, &err); +if (ret != TRUE) { +slog ("failed to read '%s', error: %s" , fname, err->message); + goto fail; + } + + ret =g_utf8_validate (content, len,NULL ); +if (ret != TRUE) { +slog ("file is not utf-8 encoded: %s" , fname); + goto fail; + } + content2 =g_strdup_printf ("%s%s" , group, content); + len +=strlen (group); + + ret =g_key_file_load_from_data (keys, content2, len,G_KEY_FILE_NONE , + &err); +if (ret != TRUE) { +slog ("failed to parse file '%s', error: %s" , fname, err->message); + goto fail; + } + +g_free (content); +g_free (content2); +return keys; + +fail: +g_error_free (err); +g_free (content); +g_free (content2); +g_key_file_free (keys); +return NULL ; +} + +GuestOSInfo *qmp_guest_get_osinfo (Error **errp) +{ +GuestOSInfo *info =g_new0 (GuestOSInfo,1 ); + +struct utsname kinfo = {0 }; +if (uname (&kinfo) !=0 ) { +error_setg_errno (errp, errno,"uname failed" ); +return NULL ; + } + + info->kernel_version =g_strdup (kinfo.version); + info->kernel_release =g_strdup (kinfo.release); + info->machine_hardware =g_strdup (kinfo.machine); + +GKeyFile *osrelease =ga_parse_osrelease ("/etc/os-release" ); +if (osrelease ==NULL ) { + osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); + } + +if (osrelease !=NULL ) { +char *value; + +#define GET_FIELD (field, osfield) do { \ + value = g_key_file_get_value(osrelease, "os-release", osfield, NULL); \ + if (value != NULL) { \ + ga_osrelease_replace_special(value); \ + info->has_ ## field = true; \ + info->field = value; \ + } \ +} while (0) +GET_FIELD (id,"ID" ); +GET_FIELD (name,"NAME" ); +GET_FIELD (pretty_name,"PRETTY_NAME" ); +GET_FIELD (version,"VERSION" ); +GET_FIELD (version_id,"VERSION_ID" ); +GET_FIELD (variant,"VARIANT" ); +GET_FIELD (variant_id,"VARIANT_ID" ); +#undef GET_FIELD + +g_key_file_free (osrelease); + } + +return info; +}
qga/commands-win32.c +185 -0
188 lines not on this page · raw message
qga/qapi-schema.json +65 -0
68 lines not on this page · raw message
Signature · 1 line
2.13.1
PATCH v6 2/3 test-qga: pass environemnt to qemu-ga
In reply to Tomáš GolembiovskýModify fixture_setup() to pass environemnt variables to spawned qemu-ga instance.
--- tests/test-qga.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
tests/test-qga.c +4 -4
@@ -46,7 +46,7 @@ static void qga_watch(GPid pid, gint status, gpointer user_data) }static void -fixture_setup (TestFixture *fixture,gconstpointer data) +fixture_setup (TestFixture *fixture,gconstpointer data,gchar **envp) {const gchar *extra_arg = data;GError *error =NULL ;
@@ -67,7 +67,7 @@ fixture_setup(TestFixture *fixture, gconstpointer data)g_shell_parse_argv (cmd,NULL , &argv, &error);g_assert_no_error (error); -g_spawn_async (fixture->test_dir, argv,NULL , +g_spawn_async (fixture->test_dir, argv, envp,G_SPAWN_SEARCH_PATH |G_SPAWN_DO_NOT_REAP_CHILD ,NULL ,NULL , &fixture->pid, &error);g_assert_no_error (error);
@@ -707,7 +707,7 @@ static void test_qga_blacklist(gconstpointer data)QDict *ret, *error;const gchar *class, *desc; -fixture_setup (&fix,"-b guest-ping,guest-get-time" ); +fixture_setup (&fix,"-b guest-ping,guest-get-time" ,NULL );/* check blacklist */ ret =qmp_fd (fix.fd,"{'execute': 'guest-ping'}" );
@@ -943,7 +943,7 @@ int main(int argc, char **argv)setlocale (LC_ALL ,"" );g_test_init (&argc, &argv,NULL ); -fixture_setup (&fix,NULL ); +fixture_setup (&fix,NULL ,NULL );g_test_add_data_func ("/qga/sync-delimited" , &fix, test_qga_sync_delimited);g_test_add_data_func ("/qga/sync" , &fix, test_qga_sync);
Signature · 1 line
2.13.1
PATCH v6 3/3 test-qga: add test for guest-get-osinfo
In reply to Tomáš GolembiovskýAdd test for guest-get-osinfo command.
Qemu-ga was modified to accept QGA_OS_RELEASE environment variable. If the variable is defined it is interpreted as path to the os-release file and it is parsed instead of the default paths.
--- qga/commands-posix.c | 13 ++++++++++--- tests/test-qga.c | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 3 deletions(-)
qga/commands-posix.c +10 -3
@@ -2683,9 +2683,16 @@ GuestOSInfo *qmp_guest_get_osinfo(Error **errp) info->kernel_release =g_strdup (kinfo.release); info->machine_hardware =g_strdup (kinfo.machine); -GKeyFile *osrelease =ga_parse_osrelease ("/etc/os-release" ); -if (osrelease ==NULL ) { - osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); +GKeyFile *osrelease =NULL ; + +const char *qga_os_release =g_getenv ("QGA_OS_RELEASE" ); +if (qga_os_release !=NULL ) { + osrelease =ga_parse_osrelease (qga_os_release); + }else { + osrelease =ga_parse_osrelease ("/etc/os-release" ); +if (osrelease ==NULL ) { + osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); + } }if (osrelease !=NULL ) {
tests/test-qga.c +53 -0
65 lines not on this page · raw message
Signature · 1 line
2.13.1
Re: [Qemu-devel] [PATCH v6 3/3] test-qga: add test for guest-get-osinfo
Hi,
It's missing test-qga-os-release :)
Quoted 112 lines · Tomáš Golembiovský
Add test for guest-get-osinfo command.
Qemu-ga was modified to accept
QGA_OS_RELEASEenvironment variable. If the variable is defined it is interpreted as path to the os-release file and it is parsed instead of the default paths.Signed-off-by Tomáš Golembiovský <[email protected]>--- qga/commands-posix.c | 13 ++++++++++--- tests/test-qga.c | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 3 deletions(-)qga/commands-posix.c +10
-3@@ -2683,9 +2683,16 @@ GuestOSInfo *qmp_guest_get_osinfo(Error **errp) info->kernel_release =g_strdup (kinfo.release); info->machine_hardware =g_strdup (kinfo.machine); -GKeyFile *osrelease =ga_parse_osrelease ("/etc/os-release" ); -if (osrelease ==NULL ) { - osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); +GKeyFile *osrelease =NULL ; + +const char *qga_os_release =g_getenv ("QGA_OS_RELEASE" ); +if (qga_os_release !=NULL ) { + osrelease =ga_parse_osrelease (qga_os_release); + }else { + osrelease =ga_parse_osrelease ("/etc/os-release" ); +if (osrelease ==NULL ) { + osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); + } }if (osrelease !=NULL ) {tests/test-qga.c +52
-0@@ -936,6 +936,58 @@ static void test_qga_guest_exec_invalid(gconstpointer fix)QDECREF (ret ); } +static void test_qga_guest_get_osinfo (gconstpointer data) +{ +TestFixture fixture; +const gchar *str; +gchar *cwd, *env[2 ]; +QDict *ret, *val; + + cwd =g_get_current_dir (); + env[0 ] =g_strdup_printf ("QGA_OS_RELEASE=%s%ctests%cdata%ctest-qga-os-release" , + cwd,G_DIR_SEPARATOR ,G_DIR_SEPARATOR ,G_DIR_SEPARATOR ); + env[1 ] =NULL ; +g_free (cwd); +fixture_setup (&fixture,NULL , env); + + ret =qmp_fd (fixture.fd,"{'execute': 'guest-get-osinfo'}" ); +g_assert_nonnull (ret); +qmp_assert_no_error (ret); + + val =qdict_get_qdict (ret,"return" ); + + str =qdict_get_try_str (val,"id" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "qemu-ga-test"); + + str =qdict_get_try_str (val,"name" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "QEMU-GA"); + + str =qdict_get_try_str (val,"pretty-name" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "QEMU Guest Agent test"); + + str =qdict_get_try_str (val,"version" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "Test 1"); + + str =qdict_get_try_str (val,"version-id" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "1"); + + str =qdict_get_try_str (val,"variant" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "Unit test \"'$`\\ and \\\\ etc."); + + str =qdict_get_try_str (val,"variant-id" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "unit-test"); + +QDECREF (ret); +g_free (env[0 ]); +} +int
main(int argc, char **argv){ TestFixture fix;tests/test-qga.c +1
-0@@ -972,6 +1024,7 @@ int main(int argc, char **argv)g_test_add_data_func ("/qga/guest-exec" , &fix, test_qga_guest_exec);g_test_add_data_func ("/qga/guest-exec-invalid" , &fix, test_qga_guest_exec_invalid); +g_test_add_data_func ("/qga/guest-get-osinfo" , &fix, test_qga_guest_get_osinfo);if (g_getenv ("QGA_TEST_SIDE_EFFECTING" )) {g_test_add_data_func("/qga/fsfreeze-and-thaw", &fix,
Quoted 4 lines
--
2.13.1--
Marc-André Lureau
Re: [Qemu-devel] [PATCH v6 3/3] test-qga: add test for guest-get-osinfo
Uh, sorry. I will resend in a minute.
Tomas
Quoted 124 lines · On Fri, 30 Jun 2017 13:48:41 +0000 Marc-André Lureau…
Hi,
It's missing test-qga-os-release :)
Quoted 112 lines · Tomáš Golembiovský
Add test for guest-get-osinfo command.
Qemu-ga was modified to accept
QGA_OS_RELEASEenvironment variable. If the variable is defined it is interpreted as path to the os-release file and it is parsed instead of the default paths.Signed-off-by Tomáš Golembiovský <[email protected]>--- qga/commands-posix.c | 13 ++++++++++--- tests/test-qga.c | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 3 deletions(-)qga/commands-posix.c +10
-3@@ -2683,9 +2683,16 @@ GuestOSInfo *qmp_guest_get_osinfo(Error **errp) info->kernel_release =g_strdup (kinfo.release); info->machine_hardware =g_strdup (kinfo.machine); -GKeyFile *osrelease =ga_parse_osrelease ("/etc/os-release" ); -if (osrelease ==NULL ) { - osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); +GKeyFile *osrelease =NULL ; + +const char *qga_os_release =g_getenv ("QGA_OS_RELEASE" ); +if (qga_os_release !=NULL ) { + osrelease =ga_parse_osrelease (qga_os_release); + }else { + osrelease =ga_parse_osrelease ("/etc/os-release" ); +if (osrelease ==NULL ) { + osrelease =ga_parse_osrelease ("/usr/lib/os-release" ); + } }if (osrelease !=NULL ) {tests/test-qga.c +52
-0@@ -936,6 +936,58 @@ static void test_qga_guest_exec_invalid(gconstpointer fix)QDECREF (ret ); } +static void test_qga_guest_get_osinfo (gconstpointer data) +{ +TestFixture fixture; +const gchar *str; +gchar *cwd, *env[2 ]; +QDict *ret, *val; + + cwd =g_get_current_dir (); + env[0 ] =g_strdup_printf ("QGA_OS_RELEASE=%s%ctests%cdata%ctest-qga-os-release" , + cwd,G_DIR_SEPARATOR ,G_DIR_SEPARATOR ,G_DIR_SEPARATOR ); + env[1 ] =NULL ; +g_free (cwd); +fixture_setup (&fixture,NULL , env); + + ret =qmp_fd (fixture.fd,"{'execute': 'guest-get-osinfo'}" ); +g_assert_nonnull (ret); +qmp_assert_no_error (ret); + + val =qdict_get_qdict (ret,"return" ); + + str =qdict_get_try_str (val,"id" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "qemu-ga-test"); + + str =qdict_get_try_str (val,"name" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "QEMU-GA"); + + str =qdict_get_try_str (val,"pretty-name" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "QEMU Guest Agent test"); + + str =qdict_get_try_str (val,"version" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "Test 1"); + + str =qdict_get_try_str (val,"version-id" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "1"); + + str =qdict_get_try_str (val,"variant" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "Unit test \"'$`\\ and \\\\ etc."); + + str =qdict_get_try_str (val,"variant-id" ); +g_assert_nonnull (str); + g_assert_cmpstr(str, ==, "unit-test"); + +QDECREF (ret); +g_free (env[0 ]); +} +int
main(int argc, char **argv){ TestFixture fix;tests/test-qga.c +1
-0@@ -972,6 +1024,7 @@ int main(int argc, char **argv)g_test_add_data_func ("/qga/guest-exec" , &fix, test_qga_guest_exec);g_test_add_data_func ("/qga/guest-exec-invalid" , &fix, test_qga_guest_exec_invalid); +g_test_add_data_func ("/qga/guest-get-osinfo" , &fix, test_qga_guest_get_osinfo);if (g_getenv ("QGA_TEST_SIDE_EFFECTING" )) {g_test_add_data_func("/qga/fsfreeze-and-thaw", &fix,Quoted 4 lines
--
2.13.1Marc-André Lureau
Signature · 1 line
Tomáš Golembiovský <[email protected]>