[v4] tests/unit: add unit test for qemu_hexdump()

[PATCH v4] tests/unit: add unit test for qemu_hexdump()

Posted by Vladimir Sementsov-Ogievskiy 2 weeks, 5 days ago

Test, that fix in previous commit make sense.

To not break compilation when we build without
'block', move hexdump.c out of "if have_block"
in meson.build.

Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
---
 tests/unit/test-cutils.c | 51 ++++++++++++++++++++++++++++++++++++++++
 util/meson.build         |  2 +-
 2 files changed, 52 insertions(+), 1 deletion(-)

diff --git a/tests/unit/test-cutils.c b/tests/unit/test-cutils.c
index 75fae29003..5f22b83564 100644
--- a/tests/unit/test-cutils.c
+++ b/tests/unit/test-cutils.c
@@ -3626,6 +3626,52 @@ static void test_si_prefix(void)
     g_assert_cmpstr(si_prefix(18), ==, "E");
 }
 
+static void test_qemu_hexdump_alignment(void)
+{
+    /*
+     * Test that ASCII part is properly aligned for incomplete lines.
+     * This test catches the bug that was fixed in previous commit
+     * "util/hexdump: fix QEMU_HEXDUMP_LINE_WIDTH logic".
+     *
+     * We use data that is not aligned to 16 bytes, so last line
+     * is incomplete.
+     */
+    const uint8_t data[] = {
+        /* First line: 16 bytes */
+        0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x57, 0x6f,  /* "Hello Wo" */
+        0x72, 0x6c, 0x64, 0x21, 0x20, 0x54, 0x68, 0x69,  /* "rld! Thi" */
+        /* Second line: 5 bytes (incomplete) */
+        0x73, 0x20, 0x69, 0x73, 0x20                     /* "s is " */
+    };
+    g_autofree char *output = NULL;
+    size_t size, bytes_read;
+
+#define TEST_FILE "test-qemu-hexdump-alignment.txt"
+    FILE *f = fopen(TEST_FILE, "w+");
+
+    g_assert_nonnull(f);
+
+    qemu_hexdump(f, "test", data, sizeof(data));
+
+    size = ftell(f);
+    fseek(f, 0, SEEK_SET);
+
+    output = g_malloc(size + 1);
+    bytes_read = fread(output, 1, size, f);
+    g_assert_cmpuint(bytes_read, ==, size);
+    output[size] = '\0';
+
+    fclose(f);
+    unlink(TEST_FILE);
+
+    /* We expect proper alignment of "s is" part on the second line */
+    const char *expected =
+        "test: 0000: 48 65 6c 6c  6f 20 57 6f  72 6c 64 21  20 54 68 69   Hello World! Thi\n"
+        "test: 0010: 73 20 69 73  20                                      s is \n";
+
+    g_assert_cmpstr(output, ==, expected);
+}
+
 int main(int argc, char **argv)
 {
     g_test_init(&argc, &argv, NULL);
@@ -3995,5 +4041,10 @@ int main(int argc, char **argv)
                     test_iec_binary_prefix);
     g_test_add_func("/cutils/si_prefix",
                     test_si_prefix);
+
+    /* qemu_hexdump() test */
+    g_test_add_func("/cutils/qemu_hexdump/alignment",
+                    test_qemu_hexdump_alignment);
+
     return g_test_run();
 }
diff --git a/util/meson.build b/util/meson.build
index 59e835a8d3..1804399da0 100644
--- a/util/meson.build
+++ b/util/meson.build
@@ -33,6 +33,7 @@ endif
 util_ss.add(files('defer-call.c'))
 util_ss.add(files('envlist.c', 'path.c', 'module.c'))
 util_ss.add(files('event.c'))
+util_ss.add(files('hexdump.c'))
 util_ss.add(files('host-utils.c'))
 util_ss.add(files('bitmap.c', 'bitops.c'))
 util_ss.add(files('fifo8.c'))
@@ -92,7 +93,6 @@ if have_block
   util_ss.add(files('buffer.c'))
   util_ss.add(files('bufferiszero.c'))
   util_ss.add(files('hbitmap.c'))
-  util_ss.add(files('hexdump.c'))
   util_ss.add(files('iova-tree.c'))
   util_ss.add(files('iov.c'))
   util_ss.add(files('nvdimm-utils.c'))
-- 
2.52.0

Re: [PATCH v4] tests/unit: add unit test for qemu_hexdump()

Posted by Vladimir Sementsov-Ogievskiy 2 weeks, 4 days ago

On 20.01.26 20:18, Vladimir Sementsov-Ogievskiy wrote:
> Test, that fix in previous commit make sense.
> 
> To not break compilation when we build without
> 'block', move hexdump.c out of "if have_block"
> in meson.build.
> 
> Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
> ---
>   tests/unit/test-cutils.c | 51 ++++++++++++++++++++++++++++++++++++++++
>   util/meson.build         |  2 +-
>   2 files changed, 52 insertions(+), 1 deletion(-)
> 
> diff --git a/tests/unit/test-cutils.c b/tests/unit/test-cutils.c
> index 75fae29003..5f22b83564 100644
> --- a/tests/unit/test-cutils.c
> +++ b/tests/unit/test-cutils.c
> @@ -3626,6 +3626,52 @@ static void test_si_prefix(void)
>       g_assert_cmpstr(si_prefix(18), ==, "E");
>   }
>   
> +static void test_qemu_hexdump_alignment(void)
> +{
> +    /*
> +     * Test that ASCII part is properly aligned for incomplete lines.
> +     * This test catches the bug that was fixed in previous commit
> +     * "util/hexdump: fix QEMU_HEXDUMP_LINE_WIDTH logic".
> +     *
> +     * We use data that is not aligned to 16 bytes, so last line
> +     * is incomplete.
> +     */
> +    const uint8_t data[] = {
> +        /* First line: 16 bytes */
> +        0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x57, 0x6f,  /* "Hello Wo" */
> +        0x72, 0x6c, 0x64, 0x21, 0x20, 0x54, 0x68, 0x69,  /* "rld! Thi" */
> +        /* Second line: 5 bytes (incomplete) */
> +        0x73, 0x20, 0x69, 0x73, 0x20                     /* "s is " */
> +    };
> +    g_autofree char *output = NULL;
> +    size_t size, bytes_read;
> +
> +#define TEST_FILE "test-qemu-hexdump-alignment.txt"
> +    FILE *f = fopen(TEST_FILE, "w+");
> +
> +    g_assert_nonnull(f);
> +
> +    qemu_hexdump(f, "test", data, sizeof(data));
> +
> +    size = ftell(f);
> +    fseek(f, 0, SEEK_SET);
> +
> +    output = g_malloc(size + 1);
> +    bytes_read = fread(output, 1, size, f);

CI fails for msys2-64bit:

# Start of qemu_hexdump tests
not ok /cutils/qemu_hexdump/alignment - ERROR:../tests/unit/test-cutils.c:3661:test_qemu_hexdump_alignment: assertion failed (bytes_read == size): (153 == 155)
Bail out!
----------------------------------- stderr -----------------------------------
**
ERROR:../tests/unit/test-cutils.c:3661:test_qemu_hexdump_alignment: assertion failed (bytes_read == size): (153 == 155)
(test program exited with status code 3)

will send v5...

> +    g_assert_cmpuint(bytes_read, ==, size);
> +    output[size] = '\0';
> +
> +    fclose(f);
> +    unlink(TEST_FILE);
> +
> +    /* We expect proper alignment of "s is" part on the second line */
> +    const char *expected =
> +        "test: 0000: 48 65 6c 6c  6f 20 57 6f  72 6c 64 21  20 54 68 69   Hello World! Thi\n"
> +        "test: 0010: 73 20 69 73  20                                      s is \n";
> +
> +    g_assert_cmpstr(output, ==, expected);
> +}
> +
>   int main(int argc, char **argv)
>   {
>       g_test_init(&argc, &argv, NULL);
> @@ -3995,5 +4041,10 @@ int main(int argc, char **argv)
>                       test_iec_binary_prefix);
>       g_test_add_func("/cutils/si_prefix",
>                       test_si_prefix);
> +
> +    /* qemu_hexdump() test */
> +    g_test_add_func("/cutils/qemu_hexdump/alignment",
> +                    test_qemu_hexdump_alignment);
> +
>       return g_test_run();
>   }
> diff --git a/util/meson.build b/util/meson.build
> index 59e835a8d3..1804399da0 100644
> --- a/util/meson.build
> +++ b/util/meson.build
> @@ -33,6 +33,7 @@ endif
>   util_ss.add(files('defer-call.c'))
>   util_ss.add(files('envlist.c', 'path.c', 'module.c'))
>   util_ss.add(files('event.c'))
> +util_ss.add(files('hexdump.c'))
>   util_ss.add(files('host-utils.c'))
>   util_ss.add(files('bitmap.c', 'bitops.c'))
>   util_ss.add(files('fifo8.c'))
> @@ -92,7 +93,6 @@ if have_block
>     util_ss.add(files('buffer.c'))
>     util_ss.add(files('bufferiszero.c'))
>     util_ss.add(files('hbitmap.c'))
> -  util_ss.add(files('hexdump.c'))
>     util_ss.add(files('iova-tree.c'))
>     util_ss.add(files('iov.c'))
>     util_ss.add(files('nvdimm-utils.c'))


-- 
Best regards,
Vladimir