From: Uwe Hermann Date: Wed, 13 Mar 2013 08:46:08 +0000 (+0100) Subject: Unit tests for 'binary' input format & version APIs. X-Git-Tag: libsigrok-0.2.2~22 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=71185b48a114a8278e8baac04f5053ae046fdbcf;p=libsigrok.git Unit tests for 'binary' input format & version APIs. --- diff --git a/tests/Makefile.am b/tests/Makefile.am index 6c8a8605..29103e40 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -30,7 +30,11 @@ check_main_SOURCES = \ lib.h \ check_main.c \ check_core.c \ + check_input_all.c \ + check_input_binary.c \ + check_output_all.c \ check_strutil.c \ + check_version.c \ check_driver_all.c check_main_CFLAGS = @check_CFLAGS@ diff --git a/tests/check_input_all.c b/tests/check_input_all.c new file mode 100644 index 00000000..ff462603 --- /dev/null +++ b/tests/check_input_all.c @@ -0,0 +1,48 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2013 Uwe Hermann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include +#include +#include "../libsigrok.h" +#include "lib.h" + +/* Check whether at least one input module is available. */ +START_TEST(test_input_available) +{ + struct sr_input_format **inputs; + + inputs = sr_input_list(); + fail_unless(inputs != NULL, "No input modules found."); +} +END_TEST + +Suite *suite_input_all(void) +{ + Suite *s; + TCase *tc; + + s = suite_create("input-all"); + + tc = tcase_create("basic"); + tcase_add_test(tc, test_input_available); + suite_add_tcase(s, tc); + + return s; +} diff --git a/tests/check_input_binary.c b/tests/check_input_binary.c new file mode 100644 index 00000000..f69c7374 --- /dev/null +++ b/tests/check_input_binary.c @@ -0,0 +1,335 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2013 Uwe Hermann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include +#include +#include "../libsigrok.h" +#include "lib.h" + +#define FILENAME "foo.dat" +#define MAX_FILESIZE (1 * 1000000) + +#define CHECK_ALL_LOW 0 +#define CHECK_ALL_HIGH 1 +#define CHECK_HELLO_WORLD 2 + +static struct sr_context *sr_ctx; + +static uint64_t df_packet_counter = 0, sample_counter = 0; +static gboolean have_seen_df_end = FALSE; +static GArray *logic_probelist = NULL; +static int check_to_perform; +static uint64_t expected_samples; +static uint64_t *expected_samplerate; + +static void setup(void) +{ + int ret; + + ret = sr_init(&sr_ctx); + fail_unless(ret == SR_OK, "sr_init() failed: %d.", ret); +} + +static void teardown(void) +{ + int ret; + + ret = sr_exit(sr_ctx); + fail_unless(ret == SR_OK, "sr_exit() failed: %d.", ret); +} + +static void check_all_low(const struct sr_datafeed_logic *logic) +{ + uint64_t i; + uint8_t *data; + + for (i = 0; i < logic->length; i++) { + data = logic->data; + if (data[i * logic->unitsize] != 0) + fail("Logic data was not all-0x00."); + } +} + +static void check_all_high(const struct sr_datafeed_logic *logic) +{ + uint64_t i; + uint8_t *data; + + for (i = 0; i < logic->length; i++) { + data = logic->data; + if (data[i * logic->unitsize] != 0xff) + fail("Logic data was not all-0xff."); + } +} + +static void check_hello_world(const struct sr_datafeed_logic *logic) +{ + uint64_t i; + uint8_t *data, b; + const char *h = "Hello world"; + + for (i = 0; i < logic->length; i++) { + data = logic->data; + b = data[sample_counter + i]; + if (b != h[sample_counter + i]) + fail("Logic data was not 'Hello world'."); + } +} + +static void datafeed_in(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet, void *cb_data) +{ + const struct sr_datafeed_meta *meta; + const struct sr_datafeed_logic *logic; + struct sr_config *src; + uint64_t samplerate, sample_interval; + GSList *l; + const void *p; + + (void)cb_data; + + fail_unless(sdi != NULL); + fail_unless(packet != NULL); + + if (df_packet_counter++ == 0) + fail_unless(packet->type == SR_DF_HEADER, + "The first packet must be an SR_DF_HEADER."); + + if (have_seen_df_end) + fail("There must be no packets after an SR_DF_END, but we " + "received a packet of type %d.", packet->type); + + p = packet->payload; + + switch (packet->type) { + case SR_DF_HEADER: + // g_debug("Received SR_DF_HEADER."); + // fail_unless(p != NULL, "SR_DF_HEADER payload was NULL."); + + logic_probelist = srtest_get_enabled_logic_probes(sdi); + fail_unless(logic_probelist != NULL); + fail_unless(logic_probelist->len != 0); + // g_debug("Enabled probes: %d.", logic_probelist->len); + break; + case SR_DF_META: + // g_debug("Received SR_DF_META."); + + meta = packet->payload; + fail_unless(p != NULL, "SR_DF_META payload was NULL."); + + for (l = meta->config; l; l = l->next) { + src = l->data; + // g_debug("Got meta key: %d.", src->key); + switch (src->key) { + case SR_CONF_SAMPLERATE: + samplerate = g_variant_get_uint64(src->data); + if (!expected_samplerate) + break; + fail_unless(samplerate == *expected_samplerate, + "Expected samplerate=%" PRIu64 ", " + "got %" PRIu64 "", samplerate, + *expected_samplerate); + // g_debug("samplerate = %" PRIu64 " Hz.", + // samplerate); + break; + case SR_CONF_SAMPLE_INTERVAL: + sample_interval = g_variant_get_uint64(src->data); + (void)sample_interval; + // g_debug("sample interval = %" PRIu64 " ms.", + // sample_interval); + break; + default: + /* Unknown metadata is not an error. */ + g_debug("Got unknown meta key: %d.", src->key); + break; + } + } + break; + case SR_DF_LOGIC: + logic = packet->payload; + fail_unless(p != NULL, "SR_DF_LOGIC payload was NULL."); + + // g_debug("Received SR_DF_LOGIC (%" PRIu64 " bytes, " + // "unitsize %d).", logic->length, logic->unitsize); + + if (check_to_perform == CHECK_ALL_LOW) + check_all_low(logic); + else if (check_to_perform == CHECK_ALL_HIGH) + check_all_high(logic); + else if (check_to_perform == CHECK_HELLO_WORLD) + check_hello_world(logic); + + sample_counter += logic->length / logic->unitsize; + + break; + case SR_DF_END: + // g_debug("Received SR_DF_END."); + // fail_unless(p != NULL, "SR_DF_END payload was NULL."); + have_seen_df_end = TRUE; + if (sample_counter != expected_samples) + fail("Expected %" PRIu64 " samples, got %" PRIu64 "", + expected_samples, sample_counter); + break; + default: + /* + * Note: The binary input format doesn't support SR_DF_TRIGGER + * and some other types, those should yield an error. + */ + fail("Invalid packet type: %d.", packet->type); + break; + } +} + +static void check_buf(const char *filename, GHashTable *param, + const uint8_t *buf, int check, uint64_t samples, + uint64_t *samplerate) +{ + int ret; + struct sr_input *in; + struct sr_input_format *in_format; + + /* Initialize global variables for this run. */ + df_packet_counter = sample_counter = 0; + have_seen_df_end = FALSE; + logic_probelist = NULL; + check_to_perform = check; + expected_samples = samples; + expected_samplerate = samplerate; + + in_format = srtest_input_get("binary"); + + in = g_try_malloc0(sizeof(struct sr_input)); + fail_unless(in != NULL); + + in->format = in_format; + in->param = param; + + srtest_buf_to_file(filename, buf, samples); /* Create a file. */ + + ret = in->format->init(in, filename); + fail_unless(ret == SR_OK, "Input format init error: %d", ret); + + sr_session_new(); + sr_session_datafeed_callback_add(datafeed_in, NULL); + sr_session_dev_add(in->sdi); + in_format->loadfile(in, filename); + sr_session_destroy(); + + g_unlink(filename); /* Delete file again. */ +} + +START_TEST(test_input_binary_all_low) +{ + uint64_t i, samplerate; + uint8_t *buf; + GHashTable *param; + + buf = g_try_malloc0(MAX_FILESIZE); + fail_unless(buf != NULL); + + param = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + fail_unless(param != NULL); + g_hash_table_insert(param, g_strdup("samplerate"), g_strdup("1250")); + samplerate = SR_HZ(1250); + + /* Check various filesizes, with/without specifying a samplerate. */ + check_buf(FILENAME, NULL, buf, CHECK_ALL_LOW, 0, NULL); + check_buf(FILENAME, param, buf, CHECK_ALL_LOW, 0, &samplerate); + for (i = 1; i < MAX_FILESIZE; i *= 3) { + check_buf(FILENAME, NULL, buf, CHECK_ALL_LOW, i, NULL); + check_buf(FILENAME, param, buf, CHECK_ALL_LOW, i, &samplerate); + + } + + g_hash_table_destroy(param); + g_free(buf); +} +END_TEST + +START_TEST(test_input_binary_all_high) +{ + uint64_t i; + uint8_t *buf; + + buf = g_try_malloc(MAX_FILESIZE); + memset(buf, 0xff, MAX_FILESIZE); + + check_buf(FILENAME, NULL, buf, CHECK_ALL_LOW, 0, NULL); + for (i = 1; i < MAX_FILESIZE; i *= 3) + check_buf(FILENAME, NULL, buf, CHECK_ALL_HIGH, i, NULL); + + g_free(buf); +} +END_TEST + +START_TEST(test_input_binary_all_high_loop) +{ + uint8_t *buf; + + /* Note: _i is the loop variable from tcase_add_loop_test(). */ + + buf = g_try_malloc((_i * 10) + 1); + memset(buf, 0xff, _i * 10); + + check_buf(FILENAME, NULL, buf, CHECK_ALL_HIGH, _i * 10, NULL); + + g_free(buf); +} +END_TEST + +START_TEST(test_input_binary_hello_world) +{ + uint64_t samplerate; + uint8_t *buf; + GHashTable *param; + + buf = (uint8_t *)g_strdup("Hello world"); + + param = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + fail_unless(param != NULL); + g_hash_table_insert(param, g_strdup("samplerate"), g_strdup("1250")); + samplerate = SR_HZ(1250); + + /* Check with and without specifying a samplerate. */ + check_buf(FILENAME, NULL, buf, CHECK_HELLO_WORLD, 11, NULL); + check_buf(FILENAME, param, buf, CHECK_HELLO_WORLD, 11, &samplerate); + + g_hash_table_destroy(param); + g_free(buf); +} +END_TEST + +Suite *suite_input_binary(void) +{ + Suite *s; + TCase *tc; + + s = suite_create("input-binary"); + + tc = tcase_create("basic"); + tcase_add_checked_fixture(tc, setup, teardown); + tcase_add_test(tc, test_input_binary_all_low); + tcase_add_test(tc, test_input_binary_all_high); + tcase_add_loop_test(tc, test_input_binary_all_high_loop, 0, 10); + tcase_add_test(tc, test_input_binary_hello_world); + suite_add_tcase(s, tc); + + return s; +} diff --git a/tests/check_main.c b/tests/check_main.c index e07a6b88..b2396edc 100644 --- a/tests/check_main.c +++ b/tests/check_main.c @@ -23,8 +23,12 @@ #include "../libsigrok.h" Suite *suite_core(void); -Suite *suite_strutil(void); Suite *suite_driver_all(void); +Suite *suite_input_all(void); +Suite *suite_input_binary(void); +Suite *suite_output_all(void); +Suite *suite_strutil(void); +Suite *suite_version(void); int main(void) { @@ -37,8 +41,12 @@ int main(void) /* Add all testsuites to the master suite. */ srunner_add_suite(srunner, suite_core()); - srunner_add_suite(srunner, suite_strutil()); srunner_add_suite(srunner, suite_driver_all()); + srunner_add_suite(srunner, suite_input_all()); + srunner_add_suite(srunner, suite_input_binary()); + srunner_add_suite(srunner, suite_output_all()); + srunner_add_suite(srunner, suite_strutil()); + srunner_add_suite(srunner, suite_version()); srunner_run_all(srunner, CK_VERBOSE); ret = srunner_ntests_failed(srunner); diff --git a/tests/check_output_all.c b/tests/check_output_all.c new file mode 100644 index 00000000..497a24a6 --- /dev/null +++ b/tests/check_output_all.c @@ -0,0 +1,48 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2013 Uwe Hermann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include +#include +#include "../libsigrok.h" +#include "lib.h" + +/* Check whether at least one output module is available. */ +START_TEST(test_output_available) +{ + struct sr_output_format **outputs; + + outputs = sr_output_list(); + fail_unless(outputs != NULL, "No output modules found."); +} +END_TEST + +Suite *suite_output_all(void) +{ + Suite *s; + TCase *tc; + + s = suite_create("output-all"); + + tc = tcase_create("basic"); + tcase_add_test(tc, test_output_available); + suite_add_tcase(s, tc); + + return s; +} diff --git a/tests/check_version.c b/tests/check_version.c new file mode 100644 index 00000000..d217b24c --- /dev/null +++ b/tests/check_version.c @@ -0,0 +1,92 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2013 Uwe Hermann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include +#include +#include "../libsigrok.h" + +/* + * Check the version number API calls and macros. + * + * The numbers returned by the sr_*_version*get() calls must match the + * respective SR_*_VERSION* macro values, must be >= 0, and must not be + * unreasonably high (> 20), otherwise something is probably wrong. + */ +START_TEST(test_version_numbers) +{ + int ver; + + ver = sr_package_version_major_get(); + fail_unless(ver == SR_PACKAGE_VERSION_MAJOR); + fail_unless(ver >= 0 && ver <= 20); + ver = sr_package_version_minor_get(); + fail_unless(ver == SR_PACKAGE_VERSION_MINOR); + fail_unless(ver >= 0 && ver <= 20); + ver = sr_package_version_micro_get(); + fail_unless(ver == SR_PACKAGE_VERSION_MICRO); + fail_unless(ver >= 0 && ver <= 20); + + ver = sr_lib_version_current_get(); + fail_unless(ver == SR_LIB_VERSION_CURRENT); + fail_unless(ver >= 0 && ver <= 20); + ver = sr_lib_version_revision_get(); + fail_unless(ver == SR_LIB_VERSION_REVISION); + fail_unless(ver >= 0 && ver <= 20); + ver = sr_lib_version_age_get(); + fail_unless(ver == SR_LIB_VERSION_AGE); + fail_unless(ver >= 0 && ver <= 20); +} +END_TEST + +/* + * Check the version number API calls and macros. + * + * The string representations of the package/lib version must match the + * version numbers, the string lengths must be >= 5 (e.g. "0.1.0"), and + * the strings length must be <= 20 characters, otherwise something is + * probably wrong. + */ +START_TEST(test_version_strings) +{ + const char *str; + + str = sr_package_version_string_get(); + fail_unless(str != NULL); + fail_unless(strlen(str) >= 5 && strlen(str) <= 20); + str = sr_lib_version_string_get(); + fail_unless(str != NULL); + fail_unless(strlen(str) >= 5 && strlen(str) <= 20); +} +END_TEST + +Suite *suite_version(void) +{ + Suite *s; + TCase *tc; + + s = suite_create("version"); + + tc = tcase_create("version"); + tcase_add_test(tc, test_version_numbers); + tcase_add_test(tc, test_version_strings); + suite_add_tcase(s, tc); + + return s; +} diff --git a/tests/lib.c b/tests/lib.c index 523d4399..b5a49508 100644 --- a/tests/lib.c +++ b/tests/lib.c @@ -20,6 +20,8 @@ #include #include +#include +#include #include #include "../libsigrok.h" @@ -42,6 +44,44 @@ struct sr_dev_driver *srtest_driver_get(const char *drivername) return driver; } +/* Get a libsigrok input format by ID. */ +struct sr_input_format *srtest_input_get(const char *id) +{ + struct sr_input_format **inputs, *input = NULL; + int i; + + inputs = sr_input_list(); + fail_unless(inputs != NULL, "No input modules found."); + + for (i = 0; inputs[i]; i++) { + if (strcmp(inputs[i]->id, id)) + continue; + input = inputs[i]; + } + fail_unless(input != NULL, "Input module '%s' not found.", id); + + return input; +} + +/* Get a libsigrok output format by ID. */ +struct sr_output_format *srtest_output_get(const char *id) +{ + struct sr_output_format **outputs, *output = NULL; + int i; + + outputs = sr_output_list(); + fail_unless(outputs != NULL, "No output modules found."); + + for (i = 0; outputs[i]; i++) { + if (strcmp(outputs[i]->id, id)) + continue; + output = outputs[i]; + } + fail_unless(output != NULL, "Output module '%s' not found.", id); + + return output; +} + /* Initialize a libsigrok driver. */ void srtest_driver_init(struct sr_context *sr_ctx, struct sr_dev_driver *driver) { @@ -69,6 +109,40 @@ void srtest_driver_init_all(struct sr_context *sr_ctx) } } +/* Initialize a libsigrok input module. */ +void srtest_input_init(struct sr_context *sr_ctx, struct sr_input_format *input) +{ + int ret; + struct sr_input *in; + + (void)sr_ctx; + + in = g_try_malloc0(sizeof(struct sr_input)); + fail_unless(in != NULL); + + in->format = input; + in->param = NULL; + + ret = in->format->init(in, "nonexisting.dat"); + fail_unless(ret == SR_OK, "Failed to init '%s' input module: %d.", + input->id, ret); + + g_free(in); +} + +/* Initialize all libsigrok input modules. */ +void srtest_input_init_all(struct sr_context *sr_ctx) +{ + struct sr_input_format **inputs; + int i; + + inputs = sr_input_list(); + fail_unless(inputs != NULL, "No input modules found."); + + for (i = 0; inputs[i]; i++) + srtest_input_init(sr_ctx, inputs[i]); +} + /* Set the samplerate for the respective driver to the specified value. */ void srtest_set_samplerate(struct sr_dev_driver *driver, uint64_t samplerate) { @@ -120,3 +194,37 @@ void srtest_check_samplerate(struct sr_context *sr_ctx, const char *drivername, fail_unless(s == samplerate, "%s: Incorrect samplerate: %" PRIu64 ".", drivername, s); } + +void srtest_buf_to_file(const char *filename, const uint8_t *buf, uint64_t len) +{ + FILE *f; + GError *error; + gboolean ret; + + f = g_fopen(filename, "wb"); + fail_unless(f != NULL); + + ret = g_file_set_contents(filename, (const gchar *)buf, len, &error); + fail_unless(ret == TRUE); + + fclose(f); +} + +GArray *srtest_get_enabled_logic_probes(const struct sr_dev_inst *sdi) +{ + struct sr_probe *probe; + GArray *probes; + GSList *l; + + probes = g_array_new(FALSE, FALSE, sizeof(int)); + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + if (probe->type != SR_PROBE_LOGIC) + continue; + if (probe->enabled != TRUE) + continue; + g_array_append_val(probes, probe->index); + } + + return probes; +} diff --git a/tests/lib.h b/tests/lib.h index beaa0f53..4f7e01c2 100644 --- a/tests/lib.h +++ b/tests/lib.h @@ -24,11 +24,21 @@ #include "../libsigrok.h" struct sr_dev_driver *srtest_driver_get(const char *drivername); +struct sr_input_format *srtest_input_get(const char *id); +struct sr_output_format *srtest_output_get(const char *id); + void srtest_driver_init(struct sr_context *sr_ctx, struct sr_dev_driver *driver); void srtest_driver_init_all(struct sr_context *sr_ctx); + +void srtest_input_init(struct sr_context *sr_ctx, struct sr_input_format *input); +void srtest_input_init_all(struct sr_context *sr_ctx); + void srtest_set_samplerate(struct sr_dev_driver *driver, uint64_t samplerate); uint64_t srtest_get_samplerate(struct sr_dev_driver *driver); void srtest_check_samplerate(struct sr_context *sr_ctx, const char *drivername, uint64_t samplerate); +void srtest_buf_to_file(const char *filename, const uint8_t *buf, uint64_t len); +GArray *srtest_get_enabled_logic_probes(const struct sr_dev_inst *sdi); + #endif