Merge branch '76-implement-a-testing-harness-for-functional-tests' into 'master' (1c4528b4) · Commits · hpc / gekkofs

.gitlab-ci.yml

+30 −14

Original line number	Diff line number	Diff line
		@@ -10,7 +10,10 @@ variables:
		DEPS_COMMIT: "${CI_PROJECT_DIR}/deps/install/gkfs_deps_commit"
		BUILD_PATH: "${CI_PROJECT_DIR}/gkfs/build"
		INSTALL_PATH: "${CI_PROJECT_DIR}/gkfs/install"
		INTEGRATION_TESTS_BIN_PATH: "${CI_PROJECT_DIR}/gkfs/install/share/gkfs/tests/integration"
		INTEGRATION_TESTS_RUN_PATH: "${CI_PROJECT_DIR}/gkfs/install/share/gkfs/tests/integration/run"
		TESTS_BUILD_PATH: "${CI_PROJECT_DIR}/test/build"
		PYTEST: "${CI_PROJECT_DIR}/gkfs/install/share/gkfs/tests/integration/pytest-venv/bin/py.test"
		LOG_PATH: "${CI_PROJECT_DIR}/logs"
		LD_LIBRARY_PATH: "${CI_PROJECT_DIR}/deps/install/lib;${CI_PROJECT_DIR}/deps/install/lib64"
		# Configuration variables
		@@ -20,7 +23,7 @@ variables:
		LIBGKFS_LOG_OUTPUT: "${CI_PROJECT_DIR}/logs/gkfs_client.log"
		GIT_SUBMODULE_STRATEGY: recursive

		image: gekkofs/gekkofs:build_env
		image: gekkofs/gekkofs:build_env-0.8.0

		compile dependencies:
		stage: build deps
		@@ -51,6 +54,8 @@ compile GekkoFS:
		-Wdev
		-Wdeprecate
		-DCMAKE_BUILD_TYPE=Debug
		-DGKFS_BUILD_TESTS:BOOL=ON
		-DGKFS_INSTALL_TESTS:BOOL=ON
		-DRPC_PROTOCOL="ofi+sockets"
		-DCMAKE_PREFIX_PATH=${DEPS_INSTALL_PATH}
		-DCMAKE_INSTALL_PREFIX=${INSTALL_PATH}
		@@ -72,6 +77,17 @@ compile tests:
		paths:
		- ${TESTS_BUILD_PATH}

		integration tests:
		stage: test
		script:
		- mkdir -p ${INTEGRATION_TESTS_RUN_PATH}
		- cd ${INTEGRATION_TESTS_BIN_PATH}
		- TMPDIR=${INTEGRATION_TESTS_RUN_PATH} unbuffer ${PYTEST} -v \| tee ${INTEGRATION_TESTS_RUN_PATH}/session.log
		artifacts:
		when: on_failure
		paths:
		- "${INTEGRATION_TESTS_RUN_PATH}"

		test wr:
		stage: test
		script:

CMake/GkfsPythonTesting.cmake

0 → 100644

+218 −0

Original line number	Diff line number	Diff line
		include(CMakeParseArguments)

		function(gkfs_enable_python_testing)
		# Parse arguments
		set(MULTI BINARY_DIRECTORIES LIBRARY_PREFIX_DIRECTORIES)

		cmake_parse_arguments(PYTEST "${OPTION}" "${SINGLE}" "${MULTI}" ${ARGN})

		if(PYTEST_UNPARSED_ARGUMENTS)
		message(WARNING "Unparsed arguments in gkfs_enable_python_testing: This often indicates typos!")
		endif()

		if(PYTEST_BINARY_DIRECTORIES)
		set(GKFS_PYTEST_BINARY_DIRECTORIES ${PYTEST_BINARY_DIRECTORIES} PARENT_SCOPE)
		endif()

		if(PYTEST_LIBRARY_PREFIX_DIRECTORIES)
		set(GKFS_PYTEST_LIBRARY_PREFIX_DIRECTORIES ${PYTEST_LIBRARY_PREFIX_DIRECTORIES} PARENT_SCOPE)
		endif()

		set(PYTEST_BINDIR_ARGS, "")
		if(PYTEST_BINARY_DIRECTORIES)
		foreach(dir IN LISTS PYTEST_BINARY_DIRECTORIES)
		list(APPEND PYTEST_BINDIR_ARGS "--bin-dir=${dir}")
		endforeach()
		endif()

		set(PYTEST_LIBDIR_ARGS, "")
		if(PYTEST_LIBRARY_PREFIX_DIRECTORIES)
		foreach(dir IN LISTS PYTEST_LIBRARY_PREFIX_DIRECTORIES)

		if(NOT IS_ABSOLUTE ${dir})
		set(dir ${CMAKE_BINARY_DIR}/${dir})
		endif()

		file(TO_CMAKE_PATH "${dir}/lib" libdir)
		file(TO_CMAKE_PATH "${dir}/lib64" lib64dir)

		if(EXISTS ${libdir})
		list(APPEND PYTEST_LIBDIR_ARGS "--lib-dir=${libdir}")
		endif()

		if(EXISTS ${lib64dir})
		list(APPEND PYTEST_LIBDIR_ARGS "--lib-dir=${lib64dir}")
		endif()
		endforeach()
		endif()

		# convert path lists to space separated arguments
		string(REPLACE ";" " " PYTEST_BINDIR_ARGS "${PYTEST_BINDIR_ARGS}")
		string(REPLACE ";" " " PYTEST_BINDIR_ARGS "${PYTEST_BINDIR_ARGS}")

		configure_file(pytest.ini.in pytest.ini @ONLY)
		configure_file(conftest.py.in conftest.py @ONLY)
		configure_file(harness/cli.py harness/cli.py COPYONLY)

		if(GKFS_INSTALL_TESTS)
		configure_file(pytest.install.ini.in pytest.install.ini @ONLY)
		install(FILES ${CMAKE_CURRENT_BINARY_DIR}/pytest.install.ini
		DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/gkfs/tests/integration
		RENAME pytest.ini
		)

		install(FILES conftest.py
		DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/gkfs/tests/integration
		)

		if(NOT PYTEST_VIRTUALENV)
		set(PYTEST_VIRTUALENV ${CMAKE_INSTALL_FULL_DATAROOTDIR}/gkfs/tests/integration/pytest-venv)
		endif()

		# Python's virtual environments are not relocatable, we need to
		# recreate the virtualenv at the appropriate install location
		# find an appropriate python interpreter
		find_package(Python3
		3.6
		REQUIRED
		COMPONENTS Interpreter)

		if(NOT Python3_FOUND)
		message(FATAL_ERROR "Unable to find Python 3")
		endif()

		install(
		CODE "message(\"Install pytest virtual environment...\")"
		CODE "message(\"-- Create virtual environment: ${PYTEST_VIRTUALENV}\")"
		CODE "execute_process(COMMAND ${Python3_EXECUTABLE} -m venv ${PYTEST_VIRTUALENV})"
		CODE "message(\"-- Installing packages...\")"
		CODE "execute_process(COMMAND ${PYTEST_VIRTUALENV}/bin/pip install --upgrade pip -v)"
		CODE "execute_process(COMMAND ${PYTEST_VIRTUALENV}/bin/pip install -r ${CMAKE_CURRENT_BINARY_DIR}/requirements.txt --upgrade -v)"
		)
		endif()

		# enable testing
		set(GKFS_PYTHON_TESTING_ENABLED ON PARENT_SCOPE)

		endfunction()

		function(gkfs_add_python_test)
		# ignore call if testing is not enabled
		if(NOT CMAKE_TESTING_ENABLED OR NOT GKFS_PYTHON_TESTING_ENABLED)
		return()
		endif()

		# Parse arguments
		set(OPTION)
		set(SINGLE NAME PYTHON_VERSION WORKING_DIRECTORY VIRTUALENV)
		set(MULTI SOURCE BINARY_DIRECTORIES LIBRARY_PREFIX_DIRECTORIES)

		cmake_parse_arguments(PYTEST "${OPTION}" "${SINGLE}" "${MULTI}" ${ARGN})

		if(PYTEST_UNPARSED_ARGUMENTS)
		message(WARNING "Unparsed arguments in gkfs_add_python_test: This often indicates typos!")
		endif()

		if(NOT PYTEST_NAME)
		message(FATAL_ERROR "gkfs_add_python_test requires a NAME argument")
		endif()

		# set default values for arguments not provided
		if(NOT PYTEST_PYTHON_VERSION)
		set(PYTEST_PYTHON_VERSION 3.0)
		endif()

		if(NOT PYTEST_WORKING_DIRECTORY)
		set(PYTEST_WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
		endif()

		if(NOT PYTEST_VIRTUALENV)
		set(PYTEST_VIRTUALENV ${CMAKE_CURRENT_BINARY_DIR}/pytest-venv)
		endif()

		# if the test doesn't provide a list of binary or library prefix
		# directories, use the one set on gkfs_enable_python_testing()
		if(NOT PYTEST_BINARY_DIRECTORIES)
		set(PYTEST_BINARY_DIRECTORIES ${GKFS_PYTEST_BINARY_DIRECTORIES})
		endif()

		if(NOT PYTEST_LIBRARY_PREFIX_DIRECTORIES)
		set(PYTEST_LIBRARY_PREFIX_DIRECTORIES ${GKFS_PYTEST_LIBRARY_PREFIX_DIRECTORIES})
		endif()

		set(PYTEST_COMMAND_ARGS, "")
		if(PYTEST_BINARY_DIRECTORIES)
		foreach(dir IN LISTS PYTEST_BINARY_DIRECTORIES)
		list(APPEND PYTEST_COMMAND_ARGS "--bin-dir=${dir}")
		endforeach()
		endif()

		if(PYTEST_LIBRARY_PREFIX_DIRECTORIES)
		foreach(dir IN LISTS PYTEST_LIBRARY_PREFIX_DIRECTORIES)

		if(NOT IS_ABSOLUTE ${dir})
		set(dir ${CMAKE_BINARY_DIR}/${dir})
		endif()

		file(TO_CMAKE_PATH "${dir}/lib" libdir)
		file(TO_CMAKE_PATH "${dir}/lib64" lib64dir)

		if(EXISTS "${dir}/lib")
		list(APPEND PYTEST_COMMAND_ARGS "--lib-dir=${libdir}")
		endif()

		if(EXISTS "${dir}/lib64")
		list(APPEND PYTEST_COMMAND_ARGS "--lib-dir=${lib64dir}")
		endif()
		endforeach()
		endif()

		# Extend the given virtualenv to be a full path.
		if(NOT IS_ABSOLUTE ${PYTEST_VIRTUALENV})
		set(PYTEST_VIRTUALENV ${CMAKE_BINARY_DIR}/${PYTEST_VIRTUALENV})
		endif()

		# find an appropriate python interpreter
		find_package(Python3
		${PYTEST_PYTHON_VERSION}
		REQUIRED
		COMPONENTS Interpreter)

		set(PYTEST_VIRTUALENV_PIP ${PYTEST_VIRTUALENV}/bin/pip)
		set(PYTEST_VIRTUALENV_INTERPRETER ${PYTEST_VIRTUALENV}/bin/python)

		# create a virtual environment to run the test
		configure_file(requirements.txt.in requirements.txt @ONLY)

		add_custom_command(
		OUTPUT ${PYTEST_VIRTUALENV}
		COMMENT "Creating virtual environment ${PYTEST_VIRTUALENV}"
		COMMAND Python3::Interpreter -m venv "${PYTEST_VIRTUALENV}"
		COMMAND ${PYTEST_VIRTUALENV_PIP} install --upgrade pip -q
		COMMAND ${PYTEST_VIRTUALENV_PIP} install -r requirements.txt --upgrade -q
		)

		if(NOT TARGET venv)
		# ensure that the virtual environment is created by the build process
		# (this is required because we can't add dependencies between
		# "test targets" and "normal targets"
		add_custom_target(venv
		ALL
		DEPENDS ${PYTEST_VIRTUALENV}
		DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/requirements.txt)
		endif()

		add_test(NAME ${PYTEST_NAME}
		COMMAND ${PYTEST_VIRTUALENV_INTERPRETER}
		-m pytest -v -s
		${PYTEST_COMMAND_ARGS}
		${PYTEST_SOURCE}
		WORKING_DIRECTORY ${PYTEST_WORKING_DIRECTORY})

		# instruct Python to not create __pycache__ directories,
		# otherwise they will pollute ${PYTEST_WORKING_DIRECTORY} which
		# is typically ${PROJECT_SOURCE_DIR}
		set_tests_properties(${PYTEST_NAME} PROPERTIES
		ENVIRONMENT PYTHONDONTWRITEBYTECODE=1)

		endfunction()

CMakeLists.txt

+15 −0

Original line number	Diff line number	Diff line
		@@ -5,6 +5,7 @@ project(
		VERSION 0.7.0
		)

		enable_testing()

		if(NOT CMAKE_COMPILER_IS_GNUCC)
		message(FATAL_ERROR "The choosen C compiler is not gcc and is not supported")
		@@ -209,3 +210,17 @@ add_subdirectory(src/global)
		add_subdirectory(src/daemon)
		# Client library
		add_subdirectory(src/client)

		option(GKFS_BUILD_TESTS "Build GekkoFS self tests" OFF)

		include(CMakeDependentOption)
		cmake_dependent_option(GKFS_INSTALL_TESTS "Install GekkoFS self tests" OFF "GKFS_BUILD_TESTS" OFF)

		if(GKFS_BUILD_TESTS)
		message(STATUS "[gekkofs] Preparing tests...")
		set(GKFS_TESTS_INTERFACE "lo" CACHE STRING "Network interface to use when running tests (default: lo)")
		message(STATUS "[gekkofs] Network interface for tests: ${GKFS_TESTS_INTERFACE}")
		add_subdirectory(tests)
		else()
		unset(GKFS_TESTS_INTERFACE CACHE)
		endif()

README.md

+15 −0

Original line number	Diff line number	Diff line
		@@ -115,6 +115,21 @@ make
		make install
		```

		In order to build self-tests, the optional GKFS_BUILD_TESTS CMake option needs
		to be enabled when building. Once that is done, tests can be run by running
		`make test` in the `build` directory:

		```bash
		mkdir build && cd build
		cmake -DGKFS_BUILD_TESTS=ON -DCMAKE_BUILD_TYPE=Release -DRPC_PROTOCOL='ofi+sockets' ..
		make
		make test
		make install
		```

		IMPORTANT: Please note that the testing framework requires Python 3.6 as an
		additional dependency in order to run.

		## Run GekkoFS

		First on each node a daemon has to be started. This can be done in two ways using the `gkfs_daemon` binary directly or

docker/debian_build_env.docker

+13 −8

Original line number	Diff line number	Diff line
		@@ -35,14 +35,19 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
		libboost-program-options-dev \
		valgrind \
		uuid-dev \
		python3 \
		python3-dev \
		python3-venv \
		expect \
		# Clean apt cache to reduce image layer size
		&& rm -rf /var/lib/apt/lists/*

		# Download dependencies source
		COPY scripts/dl_dep.sh $SCRIPTS_PATH/
		RUN /bin/bash $SCRIPTS_PATH/dl_dep.sh $DEPS_SRC_PATH all

		# Compile dependencies
		COPY scripts/compile_dep.sh $SCRIPTS_PATH/
		COPY scripts/patches $SCRIPTS_PATH/patches
		RUN /bin/bash $SCRIPTS_PATH/compile_dep.sh $DEPS_SRC_PATH $INSTALL_PATH
		## COPY scripts/dl_dep.sh $SCRIPTS_PATH/
		## COPY scripts/compile_dep.sh $SCRIPTS_PATH/
		## COPY scripts/patches $SCRIPTS_PATH/patches
		##
		## # Download dependencies source
		## RUN /bin/bash $SCRIPTS_PATH/dl_dep.sh $DEPS_SRC_PATH all
		##
		## # Compile dependencies
		## RUN /bin/bash $SCRIPTS_PATH/compile_dep.sh $DEPS_SRC_PATH $INSTALL_PATH