test/security: introduce security lib tests

This patch introduces set of unit tests of librte_security API functions.
Tests are added to dpdk-test application and can be run with
"security_autotest" runtime command.

This is the first patch in the series of patches as adding all test cases
for all API functions in a single patch would make it unreadable.

This patch defines structure of the file and necessary test framework
initialization. It also contains first subset of unit tests for
rte_security_session_create API function.

Structure of the tests file is following:
- macros for making tests more readable;
- mockup structures and functions for rte_security_ops;
- test suite and test cases setup and teardown functions;
- tests functions;
- declaration of testcases.

Signed-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
This commit is contained in:
Lukasz Wojciechowski 2020-04-09 19:24:54 +02:00 committed by Akhil Goyal
parent 27ea35b743
commit 4849e8e442
4 changed files with 689 additions and 0 deletions

View File

@ -412,6 +412,7 @@ M: Declan Doherty <declan.doherty@intel.com>
T: git://dpdk.org/next/dpdk-next-crypto
F: lib/librte_security/
F: doc/guides/prog_guide/rte_security.rst
F: app/test/test_security.c
Compression API - EXPERIMENTAL
M: Fiona Trahe <fiona.trahe@intel.com>

View File

@ -236,6 +236,8 @@ SRCS-$(CONFIG_RTE_LIBRTE_BPF) += test_bpf.c
SRCS-$(CONFIG_RTE_LIBRTE_RCU) += test_rcu_qsbr.c test_rcu_qsbr_perf.c
SRCS-$(CONFIG_RTE_LIBRTE_SECURITY) += test_security.c
SRCS-$(CONFIG_RTE_LIBRTE_IPSEC) += test_ipsec.c
SRCS-$(CONFIG_RTE_LIBRTE_IPSEC) += test_ipsec_sad.c
ifeq ($(CONFIG_RTE_LIBRTE_IPSEC),y)

View File

@ -108,6 +108,7 @@ test_sources = files('commands.c',
'test_ring_stress.c',
'test_rwlock.c',
'test_sched.c',
'test_security.c',
'test_service_cores.c',
'test_spinlock.c',
'test_stack.c',
@ -155,6 +156,7 @@ test_deps = ['acl',
'reorder',
'rib',
'ring',
'security',
'stack',
'timer'
]
@ -216,6 +218,7 @@ fast_tests = [
['rwlock_rds_wrm_autotest', true],
['rwlock_rde_wro_autotest', true],
['sched_autotest', true],
['security_autotest', false],
['spinlock_autotest', true],
['stack_autotest', false],
['stack_lf_autotest', false],

683
app/test/test_security.c Normal file
View File

@ -0,0 +1,683 @@
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
*/
#include <rte_errno.h>
#include <rte_log.h>
#include <rte_memory.h>
#include <rte_mempool.h>
#include <rte_security.h>
#include <rte_security_driver.h>
/* Before including rte_test.h file you can define
* RTE_TEST_TRACE_FAILURE(_file, _line, _func) macro to better trace/debug test
* failures. Mostly useful in development phase.
*/
#ifndef RTE_TEST_TRACE_FAILURE
#define RTE_TEST_TRACE_FAILURE(_file, _line, _func) \
RTE_LOG(DEBUG, EAL, "in %s:%d %s\n", _file, _line, _func)
#endif
#include <rte_test.h>
#include "test.h"
/**
* Security
* =======
*
* Basic unit tests of the librte_security API.
*
* Structure of the file:
* - macros for making tests more readable;
* - mockup structures and functions for rte_security_ops;
* - test suite and test cases setup and teardown functions;
* - tests functions;
* - declaration of testcases.
*/
/**
* Macros
*
* Set of macros for making tests easier to read.
*/
/**
* Verify condition inside mocked up function.
* Mockup function cannot return a test error, so the failure
* of assertion increases counter and print logs.
* The counter can be verified later to check if test case should fail.
*
* @param fail_counter fail counter
* @param cond condition expected to be true
* @param msg printf style formatting string for custom message
*/
#define MOCK_TEST_ASSERT(fail_counter, cond, msg, ...) do { \
if (!(cond)) { \
fail_counter++; \
RTE_LOG(DEBUG, EAL, "Test assert %s line %d failed: " \
msg "\n", __func__, __LINE__, \
##__VA_ARGS__); \
RTE_TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__); \
} \
} while (0)
/**
* Verify equality condition inside mocked up function.
* Mockup function cannot return a test error, so the failure
* of assertion increases counter and print logs.
* The counter can be verified later to check if test case should fail.
*
* @param fail_counter fail counter
* @param a first value of comparison
* @param b second value of comparison
* @param msg printf style formatting string for custom message
*/
#define MOCK_TEST_ASSERT_EQUAL(fail_counter, a, b, msg, ...) \
MOCK_TEST_ASSERT(fail_counter, (a) == (b), msg, ##__VA_ARGS__)
/**
* Verify if parameter of the mocked up function matches expected value.
* The expected value is stored in data structure in the field matching
* parameter name.
*
* @param data structure with expected values
* @param parameter name of the parameter (both field and parameter name)
* @param spec printf style spec for parameter
*/
#define MOCK_TEST_ASSERT_PARAMETER(data, parameter, spec) \
MOCK_TEST_ASSERT_EQUAL(data.failed, data.parameter, parameter, \
"Expecting parameter %s to be " spec \
" but it's " spec, RTE_STR(parameter), \
data.parameter, parameter)
/**
* Wrap for MOCK_TEST_ASSERT_PARAMETER macro for pointer type parameters.
*
* @param data structure with expected values
* @param parameter name of the parameter (both field and parameter name)
*/
#define MOCK_TEST_ASSERT_POINTER_PARAMETER(data, parameter) \
MOCK_TEST_ASSERT_PARAMETER(data, parameter, "%p")
/**
* Verify number of calls of the mocked up function
* and check if there were any fails during execution.
* The fails statistics inside mocked up functions are collected
* as "failed" field in mockup structures.
*
* @param mock_data structure with statistics (called, failed)
* @param exp_calls expected number of mockup function calls
*/
#define TEST_ASSERT_MOCK_CALLS(mock_data, exp_calls) do { \
TEST_ASSERT_EQUAL(exp_calls, mock_data.called, \
"Expecting sub op to be called %d times, " \
"but it's called %d times", \
exp_calls, mock_data.called); \
TEST_ASSERT_EQUAL(0, mock_data.failed, \
"Expecting sub op asserts not to fail, " \
"but they're failed %d times", \
mock_data.failed); \
} while (0)
/**
* Assert tested function result match expected value
*
* @param f_name name of tested function
* @param f_ret value returned by the function
* @param exp_ret expected returned value
* @param fmt printf style format for returned value
*/
#define TEST_ASSERT_MOCK_FUNCTION_CALL_RET(f_name, f_ret, exp_ret, fmt) \
TEST_ASSERT_EQUAL(exp_ret, f_ret, "Expecting " RTE_STR(f_name) \
" to return " fmt ", but it returned " fmt \
"\n", exp_ret, f_ret)
/**
* Assert tested function result is not NULL
*
* @param f_name name of tested function
* @param f_ret value returned by the function
*/
#define TEST_ASSERT_MOCK_FUNCTION_CALL_NOT_NULL(f_name, f_ret) \
TEST_ASSERT_NOT_NULL(f_ret, "Expecting " RTE_STR(f_name) \
" to return not NULL\n")
/**
* Verify that sess_cnt counter value matches expected
*
* @param expected_sessions_count expected counter value
*/
#define TEST_ASSERT_SESSION_COUNT(expected_sessions_count) do { \
struct security_unittest_params *ut_params = &unittest_params; \
TEST_ASSERT_EQUAL(expected_sessions_count, \
ut_params->ctx.sess_cnt, \
"Expecting session counter to be %u," \
" but it's %u", expected_sessions_count, \
ut_params->ctx.sess_cnt); \
} while (0)
/**
* Verify usage of mempool by checking if number of allocated objects matches
* expectations. The mempool is used to manage objects for sessions data.
* A single object is acquired from mempool during session_create
* and put back in session_destroy.
*
* @param expected_mempool_usage expected number of used mempool objects
*/
#define TEST_ASSERT_MEMPOOL_USAGE(expected_mempool_usage) do { \
struct security_testsuite_params *ts_params = &testsuite_params;\
unsigned int mempool_usage; \
mempool_usage = rte_mempool_in_use_count( \
ts_params->session_mpool); \
TEST_ASSERT_EQUAL(expected_mempool_usage, mempool_usage, \
"Expecting %u mempool allocations, " \
"but there are %u allocated objects", \
expected_mempool_usage, mempool_usage); \
} while (0)
/**
* Mockup structures and functions for rte_security_ops;
*
* Set of structures for controlling mockup functions calls.
* Every mockup function X has its corresponding X_data structure
* and an instance of that structure X_exp.
* Structure contains parameters that a mockup function is expected
* to be called with, a value to return (.ret) and 2 statistics:
* .called (number of times the mockup function was called)
* and .failed (number of assertion fails during mockup function call).
*
* Mockup functions verify that the parameters they are called with match
* expected values. The expected values should be stored in corresponding
* structures prior to mockup functions call. Every failure of such
* verification increases .failed counter. Every call of mockup function
* increases .called counter. Function returns value stored in .ret field
* of the structure.
* In case of some parameters in some functions the expected value is unknown
* and cannot be detrmined prior to call. Such parameters are stored
* in structure and can be compared or analyzed later in test case code.
*
* Below structures and functions follow the rules just described.
* Additional remarks and exceptions are added in comments.
*/
/**
* session_create mockup
*
* Verified parameters: device, conf, mp.
* Saved, not verified parameters: sess.
*/
static struct mock_session_create_data {
void *device;
struct rte_security_session_conf *conf;
struct rte_security_session *sess;
struct rte_mempool *mp;
int ret;
int called;
int failed;
} mock_session_create_exp = {NULL, NULL, NULL, NULL, 0, 0, 0};
static int
mock_session_create(void *device,
struct rte_security_session_conf *conf,
struct rte_security_session *sess,
struct rte_mempool *mp)
{
mock_session_create_exp.called++;
MOCK_TEST_ASSERT_POINTER_PARAMETER(mock_session_create_exp, device);
MOCK_TEST_ASSERT_POINTER_PARAMETER(mock_session_create_exp, conf);
MOCK_TEST_ASSERT_POINTER_PARAMETER(mock_session_create_exp, mp);
mock_session_create_exp.sess = sess;
return mock_session_create_exp.ret;
}
/**
* session_destroy mockup
*
* Verified parameters: device, sess.
*/
static struct mock_session_destroy_data {
void *device;
struct rte_security_session *sess;
int ret;
int called;
int failed;
} mock_session_destroy_exp = {NULL, NULL, 0, 0, 0};
static int
mock_session_destroy(void *device, struct rte_security_session *sess)
{
mock_session_destroy_exp.called++;
MOCK_TEST_ASSERT_POINTER_PARAMETER(mock_session_destroy_exp, device);
MOCK_TEST_ASSERT_POINTER_PARAMETER(mock_session_destroy_exp, sess);
return mock_session_destroy_exp.ret;
}
/**
* empty_ops
*
* is an empty security operations set (all function pointers set to NULL)
*/
struct rte_security_ops empty_ops = { NULL };
/**
* mock_ops
*
* is a security operations set using mockup functions
*/
struct rte_security_ops mock_ops = {
.session_create = mock_session_create,
.session_destroy = mock_session_destroy,
};
/**
* Test suite and test cases setup and teardown functions.
*/
/**
* struct security_testsuite_params defines parameters initialized once
* for whole tests suite.
* Currently the only stored parameter is session_mpool a mempool created
* once in testsuite_setup and released in testsuite_teardown.
* The instance of this structure is stored in testsuite_params variable.
*/
static struct security_testsuite_params {
struct rte_mempool *session_mpool;
} testsuite_params = { NULL };
/**
* struct security_unittest_params defines parameters initialized
* for every test case. The parameters are initialized in ut_setup
* and released in ut_teardown.
* The instance of this structure is stored in unittest_params variable.
*/
static struct security_unittest_params {
struct rte_security_ctx ctx;
struct rte_security_session_conf conf;
struct rte_security_session *sess;
} unittest_params = {
.ctx = {
.device = NULL,
.ops = &mock_ops,
.sess_cnt = 0,
},
.sess = NULL,
};
#define SECURITY_TEST_MEMPOOL_NAME "SecurityTestsMempoolName"
#define SECURITY_TEST_MEMPOOL_SIZE 15
#define SECURITY_TEST_SESSION_OBJECT_SIZE sizeof(struct rte_security_session)
/**
* testsuite_setup initializes whole test suite parameters.
* It creates a new mempool used in all test cases
* and verifies if it properly created.
*/
static int
testsuite_setup(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
ts_params->session_mpool = rte_mempool_create(
SECURITY_TEST_MEMPOOL_NAME,
SECURITY_TEST_MEMPOOL_SIZE,
SECURITY_TEST_SESSION_OBJECT_SIZE,
0, 0, NULL, NULL, NULL, NULL,
SOCKET_ID_ANY, 0);
TEST_ASSERT_NOT_NULL(ts_params->session_mpool,
"Cannot create mempool %s\n", rte_strerror(rte_errno));
return TEST_SUCCESS;
}
/**
* testsuite_teardown releases test suite wide parameters.
*/
static void
testsuite_teardown(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
if (ts_params->session_mpool) {
rte_mempool_free(ts_params->session_mpool);
ts_params->session_mpool = NULL;
}
}
/**
* ut_setup initializes test case parameters to default values.
* It resets also any .called and .failed statistics of mockup functions
* usage.
*/
static int
ut_setup(void)
{
struct security_unittest_params *ut_params = &unittest_params;
ut_params->ctx.device = NULL;
ut_params->ctx.ops = &mock_ops;
ut_params->ctx.sess_cnt = 0;
ut_params->sess = NULL;
mock_session_create_exp.called = 0;
mock_session_destroy_exp.called = 0;
mock_session_create_exp.failed = 0;
mock_session_destroy_exp.failed = 0;
return TEST_SUCCESS;
}
/**
* destroy_session_with_check is a helper function releasing session
* created with rte_security_session_create and stored in test case parameters.
* It's used both to release sessions created in test cases' bodies
* which are assigned to ut_params->sess
*/
static int
destroy_session_with_check(void)
{
struct security_unittest_params *ut_params = &unittest_params;
if (ut_params->sess != NULL) {
/* Assure that mockup function for destroy operation is set. */
ut_params->ctx.ops = &mock_ops;
mock_session_destroy_exp.device = NULL;
mock_session_destroy_exp.sess = ut_params->sess;
mock_session_destroy_exp.ret = 0;
mock_session_destroy_exp.called = 0;
mock_session_destroy_exp.failed = 0;
int ret = rte_security_session_destroy(&ut_params->ctx,
ut_params->sess);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_destroy,
ret, 0, "%d");
TEST_ASSERT_MOCK_CALLS(mock_session_destroy_exp, 1);
ut_params->sess = NULL;
}
return TEST_SUCCESS;
}
/**
* ut_teardown releases test case parameters.
*/
static void
ut_teardown(void)
{
destroy_session_with_check();
}
/**
* Test functions
*
* Each test function is related to a single test case.
* They are arranged by tested rte_security API function
* and by rte_security execution paths sequence in code.
*/
/**
* rte_security_session_create tests
*/
/**
* Test execution of rte_security_session_create with NULL instance
*/
static int
test_session_create_inv_context(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
sess = rte_security_session_create(NULL, &ut_params->conf,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 0);
TEST_ASSERT_MEMPOOL_USAGE(0);
TEST_ASSERT_SESSION_COUNT(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create with invalid
* security operations structure (NULL)
*/
static int
test_session_create_inv_context_ops(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
ut_params->ctx.ops = NULL;
sess = rte_security_session_create(&ut_params->ctx, &ut_params->conf,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 0);
TEST_ASSERT_MEMPOOL_USAGE(0);
TEST_ASSERT_SESSION_COUNT(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create with empty
* security operations
*/
static int
test_session_create_inv_context_ops_fun(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
ut_params->ctx.ops = &empty_ops;
sess = rte_security_session_create(&ut_params->ctx, &ut_params->conf,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 0);
TEST_ASSERT_MEMPOOL_USAGE(0);
TEST_ASSERT_SESSION_COUNT(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create with NULL conf parameter
*/
static int
test_session_create_inv_configuration(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
sess = rte_security_session_create(&ut_params->ctx, NULL,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 0);
TEST_ASSERT_MEMPOOL_USAGE(0);
TEST_ASSERT_SESSION_COUNT(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create with NULL mp parameter
*/
static int
test_session_create_inv_mempool(void)
{
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
sess = rte_security_session_create(&ut_params->ctx, &ut_params->conf,
NULL);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 0);
TEST_ASSERT_MEMPOOL_USAGE(0);
TEST_ASSERT_SESSION_COUNT(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create in case when mempool
* is fully used and no object can be got from it
*/
static int
test_session_create_mempool_empty(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *tmp[SECURITY_TEST_MEMPOOL_SIZE];
struct rte_security_session *sess;
/* Get all available objects from mempool. */
int i, ret;
for (i = 0; i < SECURITY_TEST_MEMPOOL_SIZE; ++i) {
ret = rte_mempool_get(ts_params->session_mpool,
(void **)(&tmp[i]));
TEST_ASSERT_EQUAL(0, ret,
"Expect getting %d object from mempool"
" to succeed", i);
}
TEST_ASSERT_MEMPOOL_USAGE(SECURITY_TEST_MEMPOOL_SIZE);
sess = rte_security_session_create(&ut_params->ctx, &ut_params->conf,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 0);
TEST_ASSERT_MEMPOOL_USAGE(SECURITY_TEST_MEMPOOL_SIZE);
TEST_ASSERT_SESSION_COUNT(0);
/* Put objects back to the pool. */
for (i = 0; i < SECURITY_TEST_MEMPOOL_SIZE; ++i)
rte_mempool_put(ts_params->session_mpool, (void *)(tmp[i]));
TEST_ASSERT_MEMPOOL_USAGE(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create when session_create
* security operation fails
*/
static int
test_session_create_ops_failure(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
mock_session_create_exp.device = NULL;
mock_session_create_exp.conf = &ut_params->conf;
mock_session_create_exp.mp = ts_params->session_mpool;
mock_session_create_exp.ret = -1; /* Return failure status. */
sess = rte_security_session_create(&ut_params->ctx, &ut_params->conf,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_RET(rte_security_session_create,
sess, NULL, "%p");
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 1);
TEST_ASSERT_MEMPOOL_USAGE(0);
TEST_ASSERT_SESSION_COUNT(0);
return TEST_SUCCESS;
}
/**
* Test execution of rte_security_session_create in successful execution path
*/
static int
test_session_create_success(void)
{
struct security_testsuite_params *ts_params = &testsuite_params;
struct security_unittest_params *ut_params = &unittest_params;
struct rte_security_session *sess;
mock_session_create_exp.device = NULL;
mock_session_create_exp.conf = &ut_params->conf;
mock_session_create_exp.mp = ts_params->session_mpool;
mock_session_create_exp.ret = 0; /* Return success status. */
sess = rte_security_session_create(&ut_params->ctx, &ut_params->conf,
ts_params->session_mpool);
TEST_ASSERT_MOCK_FUNCTION_CALL_NOT_NULL(rte_security_session_create,
sess);
TEST_ASSERT_EQUAL(sess, mock_session_create_exp.sess,
"Expecting session_create to be called with %p sess"
" parameter, but it's called %p sess parameter",
sess, mock_session_create_exp.sess);
TEST_ASSERT_MOCK_CALLS(mock_session_create_exp, 1);
TEST_ASSERT_MEMPOOL_USAGE(1);
TEST_ASSERT_SESSION_COUNT(1);
/*
* Store created session in test case parameters, so it can be released
* after test case in ut_teardown by destroy_session_with_check.
*/
ut_params->sess = sess;
return TEST_SUCCESS;
}
/**
* Declaration of testcases
*/
static struct unit_test_suite security_testsuite = {
.suite_name = "generic security",
.setup = testsuite_setup,
.teardown = testsuite_teardown,
.unit_test_cases = {
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_inv_context),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_inv_context_ops),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_inv_context_ops_fun),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_inv_configuration),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_inv_mempool),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_mempool_empty),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_ops_failure),
TEST_CASE_ST(ut_setup, ut_teardown,
test_session_create_success),
TEST_CASES_END() /**< NULL terminate unit test array */
}
};
static int
test_security(void)
{
rte_log_set_global_level(RTE_LOG_DEBUG);
rte_log_set_level(RTE_LOGTYPE_EAL, RTE_LOG_DEBUG);
return unit_test_suite_runner(&security_testsuite);
}
REGISTER_TEST_COMMAND(security_autotest, test_security);