Commit 3dfd4a7c authored by Pawel Niedzwiecki's avatar Pawel Niedzwiecki Committed by Jim Harris
Browse files

ut/vhost: add UT coverage for vhost_blk.c 



Change-Id: I933baf8294926eae63bc7392c51e4b24e6173def
Signed-off-by: default avatarPawel Niedzwiecki <pawelx.niedzwiecki@intel.com>
Reviewed-on: https://review.gerrithub.io/376651


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 26089992

test/unit/lib/vhost/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ 
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk



DIRS-y = vhost.c vhost_scsi.c

DIRS-y = vhost.c vhost_scsi.c vhost_blk.c



.PHONY: all clean $(DIRS-y)

test/unit/lib/vhost/vhost_blk.c/.gitignore

0 → 100644
+1 −0
Original line number Diff line number Diff line 
vhost_blk_ut

test/unit/lib/vhost/vhost_blk.c/Makefile

0 → 100644
+58 −0
Original line number Diff line number Diff line 
#

#  BSD LICENSE

#

#  Copyright (c) Intel Corporation.

#  All rights reserved.

#

#  Redistribution and use in source and binary forms, with or without

#  modification, are permitted provided that the following conditions

#  are met:

#

#    * Redistributions of source code must retain the above copyright

#      notice, this list of conditions and the following disclaimer.

#    * Redistributions in binary form must reproduce the above copyright

#      notice, this list of conditions and the following disclaimer in

#      the documentation and/or other materials provided with the

#      distribution.

#    * Neither the name of Intel Corporation nor the names of its

#      contributors may be used to endorse or promote products derived

#      from this software without specific prior written permission.

#

#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#



SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk

include $(SPDK_ROOT_DIR)/mk/spdk.app.mk



SPDK_LIB_LIST = log util



CFLAGS += -I$(SPDK_ROOT_DIR)/test

CFLAGS += -I$(SPDK_ROOT_DIR)/lib/vhost

CFLAGS += -I$(SPDK_ROOT_DIR)/lib/vhost/rte_vhost

CFLAGS += $(ENV_CFLAGS)

LIBS += $(SPDK_LIB_LINKER_ARGS)

LIBS += -lcunit



APP = vhost_blk_ut

C_SRCS = vhost_blk_ut.c



all: $(APP)



$(APP): $(OBJS) $(SPDK_LIB_FILES)

	$(LINK_C)



clean:

	$(CLEAN_C) $(APP)



include $(SPDK_ROOT_DIR)/mk/spdk.deps.mk

test/unit/lib/vhost/vhost_blk.c/vhost_blk_ut.c

0 → 100644
+288 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright(c) Intel Corporation. All rights reserved.

 *   All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of Intel Corporation nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



#include "spdk/stdinc.h"



#include "CUnit/Basic.h"

#include "spdk_cunit.h"

#include "spdk_internal/mock.h"



#include "lib/test_env.c"



#include "vhost_blk.c"



#include "spdk_internal/bdev.h"

#include "spdk/env.h"



struct spdk_conf_section {

	struct spdk_conf_section *next;

	char *name;

	int num;

	struct spdk_conf_item *item;

};



struct spdk_io_channel {

	struct spdk_thread		*thread;

	struct io_device		*dev;

	uint32_t			ref;

	TAILQ_ENTRY(spdk_io_channel)	tailq;

	spdk_io_channel_destroy_cb	destroy_cb;

};



DEFINE_STUB(spdk_ring_enqueue, size_t, (struct spdk_ring *ring, void **objs, size_t count), 0);

DEFINE_STUB(spdk_ring_dequeue, size_t, (struct spdk_ring *ring, void **objs, size_t count), 0);

DEFINE_STUB_V(spdk_vhost_vq_used_ring_enqueue, (struct spdk_vhost_dev *vdev,

		struct rte_vhost_vring *vq, uint16_t id, uint32_t len));

DEFINE_STUB_P(spdk_vhost_vq_get_desc, struct vring_desc, (struct rte_vhost_vring *vq,

		uint16_t req_idx), {0});

DEFINE_STUB(spdk_vhost_vring_desc_is_wr, bool, (struct vring_desc *cur_desc), false);

DEFINE_STUB(spdk_vhost_vring_desc_to_iov, int, (struct spdk_vhost_dev *vdev, struct iovec *iov,

		uint16_t *iov_index, const struct vring_desc *desc), 0);

DEFINE_STUB(spdk_vhost_vring_desc_has_next, bool, (struct vring_desc *cur_desc), false);

DEFINE_STUB_P(spdk_vhost_vring_desc_get_next, struct vring_desc, (struct vring_desc *vq_desc,

		struct vring_desc *cur_desc), {0});

DEFINE_STUB(spdk_bdev_free_io, int, (struct spdk_bdev_io *bdev_io), 0);

DEFINE_STUB(spdk_bdev_readv, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,

				   struct iovec *iov, int iovcnt,

				   uint64_t offset, uint64_t nbytes,

				   spdk_bdev_io_completion_cb cb, void *cb_arg), 0);

DEFINE_STUB(spdk_bdev_writev, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,

				    struct iovec *iov, int iovcnt,

				    uint64_t offset, uint64_t len,

				    spdk_bdev_io_completion_cb cb, void *cb_arg), 0);

DEFINE_STUB_P(spdk_bdev_get_product_name, const char, (const struct spdk_bdev *bdev), {0});

DEFINE_STUB(spdk_vhost_vq_avail_ring_get, uint16_t, (struct rte_vhost_vring *vq, uint16_t *reqs,

		uint16_t reqs_len), 0);

DEFINE_STUB_V(spdk_vhost_dev_mem_register, (struct spdk_vhost_dev *vdev));

DEFINE_STUB_V(spdk_poller_register, (struct spdk_poller **ppoller, spdk_poller_fn fn, void *arg,

				     uint32_t lcore, uint64_t period_microseconds));

DEFINE_STUB_V(spdk_vhost_dev_mem_unregister, (struct spdk_vhost_dev *vdev));

DEFINE_STUB(spdk_env_get_current_core, uint32_t, (void), 0);

DEFINE_STUB_V(spdk_vhost_timed_event_send, (int32_t lcore, spdk_vhost_timed_event_fn cb_fn,

		void *arg, unsigned timeout_sec, const char *errmsg));

DEFINE_STUB_V(spdk_poller_unregister, (struct spdk_poller **ppoller, struct spdk_event *complete));

DEFINE_STUB_V(spdk_ring_free, (struct spdk_ring *ring));

DEFINE_STUB(spdk_env_get_socket_id, uint32_t, (uint32_t core), 0);

DEFINE_STUB_P(spdk_bdev_get_name, const char, (const struct spdk_bdev *bdev), {0});

DEFINE_STUB_P(spdk_conf_first_section, struct spdk_conf_section, (struct spdk_conf *cp), {0});

DEFINE_STUB(spdk_conf_section_match_prefix, bool, (const struct spdk_conf_section *sp,

		const char *name_prefix), false);

DEFINE_STUB_P(spdk_conf_section_get_name, const char, (const struct spdk_conf_section *sp), {0});

DEFINE_STUB_P(spdk_conf_section_get_val, char, (struct spdk_conf_section *sp, const char *key), {0});

DEFINE_STUB(spdk_conf_section_get_boolval, bool, (struct spdk_conf_section *sp, const char *key,

		bool default_val), false);

DEFINE_STUB_P(spdk_conf_next_section, struct spdk_conf_section, (struct spdk_conf_section *sp), {0});

DEFINE_STUB_P(spdk_bdev_get_by_name, struct spdk_bdev, (const char *bdev_name), {0});

DEFINE_STUB(spdk_bdev_open, int, (struct spdk_bdev *bdev, bool write,

				  spdk_bdev_remove_cb_t remove_cb,

				  void *remove_ctx, struct spdk_bdev_desc **desc), 0);

DEFINE_STUB_V(spdk_bdev_close, (struct spdk_bdev_desc *desc));

DEFINE_STUB(rte_vhost_driver_enable_features, int, (const char *path, uint64_t features), 0);

DEFINE_STUB(spdk_json_write_null, int, (struct spdk_json_write_ctx *w), 0);

DEFINE_STUB(spdk_json_write_bool, int, (struct spdk_json_write_ctx *w, bool val), 0);

DEFINE_STUB(spdk_json_write_name, int, (struct spdk_json_write_ctx *w, const char *name), 0);

DEFINE_STUB(spdk_json_write_object_begin, int, (struct spdk_json_write_ctx *w), 0);

DEFINE_STUB(spdk_json_write_uint32, int, (struct spdk_json_write_ctx *w, uint32_t val), 0);

DEFINE_STUB(spdk_json_write_int32, int, (struct spdk_json_write_ctx *w, int32_t val), 0);

DEFINE_STUB(spdk_json_write_string, int, (struct spdk_json_write_ctx *w, const char *val), 0);

DEFINE_STUB(spdk_json_write_array_begin, int, (struct spdk_json_write_ctx *w), 0);

DEFINE_STUB(spdk_json_write_object_end, int, (struct spdk_json_write_ctx *w), 0);

DEFINE_STUB(spdk_json_write_array_end, int, (struct spdk_json_write_ctx *w), 0);

DEFINE_STUB_P(spdk_bdev_get_io_channel, struct spdk_io_channel, (struct spdk_bdev_desc *desc), {0});



/* This sets spdk_vhost_dev_remove to either to fail or success */

DEFINE_STUB(spdk_vhost_dev_remove_fail, bool, (void), false);

/* This sets spdk_vhost_dev_construct to either to fail or success */

DEFINE_STUB(spdk_vhost_dev_construct_fail, bool, (void), false);



static struct spdk_vhost_dev *g_spdk_vhost_device;

int

spdk_vhost_dev_construct(struct spdk_vhost_dev *vdev, const char *name, const char *mask_str,

			 enum spdk_vhost_dev_type type, const struct spdk_vhost_dev_backend *backend)

{

	if (spdk_vhost_dev_construct_fail()) {

		return -1;

	}



	g_spdk_vhost_device = vdev;

	return 0;

}



int

spdk_vhost_dev_remove(struct spdk_vhost_dev *vdev)

{

	if (spdk_vhost_dev_remove_fail()) {

		return -1;

	}



	free(vdev->name);

	g_spdk_vhost_device = NULL;

	return 0;

}



struct spdk_ring *

spdk_ring_create(enum spdk_ring_type type, size_t count, int socket_id)

{

	return NULL;

}



static void

vhost_blk_controller_construct_test(void)

{

	int rc;



	MOCK_SET_P(spdk_conf_next_section, struct spdk_conf_section *, NULL);



	/* VhostBlk section has non numeric suffix */

	MOCK_SET(spdk_conf_section_match_prefix, bool, true);

	MOCK_SET_P(spdk_conf_section_get_name, const char *, "VhostBlkx");

	rc = spdk_vhost_blk_controller_construct();

	CU_ASSERT(rc != 0);



	/* Device has no name */

	MOCK_SET_P(spdk_conf_section_get_name, const char *, "VhostBlk0");

	MOCK_SET_P(spdk_conf_section_get_val, char *, NULL);

	rc = spdk_vhost_blk_controller_construct();

	CU_ASSERT(rc != 0);

}



static struct spdk_vhost_blk_dev *

alloc_bvdev(void)

{

	struct spdk_vhost_blk_dev *bvdev = spdk_dma_zmalloc(sizeof(struct spdk_vhost_blk_dev),

					   SPDK_CACHE_LINE_SIZE, NULL);



	SPDK_CU_ASSERT_FATAL(bvdev != NULL);

	bvdev->vdev.type = SPDK_VHOST_DEV_T_BLK;

	return bvdev;

}



static void

vhost_blk_construct_test(void)

{

	int rc;

	struct spdk_bdev *ut_p_spdk_bdev = MOCK_PASS_THRU_P;



	MOCK_SET(spdk_vhost_dev_remove_fail, bool, false);

	MOCK_SET(spdk_vhost_dev_construct_fail, bool, false);



	/* Create device with invalid name */

	MOCK_SET_P(spdk_bdev_get_by_name, struct spdk_bdev *, NULL);

	rc = spdk_vhost_blk_construct("vhost.0", "0x1", NULL, true);

	CU_ASSERT(rc != 0);



	/* Device could not be opened */

	MOCK_SET_P(spdk_bdev_get_by_name, struct spdk_bdev *, ut_p_spdk_bdev);

	MOCK_SET(spdk_bdev_open, int, -ENOMEM);

	rc = spdk_vhost_blk_construct("vhost.0", "0x1", "Malloc0", true);

	CU_ASSERT(rc != 0);



	/* Failed to construct controller */

	MOCK_SET(spdk_bdev_open, int, 0);

	MOCK_SET(spdk_vhost_dev_construct_fail, bool, true);

	rc = spdk_vhost_blk_construct("vhost.0", "0x1", "Malloc0", true);

	CU_ASSERT(rc != 0);



	/* Failed to set readonly as a feature */

	MOCK_SET(rte_vhost_driver_enable_features, int, -1);

	rc = spdk_vhost_blk_construct("vhost.0", "0x1", "Malloc0", true);

	CU_ASSERT(rc != 0);



	/* Failed to set readonly as a feature and failde to remove controller */

	MOCK_SET(spdk_vhost_dev_remove_fail, bool, true);

	rc = spdk_vhost_blk_construct("vhost.0", "0x1", "Malloc0", true);

	CU_ASSERT(rc != 0);

}



static void

vhost_blk_destroy_test(void)

{

	int rc;

	struct spdk_vhost_blk_dev *bvdev = NULL;



	bvdev = alloc_bvdev();



	/* Device has an incorrect type */

	bvdev->vdev.type = SPDK_VHOST_DEV_T_SCSI;

	rc = spdk_vhost_blk_destroy(&bvdev->vdev);

	CU_ASSERT(rc == -EINVAL);



	/* Failed to remove device */

	bvdev->vdev.type = SPDK_VHOST_DEV_T_BLK;

	MOCK_SET(spdk_vhost_dev_remove_fail, bool, true);

	rc = spdk_vhost_blk_destroy(&bvdev->vdev);

	CU_ASSERT(rc == -1);



	if (rc != 0) {

		free(bvdev);

	}

}



static int

test_setup(void)

{

	return 0;

}



int

main(int argc, char **argv)

{

	CU_pSuite	suite = NULL;

	unsigned int	num_failures;



	if (CU_initialize_registry() != CUE_SUCCESS) {

		return CU_get_error();

	}



	suite = CU_add_suite("vhost_scsi_suite", test_setup, NULL);

	if (suite == NULL) {

		CU_cleanup_registry();

		return CU_get_error();

	}



	if (

		CU_add_test(suite, "vhost_blk_controller_construct", vhost_blk_controller_construct_test) == NULL ||

		CU_add_test(suite, "vhost_blk_construct_test", vhost_blk_construct_test) == NULL ||

		CU_add_test(suite, "vhost_blk_destroy", vhost_blk_destroy_test) == NULL

	) {

		CU_cleanup_registry();

		return CU_get_error();

	}



	CU_basic_set_mode(CU_BRM_VERBOSE);

	CU_basic_run_tests();

	num_failures = CU_get_number_of_failures();

	CU_cleanup_registry();



	return num_failures;

}

unittest.sh

+1 −0
Original line number Diff line number Diff line
@@ -95,6 +95,7 @@ $valgrind test/unit/lib/util/string.c/string_ut 
if [ $(uname -s) = Linux ]; then

$valgrind test/unit/lib/vhost/vhost.c/vhost_ut

$valgrind test/unit/lib/vhost/vhost_scsi.c/vhost_scsi_ut

$valgrind test/unit/lib/vhost/vhost_blk.c/vhost_blk_ut

fi



# local unit test coverage