tests: kernel: pipe: testcases to improve code coverage for pipes

Added back test_pipe_alloc because the z_thread_malloc called in the
API has been updated to use k_heap instead of k_mem_pool.
Adjusted test_resource_pool_auto_free by replacing z_mem_pool_malloc
with k_heap_alloc. Added new test_k_pipe_cleanup to cover one more
branch in k_pipe_cleanup. Modified test_half_pipe_put_get to cover
branches for (reader != NULL) in k_pipe_put. Added test
test_pipe_get_put to cover branches for (writer != NULL)
in k_pipe_get. Added trivial tests to cover input validity checks.
Line coverage has been improved by 52%, function cov by 56%, and
branch cov by 46%.

Signed-off-by: Shihao Shen <shihao.shen@intel.com>
This commit is contained in:
Shihao Shen 2021-03-08 13:03:56 +08:00 committed by Anas Nashif
commit 084989564a
2 changed files with 210 additions and 10 deletions

View file

@ -13,18 +13,25 @@
#include <ztest.h>
extern void test_pipe_thread2thread(void);
extern void test_pipe_put_fail(void);
extern void test_pipe_get_fail(void);
extern void test_pipe_block_put(void);
extern void test_pipe_block_put_sema(void);
extern void test_pipe_get_put(void);
extern void test_half_pipe_get_put(void);
extern void test_half_pipe_put_get(void);
extern void test_half_pipe_saturating_block_put(void);
extern void test_half_pipe_block_put_sema(void);
extern void test_pipe_alloc(void);
extern void test_pipe_reader_wait(void);
extern void test_pipe_block_writer_wait(void);
extern void test_pipe_cleanup(void);
#ifdef CONFIG_USERSPACE
extern void test_pipe_user_thread2thread(void);
extern void test_pipe_user_put_fail(void);
extern void test_pipe_user_get_fail(void);
extern void test_resource_pool_auto_free(void);
#endif
extern void test_pipe_avail_r_lt_w(void);
extern void test_pipe_avail_w_lt_r(void);
@ -37,6 +44,20 @@ extern struct k_pipe pipe, kpipe, khalfpipe, put_get_pipe;
extern struct k_sem end_sema;
extern struct k_stack tstack;
extern struct k_thread tdata;
extern struct k_heap test_pool;
#ifndef CONFIG_USERSPACE
#define dummy_test(_name) \
static void _name(void) \
{ \
ztest_test_skip(); \
}
dummy_test(test_pipe_user_thread2thread);
dummy_test(test_pipe_user_put_fail);
dummy_test(test_pipe_user_get_fail);
dummy_test(test_resource_pool_auto_free);
#endif /* !CONFIG_USERSPACE */
/*test case main entry*/
void test_main(void)
@ -45,11 +66,20 @@ void test_main(void)
&kpipe, &end_sema, &tdata, &tstack,
&khalfpipe, &put_get_pipe);
k_thread_heap_assign(k_current_get(), &test_pool);
ztest_test_suite(pipe_api,
ztest_1cpu_unit_test(test_pipe_thread2thread),
ztest_1cpu_user_unit_test(test_pipe_user_thread2thread),
ztest_1cpu_user_unit_test(test_pipe_user_put_fail),
ztest_user_unit_test(test_pipe_user_get_fail),
ztest_unit_test(test_resource_pool_auto_free),
ztest_1cpu_unit_test(test_pipe_put_fail),
ztest_unit_test(test_pipe_get_fail),
ztest_unit_test(test_half_pipe_get_put),
ztest_unit_test(test_half_pipe_put_get),
ztest_unit_test(test_pipe_get_put),
ztest_1cpu_unit_test(test_pipe_alloc),
ztest_unit_test(test_pipe_cleanup),
ztest_unit_test(test_pipe_reader_wait),
ztest_unit_test(test_pipe_avail_r_lt_w),
ztest_unit_test(test_pipe_avail_w_lt_r),

View file

@ -11,6 +11,8 @@
#define BYTES_TO_WRITE 16
#define BYTES_TO_READ BYTES_TO_WRITE
K_HEAP_DEFINE(mpool, PIPE_LEN * 1);
static ZTEST_DMEM unsigned char __aligned(4) data[] =
"abcd1234$%^&PIPEefgh5678!/?*EPIPijkl9012[]<>PEPImnop3456{}()IPEP";
BUILD_ASSERT(sizeof(data) >= PIPE_LEN);
@ -20,7 +22,7 @@ K_PIPE_DEFINE(kpipe, PIPE_LEN, 4);
K_PIPE_DEFINE(khalfpipe, (PIPE_LEN / 2), 4);
K_PIPE_DEFINE(kpipe1, PIPE_LEN, 4);
K_PIPE_DEFINE(pipe_test_alloc, PIPE_LEN, 4);
struct k_pipe pipe;
struct k_pipe pipe, pipe1;
K_THREAD_STACK_DEFINE(tstack, STACK_SIZE);
K_THREAD_STACK_DEFINE(tstack1, STACK_SIZE);
@ -30,6 +32,17 @@ struct k_thread tdata1;
struct k_thread tdata2;
K_SEM_DEFINE(end_sema, 0, 1);
#ifdef CONFIG_64BIT
#define SZ 256
#else
#define SZ 128
#endif
K_HEAP_DEFINE(test_pool, SZ * 4);
struct mem_block {
void *data;
};
static void tpipe_put(struct k_pipe *ppipe, k_timeout_t timeout)
{
size_t to_wt, wt_byte = 0;
@ -90,6 +103,23 @@ static void tpipe_thread_thread(struct k_pipe *ppipe)
k_thread_abort(tid);
}
static void tpipe_kthread_to_kthread(struct k_pipe *ppipe)
{
/**TESTPOINT: thread-thread data passing via pipe*/
k_tid_t tid = k_thread_create(&tdata, tstack, STACK_SIZE,
tThread_entry, ppipe, NULL, NULL,
K_PRIO_PREEMPT(0), 0, K_NO_WAIT);
tpipe_put(ppipe, K_NO_WAIT);
k_sem_take(&end_sema, K_FOREVER);
k_sem_take(&end_sema, K_FOREVER);
tpipe_get(ppipe, K_FOREVER);
/* clear the spawned thread avoid side effect */
k_thread_abort(tid);
}
static void tpipe_put_no_wait(struct k_pipe *ppipe)
{
size_t to_wt, wt_byte = 0;
@ -104,6 +134,89 @@ static void tpipe_put_no_wait(struct k_pipe *ppipe)
}
}
static void tpipe_put_small_size(struct k_pipe *ppipe, k_timeout_t timeout)
{
size_t to_wt, wt_byte = 0;
for (int i = 0; i < PIPE_LEN; i += wt_byte) {
/**TESTPOINT: pipe put*/
to_wt = (PIPE_LEN - i) >= 24 ?
24 : (PIPE_LEN - i);
k_pipe_put(ppipe, &data[i], to_wt, &wt_byte, 1, timeout);
}
}
static void tpipe_get_small_size(struct k_pipe *ppipe, k_timeout_t timeout)
{
unsigned char rx_data[PIPE_LEN];
size_t to_rd, rd_byte = 0;
/*get pipe data from "pipe_put"*/
for (int i = 0; i < PIPE_LEN; i += rd_byte) {
/**TESTPOINT: pipe get*/
to_rd = (PIPE_LEN - i) >= 24 ?
24 : (PIPE_LEN - i);
zassert_false(k_pipe_get(ppipe, &rx_data[i], to_rd,
&rd_byte, 1, timeout), NULL);
}
}
/**
* @brief Test Initialization and buffer allocation of pipe,
* with various parameters
* @see k_pipe_alloc_init(), k_pipe_cleanup()
*/
void test_pipe_alloc(void)
{
int ret;
zassert_false(k_pipe_alloc_init(&pipe_test_alloc, PIPE_LEN), NULL);
tpipe_kthread_to_kthread(&pipe_test_alloc);
k_pipe_cleanup(&pipe_test_alloc);
zassert_false(k_pipe_alloc_init(&pipe_test_alloc, 0), NULL);
k_pipe_cleanup(&pipe_test_alloc);
ret = k_pipe_alloc_init(&pipe_test_alloc, 2048);
zassert_true(ret == -ENOMEM,
"resource pool max block size is not smaller then requested buffer");
}
static void thread_for_get_forever(void *p1, void *p2, void *p3)
{
tpipe_get((struct k_pipe *)p1, K_FOREVER);
}
void test_pipe_cleanup(void)
{
int ret;
zassert_false(k_pipe_alloc_init(&pipe_test_alloc, PIPE_LEN), NULL);
/**TESTPOINT: test if a dynamically allocated buffer can be freed*/
ret = k_pipe_cleanup(&pipe_test_alloc);
zassert_true((ret == 0) && (pipe_test_alloc.buffer == NULL),
"Failed to free buffer with k_pipe_cleanup().");
/**TESTPOINT: nothing to do with k_pipe_cleanup() for static buffer in pipe*/
ret = k_pipe_cleanup(&kpipe);
zassert_true((ret == 0) && (kpipe.buffer != NULL),
"Static buffer should not be freed.");
zassert_false(k_pipe_alloc_init(&pipe_test_alloc, PIPE_LEN), NULL);
k_tid_t tid = k_thread_create(&tdata, tstack, STACK_SIZE,
thread_for_get_forever, &pipe_test_alloc, NULL,
NULL, K_PRIO_PREEMPT(0), 0, K_NO_WAIT);
k_sleep(K_MSEC(100));
ret = k_pipe_cleanup(&pipe_test_alloc);
zassert_true(ret == -EAGAIN, "k_pipe_cleanup() should not return with 0.");
k_thread_abort(tid);
}
static void thread_handler(void *p1, void *p2, void *p3)
{
tpipe_put_no_wait((struct k_pipe *)p1);
@ -162,7 +275,6 @@ static void thread_handler(void *p1, void *p2, void *p3)
void test_pipe_thread2thread(void)
{
/**TESTPOINT: test k_pipe_init pipe*/
k_pipe_init(&pipe, data, PIPE_LEN);
tpipe_thread_thread(&pipe);
@ -189,27 +301,85 @@ void test_pipe_user_thread2thread(void)
}
#endif
/**
* @brief Test resource pool free
* @see k_heap_alloc()
*/
#ifdef CONFIG_USERSPACE
void test_resource_pool_auto_free(void)
{
/* Pool has 2 blocks, both should succeed if kernel object and pipe
* buffer are auto-freed when the allocating threads exit
*/
zassert_true(k_heap_alloc(&test_pool, 64, K_NO_WAIT) != NULL, NULL);
zassert_true(k_heap_alloc(&test_pool, 64, K_NO_WAIT) != NULL, NULL);
}
#endif
static void tThread_half_pipe_put(void *p1, void *p2, void *p3)
{
tpipe_put((struct k_pipe *)p1, K_FOREVER);
}
static void tThread_half_pipe_get(void *p1, void *p2, void *p3)
{
tpipe_get((struct k_pipe *)p1, K_FOREVER);
}
/**
* @brief Test get/put with smaller pipe buffer
* @brief Test put/get with smaller pipe buffer
* @see k_pipe_put(), k_pipe_get()
*/
void test_half_pipe_get_put(void)
void test_half_pipe_put_get(void)
{
/**TESTPOINT: thread-thread data passing via pipe*/
k_tid_t tid = k_thread_create(&tdata, tstack, STACK_SIZE,
k_tid_t tid1 = k_thread_create(&tdata1, tstack1, STACK_SIZE,
tThread_half_pipe_get, &khalfpipe,
NULL, NULL, K_PRIO_PREEMPT(0),
K_INHERIT_PERMS | K_USER, K_NO_WAIT);
k_tid_t tid2 = k_thread_create(&tdata2, tstack2, STACK_SIZE,
tThread_half_pipe_get, &khalfpipe,
NULL, NULL, K_PRIO_PREEMPT(0),
K_INHERIT_PERMS | K_USER, K_NO_WAIT);
k_sleep(K_MSEC(100));
tpipe_put_small_size(&khalfpipe, K_NO_WAIT);
/* clear the spawned thread avoid side effect */
k_thread_abort(tid1);
k_thread_abort(tid2);
}
void test_pipe_get_put(void)
{
unsigned char rx_data[PIPE_LEN];
size_t rd_byte = 0;
int ret;
/* TESTPOINT: min_xfer > bytes_to_read */
ret = k_pipe_get(&kpipe, &rx_data[0], 1, &rd_byte, 24, K_NO_WAIT);
zassert_true(ret == -EINVAL, NULL);
ret = k_pipe_get(&kpipe, &rx_data[0], 24, NULL, 1, K_NO_WAIT);
zassert_true(ret == -EINVAL, NULL);
/**TESTPOINT: thread-thread data passing via pipe*/
k_tid_t tid1 = k_thread_create(&tdata1, tstack1, STACK_SIZE,
tThread_half_pipe_put, &khalfpipe,
NULL, NULL, K_PRIO_PREEMPT(0),
K_INHERIT_PERMS | K_USER, K_NO_WAIT);
tpipe_get(&khalfpipe, K_FOREVER);
k_tid_t tid2 = k_thread_create(&tdata2, tstack2, STACK_SIZE,
tThread_half_pipe_put, &khalfpipe,
NULL, NULL, K_PRIO_PREEMPT(0),
K_INHERIT_PERMS | K_USER, K_NO_WAIT);
k_sleep(K_MSEC(100));
tpipe_get_small_size(&khalfpipe, K_NO_WAIT);
/* clear the spawned thread avoid side effect */
k_thread_abort(tid);
k_thread_abort(tid1);
k_thread_abort(tid2);
}
/**